ansible / ansible.builtin / v2.9.23 / module / fmgr_fwobj_ippool Allows the editing of IP Pool Objects within FortiManager. | "added in version" 2.8 of ansible.builtin" Authors: Luke Weighall (@lweighall), Andrew Welsh (@Ghilli3), Jim Huber (@p4r4n0y1ng) preview | supported by communityansible.builtin.fmgr_fwobj_ippool (v2.9.23) — module
pip
Install with pip install ansible==2.9.23
Allows users to add/edit/delete IP Pool Objects.
- name: ADD FMGR_FIREWALL_IPPOOL Overload fmgr_fwobj_ippool: mode: "add" adom: "ansible" name: "Ansible_pool4_overload" comments: "Created by ansible" type: "overload" # OPTIONS FOR ALL MODES startip: "10.10.10.10" endip: "10.10.10.100" arp_reply: "enable"
- name: ADD FMGR_FIREWALL_IPPOOL one-to-one fmgr_fwobj_ippool: mode: "add" adom: "ansible" name: "Ansible_pool4_121" comments: "Created by ansible" type: "one-to-one" # OPTIONS FOR ALL MODES startip: "10.10.20.10" endip: "10.10.20.100" arp_reply: "enable"
- name: ADD FMGR_FIREWALL_IPPOOL FIXED PORT RANGE fmgr_fwobj_ippool: mode: "add" adom: "ansible" name: "Ansible_pool4_fixed_port" comments: "Created by ansible" type: "fixed-port-range" # OPTIONS FOR ALL MODES startip: "10.10.40.10" endip: "10.10.40.100" arp_reply: "enable" # FIXED PORT RANGE OPTIONS source_startip: "192.168.20.1" source_endip: "192.168.20.20"
- name: ADD FMGR_FIREWALL_IPPOOL PORT BLOCK ALLOCATION fmgr_fwobj_ippool: mode: "add" adom: "ansible" name: "Ansible_pool4_port_block_allocation" comments: "Created by ansible" type: "port-block-allocation" # OPTIONS FOR ALL MODES startip: "10.10.30.10" endip: "10.10.30.100" arp_reply: "enable" # PORT BLOCK ALLOCATION OPTIONS block_size: "128" num_blocks_per_user: "1"
adom: default: root description: - The ADOM the configuration should belong to. required: false mode: choices: - add - set - delete - update default: add description: - Sets one of three modes for managing the object. - Allows use of soft-adds instead of overwriting existing values required: false name: description: - IP pool name. required: false type: choices: - overload - one-to-one - fixed-port-range - port-block-allocation description: - IP pool type (overload, one-to-one, fixed port range, or port block allocation). - choice | overload | IP addresses in the IP pool can be shared by clients. - choice | one-to-one | One to one mapping. - choice | fixed-port-range | Fixed port range. - choice | port-block-allocation | Port block allocation. required: false endip: description: - Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default| 0.0.0.0). required: false startip: description: - First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default| 0.0.0.0). required: false arp_intf: description: - Select an interface from available options that will reply to ARP requests. (If blank, any is selected). required: false comments: description: - Comment. required: false arp_reply: choices: - disable - enable description: - Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). - choice | disable | Disable ARP reply. - choice | enable | Enable ARP reply. required: false block_size: description: - Number of addresses in a block (64 to 4096, default = 128). required: false pba_timeout: description: - Port block allocation timeout (seconds). required: false source_endip: description: - Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default| 0.0.0.0). required: false source_startip: description: - First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default| 0.0.0.0). required: false dynamic_mapping: description: - EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! - List of multiple child objects to be added. Expects a list of dictionaries. - Dictionaries must use FortiManager API parameters, not the ansible ones listed below. - If submitted, all other prefixed sub-parameter.ARE IGNORED. - This object is MUTUALLY EXCLUSIVE with its options. - We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. - WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS required: false permit_any_host: choices: - disable - enable description: - Enable/disable full cone NAT. - choice | disable | Disable full cone NAT. - choice | enable | Enable full cone NAT. required: false num_blocks_per_user: description: - Number of addresses blocks that can be used by a user (1 to 128, default = 8). required: false associated_interface: description: - Associated interface name. required: false dynamic_mapping_type: choices: - overload - one-to-one - fixed-port-range - port-block-allocation description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_endip: description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_startip: description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_arp_intf: description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_comments: description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_arp_reply: choices: - disable - enable description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_block_size: description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_pba_timeout: description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_source_endip: description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_source_startip: description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_permit_any_host: choices: - disable - enable description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_num_blocks_per_user: description: - Dynamic Mapping clone of original suffixed parameter. required: false dynamic_mapping_associated_interface: description: - Dynamic Mapping clone of original suffixed parameter. required: false
api_result: description: full API response, includes status code and message returned: always type: str