fmgr_firewall_ippool_dynamicmapping – Configure IPv4 IP pools.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
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 v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- adom - The parameter in requested url type: str required: true
- ippool - The parameter in requested url type: str required: true
- firewall_ippool_dynamicmapping - Configure IPv4 IP pools. type: dict
- _scope Scope. type: list more...
- arp_intf (Alias name: arp-intf) Arp intf. type: str more...
- arp_reply (Alias name: arp-reply) Arp reply. type: str choices: [disable, enable] more...
- associated_interface (Alias name: associated-interface) Associated interface. type: str more...
- block_size (Alias name: block-size) Block size. type: int more...
- comments Comments. type: str more...
- endip Endip. type: str more...
- num_blocks_per_user (Alias name: num-blocks-per-user) Num blocks per user. type: int more...
- pba_timeout (Alias name: pba-timeout) Pba timeout. type: int more...
- permit_any_host (Alias name: permit-any-host) Permit any host. type: str choices: [disable, enable] more...
- source_endip (Alias name: source-endip) Source endip. type: str more...
- source_startip (Alias name: source-startip) Source startip. type: str more...
- startip Startip. type: str more...
- type Type. type: str choices: [overload, one-to-one, fixed-port-range, port-block-allocation, cgn-resource-allocation] more...
- cgn_block_size (Alias name: cgn-block-size) Cgn block size. type: int more...
- cgn_client_endip (Alias name: cgn-client-endip) Cgn client endip. type: str more...
- cgn_client_startip (Alias name: cgn-client-startip) Cgn client startip. type: str more...
- cgn_fixedalloc (Alias name: cgn-fixedalloc) Cgn fixedalloc. type: str choices: [disable, enable] more...
- cgn_overload (Alias name: cgn-overload) Cgn overload. type: str choices: [disable, enable] more...
- cgn_port_end (Alias name: cgn-port-end) Cgn port end. type: int more...
- cgn_port_start (Alias name: cgn-port-start) Cgn port start. type: int more...
- cgn_spa (Alias name: cgn-spa) Cgn spa. type: str choices: [disable, enable] more...
- utilization_alarm_clear (Alias name: utilization-alarm-clear) Utilization alarm clear. type: int more...
- utilization_alarm_raise (Alias name: utilization-alarm-raise) Utilization alarm raise. type: int more...
- endport Final port number (inclusive) in the range for the address pool (default: 65533). type: int more...
- port_per_user (Alias name: port-per-user) Number of port for each user (32 to 60416, default = 0, auto). type: int more...
- startport First port number (inclusive) in the range for the address pool (default: 5117). type: int more...
- add_nat64_route (Alias name: add-nat64-route) Enable/disable adding nat64 route. type: str choices: [disable, enable] more...
- cgn_client_ipv6shift (Alias name: cgn-client-ipv6shift) Ipv6 shift for fixed-allocation. type: int more...
- nat64 Enable/disable nat64. type: str choices: [disable, enable] more...
- subnet_broadcast_in_ippool (Alias name: 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...
- exclude_ip (Alias name: exclude-ip) Exclude ips x. type: list more...
- pba_interim_log (Alias name: pba-interim-log) Port block allocation interim logging interval (600 - 86400 seconds, default = 0 which disables interim logging). type: int more...
- client_prefix_length (Alias name: client-prefix-length) Subnet length of a single deterministic nat64 client (1 - 128, default = 64). type: int more...
- icmp_session_quota (Alias name: icmp-session-quota) Maximum number of concurrent icmp sessions allowed per client (0 - 2097000, default = 0 which means no limit). type: int more...
- privileged_port_use_pba (Alias name: privileged-port-use-pba) Enable/disable selection of the external port from the port block allocation for nating privileged ports (deafult = disable). type: str choices: [disable, enable] more...
- source_prefix6 (Alias name: source-prefix6) Source ipv6 network to be translated (format = xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx, default = ::/0). type: str more...
- tcp_session_quota (Alias name: tcp-session-quota) Maximum number of concurrent tcp sessions allowed per client (0 - 2097000, default = 0 which means no limit). type: int more...
- udp_session_quota (Alias name: udp-session-quota) Maximum number of concurrent udp sessions allowed per client (0 - 2097000, default = 0 which means no limit). type: int more...
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
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure dynamic mappings of IPv4 IP pool
fortinet.fortimanager.fmgr_firewall_ippool_dynamicmapping:
bypass_validation: false
adom: ansible
ippool: "ansible-test" # name
state: present
firewall_ippool_dynamicmapping:
_scope:
- name: FGT_AWS # need a valid device name
vdom: root # need a valid vdom name under the device
comments: "ansible-comment"
endip: "222.222.222.253"
startip: "222.222.222.0"
type: overload # <value in [overload, one-to-one, fixed-port-range, ...]>
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the dynamic mappings of IPv4 IP pool
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_ippool_dynamicmapping"
params:
adom: "ansible"
ippool: "ansible-test" # name
dynamic_mapping: "your_value"
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.