fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway6 module – Set IPv6 API Gateway.
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_accessproxy_apigateway6
.
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 |
---|---|
Deprecated, please use “access_proxy” |
|
The parameter (access-proxy) in requested url. |
|
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. |
|
(list) SaaS application controlled by this Access Proxy. |
|
Deprecated, please rename it to h2_support. HTTP2 support, default=Enable. Choices:
|
|
Deprecated, please rename it to h3_support. HTTP3/QUIC support, default=Disable. Choices:
|
|
Deprecated, please rename it to http_cookie_age. Time in minutes that client web browsers should keep a cookie. |
|
Deprecated, please rename it to http_cookie_domain. Domain that HTTP cookie persistence should apply to. |
|
Deprecated, please rename it to http_cookie_domain_from_host. Enable/disable use of HTTP cookie domain from host field in … Choices:
|
|
Deprecated, please rename it to http_cookie_generation. Generation of HTTP cookie to be accepted. |
|
Deprecated, please rename it to http_cookie_path. Limit HTTP cookie persistence to the specified path. |
|
Deprecated, please rename it to http_cookie_share. Control sharing of cookies across API Gateway. Choices:
|
|
Deprecated, please rename it to https_cookie_secure. Enable/disable verification that inserted HTTPS cookies are secure. Choices:
|
|
API Gateway ID. |
|
Deprecated, please rename it to ldb_method. 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 the same… Choices:
|
|
Quic. |
|
Deprecated, please rename it to ack_delay_exponent. ACK delay exponent |
|
Deprecated, please rename it to active_connection_id_limit. Active connection ID limit |
|
Deprecated, please rename it to active_migration. Enable/disable active migration Choices:
|
|
Deprecated, please rename it to grease_quic_bit. Enable/disable grease QUIC bit Choices:
|
|
Deprecated, please rename it to max_ack_delay. Maximum ACK delay in milliseconds |
|
Deprecated, please rename it to max_datagram_frame_size. Maximum datagram frame size in bytes |
|
Deprecated, please rename it to max_idle_timeout. Maximum idle timeout milliseconds |
|
Deprecated, please rename it to max_udp_payload_size. Maximum UDP payload size in bytes |
|
Realservers. |
|
Deprecated, please rename it to addr_type. Type of address. Choices:
|
|
Address or address group of the real server. |
|
Wildcard domain name of the real server. |
|
Deprecated, please rename it to external_auth. Enable/disable use of external browser as user-agent for SAML user … Choices:
|
|
Deprecated, please rename it to health_check. Enable to check the responsiveness of the real server before forward… Choices:
|
|
Deprecated, please rename it to health_check_proto. Protocol of the health check monitor to use when polling to de… Choices:
|
|
Deprecated, please rename it to holddown_interval. Enable/disable holddown timer. Choices:
|
|
Deprecated, please rename it to http_host. 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. |
|
Deprecated, please rename it to ssh_client_cert. Set access-proxy SSH client certificate profile. |
|
(list or str) Deprecated, please rename it to ssh_host_key. One or more server host key. |
|
Deprecated, please rename it to ssh_host_key_validation. 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 traffic… Choices:
|
|
Deprecated, please rename it to translate_host. Enable/disable translation of hostname/IP from virtual server to r… Choices:
|
|
Deprecated, please rename it to tunnel_encryption. Tunnel encryption. Choices:
|
|
TCP forwarding server type. Choices:
|
|
Weight of the real server. |
|
Deprecated, please rename it to saml_redirect. Enable/disable SAML redirection after successful authentication. Choices:
|
|
Deprecated, please rename it to saml_server. SAML service provider configuration for VIP authentication. |
|
Service. Choices:
|
|
Deprecated, please rename it to ssl_algorithm. Permitted encryption algorithms for the server side of SSL full mode sessio… Choices:
|
|
Deprecated, please rename it to ssl_cipher_suites. Ssl cipher suites. |
|
Cipher suite name. Choices:
|
|
SSL/TLS cipher suites priority. |
|
SSL/TLS versions that the cipher suite can be used with. Choices:
|
|
Deprecated, please rename it to ssl_dh_bits. Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SS… Choices:
|
|
Deprecated, please rename it to ssl_max_version. Highest SSL/TLS version acceptable from a server. Choices:
|
|
Deprecated, please rename it to ssl_min_version. Lowest SSL/TLS version acceptable from a server. Choices:
|
|
Deprecated, please rename it to ssl_renegotiation. Enable/disable secure renegotiation to comply with RFC 5746. Choices:
|
|
Deprecated, please rename it to ssl_vpn_web_portal. SSL-VPN web portal. |
|
Deprecated, please rename it to url_map. URL pattern to match. |
|
Deprecated, please rename it to url_map_type. Type of url-map. Choices:
|
|
Deprecated, please rename it to virtual_host. Virtual host. |
|
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: Set IPv6 API Gateway.
fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway6:
# 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>
access_proxy: <your own value>
state: present # <value in [present, absent]>
firewall_accessproxy_apigateway6:
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>
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 |