fmgr_firewall_ippool – Configure IPv4 IP pools.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- firewall_ippool - Configure IPv4 IP pools. type: dict
- arp-intf - Select an interface from available options that will reply to ARP requests. type: str
- arp-reply - Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable). type: str choices: [disable, enable]
- associated-interface - Associated interface name. type: str
- block-size - Number of addresses in a block (64 to 4096, default = 128). type: int
- comments - Comment. type: str
- dynamic_mapping - No description for the parameter type: array
- _scope - No description for the parameter type: array
- name - No description for the parameter type: str
- vdom - No description for the parameter type: str
- arp-intf - No description for the parameter type: str
- arp-reply - No description for the parameter type: str choices: [disable, enable]
- associated-interface - No description for the parameter type: str
- block-size - No description for the parameter type: int
- comments - No description for the parameter type: str
- endip - No description for the parameter type: str
- num-blocks-per-user - No description for the parameter type: int
- pba-timeout - No description for the parameter type: int
- permit-any-host - No description for the parameter type: str choices: [disable, enable]
- source-endip - No description for the parameter type: str
- source-startip - No description for the parameter type: str
- startip - No description for the parameter type: str
- type - No description for the parameter type: str choices: [overload, one-to-one, fixed-port-range, port-block-allocation]
- _scope - No description for the parameter type: array
- endip - Final IPv4 address (inclusive) in the range for the address pool (format xxx. type: str
- name - IP pool name. type: str
- num-blocks-per-user - Number of addresses blocks that can be used by a user (1 to 128, default = 8). type: int
- pba-timeout - Port block allocation timeout (seconds). type: int
- permit-any-host - Enable/disable full cone NAT. type: str choices: [disable, enable]
- source-endip - Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx. type: str
- source-startip - First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx. type: str
- startip - First IPv4 address (inclusive) in the range for the address pool (format xxx. type: str
- type - IP pool type (overload, one-to-one, fixed port range, or port block allocation). type: str choices: [overload, one-to-one, fixed-port-range, port-block-allocation]
Notes¶
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples¶
- hosts: fortimanager-inventory
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
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
firewall_ippool:
arp-intf: <value of string>
arp-reply: <value in [disable, enable]>
associated-interface: <value of string>
block-size: <value of integer>
comments: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
arp-intf: <value of string>
arp-reply: <value in [disable, enable]>
associated-interface: <value of string>
block-size: <value of integer>
comments: <value of string>
endip: <value of string>
num-blocks-per-user: <value of integer>
pba-timeout: <value of integer>
permit-any-host: <value in [disable, enable]>
source-endip: <value of string>
source-startip: <value of string>
startip: <value of string>
type: <value in [overload, one-to-one, fixed-port-range, ...]>
endip: <value of string>
name: <value of string>
num-blocks-per-user: <value of integer>
pba-timeout: <value of integer>
permit-any-host: <value in [disable, enable]>
source-endip: <value of string>
source-startip: <value of string>
startip: <value of string>
type: <value in [overload, one-to-one, fixed-port-range, ...]>
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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict