fortinet.fortimanager.fmgr_firewall_ippool module – Configure IPv4 IP pools.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_ippool.

New in fortinet.fortimanager 1.0.0

Synopsis 

This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters 

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
firewall_ippool dictionary	The top level parameters set.
add-nat64-route string	Deprecated, please rename it to add_nat64_route. Enable/disable adding NAT64 route. Choices: `"disable"` `"enable"`
arp-intf string	Deprecated, please rename it to arp_intf. Select an interface from available options that will reply to ARP requests.
arp-reply string	Deprecated, please rename it to arp_reply. Enable/disable replying to ARP requests when an IP Pool is added to a policy Choices: `"disable"` `"enable"`
associated-interface string	Deprecated, please rename it to associated_interface. Associated interface name.
block-size integer	Deprecated, please rename it to block_size. Number of addresses in a block
cgn-block-size integer	Deprecated, please rename it to cgn_block_size. Number of ports in a block
cgn-client-endip string	Deprecated, please rename it to cgn_client_endip. Final client IPv4 address
cgn-client-ipv6shift integer	Deprecated, please rename it to cgn_client_ipv6shift. IPv6 shift for fixed-allocation.
cgn-client-startip string	Deprecated, please rename it to cgn_client_startip. First client IPv4 address
cgn-fixedalloc string	Deprecated, please rename it to cgn_fixedalloc. Enable/disable fixed-allocation mode. Choices: `"disable"` `"enable"`
cgn-overload string	Deprecated, please rename it to cgn_overload. Enable/disable overload mode. Choices: `"disable"` `"enable"`
cgn-port-end integer	Deprecated, please rename it to cgn_port_end. Ending public port can be allocated.
cgn-port-start integer	Deprecated, please rename it to cgn_port_start. Starting public port can be allocated.
cgn-spa string	Deprecated, please rename it to cgn_spa. Enable/disable single port allocation mode. Choices: `"disable"` `"enable"`
client-prefix-length integer	Deprecated, please rename it to client_prefix_length. Subnet length of a single deterministic NAT64 client
comments string	Comment.
dynamic_mapping list / elements=dictionary	Dynamic mapping.
_scope list / elements=dictionary	Scope.
name string	Name.
vdom string	Vdom.
add-nat64-route string	Deprecated, please rename it to add_nat64_route. Enable/disable adding NAT64 route. Choices: `"disable"` `"enable"`
arp-intf string	Deprecated, please rename it to arp_intf. Arp intf.
arp-reply string	Deprecated, please rename it to arp_reply. Arp reply. Choices: `"disable"` `"enable"`
associated-interface string	Deprecated, please rename it to associated_interface. Associated interface.
block-size integer	Deprecated, please rename it to block_size. Block size.
cgn-block-size integer	Deprecated, please rename it to cgn_block_size. Cgn block size.
cgn-client-endip string	Deprecated, please rename it to cgn_client_endip. Cgn client endip.
cgn-client-ipv6shift integer	Deprecated, please rename it to cgn_client_ipv6shift. IPv6 shift for fixed-allocation.
cgn-client-startip string	Deprecated, please rename it to cgn_client_startip. Cgn client startip.
cgn-fixedalloc string	Deprecated, please rename it to cgn_fixedalloc. Cgn fixedalloc. Choices: `"disable"` `"enable"`
cgn-overload string	Deprecated, please rename it to cgn_overload. Cgn overload. Choices: `"disable"` `"enable"`
cgn-port-end integer	Deprecated, please rename it to cgn_port_end. Cgn port end.
cgn-port-start integer	Deprecated, please rename it to cgn_port_start. Cgn port start.
cgn-spa string	Deprecated, please rename it to cgn_spa. Cgn spa. Choices: `"disable"` `"enable"`
client-prefix-length integer	Deprecated, please rename it to client_prefix_length. Subnet length of a single deterministic NAT64 client
comments string	Comments.
endip string	Endip.
endport integer	Final port number
exclude-ip any	(list) Deprecated, please rename it to exclude_ip. Exclude IPs x.
icmp-session-quota integer	Deprecated, please rename it to icmp_session_quota. Maximum number of concurrent ICMP sessions allowed per client
nat64 string	Enable/disable NAT64. Choices: `"disable"` `"enable"`
num-blocks-per-user integer	Deprecated, please rename it to num_blocks_per_user. Num blocks per user.
pba-interim-log integer	Deprecated, please rename it to pba_interim_log. Port block allocation interim logging interval
pba-timeout integer	Deprecated, please rename it to pba_timeout. Pba timeout.
permit-any-host string	Deprecated, please rename it to permit_any_host. Permit any host. Choices: `"disable"` `"enable"`
port-per-user integer	Deprecated, please rename it to port_per_user. Number of port for each user
privileged-port-use-pba string	Deprecated, please rename it to privileged_port_use_pba. Enable/disable selection of the external port from the po… Choices: `"disable"` `"enable"`
source-endip string	Deprecated, please rename it to source_endip. Source endip.
source-prefix6 string	Deprecated, please rename it to source_prefix6. Source IPv6 network to be translated
source-startip string	Deprecated, please rename it to source_startip. Source startip.
startip string	Startip.
startport integer	First port number
subnet-broadcast-in-ippool string	Deprecated, please rename it to subnet_broadcast_in_ippool. Enable/disable inclusion of the subnetwork address and… Choices: `"disable"` `"enable"`
tcp-session-quota integer	Deprecated, please rename it to tcp_session_quota. Maximum number of concurrent TCP sessions allowed per client
type string	Type. Choices: `"overload"` `"one-to-one"` `"fixed-port-range"` `"port-block-allocation"` `"cgn-resource-allocation"`
udp-session-quota integer	Deprecated, please rename it to udp_session_quota. Maximum number of concurrent UDP sessions allowed per client
utilization-alarm-clear integer	Deprecated, please rename it to utilization_alarm_clear. Utilization alarm clear.
utilization-alarm-raise integer	Deprecated, please rename it to utilization_alarm_raise. Utilization alarm raise.
endip string	Final IPv4 address
endport integer	Final port number
exclude-ip any	(list) Deprecated, please rename it to exclude_ip. Exclude IPs x.
icmp-session-quota integer	Deprecated, please rename it to icmp_session_quota. Maximum number of concurrent ICMP sessions allowed per client
name string / required	IP pool name.
nat64 string	Enable/disable NAT64. Choices: `"disable"` `"enable"`
num-blocks-per-user integer	Deprecated, please rename it to num_blocks_per_user. Number of addresses blocks that can be used by a user
pba-interim-log integer	Deprecated, please rename it to pba_interim_log. Port block allocation interim logging interval
pba-timeout integer	Deprecated, please rename it to pba_timeout. Port block allocation timeout
permit-any-host string	Deprecated, please rename it to permit_any_host. Enable/disable full cone NAT. Choices: `"disable"` `"enable"`
port-per-user integer	Deprecated, please rename it to port_per_user. Number of port for each user
privileged-port-use-pba string	Deprecated, please rename it to privileged_port_use_pba. Enable/disable selection of the external port from the port block… Choices: `"disable"` `"enable"`
source-endip string	Deprecated, please rename it to source_endip. Final IPv4 address
source-prefix6 string	Deprecated, please rename it to source_prefix6. Source IPv6 network to be translated
source-startip string	Deprecated, please rename it to source_startip. First IPv4 address
startip string	First IPv4 address
startport integer	First port number
subnet-broadcast-in-ippool string	Deprecated, please rename it to subnet_broadcast_in_ippool. Enable/disable inclusion of the subnetwork address and broadca… Choices: `"disable"` `"enable"`
tcp-session-quota integer	Deprecated, please rename it to tcp_session_quota. Maximum number of concurrent TCP sessions allowed per client
type string	IP pool type Choices: `"overload"` `"one-to-one"` `"fixed-port-range"` `"port-block-allocation"` `"cgn-resource-allocation"`
udp-session-quota integer	Deprecated, please rename it to udp_session_quota. Maximum number of concurrent UDP sessions allowed per client
utilization-alarm-clear integer	Deprecated, please rename it to utilization_alarm_clear. Pool utilization alarm clear threshold
utilization-alarm-raise integer	Deprecated, please rename it to utilization_alarm_raise. Pool utilization alarm raise threshold
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: `"present"` `"absent"`
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: `300`

Notes 

Note

Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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 here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

fortinet.fortimanager.fmgr_firewall_ippool module – Configure IPv4 IP pools.

Synopsis

Parameters

Notes

Examples

Return Values