fortinet.fortimanager.fmgr_firewall_accessproxy module – Configure Access Proxy.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Enable/disable adding vhost/domain to dnsdb for ztna dox tunnel. Choices:
|
|
Api gateway. |
|
(list) SaaS application controlled by this Access Proxy. |
|
HTTP2 support, default=Enable. Choices:
|
|
HTTP3/QUIC support, default=Disable. Choices:
|
|
Time in minutes that client web browsers should keep a cookie. |
|
Domain that HTTP cookie persistence should apply to. |
|
Enable/disable use of HTTP cookie domain from host field in HTTP. Choices:
|
|
Generation of HTTP cookie to be accepted. |
|
Limit HTTP cookie persistence to the specified path. |
|
Control sharing of cookies across API Gateway. Choices:
|
|
Enable/disable verification that inserted HTTPS cookies are secure. Choices:
|
|
API Gateway ID. |
|
Method used to distribute sessions to real servers. Choices:
|
|
Configure how to make sure that clients connect to the same server every time they make a request that is part of … Choices:
|
|
Quic. |
|
ACK delay exponent |
|
Active connection ID limit |
|
Enable/disable active migration Choices:
|
|
Enable/disable grease QUIC bit Choices:
|
|
Maximum ACK delay in milliseconds |
|
Maximum datagram frame size in bytes |
|
Maximum idle timeout milliseconds |
|
Maximum UDP payload size in bytes |
|
Realservers. |
|
Type of address. Choices:
|
|
Address or address group of the real server. |
|
Wildcard domain name of the real server. |
|
Enable/disable use of external browser as user-agent for SAML user authentication. Choices:
|
|
Enable to check the responsiveness of the real server before forwarding traffic. Choices:
|
|
Protocol of the health check monitor to use when polling to determine servers connectivity status. Choices:
|
|
Enable/disable holddown timer. Choices:
|
|
HTTP server domain name in HTTP header. |
|
Real server ID. |
|
IP address of the real server. |
|
(list or str) Port for communicating with the real server. |
|
Port for communicating with the real server. |
|
Set access-proxy SSH client certificate profile. |
|
(list or str) One or more server host key. |
|
Enable/disable SSH real server host key validation. Choices:
|
|
Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no… Choices:
|
|
Enable/disable translation of hostname/IP from virtual server to real server. Choices:
|
|
Tunnel encryption. Choices:
|
|
TCP forwarding server type. Choices:
|
|
Weight of the real server. |
|
Enable/disable SAML redirection after successful authentication. Choices:
|
|
SAML service provider configuration for VIP authentication. |
|
Service. Choices:
|
|
Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. Choices:
|
|
Ssl cipher suites. |
|
Cipher suite name. Choices:
|
|
SSL/TLS cipher suites priority. |
|
SSL/TLS versions that the cipher suite can be used with. Choices:
|
|
Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. Choices:
|
|
Highest SSL/TLS version acceptable from a server. Choices:
|
|
Lowest SSL/TLS version acceptable from a server. Choices:
|
|
Enable/disable secure renegotiation to comply with RFC 5746. Choices:
|
|
SSL-VPN web portal. |
|
URL pattern to match. |
|
Type of url-map. Choices:
|
|
Virtual host. |
|
Api gateway6. |
|
(list) SaaS application controlled by this Access Proxy. |
|
HTTP2 support, default=Enable. Choices:
|
|
HTTP3/QUIC support, default=Disable. Choices:
|
|
Time in minutes that client web browsers should keep a cookie. |
|
Domain that HTTP cookie persistence should apply to. |
|
Enable/disable use of HTTP cookie domain from host field in HTTP. Choices:
|
|
Generation of HTTP cookie to be accepted. |
|
Limit HTTP cookie persistence to the specified path. |
|
Control sharing of cookies across API Gateway. Choices:
|
|
Enable/disable verification that inserted HTTPS cookies are secure. Choices:
|
|
API Gateway ID. |
|
Method used to distribute sessions to real servers. Choices:
|
|
Configure how to make sure that clients connect to the same server every time they make a request that is part of … Choices:
|
|
Quic. |
|
ACK delay exponent |
|
Active connection ID limit |
|
Enable/disable active migration Choices:
|
|
Enable/disable grease QUIC bit Choices:
|
|
Maximum ACK delay in milliseconds |
|
Maximum datagram frame size in bytes |
|
Maximum idle timeout milliseconds |
|
Maximum UDP payload size in bytes |
|
Realservers. |
|
Type of address. Choices:
|
|
Address or address group of the real server. |
|
Wildcard domain name of the real server. |
|
Enable/disable use of external browser as user-agent for SAML user authentication. Choices:
|
|
Enable to check the responsiveness of the real server before forwarding traffic. Choices:
|
|
Protocol of the health check monitor to use when polling to determine servers connectivity status. Choices:
|
|
Enable/disable holddown timer. Choices:
|
|
HTTP server domain name in HTTP header. |
|
Real server ID. |
|
IPv6 address of the real server. |
|
(list or str) Port for communicating with the real server. |
|
Port for communicating with the real server. |
|
Set access-proxy SSH client certificate profile. |
|
(list or str) One or more server host key. |
|
Enable/disable SSH real server host key validation. Choices:
|
|
Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no… Choices:
|
|
Enable/disable translation of hostname/IP from virtual server to real server. Choices:
|
|
Tunnel encryption. Choices:
|
|
TCP forwarding server type. Choices:
|
|
Weight of the real server. |
|
Enable/disable SAML redirection after successful authentication. Choices:
|
|
SAML service provider configuration for VIP authentication. |
|
Service. Choices:
|
|
Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. Choices:
|
|
Ssl cipher suites. |
|
Cipher suite name. Choices:
|
|
SSL/TLS cipher suites priority. |
|
SSL/TLS versions that the cipher suite can be used with. Choices:
|
|
Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. Choices:
|
|
Highest SSL/TLS version acceptable from a server. Choices:
|
|
Lowest SSL/TLS version acceptable from a server. Choices:
|
|
Enable/disable secure renegotiation to comply with RFC 5746. Choices:
|
|
SSL-VPN web portal. |
|
URL pattern to match. |
|
Type of url-map. Choices:
|
|
Virtual host. |
|
Enable/disable authentication portal. Choices:
|
|
Virtual host for authentication portal. |
|
Enable/disable to request client certificate. Choices:
|
|
Decrypted traffic mirror. |
|
Action of an empty client certificate. Choices:
|
|
Maximum supported HTTP versions. Choices:
|
|
Method used to distribute sessions to SSL real servers. Choices:
|
|
Enable/disable logging of blocked traffic. Choices:
|
|
Access Proxy name. |
|
Realservers. |
|
Real server ID. |
|
IP address of the real server. |
|
Port for communicating with the real server. |
|
Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic… Choices:
|
|
Weight of the real server. |
|
Enable/disable SSH real server public key authentication. Choices:
|
|
Server pubkey auth settings. |
|
Name of the SSH server public key authentication CA. |
|
Cert extension. |
|
Critical option. Choices:
|
|
Name of certificate extension. |
|
Name of certificate extension. |
|
Type of certificate extension. Choices:
|
|
Enable/disable appending permit-agent-forwarding certificate extension. Choices:
|
|
Enable/disable appending permit-port-forwarding certificate extension. Choices:
|
|
Enable/disable appending permit-pty certificate extension. Choices:
|
|
Enable/disable appending permit-user-rc certificate extension. Choices:
|
|
Enable/disable appending permit-x11-forwarding certificate extension. Choices:
|
|
Enable/disable appending source-address certificate critical option. Choices:
|
|
Enable/disable server pool multiplexing. Choices:
|
|
Maximum number of concurrent requests that servers in server pool could handle |
|
Maximum number of requests that servers in server pool handle before disconnecting |
|
Time-to-live in the server pool for idle connections to servers. |
|
Enable/disable to detect device type by HTTP user-agent if no client certificate provided. Choices:
|
|
Virtual IP name. |
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |