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.1.5).

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 version 2.10: of fortinet.fortimanager

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
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: no ← (default) yes
enable_log boolean	Enable/Disable logging for task Choices: no ← (default) yes
firewall_vip_dynamicmapping dictionary	the top level parameters set
_scope list / elements=string	no description
name string	Name.
vdom string	Vdom.
arp-reply string	Enable to respond to ARP requests for this virtual IP address. Enabled by default. Choices: disable enable
color integer	Color of icon on the GUI.
comment string	Comment.
dns-mapping-ttl integer	DNS mapping TTL (Set to zero to use TTL in DNS response, default = 0).
extaddr string	External FQDN address name.
extintf string	Interface connected to the source network that receives the packets that will be forwarded to the destination network.
extip string	IP address or address range on the external interface that you want to map to an address or address range on the destination n…
extport string	Incoming port number range that you want to map to a port number range on the destination network.
gratuitous-arp-interval integer	Enable to have the VIP send gratuitous ARPs. 0=disabled. Set from 5 up to 8640000 seconds to enable.
http-cookie-age integer	Time in minutes that client web browsers should keep a cookie. Default is 60 seconds. 0 = no time limit.
http-cookie-domain string	Domain that HTTP cookie persistence should apply to.
http-cookie-domain-from-host string	Enable/disable use of HTTP cookie domain from host field in HTTP. Choices: disable enable
http-cookie-generation integer	Generation of HTTP cookie to be accepted. Changing invalidates all existing cookies.
http-cookie-path string	Limit HTTP cookie persistence to the specified path.
http-cookie-share string	Control sharing of cookies across virtual servers. same-ip means a cookie from one virtual server can be used by another. Disa… Choices: disable same-ip
http-ip-header string	For HTTP multiplexing, enable to add the original client IP address in the XForwarded-For HTTP header. Choices: disable enable
http-ip-header-name string	For HTTP multiplexing, enter a custom HTTPS header name. The original client IP address is added to this header. If empty, X-F…
http-multiplex string	Enable/disable HTTP multiplexing. Choices: disable enable
http-redirect string	Enable/disable redirection of HTTP to HTTPS Choices: disable enable
https-cookie-secure string	Enable/disable verification that inserted HTTPS cookies are secure. Choices: disable enable
id integer	Custom defined ID.
ldb-method string	Method used to distribute sessions to real servers. Choices: static round-robin weighted least-session least-rtt first-alive http-host
mapped-addr string	Mapped FQDN address name.
mappedip string	no description
mappedport string	Port number range on the destination network to which the external port number range is mapped.
max-embryonic-connections integer	Maximum number of incomplete connections.
monitor string	no description
nat-source-vip string	Enable/disable forcing the source NAT mapped IP to the external IP for all traffic. Choices: disable enable
outlook-web-access string	Enable to add the Front-End-Https header for Microsoft Outlook Web Access. Choices: disable enable
persistence string	Configure how to make sure that clients connect to the same server every time they make a request that is part of the same ses… Choices: none http-cookie ssl-session-id
portforward string	Enable/disable port forwarding. Choices: disable enable
portmapping-type string	Port mapping type. Choices: 1-to-1 m-to-n
protocol string	Protocol to use when forwarding packets. Choices: tcp udp sctp icmp
realservers list / elements=string	no description
address string	Address.
client-ip string	no description
healthcheck string	Enable to check the responsiveness of the real server before forwarding traffic. Choices: disable enable vip
holddown-interval integer	Time in seconds that the health check monitor continues to monitor and unresponsive server that should be active.
http-host string	HTTP server domain name in HTTP header.
id integer	Real server ID.
ip string	IP address of the real server.
max-connections integer	Max number of active connections that can be directed to the real server. When reached, sessions are sent to other rea…
monitor string	Name of the health check monitor to use when polling to determine a virtual servers connectivity status.
port integer	Port for communicating with the real server. Required if port forwarding is enabled.
seq integer	Seq.
status string	Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is … Choices: active standby disable
type string	Type. Choices: ip address
weight integer	Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connect…
server-type string	Protocol to be load balanced by the virtual server (also called the server load balance virtual IP). Choices: http https ssl tcp udp ip imaps pop3s smtps ssh
service string	Service name.
src-filter string	no description
srcintf-filter string	no description
ssl-algorithm string	Permitted encryption algorithms for SSL sessions according to encryption strength. Choices: high medium low custom
ssl-certificate string	The name of the SSL certificate to use for SSL acceleration.
ssl-cipher-suites list / elements=string	no description
cipher string	Cipher suite name. 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
id integer	Id.
priority integer	SSL/TLS cipher suites priority.
versions list / elements=string	no description Choices: ssl-3.0 tls-1.0 tls-1.1 tls-1.2 tls-1.3
ssl-client-fallback string	Enable/disable support for preventing Downgrade Attacks on client connections (RFC 7507). Choices: disable enable
ssl-client-rekey-count integer	Maximum length of data in MB before triggering a client rekey (0 = disable).
ssl-client-renegotiation string	Allow, deny, or require secure renegotiation of client sessions to comply with RFC 5746. Choices: deny allow secure
ssl-client-session-state-max integer	Maximum number of client to FortiGate SSL session states to keep.
ssl-client-session-state-timeout integer	Number of minutes to keep client to FortiGate SSL session state.
ssl-client-session-state-type string	How to expire SSL sessions for the segment of the SSL connection between the client and the FortiGate. Choices: disable time count both
ssl-dh-bits string	Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. Choices: 768 1024 1536 2048 3072 4096
ssl-hpkp string	Enable/disable including HPKP header in response. Choices: disable enable report-only
ssl-hpkp-age integer	Number of seconds the client should honour the HPKP setting.
ssl-hpkp-backup string	Certificate to generate backup HPKP pin from.
ssl-hpkp-include-subdomains string	Indicate that HPKP header applies to all subdomains. Choices: disable enable
ssl-hpkp-primary string	Certificate to generate primary HPKP pin from.
ssl-hpkp-report-uri string	URL to report HPKP violations to.
ssl-hsts string	Enable/disable including HSTS header in response. Choices: disable enable
ssl-hsts-age integer	Number of seconds the client should honour the HSTS setting.
ssl-hsts-include-subdomains string	Indicate that HSTS header applies to all subdomains. Choices: disable enable
ssl-http-location-conversion string	Enable to replace HTTP with HTTPS in the replys Location HTTP header field. Choices: disable enable
ssl-http-match-host string	Enable/disable HTTP host matching for location conversion. Choices: disable enable
ssl-max-version string	Highest SSL/TLS version acceptable from a client. Choices: ssl-3.0 tls-1.0 tls-1.1 tls-1.2 tls-1.3
ssl-min-version string	Lowest SSL/TLS version acceptable from a client. Choices: ssl-3.0 tls-1.0 tls-1.1 tls-1.2 tls-1.3
ssl-mode string	Apply SSL offloading between the client and the FortiGate (half) or from the client to the FortiGate and from the FortiGate to… Choices: half full
ssl-pfs string	Select the cipher suites that can be used for SSL perfect forward secrecy (PFS). Applies to both client and server sessions. Choices: require deny allow
ssl-send-empty-frags string	Enable/disable sending empty fragments to avoid CBC IV attacks (SSL 3.0 & TLS 1.0 only). May need to be disabled for compatibi… Choices: disable enable
ssl-server-algorithm string	Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. Choices: high low medium custom client
ssl-server-max-version string	Highest SSL/TLS version acceptable from a server. Use the client setting by default. Choices: ssl-3.0 tls-1.0 tls-1.1 tls-1.2 client tls-1.3
ssl-server-min-version string	Lowest SSL/TLS version acceptable from a server. Use the client setting by default. Choices: ssl-3.0 tls-1.0 tls-1.1 tls-1.2 client tls-1.3
ssl-server-session-state-max integer	Maximum number of FortiGate to Server SSL session states to keep.
ssl-server-session-state-timeout integer	Number of minutes to keep FortiGate to Server SSL session state.
ssl-server-session-state-type string	How to expire SSL sessions for the segment of the SSL connection between the server and the FortiGate. Choices: disable time count both
status string	Enable/disable VIP. Choices: disable enable
type string	Configure a static NAT, load balance, server load balance, DNS translation, or FQDN VIP. Choices: static-nat load-balance server-load-balance dns-translation fqdn access-proxy
uuid string	Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
weblogic-server string	Enable to add an HTTP header to indicate SSL offloading for a WebLogic server. Choices: disable enable
websphere-server string	Enable to add an HTTP header to indicate SSL offloading for a WebSphere server. Choices: disable enable
proposed_method string	The overridden method for the underlying Json RPC request Choices: update set add
rc_failed list / elements=string	the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string	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

- 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

- 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: ''

Return Values

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

Key	Description
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_message string	The descriptive message of the api response Returned: always Sample: “OK.”

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

Issue Tracker Homepage Repository (Sources)