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.

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 7.2.0
firewall_ippool_dynamicmapping yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: 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 - no description type: dict
    • _scope - No description for the parameter type: array more...
      • name - Name. type: str more...
      • vdom - Vdom. type: str more...
    • arp-intf - Select an interface from available options that will reply to ARP requests. type: str more...
    • arp-reply - Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). type: str choices: [disable, enable] more...
    • associated-interface - Associated interface name. type: str more...
    • block-size - Number of addresses in a block (64 to 4096, default = 128). type: int more...
    • comments - Comment. type: str more...
    • endip - Final IPv4 address (inclusive) in the range for the address pool (format xxx. type: str more...
    • num-blocks-per-user - Number of addresses blocks that can be used by a user (1 to 128, default = 8). type: int more...
    • pba-timeout - Port block allocation timeout (seconds). type: int more...
    • permit-any-host - Enable/disable full cone NAT. type: str choices: [disable, enable] more...
    • source-endip - Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx. type: str more...
    • source-startip - First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx. type: str more...
    • startip - First IPv4 address (inclusive) in the range for the address pool (format xxx. type: str more...
    • type - IP pool type (overload, one-to-one, fixed port range, or port block allocation). type: str choices: [overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation] more...
    • cgn-block-size - Number of ports in a block(64 to 4096 in unit of 64, default = 128). type: int more...
    • cgn-client-endip - Final client IPv4 address (inclusive) (format xxx. type: str more...
    • cgn-client-startip - First client IPv4 address (inclusive) (format xxx. type: str more...
    • cgn-fixedalloc - Enable/disable fixed-allocation mode. type: str choices: [disable, enable] more...
    • cgn-overload - Enable/disable overload mode. type: str choices: [disable, enable] more...
    • cgn-port-end - Ending public port can be allocated. type: int more...
    • cgn-port-start - Starting public port can be allocated. type: int more...
    • cgn-spa - Enable/disable single port allocation mode. type: str choices: [disable, enable] more...
    • utilization-alarm-clear - Pool utilization alarm clear threshold (40-100). type: int more...
    • utilization-alarm-raise - Pool utilization alarm raise threshold (50-100). 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...
    • add-nat64-route - Enable/disable adding NAT64 route. type: str choices: [disable, enable] more...
    • cgn-client-ipv6shift - No description for the parameter type: int more...
    • nat64 - Enable/disable NAT64. type: str choices: [disable, enable] 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: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure dynamic mappings of IPv4 IP pool
     fmgr_firewall_ippool_dynamicmapping:
        bypass_validation: False
        adom: ansible
        ippool: 'ansible-test' # name
        state: present
        firewall_ippool_dynamicmapping:
           _scope:
             -
                 name: FGT_AWS # need a valid device name
                 vdom: root # need a valid vdom name under the device
           comments: 'ansible-comment'
           endip: '222.222.222.253'
           startip: '222.222.222.0'
           type: overload #<value in [overload, one-to-one, fixed-port-range, ...]>
- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the dynamic mappings of IPv4 IP pool
     fmgr_fact:
       facts:
           selector: 'firewall_ippool_dynamicmapping'
           params:
               adom: 'ansible'
               ippool: 'ansible-test' # name
               dynamic_mapping: 'your_value'

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.