fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping module – Configure virtual IP for IPv4.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping
.
New in fortinet.fortimanager 2.0.0
Synopsis
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.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Scope. |
|
Name. |
|
Vdom. |
|
Enable/disable adding NAT46 route. Choices:
|
|
Arp reply. Choices:
|
|
Color. |
|
Comment. |
|
Dns mapping ttl. |
|
(list or str) Extaddr. |
|
Extintf. |
|
Extip. |
|
Extport. |
|
Gratuitous arp interval. |
|
Domain to use when integrating with FortiGSLB. |
|
Hostname to use within the configured FortiGSLB domain. |
|
Enable/disable HTTP2 support Choices:
|
|
Enable/disable HTTP3/QUIC support Choices:
|
|
Http cookie age. |
|
Http cookie domain. |
|
Http cookie domain from host. Choices:
|
|
Http cookie generation. |
|
Http cookie path. |
|
Http cookie share. Choices:
|
|
Http ip header. Choices:
|
|
Http ip header name. |
|
Http multiplex. Choices:
|
|
Maximum number of concurrent requests that a multiplex server can handle |
|
Maximum number of requests that a multiplex server can handle before disconnecting sessions |
|
Time-to-live for idle connections to servers. |
|
Http redirect. Choices:
|
|
Maximum supported HTTP versions. Choices:
|
|
Https cookie secure. Choices:
|
|
Id. |
|
Range of mapped IPv6 addresses. |
|
IPv6 port number range on the destination network to which the external port number range is mapped. |
|
Ldb method. Choices:
|
|
Mapped addr. |
|
(list) Mappedip. |
|
Mappedport. |
|
Max embryonic connections. |
|
(list or str) Monitor. |
|
Enable/disable NAT44. Choices:
|
|
Enable/disable NAT46. Choices:
|
|
Nat source vip. Choices:
|
|
Enable/disable one click GSLB server integration with FortiGSLB. Choices:
|
|
Outlook web access. Choices:
|
|
Persistence. Choices:
|
|
Portforward. Choices:
|
|
Portmapping type. Choices:
|
|
Protocol. Choices:
|
|
Realservers. |
|
Address. |
|
(list) Client ip. |
|
Health check proto. Choices:
|
|
Healthcheck. Choices:
|
|
Holddown interval. |
|
Http host. |
|
Id. |
|
Ip. |
|
Max connections. |
|
(list or str) Monitor. |
|
Port. |
|
Seq. |
|
Status. Choices:
|
|
Enable/disable translation of hostname/IP from virtual server to real server. Choices:
|
|
Type. Choices:
|
|
Weight. |
|
Server type. Choices:
|
|
(list or str) Service. |
|
(list) Src filter. |
|
Enable/disable use of src-filter to match destinations for the reverse SNAT rule. Choices:
|
|
(list) Srcintf filter. |
|
Enable/disable FFDHE cipher suite for SSL key exchange. Choices:
|
|
Ssl algorithm. Choices:
|
|
Ssl certificate. |
|
Ssl cipher suites. |
|
Cipher. Choices:
|
|
Id. |
|
Priority. |
|
Versions. Choices:
|
|
Ssl client fallback. Choices:
|
|
Ssl client rekey count. |
|
Ssl client renegotiation. Choices:
|
|
Ssl client session state max. |
|
Ssl client session state timeout. |
|
Ssl client session state type. Choices:
|
|
Ssl dh bits. Choices:
|
|
Ssl hpkp. Choices:
|
|
Ssl hpkp age. |
|
Ssl hpkp backup. |
|
Ssl hpkp include subdomains. Choices:
|
|
Ssl hpkp primary. |
|
Ssl hpkp report uri. |
|
Ssl hsts. Choices:
|
|
Ssl hsts age. |
|
Ssl hsts include subdomains. Choices:
|
|
Ssl http location conversion. Choices:
|
|
Ssl http match host. Choices:
|
|
Ssl max version. Choices:
|
|
Ssl min version. Choices:
|
|
Ssl mode. Choices:
|
|
Ssl pfs. Choices:
|
|
Ssl send empty frags. Choices:
|
|
Ssl server algorithm. Choices:
|
|
Ssl server max version. Choices:
|
|
Ssl server min version. Choices:
|
|
Enable/disable secure renegotiation to comply with RFC 5746. Choices:
|
|
Ssl server session state max. |
|
Ssl server session state timeout. |
|
Ssl server session state type. Choices:
|
|
Enable/disable VIP. Choices:
|
|
Type. Choices:
|
|
Uuid. |
|
Weblogic server. Choices:
|
|
Websphere server. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The parameter (vip) in requested url. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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 virtual IP for IPv4
fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping:
bypass_validation: false
adom: ansible
vip: "ansible-test-vip" # name
state: present
firewall_vip_dynamicmapping:
_scope: # Required
- name: FGT_AWS # need a valid device name
vdom: root # need a valid vdom name under the device
arp-reply: enable
color: 2
comment: "ansible-comment"
id: 1
- 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 virtual IP for IPv4
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_vip_dynamicmapping"
params:
adom: "ansible"
vip: "ansible-test-vip" # name
dynamic_mapping: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |