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

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

aliases: add-nat46-route

string

Enable/disable adding NAT46 route.

Choices:

  • "disable"

  • "enable"

arp_reply

aliases: arp-reply

string

Arp reply.

Choices:

  • "disable"

  • "enable"

color

integer

Color.

comment

string

Comment.

dns_mapping_ttl

aliases: dns-mapping-ttl

integer

Dns mapping ttl.

extaddr

any

(list or str) Extaddr.

extintf

string

Extintf.

extip

string

Extip.

extport

string

Extport.

gratuitous_arp_interval

aliases: gratuitous-arp-interval

integer

Gratuitous arp interval.

gslb_domain_name

aliases: gslb-domain-name

string

Domain to use when integrating with FortiGSLB.

gslb_hostname

aliases: gslb-hostname

string

Hostname to use within the configured FortiGSLB domain.

h2_support

aliases: h2-support

string

Enable/disable HTTP2 support

Choices:

  • "disable"

  • "enable"

h3_support

aliases: h3-support

string

Enable/disable HTTP3/QUIC support

Choices:

  • "disable"

  • "enable"

http_cookie_age

aliases: http-cookie-age

integer

Http cookie age.

http_cookie_domain

aliases: http-cookie-domain

string

Http cookie domain.

http_cookie_domain_from_host

aliases: http-cookie-domain-from-host

string

Http cookie domain from host.

Choices:

  • "disable"

  • "enable"

http_cookie_generation

aliases: http-cookie-generation

integer

Http cookie generation.

http_cookie_path

aliases: http-cookie-path

string

Http cookie path.

http_cookie_share

aliases: http-cookie-share

string

Http cookie share.

Choices:

  • "disable"

  • "same-ip"

http_ip_header

aliases: http-ip-header

string

Http ip header.

Choices:

  • "disable"

  • "enable"

http_ip_header_name

aliases: http-ip-header-name

string

Http ip header name.

http_multiplex

aliases: http-multiplex

string

Http multiplex.

Choices:

  • "disable"

  • "enable"

http_multiplex_max_concurrent_request

aliases: http-multiplex-max-concurrent-request

integer

Maximum number of concurrent requests that a multiplex server can handle

http_multiplex_max_request

aliases: http-multiplex-max-request

integer

Maximum number of requests that a multiplex server can handle before disconnecting sessions

http_multiplex_ttl

aliases: http-multiplex-ttl

integer

Time-to-live for idle connections to servers.

http_redirect

aliases: http-redirect

string

Http redirect.

Choices:

  • "disable"

  • "enable"

http_supported_max_version

aliases: http-supported-max-version

string

Maximum supported HTTP versions.

Choices:

  • "http1"

  • "http2"

https_cookie_secure

aliases: https-cookie-secure

string

Https cookie secure.

Choices:

  • "disable"

  • "enable"

id

integer

Id.

ipv6_mappedip

aliases: ipv6-mappedip

string

Range of mapped IPv6 addresses.

ipv6_mappedport

aliases: ipv6-mappedport

string

IPv6 port number range on the destination network to which the external port number range is mapped.

ldb_method

aliases: ldb-method

string

Ldb method.

Choices:

  • "static"

  • "round-robin"

  • "weighted"

  • "least-session"

  • "least-rtt"

  • "first-alive"

  • "http-host"

mapped_addr

aliases: mapped-addr

string

Mapped addr.

mappedip

any

(list) Mappedip.

mappedport

string

Mappedport.

max_embryonic_connections

aliases: max-embryonic-connections

integer

Max embryonic connections.

monitor

any

(list or str) Monitor.

nat44

string

Enable/disable NAT44.

Choices:

  • "disable"

  • "enable"

nat46

string

Enable/disable NAT46.

Choices:

  • "disable"

  • "enable"

nat_source_vip

aliases: nat-source-vip

string

Nat source vip.

Choices:

  • "disable"

  • "enable"

one_click_gslb_server

aliases: one-click-gslb-server

string

Enable/disable one click GSLB server integration with FortiGSLB.

Choices:

  • "disable"

  • "enable"

outlook_web_access

aliases: outlook-web-access

string

Outlook web access.

Choices:

  • "disable"

  • "enable"

persistence

string

Persistence.

Choices:

  • "none"

  • "http-cookie"

  • "ssl-session-id"

portforward

string

Portforward.

Choices:

  • "disable"

  • "enable"

portmapping_type

aliases: portmapping-type

string

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

aliases: client-ip

any

(list) Client ip.

health_check_proto

aliases: health-check-proto

string

Health check proto.

Choices:

  • "ping"

  • "http"

healthcheck

string

Healthcheck.

Choices:

  • "disable"

  • "enable"

  • "vip"

holddown_interval

aliases: holddown-interval

integer

Holddown interval.

http_host

aliases: http-host

string

Http host.

id

integer

Id.

ip

string

Ip.

max_connections

aliases: max-connections

integer

Max connections.

monitor

any

(list or str) Monitor.

port

integer

Port.

seq

integer

Seq.

status

string

Status.

Choices:

  • "active"

  • "standby"

  • "disable"

translate_host

aliases: translate-host

string

Enable/disable translation of hostname/IP from virtual server to real server.

Choices:

  • "disable"

  • "enable"

type

string

Type.

Choices:

  • "ip"

  • "address"

weight

integer

Weight.

server_type

aliases: server-type

string

Server type.

Choices:

  • "http"

  • "https"

  • "ssl"

  • "tcp"

  • "udp"

  • "ip"

  • "imaps"

  • "pop3s"

  • "smtps"

  • "ssh"

service

any

(list or str) Service.

src_filter

aliases: src-filter

any

(list) Src filter.

src_vip_filter

aliases: src-vip-filter

string

Enable/disable use of src-filter to match destinations for the reverse SNAT rule.

Choices:

  • "disable"

  • "enable"

srcintf_filter

aliases: srcintf-filter

any

(list) Srcintf filter.

ssl_accept_ffdhe_groups

aliases: ssl-accept-ffdhe-groups

string

Enable/disable FFDHE cipher suite for SSL key exchange.

Choices:

  • "disable"

  • "enable"

ssl_algorithm

aliases: ssl-algorithm

string

Ssl algorithm.

Choices:

  • "high"

  • "medium"

  • "low"

  • "custom"

ssl_certificate

aliases: ssl-certificate

string

Ssl certificate.

ssl_cipher_suites

aliases: ssl-cipher-suites

list / elements=dictionary

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

aliases: ssl-client-fallback

string

Ssl client fallback.

Choices:

  • "disable"

  • "enable"

ssl_client_rekey_count

aliases: ssl-client-rekey-count

integer

Ssl client rekey count.

ssl_client_renegotiation

aliases: ssl-client-renegotiation

string

Ssl client renegotiation.

Choices:

  • "deny"

  • "allow"

  • "secure"

ssl_client_session_state_max

aliases: ssl-client-session-state-max

integer

Ssl client session state max.

ssl_client_session_state_timeout

aliases: ssl-client-session-state-timeout

integer

Ssl client session state timeout.

ssl_client_session_state_type

aliases: ssl-client-session-state-type

string

Ssl client session state type.

Choices:

  • "disable"

  • "time"

  • "count"

  • "both"

ssl_dh_bits

aliases: ssl-dh-bits

string

Ssl dh bits.

Choices:

  • "768"

  • "1024"

  • "1536"

  • "2048"

  • "3072"

  • "4096"

ssl_hpkp

aliases: ssl-hpkp

string

Ssl hpkp.

Choices:

  • "disable"

  • "enable"

  • "report-only"

ssl_hpkp_age

aliases: ssl-hpkp-age

integer

Ssl hpkp age.

ssl_hpkp_backup

aliases: ssl-hpkp-backup

string

Ssl hpkp backup.

ssl_hpkp_include_subdomains

aliases: ssl-hpkp-include-subdomains

string

Ssl hpkp include subdomains.

Choices:

  • "disable"

  • "enable"

ssl_hpkp_primary

aliases: ssl-hpkp-primary

string

Ssl hpkp primary.

ssl_hpkp_report_uri

aliases: ssl-hpkp-report-uri

string

Ssl hpkp report uri.

ssl_hsts

aliases: ssl-hsts

string

Ssl hsts.

Choices:

  • "disable"

  • "enable"

ssl_hsts_age

aliases: ssl-hsts-age

integer

Ssl hsts age.

ssl_hsts_include_subdomains

aliases: ssl-hsts-include-subdomains

string

Ssl hsts include subdomains.

Choices:

  • "disable"

  • "enable"

ssl_http_location_conversion

aliases: ssl-http-location-conversion

string

Ssl http location conversion.

Choices:

  • "disable"

  • "enable"

ssl_http_match_host

aliases: ssl-http-match-host

string

Ssl http match host.

Choices:

  • "disable"

  • "enable"

ssl_max_version

aliases: ssl-max-version

string

Ssl max version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl_min_version

aliases: ssl-min-version

string

Ssl min version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl_mode

aliases: ssl-mode

string

Ssl mode.

Choices:

  • "half"

  • "full"

ssl_pfs

aliases: ssl-pfs

string

Ssl pfs.

Choices:

  • "require"

  • "deny"

  • "allow"

ssl_send_empty_frags

aliases: ssl-send-empty-frags

string

Ssl send empty frags.

Choices:

  • "disable"

  • "enable"

ssl_server_algorithm

aliases: ssl-server-algorithm

string

Ssl server algorithm.

Choices:

  • "high"

  • "low"

  • "medium"

  • "custom"

  • "client"

ssl_server_max_version

aliases: ssl-server-max-version

string

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

aliases: ssl-server-min-version

string

Ssl server min version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "client"

  • "tls-1.3"

ssl_server_renegotiation

aliases: ssl-server-renegotiation

string

Enable/disable secure renegotiation to comply with RFC 5746.

Choices:

  • "disable"

  • "enable"

ssl_server_session_state_max

aliases: ssl-server-session-state-max

integer

Ssl server session state max.

ssl_server_session_state_timeout

aliases: ssl-server-session-state-timeout

integer

Ssl server session state timeout.

ssl_server_session_state_type

aliases: ssl-server-session-state-type

string

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

aliases: weblogic-server

string

Weblogic server.

Choices:

  • "disable"

  • "enable"

websphere_server

aliases: websphere-server

string

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)