fortinet.fortimanager.fmgr_firewall_ippool module – Configure IPv4 IP pools.
Note
This module is part of the fortinet.fortimanager collection (version 2.4.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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to add_nat64_route. Enable/disable adding NAT64 route. Choices:
|
|
Deprecated, please rename it to arp_intf. Select an interface from available options that will reply to ARP requests. |
|
Deprecated, please rename it to arp_reply. Enable/disable replying to ARP requests when an IP Pool is added to a policy Choices:
|
|
Deprecated, please rename it to associated_interface. Associated interface name. |
|
Deprecated, please rename it to block_size. Number of addresses in a block |
|
Deprecated, please rename it to cgn_block_size. Number of ports in a block |
|
Deprecated, please rename it to cgn_client_endip. Final client IPv4 address |
|
Deprecated, please rename it to cgn_client_ipv6shift. IPv6 shift for fixed-allocation. |
|
Deprecated, please rename it to cgn_client_startip. First client IPv4 address |
|
Deprecated, please rename it to cgn_fixedalloc. Enable/disable fixed-allocation mode. Choices:
|
|
Deprecated, please rename it to cgn_overload. Enable/disable overload mode. Choices:
|
|
Deprecated, please rename it to cgn_port_end. Ending public port can be allocated. |
|
Deprecated, please rename it to cgn_port_start. Starting public port can be allocated. |
|
Deprecated, please rename it to cgn_spa. Enable/disable single port allocation mode. Choices:
|
|
Comment. |
|
Dynamic_Mapping. |
|
_Scope. |
|
Name. |
|
Vdom. |
|
Deprecated, please rename it to add_nat64_route. Enable/disable adding NAT64 route. Choices:
|
|
Deprecated, please rename it to arp_intf. Select an interface from available options that will reply to ARP requests. |
|
Deprecated, please rename it to arp_reply. Enable/disable replying to ARP requests when an IP Pool is added to a p… Choices:
|
|
Deprecated, please rename it to associated_interface. Associated interface name. |
|
Deprecated, please rename it to block_size. Number of addresses in a block |
|
Deprecated, please rename it to cgn_block_size. Number of ports in a block |
|
Deprecated, please rename it to cgn_client_endip. Final client IPv4 address |
|
Deprecated, please rename it to cgn_client_ipv6shift. IPv6 shift for fixed-allocation. |
|
Deprecated, please rename it to cgn_client_startip. First client IPv4 address |
|
Deprecated, please rename it to cgn_fixedalloc. Enable/disable fixed-allocation mode. Choices:
|
|
Deprecated, please rename it to cgn_overload. Enable/disable overload mode. Choices:
|
|
Deprecated, please rename it to cgn_port_end. Ending public port can be allocated. |
|
Deprecated, please rename it to cgn_port_start. Starting public port can be allocated. |
|
Deprecated, please rename it to cgn_spa. Enable/disable single port allocation mode. Choices:
|
|
Comment. |
|
Final IPv4 address |
|
Final port number |
|
(list) Deprecated, please rename it to exclude_ip. |
|
Enable/disable NAT64. Choices:
|
|
Deprecated, please rename it to num_blocks_per_user. Number of addresses blocks that can be used by a user |
|
Deprecated, please rename it to pba_timeout. Port block allocation timeout |
|
Deprecated, please rename it to permit_any_host. Enable/disable full cone NAT. Choices:
|
|
Deprecated, please rename it to port_per_user. Number of port for each user |
|
Deprecated, please rename it to source_endip. Final IPv4 address |
|
Deprecated, please rename it to source_startip. First IPv4 address |
|
First IPv4 address |
|
First port number |
|
Deprecated, please rename it to subnet_broadcast_in_ippool. Enable/disable inclusion of the subnetwork address and… Choices:
|
|
IP pool type Choices:
|
|
Deprecated, please rename it to utilization_alarm_clear. Pool utilization alarm clear threshold |
|
Deprecated, please rename it to utilization_alarm_raise. Pool utilization alarm raise threshold |
|
Final IPv4 address |
|
Final port number |
|
(list) Deprecated, please rename it to exclude_ip. |
|
IP pool name. |
|
Enable/disable NAT64. Choices:
|
|
Deprecated, please rename it to num_blocks_per_user. Number of addresses blocks that can be used by a user |
|
Deprecated, please rename it to pba_timeout. Port block allocation timeout |
|
Deprecated, please rename it to permit_any_host. Enable/disable full cone NAT. Choices:
|
|
Deprecated, please rename it to port_per_user. Number of port for each user |
|
Deprecated, please rename it to source_endip. Final IPv4 address |
|
Deprecated, please rename it to source_startip. First IPv4 address |
|
First IPv4 address |
|
First port number |
|
Deprecated, please rename it to subnet_broadcast_in_ippool. Enable/disable inclusion of the subnetwork address and broadca… Choices:
|
|
IP pool type Choices:
|
|
Deprecated, please rename it to utilization_alarm_clear. Pool utilization alarm clear threshold |
|
Deprecated, please rename it to utilization_alarm_raise. Pool utilization alarm raise threshold |
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |