fortinet.fortios.fortios_firewall_ippool module – Configure IPv4 IP pools in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_ippool.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ippool category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure IPv4 IP pools. |
|
Enable/disable adding NAT64 route. Choices:
|
|
Select an interface from available options that will reply to ARP requests. (If blank, any is selected). Source system.interface.name. |
|
Enable/disable replying to ARP requests when an IP Pool is added to a policy . Choices:
|
|
Associated interface name. Source system.interface.name. |
|
Number of addresses in a block (64 - 4096). |
|
Subnet length of a single deterministic NAT64 client (1 - 128). |
|
Comment. |
|
Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx). |
|
Final port number (inclusive) in the range for the address pool (1024 - 65535). |
|
Maximum number of concurrent ICMP sessions allowed per client (0 - 2097000). |
|
IP pool name. |
|
Enable/disable NAT64. Choices:
|
|
Number of addresses blocks that can be used by a user (1 to 128). |
|
Port block allocation interim logging interval (600 - 86400 seconds). |
|
Port block allocation timeout (seconds). |
|
Enable/disable full cone NAT. Choices:
|
|
Number of port for each user (32 - 60416). |
|
Enable/disable selection of the external port from the port block allocation for NAT”ing privileged ports (deafult = disable). Choices:
|
|
Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx). |
|
Source IPv6 network to be translated (format = xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). |
|
First IPv4 address (inclusive) in the range of the source addresses to be translated (format = xxx.xxx.xxx.xxx). |
|
First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx). |
|
First port number (inclusive) in the range for the address pool (1024 - 65535). |
|
Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. Choices:
|
|
Maximum number of concurrent TCP sessions allowed per client (0 - 2097000). |
|
IP pool type: overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation (hyperscale vdom only) Choices:
|
|
Maximum number of concurrent UDP sessions allowed per client (0 - 2097000). |
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure IPv4 IP pools.
fortinet.fortios.fortios_firewall_ippool:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ippool:
add_nat64_route: "disable"
arp_intf: "<your_own_value> (source system.interface.name)"
arp_reply: "disable"
associated_interface: "<your_own_value> (source system.interface.name)"
block_size: "128"
client_prefix_length: "64"
comments: "<your_own_value>"
endip: "<your_own_value>"
endport: "65533"
icmp_session_quota: "0"
name: "default_name_13"
nat64: "disable"
num_blocks_per_user: "8"
pba_interim_log: "0"
pba_timeout: "30"
permit_any_host: "disable"
port_per_user: "0"
privileged_port_use_pba: "disable"
source_endip: "<your_own_value>"
source_prefix6: "<your_own_value>"
source_startip: "<your_own_value>"
startip: "<your_own_value>"
startport: "5117"
subnet_broadcast_in_ippool: "disable"
tcp_session_quota: "0"
type: "overload"
udp_session_quota: "0"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |