You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping module – Configure virtual IP for IPv4.

Note

This module is part of the fortinet.fortimanager collection (version 2.2.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
access_token string	The token to access FortiManager without using username and password.
adom string / required	the parameter (adom) in requested url
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
firewall_vip_dynamicmapping dictionary	the top level parameters set
_scope list / elements=dictionary	description
name string	no description
vdom string	no description
add-nat46-route string	Enable/disable adding NAT46 route. Choices: "disable" "enable"
arp-reply string	no description Choices: "disable" "enable"
color integer	no description
comment string	no description
dns-mapping-ttl integer	no description
extaddr string	no description
extintf string	no description
extip string	no description
extport string	no description
gratuitous-arp-interval integer	no description
http-cookie-age integer	no description
http-cookie-domain string	no description
http-cookie-domain-from-host string	no description Choices: "disable" "enable"
http-cookie-generation integer	no description
http-cookie-path string	no description
http-cookie-share string	no description Choices: "disable" "same-ip"
http-ip-header string	no description Choices: "disable" "enable"
http-ip-header-name string	no description
http-multiplex string	no description Choices: "disable" "enable"
http-multiplex-max-request integer	Maximum number of requests that a multiplex server can handle before disconnecting sessions
http-multiplex-ttl integer	Time-to-live for idle connections to servers.
http-redirect string	no description Choices: "disable" "enable"
http-supported-max-version string	Maximum supported HTTP versions. Choices: "http1" "http2"
https-cookie-secure string	no description Choices: "disable" "enable"
id integer	no description
ipv6-mappedip string	Range of mapped IPv6 addresses.
ipv6-mappedport string	IPv6 port number range on the destination network to which the external port number range is mapped.
ldb-method string	no description Choices: "static" "round-robin" "weighted" "least-session" "least-rtt" "first-alive" "http-host"
mapped-addr string	no description
mappedip string	description
mappedport string	no description
max-embryonic-connections integer	no description
monitor string	description
nat-source-vip string	no description Choices: "disable" "enable"
nat44 string	Enable/disable NAT44. Choices: "disable" "enable"
nat46 string	Enable/disable NAT46. Choices: "disable" "enable"
outlook-web-access string	no description Choices: "disable" "enable"
persistence string	no description Choices: "none" "http-cookie" "ssl-session-id"
portforward string	no description Choices: "disable" "enable"
portmapping-type string	no description Choices: "1-to-1" "m-to-n"
protocol string	no description Choices: "tcp" "udp" "sctp" "icmp"
realservers list / elements=dictionary	description
address string	no description
client-ip string	description
health-check-proto string	no description Choices: "ping" "http"
healthcheck string	no description Choices: "disable" "enable" "vip"
holddown-interval integer	no description
http-host string	no description
id integer	no description
ip string	no description
max-connections integer	no description
monitor string	no description
port integer	no description
seq integer	no description
status string	no description Choices: "active" "standby" "disable"
translate-host string	Enable/disable translation of hostname/IP from virtual server to real server. Choices: "disable" "enable"
type string	no description Choices: "ip" "address"
weight integer	no description
server-type string	no description Choices: "http" "https" "ssl" "tcp" "udp" "ip" "imaps" "pop3s" "smtps" "ssh"
service string	no description
src-filter string	description
srcintf-filter string	description
ssl-accept-ffdhe-groups string	Enable/disable FFDHE cipher suite for SSL key exchange. Choices: "disable" "enable"
ssl-algorithm string	no description Choices: "high" "medium" "low" "custom"
ssl-certificate string	no description
ssl-cipher-suites list / elements=dictionary	description
cipher string	no description Choices: "TLS-RSA-WITH-RC4-128-MD5" "TLS-RSA-WITH-RC4-128-SHA" "TLS-RSA-WITH-DES-CBC-SHA" "TLS-RSA-WITH-3DES-EDE-CBC-SHA" "TLS-RSA-WITH-AES-128-CBC-SHA" "TLS-RSA-WITH-AES-256-CBC-SHA" "TLS-RSA-WITH-AES-128-CBC-SHA256" "TLS-RSA-WITH-AES-256-CBC-SHA256" "TLS-RSA-WITH-CAMELLIA-128-CBC-SHA" "TLS-RSA-WITH-CAMELLIA-256-CBC-SHA" "TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256" "TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256" "TLS-RSA-WITH-SEED-CBC-SHA" "TLS-RSA-WITH-ARIA-128-CBC-SHA256" "TLS-RSA-WITH-ARIA-256-CBC-SHA384" "TLS-DHE-RSA-WITH-DES-CBC-SHA" "TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA" "TLS-DHE-RSA-WITH-AES-128-CBC-SHA" "TLS-DHE-RSA-WITH-AES-256-CBC-SHA" "TLS-DHE-RSA-WITH-AES-128-CBC-SHA256" "TLS-DHE-RSA-WITH-AES-256-CBC-SHA256" "TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA" "TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA" "TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256" "TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256" "TLS-DHE-RSA-WITH-SEED-CBC-SHA" "TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256" "TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384" "TLS-ECDHE-RSA-WITH-RC4-128-SHA" "TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA" "TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA" "TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA" "TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256" "TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256" "TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256" "TLS-DHE-RSA-WITH-AES-128-GCM-SHA256" "TLS-DHE-RSA-WITH-AES-256-GCM-SHA384" "TLS-DHE-DSS-WITH-AES-128-CBC-SHA" "TLS-DHE-DSS-WITH-AES-256-CBC-SHA" "TLS-DHE-DSS-WITH-AES-128-CBC-SHA256" "TLS-DHE-DSS-WITH-AES-128-GCM-SHA256" "TLS-DHE-DSS-WITH-AES-256-CBC-SHA256" "TLS-DHE-DSS-WITH-AES-256-GCM-SHA384" "TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256" "TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256" "TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384" "TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384" "TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA" "TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256" "TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256" "TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384" "TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384" "TLS-RSA-WITH-AES-128-GCM-SHA256" "TLS-RSA-WITH-AES-256-GCM-SHA384" "TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA" "TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA" "TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256" "TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256" "TLS-DHE-DSS-WITH-SEED-CBC-SHA" "TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256" "TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384" "TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256" "TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384" "TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256" "TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384" "TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA" "TLS-DHE-DSS-WITH-DES-CBC-SHA" "TLS-AES-128-GCM-SHA256" "TLS-AES-256-GCM-SHA384" "TLS-CHACHA20-POLY1305-SHA256" "TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA"
id integer	no description
priority integer	no description
versions list / elements=string	description Choices: "ssl-3.0" "tls-1.0" "tls-1.1" "tls-1.2" "tls-1.3"
ssl-client-fallback string	no description Choices: "disable" "enable"
ssl-client-rekey-count integer	no description
ssl-client-renegotiation string	no description Choices: "deny" "allow" "secure"
ssl-client-session-state-max integer	no description
ssl-client-session-state-timeout integer	no description
ssl-client-session-state-type string	no description Choices: "disable" "time" "count" "both"
ssl-dh-bits string	no description Choices: "768" "1024" "1536" "2048" "3072" "4096"
ssl-hpkp string	no description Choices: "disable" "enable" "report-only"
ssl-hpkp-age integer	no description
ssl-hpkp-backup string	no description
ssl-hpkp-include-subdomains string	no description Choices: "disable" "enable"
ssl-hpkp-primary string	no description
ssl-hpkp-report-uri string	no description
ssl-hsts string	no description Choices: "disable" "enable"
ssl-hsts-age integer	no description
ssl-hsts-include-subdomains string	no description Choices: "disable" "enable"
ssl-http-location-conversion string	no description Choices: "disable" "enable"
ssl-http-match-host string	no description Choices: "disable" "enable"
ssl-max-version string	no description Choices: "ssl-3.0" "tls-1.0" "tls-1.1" "tls-1.2" "tls-1.3"
ssl-min-version string	no description Choices: "ssl-3.0" "tls-1.0" "tls-1.1" "tls-1.2" "tls-1.3"
ssl-mode string	no description Choices: "half" "full"
ssl-pfs string	no description Choices: "require" "deny" "allow"
ssl-send-empty-frags string	no description Choices: "disable" "enable"
ssl-server-algorithm string	no description Choices: "high" "low" "medium" "custom" "client"
ssl-server-max-version string	no description Choices: "ssl-3.0" "tls-1.0" "tls-1.1" "tls-1.2" "client" "tls-1.3"
ssl-server-min-version string	no description Choices: "ssl-3.0" "tls-1.0" "tls-1.1" "tls-1.2" "client" "tls-1.3"
ssl-server-renegotiation string	Enable/disable secure renegotiation to comply with RFC 5746. Choices: "disable" "enable"
ssl-server-session-state-max integer	no description
ssl-server-session-state-timeout integer	no description
ssl-server-session-state-type string	no description Choices: "disable" "time" "count" "both"
status string	Enable/disable VIP. Choices: "disable" "enable"
type string	no description Choices: "static-nat" "load-balance" "server-load-balance" "dns-translation" "fqdn" "access-proxy"
uuid string	no description
weblogic-server string	no description Choices: "disable" "enable"
websphere-server string	no description Choices: "disable" "enable"
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: "present" "absent"
vip string / required	the parameter (vip) in requested url
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

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: 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 dynamic mappings of virtual IP for IPv4
     fmgr_fact:
       facts:
           selector: 'firewall_vip_dynamicmapping'
           params:
               adom: 'ansible'
               vip: 'ansible-test-vip' # name
               dynamic_mapping: 'your_value'
- 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 dynamic mappings of virtual IP for IPv4
     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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

Issue Tracker Homepage Repository (Sources)