source: | fortios_firewall_ippool.py |
---|---|
orphan: |
.. versionadded:: 2.0.0
- 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
The below requirements are needed on the host that executes this module.
- ansible>=2.15
Using member operation to add an element to an existing object.
Supported Version Ranges: v6.0.0 -> 7.4.3
- 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...
Supported Version Ranges firewall_ippool v6.0.0 -> 7.4.3
- add_nat64_route - Enable/disable adding NAT64 route. type: str choices: disable, enable
more...
Supported Version Ranges add_nat64_route v7.0.1 -> 7.4.3
[disable] v7.0.1 -> 7.4.3
[enable] v7.0.1 -> 7.4.3
- 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...
Supported Version Ranges arp_intf v6.0.0 -> 7.4.3
- arp_reply - Enable/disable replying to ARP requests when an IP Pool is added to a policy . type: str choices: disable, enable
more...
Supported Version Ranges arp_reply v6.0.0 -> 7.4.3
[disable] v6.0.0 -> 7.4.3
[enable] v6.0.0 -> 7.4.3
- associated_interface - Associated interface name. Source system.interface.name. type: str
more...
Supported Version Ranges associated_interface v6.0.0 -> 7.4.3
- block_size - Number of addresses in a block (64 - 4096). type: int
more...
Supported Version Ranges block_size v6.0.0 -> 7.4.3
- comments - Comment. type: str
more...
Supported Version Ranges comments v6.0.0 -> 7.4.3
- endip - Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx). type: str
more...
Supported Version Ranges endip v6.0.0 -> 7.4.3
- endport - Final port number (inclusive) in the range for the address pool . type: int
more...
Supported Version Ranges endport v7.0.0 -> 7.4.3
- name - IP pool name. type: str required: true
more...
Supported Version Ranges name v6.0.0 -> 7.4.3
- nat64 - Enable/disable NAT64. type: str choices: disable, enable
more...
Supported Version Ranges nat64 v7.0.1 -> 7.4.3
[disable] v7.0.1 -> 7.4.3
[enable] v7.0.1 -> 7.4.3
- num_blocks_per_user - Number of addresses blocks that can be used by a user (1 to 128). type: int
more...
Supported Version Ranges num_blocks_per_user v6.0.0 -> 7.4.3
- pba_timeout - Port block allocation timeout (seconds). type: int
more...
Supported Version Ranges pba_timeout v6.0.0 -> 7.4.3
- permit_any_host - Enable/disable full cone NAT. type: str choices: disable, enable
more...
Supported Version Ranges permit_any_host v6.0.0 -> 7.4.3
[disable] v6.0.0 -> 7.4.3
[enable] v6.0.0 -> 7.4.3
- port_per_user - Number of port for each user (32 - 60416). type: int
more...
Supported Version Ranges port_per_user v7.0.0 -> 7.4.3
- source_endip - Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx). type: str
more...
Supported Version Ranges source_endip v6.0.0 -> 7.4.3
- source_startip - First IPv4 address (inclusive) in the range of the source addresses to be translated (format = xxx.xxx.xxx.xxx). type: str
more...
Supported Version Ranges source_startip v6.0.0 -> 7.4.3
- startip - First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx). type: str
more...
Supported Version Ranges startip v6.0.0 -> 7.4.3
- startport - First port number (inclusive) in the range for the address pool . type: int
more...
Supported Version Ranges startport v7.0.0 -> 7.4.3
- 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...
Supported Version Ranges subnet_broadcast_in_ippool v7.0.8 -> v7.0.12
v7.2.4 -> 7.4.3
[disable] v7.0.8 -> v7.0.12
[enable] v7.0.8 -> v7.0.12
- 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...
Supported Version Ranges type v6.0.0 -> 7.4.3
[overload] v6.0.0 -> 7.4.3
[one-to-one] v6.0.0 -> 7.4.3
[fixed-port-range] v6.0.0 -> 7.4.3
[port-block-allocation] v6.0.0 -> 7.4.3
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- 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"
comments: "<your_own_value>"
endip: "<your_own_value>"
endport: "65533"
name: "default_name_11"
nat64: "disable"
num_blocks_per_user: "8"
pba_timeout: "30"
permit_any_host: "disable"
port_per_user: "0"
source_endip: "<your_own_value>"
source_startip: "<your_own_value>"
startip: "<your_own_value>"
startport: "5117"
subnet_broadcast_in_ippool: "disable"
type: "overload"
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
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.