fmgr_firewall_ippool – Configure IPv4 IP pools.

Added in version 1.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> 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
  • adom - The parameter in requested url type: str required: true
  • firewall_ippool - Configure IPv4 IP pools. type: dict
    • 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 to 4096, default = 128). type: int more...
    • 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...
      • 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 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 (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_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...
      • source_endip (Alias name: source-endip) Final ipv4 address (inclusive) in the range of the source addresses to be translated (format xxx. type: str more...
      • source_startip (Alias name: 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 (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_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...
      • 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...
      • endport Final port number (inclusive) in the range for the address pool (default: 65533). type: int more...
      • port_per_user (Alias name: 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 (Alias name: add-nat64-route) Enable/disable adding nat64 route. type: str choices: [disable, enable] more...
      • cgn_client_ipv6shift (Alias name: cgn-client-ipv6shift) Ipv6 shift for fixed-allocation. type: int more...
      • nat64 Enable/disable nat64. type: str choices: [disable, enable] 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...
      • exclude_ip (Alias name: exclude-ip) type: list more...
    • endip Final ipv4 address (inclusive) in the range for the address pool (format xxx. type: str more...
    • name Ip pool name. type: str 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_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...
    • source_endip (Alias name: source-endip) Final ipv4 address (inclusive) in the range of the source addresses to be translated (format xxx. type: str more...
    • source_startip (Alias name: 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...
    • utilization_alarm_clear (Alias name: utilization-alarm-clear) Pool utilization alarm clear threshold (40-100). type: int more...
    • cgn_fixedalloc (Alias name: cgn-fixedalloc) Enable/disable fixed-allocation mode. type: str choices: [disable, enable] more...
    • cgn_client_startip (Alias name: cgn-client-startip) First client ipv4 address (inclusive) (format xxx. type: str more...
    • cgn_client_endip (Alias name: cgn-client-endip) Final client ipv4 address (inclusive) (format xxx. type: str more...
    • cgn_overload (Alias name: cgn-overload) Enable/disable overload mode. type: str choices: [disable, enable] 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...
    • utilization_alarm_raise (Alias name: utilization-alarm-raise) Pool utilization alarm raise threshold (50-100). 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...
    • cgn_port_end (Alias name: cgn-port-end) Ending 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...
    • port_per_user (Alias name: 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 (Alias name: add-nat64-route) Enable/disable adding nat64 route. type: str choices: [disable, enable] more...
    • nat64 Enable/disable nat64. type: str choices: [disable, enable] more...
    • cgn_client_ipv6shift (Alias name: cgn-client-ipv6shift) Ipv6 shift for fixed-allocation. 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...
    • exclude_ip (Alias name: exclude-ip) type: list 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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 IP pools.
      fortinet.fortimanager.fmgr_firewall_ippool:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_ippool:
          comments: "ansible-comment"
          endip: "222.222.222.254"
          name: "ansible-test"
          startip: "222.222.222.0"
          type: overload # <value in [overload, one-to-one, fixed-port-range, ...]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IPv4 IP pools
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_ippool"
          params:
            adom: "ansible"
            ippool: "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:

  • 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)