fortios_firewall_ippool – Configure IPv4 IP pools in Fortinet’s FortiOS and FortiGate.
Added in version 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.16
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- firewall_ippool - Configure IPv4 IP pools. type: dict more...
- add_nat64_route - Enable/disable adding NAT64 route. type: str choices: disable, enable more...
- arp_intf - Select an interface from available options that will reply to ARP requests. (If blank, any is selected). Source system.interface.name. type: str more...
- arp_reply - Enable/disable replying to ARP requests when an IP Pool is added to a policy . type: str choices: disable, enable more...
- associated_interface - Associated interface name. Source system.interface.name. type: str more...
- block_size - Number of addresses in a block (64 - 4096). type: int more...
- client_prefix_length - Subnet length of a single deterministic NAT64 client (1 - 128). type: int more...
- comments - Comment. type: str more...
- endip - Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx). type: str more...
- endport - Final port number (inclusive) in the range for the address pool (1024 - 65535). type: int more...
- icmp_session_quota - Maximum number of concurrent ICMP sessions allowed per client (0 - 2097000). type: int more...
- name - IP pool name. type: str required: true more...
- nat64 - Enable/disable NAT64. type: str choices: disable, enable more...
- num_blocks_per_user - Number of addresses blocks that can be used by a user (1 to 128). type: int more...
- pba_interim_log - Port block allocation interim logging interval (600 - 86400 seconds). type: int more...
- pba_timeout - Port block allocation timeout (seconds). type: int more...
- permit_any_host - Enable/disable fullcone NAT. Accept UDP packets from any host. type: str choices: disable, enable more...
- port_per_user - Number of port for each user (32 - 60416). type: int more...
- privileged_port_use_pba - Enable/disable selection of the external port from the port block allocation for NAT"ing privileged ports (deafult = disable). type: str choices: disable, enable more...
- source_endip - Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx). type: str more...
- source_prefix6 - Source IPv6 network to be translated (format = xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). type: str more...
- source_startip - First IPv4 address (inclusive) in the range of the source addresses to be translated (format = xxx.xxx.xxx.xxx). type: str more...
- startip - First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx). type: str more...
- startport - First port number (inclusive) in the range for the address pool (1024 - 65535). type: int more...
- 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...
- tcp_session_quota - Maximum number of concurrent TCP sessions allowed per client (0 - 2097000). 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 more...
- udp_session_quota - Maximum number of concurrent UDP sessions allowed per client (0 - 2097000). type: int more...
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.