fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping module – Configure virtual IP for IPv4.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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. |
|
Deprecated, please rename it to add_nat46_route. Enable/disable adding NAT46 route. Choices:
|
|
Deprecated, please rename it to arp_reply. Arp reply. Choices:
|
|
Color. |
|
Comment. |
|
Deprecated, please rename it to dns_mapping_ttl. Dns mapping ttl. |
|
(list or str) Extaddr. |
|
Extintf. |
|
Extip. |
|
Extport. |
|
Deprecated, please rename it to gratuitous_arp_interval. Gratuitous arp interval. |
|
Deprecated, please rename it to gslb_domain_name. Domain to use when integrating with FortiGSLB. |
|
Deprecated, please rename it to gslb_hostname. Hostname to use within the configured FortiGSLB domain. |
|
Deprecated, please rename it to h2_support. Enable/disable HTTP2 support Choices:
|
|
Deprecated, please rename it to h3_support. Enable/disable HTTP3/QUIC support Choices:
|
|
Deprecated, please rename it to http_cookie_age. Http cookie age. |
|
Deprecated, please rename it to http_cookie_domain. Http cookie domain. |
|
Deprecated, please rename it to http_cookie_domain_from_host. Http cookie domain from host. Choices:
|
|
Deprecated, please rename it to http_cookie_generation. Http cookie generation. |
|
Deprecated, please rename it to http_cookie_path. Http cookie path. |
|
Deprecated, please rename it to http_cookie_share. Http cookie share. Choices:
|
|
Deprecated, please rename it to http_ip_header. Http ip header. Choices:
|
|
Deprecated, please rename it to http_ip_header_name. Http ip header name. |
|
Deprecated, please rename it to http_multiplex. Http multiplex. Choices:
|
|
Deprecated, please rename it to http_multiplex_max_concurrent_request. Maximum number of concurrent requests that a multip… |
|
Deprecated, please rename it to http_multiplex_max_request. Maximum number of requests that a multiplex server can handle … |
|
Deprecated, please rename it to http_multiplex_ttl. Time-to-live for idle connections to servers. |
|
Deprecated, please rename it to http_redirect. Http redirect. Choices:
|
|
Deprecated, please rename it to http_supported_max_version. Maximum supported HTTP versions. Choices:
|
|
Deprecated, please rename it to https_cookie_secure. Https cookie secure. Choices:
|
|
Id. |
|
Deprecated, please rename it to ipv6_mappedip. Range of mapped IPv6 addresses. |
|
Deprecated, please rename it to ipv6_mappedport. IPv6 port number range on the destination network to which the external p… |
|
Deprecated, please rename it to ldb_method. Ldb method. Choices:
|
|
Deprecated, please rename it to mapped_addr. Mapped addr. |
|
(list) Mappedip. |
|
Mappedport. |
|
Deprecated, please rename it to max_embryonic_connections. Max embryonic connections. |
|
(list or str) Monitor. |
|
Deprecated, please rename it to nat_source_vip. Nat source vip. Choices:
|
|
Enable/disable NAT44. Choices:
|
|
Enable/disable NAT46. Choices:
|
|
Deprecated, please rename it to one_click_gslb_server. Enable/disable one click GSLB server integration with FortiGSLB. Choices:
|
|
Deprecated, please rename it to outlook_web_access. Outlook web access. Choices:
|
|
Persistence. Choices:
|
|
Portforward. Choices:
|
|
Deprecated, please rename it to portmapping_type. Portmapping type. Choices:
|
|
Protocol. Choices:
|
|
Realservers. |
|
Address. |
|
(list) Deprecated, please rename it to client_ip. Client ip. |
|
Deprecated, please rename it to health_check_proto. Health check proto. Choices:
|
|
Healthcheck. Choices:
|
|
Deprecated, please rename it to holddown_interval. Holddown interval. |
|
Deprecated, please rename it to http_host. Http host. |
|
Id. |
|
Ip. |
|
Deprecated, please rename it to max_connections. Max connections. |
|
(list or str) Monitor. |
|
Port. |
|
Seq. |
|
Status. Choices:
|
|
Deprecated, please rename it to translate_host. Enable/disable translation of hostname/IP from virtual server to r… Choices:
|
|
Type. Choices:
|
|
Weight. |
|
Deprecated, please rename it to server_type. Server type. Choices:
|
|
(list or str) Service. |
|
(list) Deprecated, please rename it to src_filter. Src filter. |
|
Deprecated, please rename it to src_vip_filter. Enable/disable use of src-filter to match destinations for the reverse SNA… Choices:
|
|
(list) Deprecated, please rename it to srcintf_filter. Srcintf filter. |
|
Deprecated, please rename it to ssl_accept_ffdhe_groups. Enable/disable FFDHE cipher suite for SSL key exchange. Choices:
|
|
Deprecated, please rename it to ssl_algorithm. Ssl algorithm. Choices:
|
|
Deprecated, please rename it to ssl_certificate. Ssl certificate. |
|
Deprecated, please rename it to ssl_cipher_suites. Ssl cipher suites. |
|
Cipher. Choices:
|
|
Id. |
|
Priority. |
|
Versions. Choices:
|
|
Deprecated, please rename it to ssl_client_fallback. Ssl client fallback. Choices:
|
|
Deprecated, please rename it to ssl_client_rekey_count. Ssl client rekey count. |
|
Deprecated, please rename it to ssl_client_renegotiation. Ssl client renegotiation. Choices:
|
|
Deprecated, please rename it to ssl_client_session_state_max. Ssl client session state max. |
|
Deprecated, please rename it to ssl_client_session_state_timeout. Ssl client session state timeout. |
|
Deprecated, please rename it to ssl_client_session_state_type. Ssl client session state type. Choices:
|
|
Deprecated, please rename it to ssl_dh_bits. Ssl dh bits. Choices:
|
|
Deprecated, please rename it to ssl_hpkp. Ssl hpkp. Choices:
|
|
Deprecated, please rename it to ssl_hpkp_age. Ssl hpkp age. |
|
Deprecated, please rename it to ssl_hpkp_backup. Ssl hpkp backup. |
|
Deprecated, please rename it to ssl_hpkp_include_subdomains. Ssl hpkp include subdomains. Choices:
|
|
Deprecated, please rename it to ssl_hpkp_primary. Ssl hpkp primary. |
|
Deprecated, please rename it to ssl_hpkp_report_uri. Ssl hpkp report uri. |
|
Deprecated, please rename it to ssl_hsts. Ssl hsts. Choices:
|
|
Deprecated, please rename it to ssl_hsts_age. Ssl hsts age. |
|
Deprecated, please rename it to ssl_hsts_include_subdomains. Ssl hsts include subdomains. Choices:
|
|
Deprecated, please rename it to ssl_http_location_conversion. Ssl http location conversion. Choices:
|
|
Deprecated, please rename it to ssl_http_match_host. Ssl http match host. Choices:
|
|
Deprecated, please rename it to ssl_max_version. Ssl max version. Choices:
|
|
Deprecated, please rename it to ssl_min_version. Ssl min version. Choices:
|
|
Deprecated, please rename it to ssl_mode. Ssl mode. Choices:
|
|
Deprecated, please rename it to ssl_pfs. Ssl pfs. Choices:
|
|
Deprecated, please rename it to ssl_send_empty_frags. Ssl send empty frags. Choices:
|
|
Deprecated, please rename it to ssl_server_algorithm. Ssl server algorithm. Choices:
|
|
Deprecated, please rename it to ssl_server_max_version. Ssl server max version. Choices:
|
|
Deprecated, please rename it to ssl_server_min_version. Ssl server min version. Choices:
|
|
Deprecated, please rename it to ssl_server_renegotiation. Enable/disable secure renegotiation to comply with RFC 5746. Choices:
|
|
Deprecated, please rename it to ssl_server_session_state_max. Ssl server session state max. |
|
Deprecated, please rename it to ssl_server_session_state_timeout. Ssl server session state timeout. |
|
Deprecated, please rename it to ssl_server_session_state_type. Ssl server session state type. Choices:
|
|
Enable/disable VIP. Choices:
|
|
Type. Choices:
|
|
Uuid. |
|
Deprecated, please rename it to weblogic_server. Weblogic server. Choices:
|
|
Deprecated, please rename it to websphere_server. 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 |