fmgr_firewall_ippool_dynamicmapping – Configure IPv4 IP pools.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.
  • Tested with FortiManager v6.0.0.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
firewall_ippool_dynamicmapping yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • ippool - The parameter in requested url type: str required: true
  • firewall_ippool_dynamicmapping - Configure IPv4 IP pools. type: dict
    • _scope - No description for the parameter type: array more...
      • name - No description for the parameter type: str more...
      • vdom - No description for the parameter type: str more...
    • arp-intf - No description for the parameter type: str more...
    • arp-reply - No description for the parameter type: str choices: [disable, enable] more...
    • associated-interface - No description for the parameter type: str more...
    • block-size - No description for the parameter type: int more...
    • comments - No description for the parameter type: str more...
    • endip - No description for the parameter type: str more...
    • num-blocks-per-user - No description for the parameter type: int more...
    • pba-timeout - No description for the parameter type: int more...
    • permit-any-host - No description for the parameter type: str choices: [disable, enable] more...
    • source-endip - No description for the parameter type: str more...
    • source-startip - No description for the parameter type: str more...
    • startip - No description for the parameter type: str more...
    • type - No description for the parameter type: str choices: [overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation] more...
    • cgn-block-size - No description for the parameter type: int more...
    • cgn-client-endip - No description for the parameter type: str more...
    • cgn-client-startip - No description for the parameter type: str more...
    • cgn-fixedalloc - No description for the parameter type: str choices: [disable, enable] more...
    • cgn-overload - No description for the parameter type: str choices: [disable, enable] more...
    • cgn-port-end - No description for the parameter type: int more...
    • cgn-port-start - No description for the parameter type: int more...
    • cgn-spa - No description for the parameter type: str choices: [disable, enable] more...
    • utilization-alarm-clear - No description for the parameter type: int more...
    • utilization-alarm-raise - No description for the parameter type: int more...
    • endport - Final port number (inclusive) in the range for the address pool (Default: 65533). type: int more...
    • port-per-user - Number of port for each user (32 to 60416, default = 0, auto). type: int more...
    • startport - First port number (inclusive) in the range for the address pool (Default: 5117). type: int more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv4 IP pools.
     fmgr_firewall_ippool_dynamicmapping:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        ippool: <your own value>
        state: <value in [present, absent]>
        firewall_ippool_dynamicmapping:
           _scope:
             -
                 name: <value of string>
                 vdom: <value of string>
           arp-intf: <value of string>
           arp-reply: <value in [disable, enable]>
           associated-interface: <value of string>
           block-size: <value of integer>
           comments: <value of string>
           endip: <value of string>
           num-blocks-per-user: <value of integer>
           pba-timeout: <value of integer>
           permit-any-host: <value in [disable, enable]>
           source-endip: <value of string>
           source-startip: <value of string>
           startip: <value of string>
           type: <value in [overload, one-to-one, fixed-port-range, ...]>
           cgn-block-size: <value of integer>
           cgn-client-endip: <value of string>
           cgn-client-startip: <value of string>
           cgn-fixedalloc: <value in [disable, enable]>
           cgn-overload: <value in [disable, enable]>
           cgn-port-end: <value of integer>
           cgn-port-start: <value of integer>
           cgn-spa: <value in [disable, enable]>
           utilization-alarm-clear: <value of integer>
           utilization-alarm-raise: <value of integer>
           endport: <value of integer>
           port-per-user: <value of integer>
           startport: <value of integer>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.