fortinet.fortimanager.fmgr_firewall_vip6 module – Configure virtual IP for IPv6.

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_vip6.

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_vip6

dictionary

The top level parameters set.

add-nat64-route

string

Deprecated, please rename it to add_nat64_route. Enable/disable adding NAT64 route.

Choices:

  • "disable"

  • "enable"

arp-reply

string

Deprecated, please rename it to arp_reply. Enable to respond to ARP requests for this virtual IP address.

Choices:

  • "disable"

  • "enable"

color

integer

Color of icon on the GUI.

comment

string

Comment.

dynamic_mapping

list / elements=dictionary

Dynamic mapping.

_scope

list / elements=dictionary

Scope.

name

string

Name.

vdom

string

Vdom.

add-nat64-route

string

Deprecated, please rename it to add_nat64_route. Enable/disable adding NAT64 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.

embedded-ipv4-address

string

Deprecated, please rename it to embedded_ipv4_address. Enable/disable use of the lower 32 bits of the external IPv…

Choices:

  • "disable"

  • "enable"

extip

string

Extip.

extport

string

Extport.

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-redirect

string

Deprecated, please rename it to http_redirect. Http redirect.

Choices:

  • "disable"

  • "enable"

string

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

Choices:

  • "disable"

  • "enable"

id

integer

Id.

ipv4-mappedip

string

Deprecated, please rename it to ipv4_mappedip. Range of mapped IP addresses.

ipv4-mappedport

string

Deprecated, please rename it to ipv4_mappedport. IPv4 port number range on the destination network to which the ex…

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"

mappedip

string

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"

nat64

string

Enable/disable DNAT64.

Choices:

  • "disable"

  • "enable"

nat66

string

Enable/disable DNAT66.

Choices:

  • "disable"

  • "enable"

ndp-reply

string

Deprecated, please rename it to ndp_reply. Enable/disable this FortiGate units ability to respond to NDP requests …

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"

protocol

string

Protocol.

Choices:

  • "tcp"

  • "udp"

  • "sctp"

realservers

list / elements=dictionary

Realservers.

client-ip

string

Deprecated, please rename it to client_ip. Only clients in this IP range can connect to this real server.

healthcheck

string

Enable to check the responsiveness of the real server before forwarding traffic.

Choices:

  • "disable"

  • "enable"

  • "vip"

holddown-interval

integer

Deprecated, please rename it to holddown_interval. Time in seconds that the health check monitor continues…

http-host

string

Deprecated, please rename it to http_host. HTTP server domain name in HTTP header.

id

integer

Real server ID.

ip

string

IP address of the real server.

max-connections

integer

Deprecated, please rename it to max_connections. Max number of active connections that can directed to the…

monitor

any

(list or str) Name of the health check monitor to use when polling to determine a virtual servers connecti…

port

integer

Port for communicating with the real server.

status

string

Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no…

Choices:

  • "active"

  • "standby"

  • "disable"

translate-host

string

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

Choices:

  • "disable"

  • "enable"

weight

integer

Weight of the real server.

server-type

string

Deprecated, please rename it to server_type. Server type.

Choices:

  • "http"

  • "https"

  • "ssl"

  • "tcp"

  • "udp"

  • "ip"

  • "imaps"

  • "pop3s"

  • "smtps"

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 rev…

Choices:

  • "disable"

  • "enable"

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"

  • "low"

  • "medium"

  • "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 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"

  • "TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA"

priority

integer

SSL/TLS cipher suites priority.

versions

list / elements=string

SSL/TLS versions that the cipher suite can be used with.

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"

type

string

Type.

Choices:

  • "static-nat"

  • "server-load-balance"

  • "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"

embedded-ipv4-address

string

Deprecated, please rename it to embedded_ipv4_address. Enable/disable use of the lower 32 bits of the external IPv6 addres…

Choices:

  • "disable"

  • "enable"

extip

string

IP address or address range on the external interface that you want to map to an address or address range on the destinati…

extport

string

Incoming port number range that you want to map to a port number range on the destination network.

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. Time in minutes that client web browsers should keep a cookie.

string

Deprecated, please rename it to http_cookie_domain. Domain that HTTP cookie persistence should apply to.

string

Deprecated, please rename it to http_cookie_domain_from_host. Enable/disable use of HTTP cookie domain from host field in …

Choices:

  • "disable"

  • "enable"

integer

Deprecated, please rename it to http_cookie_generation. Generation of HTTP cookie to be accepted.

string

Deprecated, please rename it to http_cookie_path. Limit HTTP cookie persistence to the specified path.

string

Deprecated, please rename it to http_cookie_share. Control sharing of cookies across virtual servers.

Choices:

  • "disable"

  • "same-ip"

http-ip-header

string

Deprecated, please rename it to http_ip_header. For HTTP multiplexing, enable to add the original client IP address in the…

Choices:

  • "disable"

  • "enable"

http-ip-header-name

string

Deprecated, please rename it to http_ip_header_name. For HTTP multiplexing, enter a custom HTTPS header name.

http-multiplex

string

Deprecated, please rename it to http_multiplex. Enable/disable HTTP multiplexing.

Choices:

  • "disable"

  • "enable"

http-redirect

string

Deprecated, please rename it to http_redirect. Enable/disable redirection of HTTP to HTTPS

Choices:

  • "disable"

  • "enable"

string

Deprecated, please rename it to https_cookie_secure. Enable/disable verification that inserted HTTPS cookies are secure.

Choices:

  • "disable"

  • "enable"

id

integer

Custom defined ID.

ipv4-mappedip

string

Deprecated, please rename it to ipv4_mappedip. Range of mapped IP addresses.

ipv4-mappedport

string

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

ldb-method

string

Deprecated, please rename it to ldb_method. Method used to distribute sessions to real servers.

Choices:

  • "static"

  • "round-robin"

  • "weighted"

  • "least-session"

  • "least-rtt"

  • "first-alive"

  • "http-host"

mappedip

string

Mapped IP address range in the format startIP-endIP.

mappedport

string

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

max-embryonic-connections

integer

Deprecated, please rename it to max_embryonic_connections. Maximum number of incomplete connections.

monitor

any

(list or str) Name of the health check monitor to use when polling to determine a virtual servers connectivity status.

name

string / required

Virtual ip6 name.

nat-source-vip

string

Deprecated, please rename it to nat_source_vip. Enable to perform SNAT on traffic from mappedip to the extip for all egres…

Choices:

  • "disable"

  • "enable"

nat64

string

Enable/disable DNAT64.

Choices:

  • "disable"

  • "enable"

nat66

string

Enable/disable DNAT66.

Choices:

  • "disable"

  • "enable"

ndp-reply

string

Deprecated, please rename it to ndp_reply. Enable/disable this FortiGate units ability to respond to NDP requests for this…

Choices:

  • "disable"

  • "enable"

outlook-web-access

string

Deprecated, please rename it to outlook_web_access. 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…

Choices:

  • "none"

  • "http-cookie"

  • "ssl-session-id"

portforward

string

Enable port forwarding.

Choices:

  • "disable"

  • "enable"

protocol

string

Protocol to use when forwarding packets.

Choices:

  • "tcp"

  • "udp"

  • "sctp"

quic

dictionary

Quic.

ack-delay-exponent

integer

Deprecated, please rename it to ack_delay_exponent.

Support meta variable

ACK delay exponent

active-connection-id-limit

integer

Deprecated, please rename it to active_connection_id_limit.

Support meta variable

Active connection ID limit

active-migration

string

Deprecated, please rename it to active_migration. Enable/disable active migration

Choices:

  • "disable"

  • "enable"

grease-quic-bit

string

Deprecated, please rename it to grease_quic_bit. Enable/disable grease QUIC bit

Choices:

  • "disable"

  • "enable"

max-ack-delay

integer

Deprecated, please rename it to max_ack_delay.

Support meta variable

Maximum ACK delay in milliseconds

max-datagram-frame-size

integer

Deprecated, please rename it to max_datagram_frame_size.

Support meta variable

Maximum datagram frame size in bytes

max-idle-timeout

integer

Deprecated, please rename it to max_idle_timeout.

Support meta variable

Maximum idle timeout milliseconds

max-udp-payload-size

integer

Deprecated, please rename it to max_udp_payload_size.

Support meta variable

Maximum UDP payload size in bytes

realservers

list / elements=dictionary

Realservers.

client-ip

string

Deprecated, please rename it to client_ip. Only clients in this IP range can connect to this real server.

healthcheck

string

Enable to check the responsiveness of the real server before forwarding traffic.

Choices:

  • "disable"

  • "enable"

  • "vip"

holddown-interval

integer

Deprecated, please rename it to holddown_interval. Time in seconds that the health check monitor continues to moni…

http-host

string

Deprecated, please rename it to http_host. HTTP server domain name in HTTP header.

id

integer

Real server ID.

ip

string

IPv6 address of the real server.

max-connections

integer

Deprecated, please rename it to max_connections. Max number of active connections that can directed to the real se…

monitor

any

(list or str) 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.

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…

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"

weight

integer

Weight of the real server.

server-type

string

Deprecated, please rename it to server_type. Protocol to be load balanced by the virtual server

Choices:

  • "http"

  • "https"

  • "ssl"

  • "tcp"

  • "udp"

  • "ip"

  • "imaps"

  • "pop3s"

  • "smtps"

src-filter

any

(list) Deprecated, please rename it to src_filter. Source IP6 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"

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. Permitted encryption algorithms for SSL sessions according to encryption st…

Choices:

  • "high"

  • "low"

  • "medium"

  • "custom"

ssl-certificate

string

Deprecated, please rename it to ssl_certificate. The name of the SSL certificate to use for SSL acceleration.

ssl-cipher-suites

list / elements=dictionary

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

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"

  • "TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA"

priority

integer

SSL/TLS cipher suites priority.

versions

list / elements=string

SSL/TLS versions that the cipher suite can be used with.

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. Enable/disable support for preventing Downgrade Attacks on client con…

Choices:

  • "disable"

  • "enable"

ssl-client-rekey-count

integer

Deprecated, please rename it to ssl_client_rekey_count. Maximum length of data in MB before triggering a client rekey

ssl-client-renegotiation

string

Deprecated, please rename it to ssl_client_renegotiation. Allow, deny, or require secure renegotiation of client sessions …

Choices:

  • "deny"

  • "allow"

  • "secure"

ssl-client-session-state-max

integer

Deprecated, please rename it to ssl_client_session_state_max. Maximum number of client to FortiGate SSL session states to …

ssl-client-session-state-timeout

integer

Deprecated, please rename it to ssl_client_session_state_timeout. Number of minutes to keep client to FortiGate SSL sessio…

ssl-client-session-state-type

string

Deprecated, please rename it to ssl_client_session_state_type. How to expire SSL sessions for the segment of the SSL conne…

Choices:

  • "disable"

  • "time"

  • "count"

  • "both"

ssl-dh-bits

string

Deprecated, please rename it to ssl_dh_bits. Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SS…

Choices:

  • "768"

  • "1024"

  • "1536"

  • "2048"

  • "3072"

  • "4096"

ssl-hpkp

string

Deprecated, please rename it to ssl_hpkp. Enable/disable including HPKP header in response.

Choices:

  • "disable"

  • "enable"

  • "report-only"

ssl-hpkp-age

integer

Deprecated, please rename it to ssl_hpkp_age. Number of minutes the web browser should keep HPKP.

ssl-hpkp-backup

string

Deprecated, please rename it to ssl_hpkp_backup. Certificate to generate backup HPKP pin from.

ssl-hpkp-include-subdomains

string

Deprecated, please rename it to ssl_hpkp_include_subdomains. Indicate that HPKP header applies to all subdomains.

Choices:

  • "disable"

  • "enable"

ssl-hpkp-primary

string

Deprecated, please rename it to ssl_hpkp_primary. Certificate to generate primary HPKP pin from.

ssl-hpkp-report-uri

string

Deprecated, please rename it to ssl_hpkp_report_uri. URL to report HPKP violations to.

ssl-hsts

string

Deprecated, please rename it to ssl_hsts. Enable/disable including HSTS header in response.

Choices:

  • "disable"

  • "enable"

ssl-hsts-age

integer

Deprecated, please rename it to ssl_hsts_age. Number of seconds the client should honour the HSTS setting.

ssl-hsts-include-subdomains

string

Deprecated, please rename it to ssl_hsts_include_subdomains. Indicate that HSTS header applies to all subdomains.

Choices:

  • "disable"

  • "enable"

ssl-http-location-conversion

string

Deprecated, please rename it to ssl_http_location_conversion. Enable to replace HTTP with HTTPS in the replys Location HTT…

Choices:

  • "disable"

  • "enable"

ssl-http-match-host

string

Deprecated, please rename it to ssl_http_match_host. Enable/disable HTTP host matching for location conversion.

Choices:

  • "disable"

  • "enable"

ssl-max-version

string

Deprecated, please rename it to ssl_max_version. 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

Deprecated, please rename it to ssl_min_version. 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

Deprecated, please rename it to ssl_mode. Apply SSL offloading between the client and the FortiGate

Choices:

  • "half"

  • "full"

ssl-pfs

string

Deprecated, please rename it to ssl_pfs. Select the cipher suites that can be used for SSL perfect forward secrecy

Choices:

  • "require"

  • "deny"

  • "allow"

ssl-send-empty-frags

string

Deprecated, please rename it to ssl_send_empty_frags. Enable/disable sending empty fragments to avoid CBC IV attacks

Choices:

  • "disable"

  • "enable"

ssl-server-algorithm

string

Deprecated, please rename it to ssl_server_algorithm. Permitted encryption algorithms for the server side of SSL full mode…

Choices:

  • "high"

  • "low"

  • "medium"

  • "custom"

  • "client"

ssl-server-cipher-suites

list / elements=dictionary

Deprecated, please rename it to ssl_server_cipher_suites. Ssl server cipher suites.

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"

  • "TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA"

priority

integer

SSL/TLS cipher suites priority.

versions

list / elements=string

SSL/TLS versions that the cipher suite can be used with.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ssl-server-max-version

string

Deprecated, please rename it to ssl_server_max_version. Highest SSL/TLS version acceptable from a server.

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. Lowest SSL/TLS version acceptable from a server.

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. Maximum number of FortiGate to Server SSL session states to …

ssl-server-session-state-timeout

integer

Deprecated, please rename it to ssl_server_session_state_timeout. Number of minutes to keep FortiGate to Server SSL sessio…

ssl-server-session-state-type

string

Deprecated, please rename it to ssl_server_session_state_type. How to expire SSL sessions for the segment of the SSL conne…

Choices:

  • "disable"

  • "time"

  • "count"

  • "both"

type

string

Configure a static NAT VIP.

Choices:

  • "static-nat"

  • "server-load-balance"

  • "access-proxy"

uuid

string

Universally Unique Identifier

weblogic-server

string

Deprecated, please rename it to weblogic_server. Enable to add an HTTP header to indicate SSL offloading for a WebLogic se…

Choices:

  • "disable"

  • "enable"

websphere-server

string

Deprecated, please rename it to websphere_server. Enable to add an HTTP header to indicate SSL offloading for a WebSphere …

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"

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 virtual IP for IPv6.
      fortinet.fortimanager.fmgr_firewall_vip6:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_vip6:
          arp-reply: disable
          color: 1
          comment: "ansible-comment"
          id: 1
          name: "ansible-test-vip6"

- 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 scripts
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_vip6"
          params:
            adom: "ansible"
            vip6: "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)