fmgd_firewall_ippool – Configure IPv4 IP pools.

Added in version 1.1.0.

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 v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • firewall_ippool - Configure IPv4 IP pools. type: dict
    • comments Comment. type: str more...
    • dynamic_mapping Dynamic mapping. type: list more...
      • _scope Scope. type: list more...
        • name Name. type: str more...
        • vdom Vdom. type: str more...
      • add_nat64_route (Alias name: add-nat64-route) Enable/disable adding nat64 route. type: str choices: [disable, enable] more...
      • arp_intf (Alias name: arp-intf) Select an interface from available options that will reply to arp requests. type: str more...
      • arp_reply (Alias name: 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 (Alias name: associated-interface) Associated interface name. type: str more...
      • block_size (Alias name: block-size) Number of addresses in a block (64 - 4096, default = 128). type: int more...
      • cgn_block_size (Alias name: cgn-block-size) Number of ports in a block(64 to 4096 in unit of 64, default = 128). type: int more...
      • cgn_client_endip (Alias name: cgn-client-endip) Final client ipv4 address (inclusive) (format xxx. type: str more...
      • cgn_client_ipv6shift (Alias name: cgn-client-ipv6shift) Ipv6 shift for fixed-allocation. type: int more...
      • cgn_client_startip (Alias name: cgn-client-startip) First client ipv4 address (inclusive) (format xxx. type: str more...
      • cgn_fixedalloc (Alias name: cgn-fixedalloc) Enable/disable fixed-allocation mode. type: str choices: [disable, enable] more...
      • cgn_overload (Alias name: cgn-overload) Enable/disable overload mode. type: str choices: [disable, enable] more...
      • cgn_port_end (Alias name: cgn-port-end) Ending public port can be allocated. type: int more...
      • cgn_port_start (Alias name: cgn-port-start) Starting public port can be allocated. type: int more...
      • cgn_spa (Alias name: cgn-spa) Enable/disable single port allocation mode. type: str choices: [disable, enable] more...
      • comments Comment. type: str more...
      • endip Support meta variable type: str more...
      • endport Final port number (inclusive) in the range for the address pool (default: 65533). type: int more...
      • exclude_ip (Alias name: exclude-ip) Exclude ips x. type: list more...
      • nat64 Enable/disable nat64. type: str choices: [disable, enable] more...
      • num_blocks_per_user (Alias name: num-blocks-per-user) Number of addresses blocks that can be used by a user (1 to 128, default = 8). type: int more...
      • pba_interim_log (Alias name: pba-interim-log) Port block allocation interim logging interval (600 - 86400 seconds, default = 0 which disables interim logging). type: int more...
      • pba_timeout (Alias name: pba-timeout) Port block allocation timeout (seconds). type: int more...
      • permit_any_host (Alias name: permit-any-host) Enable/disable full cone nat. type: str choices: [disable, enable] more...
      • port_per_user (Alias name: port-per-user) Number of port for each user (32 - 60416, default = 0, which is auto). type: int more...
      • source_endip (Alias name: source-endip) Support meta variable type: str more...
      • source_startip (Alias name: source-startip) Support meta variable type: str more...
      • startip Support meta variable type: str more...
      • startport First port number (inclusive) in the range for the address pool (default: 5117). type: int more...
      • subnet_broadcast_in_ippool (Alias name: subnet-broadcast-in-ippool) Enable/disable inclusion of the subnetwork address and broadcast ip address in the nat64 ip pool. type: str choices: [disable, enable] more...
      • type Ip pool type: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only) type: str choices: [overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation] more...
      • utilization_alarm_clear (Alias name: utilization-alarm-clear) Pool utilization alarm clear threshold (40-100). type: int more...
      • utilization_alarm_raise (Alias name: utilization-alarm-raise) Pool utilization alarm raise threshold (50-100). type: int more...
      • client_prefix_length (Alias name: client-prefix-length) Subnet length of a single deterministic nat64 client (1 - 128, default = 64). type: int more...
      • icmp_session_quota (Alias name: icmp-session-quota) Maximum number of concurrent icmp sessions allowed per client (0 - 2097000, default = 0 which means no limit). type: int more...
      • privileged_port_use_pba (Alias name: privileged-port-use-pba) Enable/disable selection of the external port from the port block allocation for nating privileged ports (deafult = disable). type: str choices: [disable, enable] more...
      • source_prefix6 (Alias name: source-prefix6) Source ipv6 network to be translated (format = xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx, default = ::/0). type: str more...
      • tcp_session_quota (Alias name: tcp-session-quota) Maximum number of concurrent tcp sessions allowed per client (0 - 2097000, default = 0 which means no limit). type: int more...
      • udp_session_quota (Alias name: udp-session-quota) Maximum number of concurrent udp sessions allowed per client (0 - 2097000, default = 0 which means no limit). type: int more...
    • endip Support meta variable type: str more...
    • name Ip pool name. type: str more...
    • startip Support meta variable type: str more...
    • arp_intf (Alias name: arp-intf) Select an interface from available options that will reply to arp requests. type: list more...
    • cgn_overload (Alias name: cgn-overload) Enable/disable overload mode. type: str choices: [disable, enable] more...
    • arp_reply (Alias name: 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...
    • add_nat64_route (Alias name: add-nat64-route) Enable/disable adding nat64 route. type: str choices: [disable, enable] more...
    • source_endip (Alias name: source-endip) Support meta variable type: str more...
    • exclude_ip (Alias name: exclude-ip) Exclude ips x. type: list more...
    • cgn_port_end (Alias name: cgn-port-end) Ending public port can be allocated. type: int more...
    • pba_timeout (Alias name: pba-timeout) Port block allocation timeout (seconds). type: int more...
    • associated_interface (Alias name: associated-interface) Associated interface name. type: list more...
    • cgn_spa (Alias name: cgn-spa) Enable/disable single port allocation mode. type: str choices: [disable, enable] more...
    • startport First port number (inclusive) in the range for the address pool (default: 5117). type: int more...
    • source_startip (Alias name: source-startip) Support meta variable type: str more...
    • cgn_client_startip (Alias name: cgn-client-startip) First client ipv4 address (inclusive) (format xxx. type: str more...
    • cgn_fixedalloc (Alias name: cgn-fixedalloc) Enable/disable fixed-allocation mode. type: str choices: [disable, enable] more...
    • utilization_alarm_clear (Alias name: utilization-alarm-clear) Pool utilization alarm clear threshold (40-100). type: int more...
    • block_size (Alias name: block-size) Number of addresses in a block (64 - 4096, default = 128). type: int more...
    • cgn_block_size (Alias name: cgn-block-size) Number of ports in a block(64 to 4096 in unit of 64, default = 128). type: int more...
    • pba_interim_log (Alias name: pba-interim-log) Port block allocation interim logging interval (600 - 86400 seconds, default = 0 which disables interim logging). type: int more...
    • type Ip pool type: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only) type: str choices: [overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation] more...
    • cgn_client_endip (Alias name: cgn-client-endip) Final client ipv4 address (inclusive) (format xxx. type: str more...
    • subnet_broadcast_in_ippool (Alias name: subnet-broadcast-in-ippool) Enable/disable inclusion of the subnetwork address and broadcast ip address in the nat64 ip pool. type: str choices: [disable, enable] more...
    • nat64 Enable/disable nat64. type: str choices: [disable, enable] more...
    • utilization_alarm_raise (Alias name: utilization-alarm-raise) Pool utilization alarm raise threshold (50-100). type: int more...
    • port_per_user (Alias name: port-per-user) Number of port for each user (32 - 60416, default = 0, which is auto). type: int more...
    • permit_any_host (Alias name: permit-any-host) Enable/disable full cone nat. type: str choices: [disable, enable] more...
    • num_blocks_per_user (Alias name: num-blocks-per-user) Number of addresses blocks that can be used by a user (1 to 128, default = 8). type: int more...
    • cgn_client_ipv6shift (Alias name: cgn-client-ipv6shift) Ipv6 shift for fixed-allocation. type: int more...
    • cgn_port_start (Alias name: cgn-port-start) Starting public port can be allocated. type: int more...
    • endport Final port number (inclusive) in the range for the address pool (default: 65533). type: int more...
    • icmp_session_quota (Alias name: icmp-session-quota) Maximum number of concurrent icmp sessions allowed per client (0 - 2097000, default = 0 which means no limit). type: int more...
    • client_prefix_length (Alias name: client-prefix-length) Subnet length of a single deterministic nat64 client (1 - 128, default = 64). type: int more...
    • privileged_port_use_pba (Alias name: privileged-port-use-pba) Enable/disable selection of the external port from the port block allocation for nating privileged ports (deafult = disable). type: str choices: [disable, enable] more...
    • source_prefix6 (Alias name: source-prefix6) Source ipv6 network to be translated (format = xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx, default = ::/0). type: str more...
    • tcp_session_quota (Alias name: tcp-session-quota) Maximum number of concurrent tcp sessions allowed per client (0 - 2097000, default = 0 which means no limit). type: int more...
    • udp_session_quota (Alias name: udp-session-quota) Maximum number of concurrent udp sessions allowed per client (0 - 2097000, default = 0 which means no limit). 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 IP pools.
      fortinet.fmgdevice.fmgd_firewall_ippool:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        firewall_ippool:
          name: "your value" # Required variable, string
          # comments: <string>
          # dynamic_mapping:
          #   - _scope:
          #       - name: <string>
          #         vdom: <string>
          #     add_nat64_route: <value in [disable, enable]>
          #     arp_intf: <string>
          #     arp_reply: <value in [disable, enable]>
          #     associated_interface: <string>
          #     block_size: <integer>
          #     cgn_block_size: <integer>
          #     cgn_client_endip: <string>
          #     cgn_client_ipv6shift: <integer>
          #     cgn_client_startip: <string>
          #     cgn_fixedalloc: <value in [disable, enable]>
          #     cgn_overload: <value in [disable, enable]>
          #     cgn_port_end: <integer>
          #     cgn_port_start: <integer>
          #     cgn_spa: <value in [disable, enable]>
          #     comments: <string>
          #     endip: <string>
          #     endport: <integer>
          #     exclude_ip: <list or string>
          #     nat64: <value in [disable, enable]>
          #     num_blocks_per_user: <integer>
          #     pba_interim_log: <integer>
          #     pba_timeout: <integer>
          #     permit_any_host: <value in [disable, enable]>
          #     port_per_user: <integer>
          #     source_endip: <string>
          #     source_startip: <string>
          #     startip: <string>
          #     startport: <integer>
          #     subnet_broadcast_in_ippool: <value in [disable, enable]>
          #     type: <value in [overload, one-to-one, fixed-port-range, ...]>
          #     utilization_alarm_clear: <integer>
          #     utilization_alarm_raise: <integer>
          #     client_prefix_length: <integer>
          #     icmp_session_quota: <integer>
          #     privileged_port_use_pba: <value in [disable, enable]>
          #     source_prefix6: <string>
          #     tcp_session_quota: <integer>
          #     udp_session_quota: <integer>
          # endip: <string>
          # startip: <string>
          # arp_intf: <list or string>
          # cgn_overload: <value in [disable, enable]>
          # arp_reply: <value in [disable, enable]>
          # add_nat64_route: <value in [disable, enable]>
          # source_endip: <string>
          # exclude_ip: <list or string>
          # cgn_port_end: <integer>
          # pba_timeout: <integer>
          # associated_interface: <list or string>
          # cgn_spa: <value in [disable, enable]>
          # startport: <integer>
          # source_startip: <string>
          # cgn_client_startip: <string>
          # cgn_fixedalloc: <value in [disable, enable]>
          # utilization_alarm_clear: <integer>
          # block_size: <integer>
          # cgn_block_size: <integer>
          # pba_interim_log: <integer>
          # type: <value in [overload, one-to-one, fixed-port-range, ...]>
          # cgn_client_endip: <string>
          # subnet_broadcast_in_ippool: <value in [disable, enable]>
          # nat64: <value in [disable, enable]>
          # utilization_alarm_raise: <integer>
          # port_per_user: <integer>
          # permit_any_host: <value in [disable, enable]>
          # num_blocks_per_user: <integer>
          # cgn_client_ipv6shift: <integer>
          # cgn_port_start: <integer>
          # endport: <integer>
          # icmp_session_quota: <integer>
          # client_prefix_length: <integer>
          # privileged_port_use_pba: <value in [disable, enable]>
          # source_prefix6: <string>
          # tcp_session_quota: <integer>
          # udp_session_quota: <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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)