drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_firewall_ippool Configure IPv4 IP pools. | "added in version" 1.0.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_firewall_ippool (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- hosts: fortimanager00 collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configure IPv4 IP pools. 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: fortimanager00 gather_facts: no connection: httpapi collections: - fortinet.fortimanager vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: retrieve all the IPv4 IP pools fmgr_fact: facts: selector: 'firewall_ippool' params: adom: 'ansible' ippool: 'your_value'
adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list firewall_ippool: description: the top level parameters set required: false suboptions: add-nat64-route: choices: - disable - enable description: Enable/disable adding NAT64 route. type: str arp-intf: description: Select an interface from available options that will reply to ARP requests. type: str arp-reply: choices: - disable - enable description: Enable/disable replying to ARP requests when an IP Pool is added to a policy type: str associated-interface: description: Associated interface name. type: str block-size: description: Number of addresses in a block type: int cgn-block-size: description: Number of ports in a block type: int cgn-client-endip: description: Final client IPv4 address type: str cgn-client-ipv6shift: description: IPv6 shift for fixed-allocation. type: int cgn-client-startip: description: First client IPv4 address type: str cgn-fixedalloc: choices: - disable - enable description: Enable/disable fixed-allocation mode. type: str cgn-overload: choices: - disable - enable description: Enable/disable overload mode. type: str cgn-port-end: description: Ending public port can be allocated. type: int cgn-port-start: description: Starting public port can be allocated. type: int cgn-spa: choices: - disable - enable description: Enable/disable single port allocation mode. type: str comments: description: Comment. type: str dynamic_mapping: description: Dynamic_Mapping. elements: dict suboptions: _scope: description: _Scope. elements: dict suboptions: name: description: Name. type: str vdom: description: Vdom. type: str type: list add-nat64-route: choices: - disable - enable description: Enable/disable adding NAT64 route. type: str arp-intf: description: Select an interface from available options that will reply to ARP requests. type: str arp-reply: choices: - disable - enable description: Enable/disable replying to ARP requests when an IP Pool is added to a policy type: str associated-interface: description: Associated interface name. type: str block-size: description: Number of addresses in a block type: int cgn-block-size: description: Number of ports in a block type: int cgn-client-endip: description: Final client IPv4 address type: str cgn-client-ipv6shift: description: IPv6 shift for fixed-allocation. type: int cgn-client-startip: description: First client IPv4 address type: str cgn-fixedalloc: choices: - disable - enable description: Enable/disable fixed-allocation mode. type: str cgn-overload: choices: - disable - enable description: Enable/disable overload mode. type: str cgn-port-end: description: Ending public port can be allocated. type: int cgn-port-start: description: Starting public port can be allocated. type: int cgn-spa: choices: - disable - enable description: Enable/disable single port allocation mode. type: str comments: description: Comment. type: str endip: description: Final IPv4 address type: str endport: description: Final port number type: int exclude-ip: description: description type: str nat64: choices: - disable - enable description: Enable/disable NAT64. type: str num-blocks-per-user: description: Number of addresses blocks that can be used by a user type: int pba-timeout: description: Port block allocation timeout type: int permit-any-host: choices: - disable - enable description: Enable/disable full cone NAT. type: str port-per-user: description: Number of port for each user type: int source-endip: description: Final IPv4 address type: str source-startip: description: First IPv4 address type: str startip: description: First IPv4 address type: str startport: description: First port number type: int subnet-broadcast-in-ippool: choices: - disable - enable description: Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. type: str type: choices: - overload - one-to-one - fixed-port-range - port-block-allocation - cgn-resource-allocation description: IP pool type type: str utilization-alarm-clear: description: Pool utilization alarm clear threshold type: int utilization-alarm-raise: description: Pool utilization alarm raise threshold type: int type: list endip: description: Final IPv4 address type: str endport: description: Final port number type: int exclude-ip: description: description type: str name: description: IP pool name. type: str nat64: choices: - disable - enable description: Enable/disable NAT64. type: str num-blocks-per-user: description: Number of addresses blocks that can be used by a user type: int pba-timeout: description: Port block allocation timeout type: int permit-any-host: choices: - disable - enable description: Enable/disable full cone NAT. type: str port-per-user: description: Number of port for each user type: int source-endip: description: Final IPv4 address type: str source-startip: description: First IPv4 address type: str startip: description: First IPv4 address type: str startport: description: First port number type: int subnet-broadcast-in-ippool: choices: - disable - enable description: Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool. type: str type: choices: - overload - one-to-one - fixed-port-range - port-block-allocation - cgn-resource-allocation description: IP pool type type: str utilization-alarm-clear: description: Pool utilization alarm clear threshold type: int utilization-alarm-raise: description: Pool utilization alarm raise threshold type: int type: dict proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list