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

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

Scope.

name

string

Name.

vdom

string

Vdom.

add-nat46-route

string

Deprecated, please rename it to add_nat46_route. Enable/disable adding NAT46 route.

Choices:

  • "disable"

  • "enable"

arp-reply

string

Deprecated, please rename it to arp_reply. Arp reply.

Choices:

  • "disable"

  • "enable"

color

integer

Color.

comment

string

Comment.

dns-mapping-ttl

integer

Deprecated, please rename it to dns_mapping_ttl. Dns mapping ttl.

extaddr

any

(list or str) Extaddr.

extintf

string

Extintf.

extip

string

Extip.

extport

string

Extport.

gratuitous-arp-interval

integer

Deprecated, please rename it to gratuitous_arp_interval. Gratuitous arp interval.

gslb-domain-name

string

Deprecated, please rename it to gslb_domain_name. Domain to use when integrating with FortiGSLB.

gslb-hostname

string

Deprecated, please rename it to gslb_hostname. Hostname to use within the configured FortiGSLB domain.

h2-support

string

Deprecated, please rename it to h2_support. Enable/disable HTTP2 support

Choices:

  • "disable"

  • "enable"

h3-support

string

Deprecated, please rename it to h3_support. Enable/disable HTTP3/QUIC support

Choices:

  • "disable"

  • "enable"

integer

Deprecated, please rename it to http_cookie_age. Http cookie age.

string

Deprecated, please rename it to http_cookie_domain. Http cookie domain.

string

Deprecated, please rename it to http_cookie_domain_from_host. Http cookie domain from host.

Choices:

  • "disable"

  • "enable"

integer

Deprecated, please rename it to http_cookie_generation. Http cookie generation.

string

Deprecated, please rename it to http_cookie_path. Http cookie path.

string

Deprecated, please rename it to http_cookie_share. Http cookie share.

Choices:

  • "disable"

  • "same-ip"

http-ip-header

string

Deprecated, please rename it to http_ip_header. Http ip header.

Choices:

  • "disable"

  • "enable"

http-ip-header-name

string

Deprecated, please rename it to http_ip_header_name. Http ip header name.

http-multiplex

string

Deprecated, please rename it to http_multiplex. Http multiplex.

Choices:

  • "disable"

  • "enable"

http-multiplex-max-concurrent-request

integer

Deprecated, please rename it to http_multiplex_max_concurrent_request. Maximum number of concurrent requests that a multip…

http-multiplex-max-request

integer

Deprecated, please rename it to http_multiplex_max_request. Maximum number of requests that a multiplex server can handle …

http-multiplex-ttl

integer

Deprecated, please rename it to http_multiplex_ttl. Time-to-live for idle connections to servers.

http-redirect

string

Deprecated, please rename it to http_redirect. Http redirect.

Choices:

  • "disable"

  • "enable"

http-supported-max-version

string

Deprecated, please rename it to http_supported_max_version. Maximum supported HTTP versions.

Choices:

  • "http1"

  • "http2"

string

Deprecated, please rename it to https_cookie_secure. Https cookie secure.

Choices:

  • "disable"

  • "enable"

id

integer

Id.

ipv6-mappedip

string

Deprecated, please rename it to ipv6_mappedip. Range of mapped IPv6 addresses.

ipv6-mappedport

string

Deprecated, please rename it to ipv6_mappedport. IPv6 port number range on the destination network to which the external p…

ldb-method

string

Deprecated, please rename it to ldb_method. Ldb method.

Choices:

  • "static"

  • "round-robin"

  • "weighted"

  • "least-session"

  • "least-rtt"

  • "first-alive"

  • "http-host"

mapped-addr

string

Deprecated, please rename it to mapped_addr. Mapped addr.

mappedip

any

(list) Mappedip.

mappedport

string

Mappedport.

max-embryonic-connections

integer

Deprecated, please rename it to max_embryonic_connections. Max embryonic connections.

monitor

any

(list or str) Monitor.

nat-source-vip

string

Deprecated, please rename it to nat_source_vip. Nat source vip.

Choices:

  • "disable"

  • "enable"

nat44

string

Enable/disable NAT44.

Choices:

  • "disable"

  • "enable"

nat46

string

Enable/disable NAT46.

Choices:

  • "disable"

  • "enable"

one-click-gslb-server

string

Deprecated, please rename it to one_click_gslb_server. Enable/disable one click GSLB server integration with FortiGSLB.

Choices:

  • "disable"

  • "enable"

outlook-web-access

string

Deprecated, please rename it to outlook_web_access. Outlook web access.

Choices:

  • "disable"

  • "enable"

persistence

string

Persistence.

Choices:

  • "none"

  • "http-cookie"

  • "ssl-session-id"

portforward

string

Portforward.

Choices:

  • "disable"

  • "enable"

portmapping-type

string

Deprecated, please rename it to portmapping_type. Portmapping type.

Choices:

  • "1-to-1"

  • "m-to-n"

protocol

string

Protocol.

Choices:

  • "tcp"

  • "udp"

  • "sctp"

  • "icmp"

realservers

list / elements=dictionary

Realservers.

address

string

Address.

client-ip

any

(list) Deprecated, please rename it to client_ip. Client ip.

health-check-proto

string

Deprecated, please rename it to health_check_proto. Health check proto.

Choices:

  • "ping"

  • "http"

healthcheck

string

Healthcheck.

Choices:

  • "disable"

  • "enable"

  • "vip"

holddown-interval

integer

Deprecated, please rename it to holddown_interval. Holddown interval.

http-host

string

Deprecated, please rename it to http_host. Http host.

id

integer

Id.

ip

string

Ip.

max-connections

integer

Deprecated, please rename it to max_connections. Max connections.

monitor

any

(list or str) Monitor.

port

integer

Port.

seq

integer

Seq.

status

string

Status.

Choices:

  • "active"

  • "standby"

  • "disable"

translate-host

string

Deprecated, please rename it to translate_host. Enable/disable translation of hostname/IP from virtual server to r…

Choices:

  • "disable"

  • "enable"

type

string

Type.

Choices:

  • "ip"

  • "address"

weight

integer

Weight.

server-type

string

Deprecated, please rename it to server_type. Server type.

Choices:

  • "http"

  • "https"

  • "ssl"

  • "tcp"

  • "udp"

  • "ip"

  • "imaps"

  • "pop3s"

  • "smtps"

  • "ssh"

service

any

(list or str) Service.

src-filter

any

(list) Deprecated, please rename it to src_filter. Src filter.

src-vip-filter

string

Deprecated, please rename it to src_vip_filter. Enable/disable use of src-filter to match destinations for the reverse SNA…

Choices:

  • "disable"

  • "enable"

srcintf-filter

any

(list) Deprecated, please rename it to srcintf_filter. Srcintf filter.

ssl-accept-ffdhe-groups

string

Deprecated, please rename it to ssl_accept_ffdhe_groups. Enable/disable FFDHE cipher suite for SSL key exchange.

Choices:

  • "disable"

  • "enable"

ssl-algorithm

string

Deprecated, please rename it to ssl_algorithm. Ssl algorithm.

Choices:

  • "high"

  • "medium"

  • "low"

  • "custom"

ssl-certificate

string

Deprecated, please rename it to ssl_certificate. Ssl certificate.

ssl-cipher-suites

list / elements=dictionary

Deprecated, please rename it to ssl_cipher_suites. Ssl cipher suites.

cipher

string

Cipher.

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

Id.

priority

integer

Priority.

versions

list / elements=string

Versions.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl-client-fallback

string

Deprecated, please rename it to ssl_client_fallback. Ssl client fallback.

Choices:

  • "disable"

  • "enable"

ssl-client-rekey-count

integer

Deprecated, please rename it to ssl_client_rekey_count. Ssl client rekey count.

ssl-client-renegotiation

string

Deprecated, please rename it to ssl_client_renegotiation. Ssl client renegotiation.

Choices:

  • "deny"

  • "allow"

  • "secure"

ssl-client-session-state-max

integer

Deprecated, please rename it to ssl_client_session_state_max. Ssl client session state max.

ssl-client-session-state-timeout

integer

Deprecated, please rename it to ssl_client_session_state_timeout. Ssl client session state timeout.

ssl-client-session-state-type

string

Deprecated, please rename it to ssl_client_session_state_type. Ssl client session state type.

Choices:

  • "disable"

  • "time"

  • "count"

  • "both"

ssl-dh-bits

string

Deprecated, please rename it to ssl_dh_bits. Ssl dh bits.

Choices:

  • "768"

  • "1024"

  • "1536"

  • "2048"

  • "3072"

  • "4096"

ssl-hpkp

string

Deprecated, please rename it to ssl_hpkp. Ssl hpkp.

Choices:

  • "disable"

  • "enable"

  • "report-only"

ssl-hpkp-age

integer

Deprecated, please rename it to ssl_hpkp_age. Ssl hpkp age.

ssl-hpkp-backup

string

Deprecated, please rename it to ssl_hpkp_backup. Ssl hpkp backup.

ssl-hpkp-include-subdomains

string

Deprecated, please rename it to ssl_hpkp_include_subdomains. Ssl hpkp include subdomains.

Choices:

  • "disable"

  • "enable"

ssl-hpkp-primary

string

Deprecated, please rename it to ssl_hpkp_primary. Ssl hpkp primary.

ssl-hpkp-report-uri

string

Deprecated, please rename it to ssl_hpkp_report_uri. Ssl hpkp report uri.

ssl-hsts

string

Deprecated, please rename it to ssl_hsts. Ssl hsts.

Choices:

  • "disable"

  • "enable"

ssl-hsts-age

integer

Deprecated, please rename it to ssl_hsts_age. Ssl hsts age.

ssl-hsts-include-subdomains

string

Deprecated, please rename it to ssl_hsts_include_subdomains. Ssl hsts include subdomains.

Choices:

  • "disable"

  • "enable"

ssl-http-location-conversion

string

Deprecated, please rename it to ssl_http_location_conversion. Ssl http location conversion.

Choices:

  • "disable"

  • "enable"

ssl-http-match-host

string

Deprecated, please rename it to ssl_http_match_host. Ssl http match host.

Choices:

  • "disable"

  • "enable"

ssl-max-version

string

Deprecated, please rename it to ssl_max_version. Ssl max version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl-min-version

string

Deprecated, please rename it to ssl_min_version. Ssl min version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl-mode

string

Deprecated, please rename it to ssl_mode. Ssl mode.

Choices:

  • "half"

  • "full"

ssl-pfs

string

Deprecated, please rename it to ssl_pfs. Ssl pfs.

Choices:

  • "require"

  • "deny"

  • "allow"

ssl-send-empty-frags

string

Deprecated, please rename it to ssl_send_empty_frags. Ssl send empty frags.

Choices:

  • "disable"

  • "enable"

ssl-server-algorithm

string

Deprecated, please rename it to ssl_server_algorithm. Ssl server algorithm.

Choices:

  • "high"

  • "low"

  • "medium"

  • "custom"

  • "client"

ssl-server-max-version

string

Deprecated, please rename it to ssl_server_max_version. Ssl server max version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "client"

  • "tls-1.3"

ssl-server-min-version

string

Deprecated, please rename it to ssl_server_min_version. Ssl server min version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "client"

  • "tls-1.3"

ssl-server-renegotiation

string

Deprecated, please rename it to ssl_server_renegotiation. Enable/disable secure renegotiation to comply with RFC 5746.

Choices:

  • "disable"

  • "enable"

ssl-server-session-state-max

integer

Deprecated, please rename it to ssl_server_session_state_max. Ssl server session state max.

ssl-server-session-state-timeout

integer

Deprecated, please rename it to ssl_server_session_state_timeout. Ssl server session state timeout.

ssl-server-session-state-type

string

Deprecated, please rename it to ssl_server_session_state_type. Ssl server session state type.

Choices:

  • "disable"

  • "time"

  • "count"

  • "both"

status

string

Enable/disable VIP.

Choices:

  • "disable"

  • "enable"

type

string

Type.

Choices:

  • "static-nat"

  • "load-balance"

  • "server-load-balance"

  • "dns-translation"

  • "fqdn"

  • "access-proxy"

uuid

string

Uuid.

weblogic-server

string

Deprecated, please rename it to weblogic_server. Weblogic server.

Choices:

  • "disable"

  • "enable"

websphere-server

string

Deprecated, please rename it to websphere_server. Websphere server.

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

  • 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

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)