fortinet.fortimanager.fmgr_firewall_accessproxy module – Configure Access Proxy.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.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_accessproxy.

New in fortinet.fortimanager 2.1.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_accessproxy dictionary	The top level parameters set.
add-vhost-domain-to-dnsdb string	Deprecated, please rename it to add_vhost_domain_to_dnsdb. Enable/disable adding vhost/domain to dnsdb for ztna dox tunnel. Choices: "disable" "enable"
api-gateway list / elements=dictionary	Deprecated, please rename it to api_gateway. Api-Gateway.
application any	(list) No description.
h2-support string	Deprecated, please rename it to h2_support. HTTP2 support, default=Enable. Choices: "disable" "enable"
h3-support string	Deprecated, please rename it to h3_support. HTTP3/QUIC support, default=Disable. Choices: "disable" "enable"
http-cookie-age integer	Deprecated, please rename it to http_cookie_age. Time in minutes that client web browsers should keep a cookie.
http-cookie-domain string	Deprecated, please rename it to http_cookie_domain. Domain that HTTP cookie persistence should apply to.
http-cookie-domain-from-host string	Deprecated, please rename it to http_cookie_domain_from_host. Enable/disable use of HTTP cookie domain from host f… Choices: "disable" "enable"
http-cookie-generation integer	Deprecated, please rename it to http_cookie_generation. Generation of HTTP cookie to be accepted.
http-cookie-path string	Deprecated, please rename it to http_cookie_path. Limit HTTP cookie persistence to the specified path.
http-cookie-share string	Deprecated, please rename it to http_cookie_share. Control sharing of cookies across API Gateway. Choices: "disable" "same-ip"
https-cookie-secure string	Deprecated, please rename it to https_cookie_secure. Enable/disable verification that inserted HTTPS cookies are s… Choices: "disable" "enable"
id integer	API Gateway ID.
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"
persistence string	Configure how to make sure that clients connect to the same server every time they make a request that is part of … Choices: "none" "http-cookie"
quic dictionary	No description.
ack-delay-exponent integer	Deprecated, please rename it to ack_delay_exponent. ACK delay exponent
active-connection-id-limit integer	Deprecated, please rename it to active_connection_id_limit. 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. Maximum ACK delay in milliseconds
max-datagram-frame-size integer	Deprecated, please rename it to max_datagram_frame_size. Maximum datagram frame size in bytes
max-idle-timeout integer	Deprecated, please rename it to max_idle_timeout. Maximum idle timeout milliseconds
max-udp-payload-size integer	Deprecated, please rename it to max_udp_payload_size. Maximum UDP payload size in bytes
realservers list / elements=dictionary	Realservers.
addr-type string	Deprecated, please rename it to addr_type. Type of address. Choices: "fqdn" "ip"
address string	Address or address group of the real server.
domain string	Wildcard domain name of the real server.
external-auth string	Deprecated, please rename it to external_auth. Enable/disable use of external browser as user-agent for SA… Choices: "disable" "enable"
health-check string	Deprecated, please rename it to health_check. Enable to check the responsiveness of the real server before… Choices: "disable" "enable"
health-check-proto string	Deprecated, please rename it to health_check_proto. Protocol of the health check monitor to use when polli… Choices: "ping" "http" "tcp-connect"
holddown-interval string	Deprecated, please rename it to holddown_interval. Enable/disable holddown timer. Choices: "disable" "enable"
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.
mappedport any	(list or str) Port for communicating with the real server.
port integer	Port for communicating with the real server.
ssh-client-cert string	Deprecated, please rename it to ssh_client_cert. Set access-proxy SSH client certificate profile.
ssh-host-key any	(list or str) Deprecated, please rename it to ssh_host_key.
ssh-host-key-validation string	Deprecated, please rename it to ssh_host_key_validation. Enable/disable SSH real server host key validation. Choices: "disable" "enable"
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"
tunnel-encryption string	Deprecated, please rename it to tunnel_encryption. Tunnel encryption. Choices: "disable" "enable"
type string	TCP forwarding server type. Choices: "tcp-forwarding" "ssh"
weight integer	Weight of the real server.
saml-redirect string	Deprecated, please rename it to saml_redirect. Enable/disable SAML redirection after successful authentication. Choices: "disable" "enable"
saml-server string	Deprecated, please rename it to saml_server. SAML service provider configuration for VIP authentication.
service string	Service. Choices: "http" "https" "tcp-forwarding" "samlsp" "web-portal" "saas"
ssl-algorithm string	Deprecated, please rename it to ssl_algorithm. Permitted encryption algorithms for the server side of SSL full mod… Choices: "high" "medium" "low" "custom"
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: "tls-1.0" "tls-1.1" "tls-1.2" "tls-1.3"
ssl-dh-bits string	Deprecated, please rename it to ssl_dh_bits. Number of bits to use in the Diffie-Hellman exchange for RSA encrypti… Choices: "768" "1024" "1536" "2048" "3072" "4096"
ssl-max-version string	Deprecated, please rename it to ssl_max_version. Highest SSL/TLS version acceptable from a server. Choices: "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 server. Choices: "tls-1.0" "tls-1.1" "tls-1.2" "tls-1.3"
ssl-renegotiation string	Deprecated, please rename it to ssl_renegotiation. Enable/disable secure renegotiation to comply with RFC 5746. Choices: "disable" "enable"
ssl-vpn-web-portal string	Deprecated, please rename it to ssl_vpn_web_portal. SSL-VPN web portal.
url-map string	Deprecated, please rename it to url_map. URL pattern to match.
url-map-type string	Deprecated, please rename it to url_map_type. Type of url-map. Choices: "sub-string" "wildcard" "regex"
virtual-host string	Deprecated, please rename it to virtual_host. Virtual host.
api-gateway6 list / elements=dictionary	Deprecated, please rename it to api_gateway6.
application any	(list) No description.
h2-support string	Deprecated, please rename it to h2_support. HTTP2 support, default=Enable. Choices: "disable" "enable"
h3-support string	Deprecated, please rename it to h3_support. HTTP3/QUIC support, default=Disable. Choices: "disable" "enable"
http-cookie-age integer	Deprecated, please rename it to http_cookie_age. Time in minutes that client web browsers should keep a cookie.
http-cookie-domain string	Deprecated, please rename it to http_cookie_domain. Domain that HTTP cookie persistence should apply to.
http-cookie-domain-from-host string	Deprecated, please rename it to http_cookie_domain_from_host. Enable/disable use of HTTP cookie domain from host f… Choices: "disable" "enable"
http-cookie-generation integer	Deprecated, please rename it to http_cookie_generation. Generation of HTTP cookie to be accepted.
http-cookie-path string	Deprecated, please rename it to http_cookie_path. Limit HTTP cookie persistence to the specified path.
http-cookie-share string	Deprecated, please rename it to http_cookie_share. Control sharing of cookies across API Gateway. Choices: "disable" "same-ip"
https-cookie-secure string	Deprecated, please rename it to https_cookie_secure. Enable/disable verification that inserted HTTPS cookies are s… Choices: "disable" "enable"
id integer	API Gateway ID.
ldb-method string	Deprecated, please rename it to ldb_method. Method used to distribute sessions to real servers. Choices: "static" "round-robin" "weighted" "first-alive" "http-host"
persistence string	Configure how to make sure that clients connect to the same server every time they make a request that is part of … Choices: "none" "http-cookie"
quic dictionary	No description.
ack-delay-exponent integer	Deprecated, please rename it to ack_delay_exponent. ACK delay exponent
active-connection-id-limit integer	Deprecated, please rename it to active_connection_id_limit. 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. Maximum ACK delay in milliseconds
max-datagram-frame-size integer	Deprecated, please rename it to max_datagram_frame_size. Maximum datagram frame size in bytes
max-idle-timeout integer	Deprecated, please rename it to max_idle_timeout. Maximum idle timeout milliseconds
max-udp-payload-size integer	Deprecated, please rename it to max_udp_payload_size. Maximum UDP payload size in bytes
realservers list / elements=dictionary	No description.
addr-type string	Deprecated, please rename it to addr_type. Type of address. Choices: "fqdn" "ip"
address string	Address or address group of the real server.
domain string	Wildcard domain name of the real server.
external-auth string	Deprecated, please rename it to external_auth. Enable/disable use of external browser as user-agent for SA… Choices: "disable" "enable"
health-check string	Deprecated, please rename it to health_check. Enable to check the responsiveness of the real server before… Choices: "disable" "enable"
health-check-proto string	Deprecated, please rename it to health_check_proto. Protocol of the health check monitor to use when polli… Choices: "ping" "http" "tcp-connect"
holddown-interval string	Deprecated, please rename it to holddown_interval. Enable/disable holddown timer. Choices: "disable" "enable"
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.
mappedport any	(list or str) Port for communicating with the real server.
port integer	Port for communicating with the real server.
ssh-client-cert string	Deprecated, please rename it to ssh_client_cert. Set access-proxy SSH client certificate profile.
ssh-host-key any	(list or str) Deprecated, please rename it to ssh_host_key.
ssh-host-key-validation string	Deprecated, please rename it to ssh_host_key_validation. Enable/disable SSH real server host key validation. Choices: "disable" "enable"
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"
tunnel-encryption string	Deprecated, please rename it to tunnel_encryption. Tunnel encryption. Choices: "disable" "enable"
type string	TCP forwarding server type. Choices: "tcp-forwarding" "ssh"
weight integer	Weight of the real server.
saml-redirect string	Deprecated, please rename it to saml_redirect. Enable/disable SAML redirection after successful authentication. Choices: "disable" "enable"
saml-server string	Deprecated, please rename it to saml_server. SAML service provider configuration for VIP authentication.
service string	Service. Choices: "http" "https" "tcp-forwarding" "samlsp" "web-portal" "saas"
ssl-algorithm string	Deprecated, please rename it to ssl_algorithm. Permitted encryption algorithms for the server side of SSL full mod… Choices: "high" "medium" "low"
ssl-cipher-suites list / elements=dictionary	Deprecated, please rename it to 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	No description. Choices: "tls-1.0" "tls-1.1" "tls-1.2" "tls-1.3"
ssl-dh-bits string	Deprecated, please rename it to ssl_dh_bits. Number of bits to use in the Diffie-Hellman exchange for RSA encrypti… Choices: "768" "1024" "1536" "2048" "3072" "4096"
ssl-max-version string	Deprecated, please rename it to ssl_max_version. Highest SSL/TLS version acceptable from a server. Choices: "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 server. Choices: "tls-1.0" "tls-1.1" "tls-1.2" "tls-1.3"
ssl-renegotiation string	Deprecated, please rename it to ssl_renegotiation. Enable/disable secure renegotiation to comply with RFC 5746. Choices: "disable" "enable"
ssl-vpn-web-portal string	Deprecated, please rename it to ssl_vpn_web_portal. SSL-VPN web portal.
url-map string	Deprecated, please rename it to url_map. URL pattern to match.
url-map-type string	Deprecated, please rename it to url_map_type. Type of url-map. Choices: "sub-string" "wildcard" "regex"
virtual-host string	Deprecated, please rename it to virtual_host. Virtual host.
auth-portal string	Deprecated, please rename it to auth_portal. Enable/disable authentication portal. Choices: "disable" "enable"
auth-virtual-host string	Deprecated, please rename it to auth_virtual_host. Virtual host for authentication portal.
client-cert string	Deprecated, please rename it to client_cert. Enable/disable to request client certificate. Choices: "disable" "enable"
decrypted-traffic-mirror string	Deprecated, please rename it to decrypted_traffic_mirror. Decrypted traffic mirror.
empty-cert-action string	Deprecated, please rename it to empty_cert_action. Action of an empty client certificate. Choices: "block" "accept" "accept-unmanageable"
http-supported-max-version string	Deprecated, please rename it to http_supported_max_version. Maximum supported HTTP versions. Choices: "http1" "http2"
ldb-method string	Deprecated, please rename it to ldb_method. Method used to distribute sessions to SSL real servers. Choices: "static" "round-robin" "weighted" "least-session" "least-rtt" "first-alive"
log-blocked-traffic string	Deprecated, please rename it to log_blocked_traffic. Enable/disable logging of blocked traffic. Choices: "disable" "enable"
name string / required	Access Proxy name.
realservers list / elements=dictionary	Realservers.
id integer	Real server ID.
ip string	IP address of the real server.
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"
weight integer	Weight of the real server.
server-pubkey-auth string	Deprecated, please rename it to server_pubkey_auth. Enable/disable SSH real server public key authentication. Choices: "disable" "enable"
server-pubkey-auth-settings dictionary	Deprecated, please rename it to server_pubkey_auth_settings.
auth-ca string	Deprecated, please rename it to auth_ca. Name of the SSH server public key authentication CA.
cert-extension list / elements=dictionary	Deprecated, please rename it to cert_extension. Cert-Extension.
critical string	Critical option. Choices: "no" "yes"
data string	Name of certificate extension.
name string	Name of certificate extension.
type string	Type of certificate extension. Choices: "fixed" "user"
permit-agent-forwarding string	Deprecated, please rename it to permit_agent_forwarding. Enable/disable appending permit-agent-forwarding certific… Choices: "disable" "enable"
permit-port-forwarding string	Deprecated, please rename it to permit_port_forwarding. Enable/disable appending permit-port-forwarding certificat… Choices: "disable" "enable"
permit-pty string	Deprecated, please rename it to permit_pty. Enable/disable appending permit-pty certificate extension. Choices: "disable" "enable"
permit-user-rc string	Deprecated, please rename it to permit_user_rc. Enable/disable appending permit-user-rc certificate extension. Choices: "disable" "enable"
permit-x11-forwarding string	Deprecated, please rename it to permit_x11_forwarding. Enable/disable appending permit-x11-forwarding certificate … Choices: "disable" "enable"
source-address string	Deprecated, please rename it to source_address. Enable/disable appending source-address certificate critical option. Choices: "disable" "enable"
svr-pool-multiplex string	Deprecated, please rename it to svr_pool_multiplex. Enable/disable server pool multiplexing. Choices: "disable" "enable"
svr-pool-server-max-concurrent-request integer	Deprecated, please rename it to svr_pool_server_max_concurrent_request. Maximum number of concurrent requests that servers…
svr-pool-server-max-request integer	Deprecated, please rename it to svr_pool_server_max_request. Maximum number of requests that servers in server pool handle…
svr-pool-ttl integer	Deprecated, please rename it to svr_pool_ttl. Time-to-live in the server pool for idle connections to servers.
user-agent-detect string	Deprecated, please rename it to user_agent_detect. Enable/disable to detect device type by HTTP user-agent if no client ce… Choices: "disable" "enable"
vip string	Virtual IP name.
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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure Access Proxy.
      fortinet.fortimanager.fmgr_firewall_accessproxy:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        firewall_accessproxy:
          api_gateway:
            -
              http_cookie_age: <integer>
              http_cookie_domain: <string>
              http_cookie_domain_from_host: <value in [disable, enable]>
              http_cookie_generation: <integer>
              http_cookie_path: <string>
              http_cookie_share: <value in [disable, same-ip]>
              https_cookie_secure: <value in [disable, enable]>
              id: <integer>
              ldb_method: <value in [static, round-robin, weighted, ...]>
              persistence: <value in [none, http-cookie]>
              realservers:
                -
                  address: <string>
                  health_check: <value in [disable, enable]>
                  health_check_proto: <value in [ping, http, tcp-connect]>
                  http_host: <string>
                  id: <integer>
                  ip: <string>
                  mappedport: <list or string>
                  port: <integer>
                  status: <value in [active, standby, disable]>
                  weight: <integer>
                  addr_type: <value in [fqdn, ip]>
                  domain: <string>
                  holddown_interval: <value in [disable, enable]>
                  ssh_client_cert: <string>
                  ssh_host_key: <list or string>
                  ssh_host_key_validation: <value in [disable, enable]>
                  type: <value in [tcp-forwarding, ssh]>
                  translate_host: <value in [disable, enable]>
                  external_auth: <value in [disable, enable]>
                  tunnel_encryption: <value in [disable, enable]>
              saml_server: <string>
              service: <value in [http, https, tcp-forwarding, ...]>
              ssl_algorithm: <value in [high, medium, low, ...]>
              ssl_cipher_suites:
                -
                  cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
                  priority: <integer>
                  versions:
                    - tls-1.0
                    - tls-1.1
                    - tls-1.2
                    - tls-1.3
              ssl_dh_bits: <value in [768, 1024, 1536, ...]>
              ssl_max_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
              ssl_min_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
              url_map: <string>
              url_map_type: <value in [sub-string, wildcard, regex]>
              virtual_host: <string>
              saml_redirect: <value in [disable, enable]>
              ssl_vpn_web_portal: <string>
              application: <list or string>
              ssl_renegotiation: <value in [disable, enable]>
              h2_support: <value in [disable, enable]>
              h3_support: <value in [disable, enable]>
              quic:
                ack_delay_exponent: <integer>
                active_connection_id_limit: <integer>
                active_migration: <value in [disable, enable]>
                grease_quic_bit: <value in [disable, enable]>
                max_ack_delay: <integer>
                max_datagram_frame_size: <integer>
                max_idle_timeout: <integer>
                max_udp_payload_size: <integer>
          client_cert: <value in [disable, enable]>
          empty_cert_action: <value in [block, accept, accept-unmanageable]>
          ldb_method: <value in [static, round-robin, weighted, ...]>
          name: <string>
          realservers:
            -
              id: <integer>
              ip: <string>
              port: <integer>
              status: <value in [active, standby, disable]>
              weight: <integer>
          server_pubkey_auth: <value in [disable, enable]>
          server_pubkey_auth_settings:
            auth_ca: <string>
            cert_extension:
              -
                critical: <value in [no, yes]>
                data: <string>
                name: <string>
                type: <value in [fixed, user]>
            permit_agent_forwarding: <value in [disable, enable]>
            permit_port_forwarding: <value in [disable, enable]>
            permit_pty: <value in [disable, enable]>
            permit_user_rc: <value in [disable, enable]>
            permit_x11_forwarding: <value in [disable, enable]>
            source_address: <value in [disable, enable]>
          vip: <string>
          api_gateway6:
            -
              http_cookie_age: <integer>
              http_cookie_domain: <string>
              http_cookie_domain_from_host: <value in [disable, enable]>
              http_cookie_generation: <integer>
              http_cookie_path: <string>
              http_cookie_share: <value in [disable, same-ip]>
              https_cookie_secure: <value in [disable, enable]>
              id: <integer>
              ldb_method: <value in [static, round-robin, weighted, ...]>
              persistence: <value in [none, http-cookie]>
              realservers:
                -
                  addr_type: <value in [fqdn, ip]>
                  address: <string>
                  domain: <string>
                  health_check: <value in [disable, enable]>
                  health_check_proto: <value in [ping, http, tcp-connect]>
                  holddown_interval: <value in [disable, enable]>
                  http_host: <string>
                  id: <integer>
                  ip: <string>
                  mappedport: <list or string>
                  port: <integer>
                  ssh_client_cert: <string>
                  ssh_host_key: <list or string>
                  ssh_host_key_validation: <value in [disable, enable]>
                  status: <value in [active, standby, disable]>
                  type: <value in [tcp-forwarding, ssh]>
                  weight: <integer>
                  translate_host: <value in [disable, enable]>
                  external_auth: <value in [disable, enable]>
                  tunnel_encryption: <value in [disable, enable]>
              saml_redirect: <value in [disable, enable]>
              saml_server: <string>
              service: <value in [http, https, tcp-forwarding, ...]>
              ssl_algorithm: <value in [high, medium, low]>
              ssl_cipher_suites:
                -
                  cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
                  priority: <integer>
                  versions:
                    - tls-1.0
                    - tls-1.1
                    - tls-1.2
                    - tls-1.3
              ssl_dh_bits: <value in [768, 1024, 1536, ...]>
              ssl_max_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
              ssl_min_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
              ssl_vpn_web_portal: <string>
              url_map: <string>
              url_map_type: <value in [sub-string, wildcard, regex]>
              virtual_host: <string>
              application: <list or string>
              ssl_renegotiation: <value in [disable, enable]>
              h2_support: <value in [disable, enable]>
              h3_support: <value in [disable, enable]>
              quic:
                ack_delay_exponent: <integer>
                active_connection_id_limit: <integer>
                active_migration: <value in [disable, enable]>
                grease_quic_bit: <value in [disable, enable]>
                max_ack_delay: <integer>
                max_datagram_frame_size: <integer>
                max_idle_timeout: <integer>
                max_udp_payload_size: <integer>
          auth_portal: <value in [disable, enable]>
          auth_virtual_host: <string>
          decrypted_traffic_mirror: <string>
          log_blocked_traffic: <value in [disable, enable]>
          add_vhost_domain_to_dnsdb: <value in [disable, enable]>
          user_agent_detect: <value in [disable, enable]>
          http_supported_max_version: <value in [http1, http2]>
          svr_pool_multiplex: <value in [disable, enable]>
          svr_pool_server_max_request: <integer>
          svr_pool_ttl: <integer>
          svr_pool_server_max_concurrent_request: <integer>

Return Values

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

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

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)