fmgr_firewall_accessproxy6 – Configure IPv6 access proxy.

New in version 2.2.0.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.
  • Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
False
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11
False False False False False False False False False False False
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12
False False False False False False False False False False False False False
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8
False False False False False False False False False
7.2.0 7.2.1 7.2.2 7.2.3
False True True True
7.4.0
True

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • firewall_accessproxy6 - Configure IPv6 access proxy. type: dict
    • add-vhost-domain-to-dnsdb - Enable/disable adding vhost/domain to dnsdb for ztna dox tunnel. type: str choices: [disable, enable] more...
    • api-gateway - No description for the parameter type: array more...
      • application - No description for the parameter type: str more...
      • http-cookie-age - Time in minutes that client web browsers should keep a cookie. type: int more...
      • http-cookie-domain - Domain that HTTP cookie persistence should apply to. type: str more...
      • http-cookie-domain-from-host - Enable/disable use of HTTP cookie domain from host field in HTTP. type: str choices: [disable, enable] more...
      • http-cookie-generation - Generation of HTTP cookie to be accepted. type: int more...
      • http-cookie-path - Limit HTTP cookie persistence to the specified path. type: str more...
      • http-cookie-share - Control sharing of cookies across API Gateway. type: str choices: [disable, same-ip] more...
      • https-cookie-secure - Enable/disable verification that inserted HTTPS cookies are secure. type: str choices: [disable, enable] more...
      • id - API Gateway ID. type: int more...
      • ldb-method - Method used to distribute sessions to real servers. type: str choices: [static, round-robin, weighted, first-alive, http-host] more...
      • persistence - Configure how to make sure that clients connect to the same server every time they make a request that is part of the same session. type: str choices: [none, http-cookie] more...
      • realservers - No description for the parameter type: array more...
        • addr-type - Type of address. type: str choices: [fqdn, ip] more...
        • address - Address or address group of the real server. type: str more...
        • domain - Wildcard domain name of the real server. type: str more...
        • health-check - Enable to check the responsiveness of the real server before forwarding traffic. type: str choices: [disable, enable] more...
        • health-check-proto - Protocol of the health check monitor to use when polling to determine servers connectivity status. type: str choices: [ping, http, tcp-connect] more...
        • holddown-interval - Enable/disable holddown timer. type: str choices: [disable, enable] more...
        • http-host - HTTP server domain name in HTTP header. type: str more...
        • id - Real server ID. type: int more...
        • ip - IP address of the real server. type: str more...
        • mappedport - Port for communicating with the real server. type: str more...
        • port - Port for communicating with the real server. type: int more...
        • ssh-client-cert - Set access-proxy SSH client certificate profile. type: str more...
        • ssh-host-key - No description for the parameter type: str more...
        • ssh-host-key-validation - Enable/disable SSH real server host key validation. type: str choices: [disable, enable] more...
        • status - Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is sent. type: str choices: [active, standby, disable] more...
        • type - TCP forwarding server type. type: str choices: [tcp-forwarding, ssh] more...
        • weight - Weight of the real server. type: int more...
        • translate-host - Enable/disable translation of hostname/IP from virtual server to real server. type: str choices: [disable, enable] more...
        • external-auth - Enable/disable use of external browser as user-agent for SAML user authentication. type: str choices: [disable, enable] more...
        • tunnel-encryption - Tunnel encryption. type: str choices: [disable, enable] more...
      • saml-redirect - Enable/disable SAML redirection after successful authentication. type: str choices: [disable, enable] more...
      • saml-server - SAML service provider configuration for VIP authentication. type: str more...
      • service - Service. type: str choices: [http, https, tcp-forwarding, samlsp, web-portal, saas] more...
      • ssl-algorithm - Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. type: str choices: [high, medium, low] more...
      • ssl-cipher-suites - No description for the parameter type: array more...
        • cipher - Cipher suite name. type: str 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] more...
        • priority - SSL/TLS cipher suites priority. type: int more...
        • versions - No description for the parameter type: array choices: [tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
      • ssl-dh-bits - Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. type: str choices: [768, 1024, 1536, 2048, 3072, 4096] more...
      • ssl-max-version - Highest SSL/TLS version acceptable from a server. type: str choices: [tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
      • ssl-min-version - Lowest SSL/TLS version acceptable from a server. type: str choices: [tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
      • ssl-vpn-web-portal - SSL-VPN web portal. type: str more...
      • url-map - URL pattern to match. type: str more...
      • url-map-type - Type of url-map. type: str choices: [sub-string, wildcard, regex] more...
      • virtual-host - Virtual host. type: str more...
      • ssl-renegotiation - Enable/disable secure renegotiation to comply with RFC 5746. type: str choices: [disable, enable] more...
    • api-gateway6 - No description for the parameter type: array more...
      • application - No description for the parameter type: str more...
      • http-cookie-age - Time in minutes that client web browsers should keep a cookie. type: int more...
      • http-cookie-domain - Domain that HTTP cookie persistence should apply to. type: str more...
      • http-cookie-domain-from-host - Enable/disable use of HTTP cookie domain from host field in HTTP. type: str choices: [disable, enable] more...
      • http-cookie-generation - Generation of HTTP cookie to be accepted. type: int more...
      • http-cookie-path - Limit HTTP cookie persistence to the specified path. type: str more...
      • http-cookie-share - Control sharing of cookies across API Gateway. type: str choices: [disable, same-ip] more...
      • https-cookie-secure - Enable/disable verification that inserted HTTPS cookies are secure. type: str choices: [disable, enable] more...
      • id - API Gateway ID. type: int more...
      • ldb-method - Method used to distribute sessions to real servers. type: str choices: [static, round-robin, weighted, first-alive, http-host] more...
      • persistence - Configure how to make sure that clients connect to the same server every time they make a request that is part of the same session. type: str choices: [none, http-cookie] more...
      • realservers - No description for the parameter type: array more...
        • addr-type - Type of address. type: str choices: [fqdn, ip] more...
        • address - Address or address group of the real server. type: str more...
        • domain - Wildcard domain name of the real server. type: str more...
        • health-check - Enable to check the responsiveness of the real server before forwarding traffic. type: str choices: [disable, enable] more...
        • health-check-proto - Protocol of the health check monitor to use when polling to determine servers connectivity status. type: str choices: [ping, http, tcp-connect] more...
        • holddown-interval - Enable/disable holddown timer. type: str choices: [disable, enable] more...
        • http-host - HTTP server domain name in HTTP header. type: str more...
        • id - Real server ID. type: int more...
        • ip - IPv6 address of the real server. type: str more...
        • mappedport - Port for communicating with the real server. type: str more...
        • port - Port for communicating with the real server. type: int more...
        • ssh-client-cert - Set access-proxy SSH client certificate profile. type: str more...
        • ssh-host-key - No description for the parameter type: str more...
        • ssh-host-key-validation - Enable/disable SSH real server host key validation. type: str choices: [disable, enable] more...
        • status - Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is sent. type: str choices: [active, standby, disable] more...
        • type - TCP forwarding server type. type: str choices: [tcp-forwarding, ssh] more...
        • weight - Weight of the real server. type: int more...
        • translate-host - Enable/disable translation of hostname/IP from virtual server to real server. type: str choices: [disable, enable] more...
        • external-auth - Enable/disable use of external browser as user-agent for SAML user authentication. type: str choices: [disable, enable] more...
        • tunnel-encryption - Tunnel encryption. type: str choices: [disable, enable] more...
      • saml-redirect - Enable/disable SAML redirection after successful authentication. type: str choices: [disable, enable] more...
      • saml-server - SAML service provider configuration for VIP authentication. type: str more...
      • service - Service. type: str choices: [http, https, tcp-forwarding, samlsp, web-portal, saas] more...
      • ssl-algorithm - Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. type: str choices: [high, medium, low] more...
      • ssl-cipher-suites - No description for the parameter type: array more...
        • cipher - Cipher suite name. type: str 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] more...
        • priority - SSL/TLS cipher suites priority. type: int more...
        • versions - No description for the parameter type: array choices: [tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
      • ssl-dh-bits - Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. type: str choices: [768, 1024, 1536, 2048, 3072, 4096] more...
      • ssl-max-version - Highest SSL/TLS version acceptable from a server. type: str choices: [tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
      • ssl-min-version - Lowest SSL/TLS version acceptable from a server. type: str choices: [tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
      • ssl-vpn-web-portal - SSL-VPN web portal. type: str more...
      • url-map - URL pattern to match. type: str more...
      • url-map-type - Type of url-map. type: str choices: [sub-string, wildcard, regex] more...
      • virtual-host - Virtual host. type: str more...
      • ssl-renegotiation - Enable/disable secure renegotiation to comply with RFC 5746. type: str choices: [disable, enable] more...
    • auth-portal - Enable/disable authentication portal. type: str choices: [disable, enable] more...
    • auth-virtual-host - Virtual host for authentication portal. type: str more...
    • client-cert - Enable/disable to request client certificate. type: str choices: [disable, enable] more...
    • decrypted-traffic-mirror - Decrypted traffic mirror. type: str more...
    • empty-cert-action - Action of an empty client certificate. type: str choices: [block, accept, accept-unmanageable] more...
    • log-blocked-traffic - Enable/disable logging of blocked traffic. type: str choices: [disable, enable] more...
    • name - Access Proxy name. type: str more...
    • user-agent-detect - Enable/disable to detect device type by HTTP user-agent if no client certificate provided. type: str choices: [disable, enable] more...
    • vip - Virtual IP name. type: str more...
    • http-supported-max-version - Maximum supported HTTP versions. type: str choices: [http1, http2] more...
    • svr-pool-multiplex - Enable/disable server pool multiplexing. type: str choices: [disable, enable] more...
    • svr-pool-server-max-request - Maximum number of requests that servers in server pool handle before disconnecting (default = unlimited). type: int more...
    • svr-pool-ttl - Time-to-live in the server pool for idle connections to servers. type: int more...

Notes

Note

  • 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv6 access proxy.
     fmgr_firewall_accessproxy6:
        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: <value in [present, absent]>
        firewall_accessproxy6:
           add-vhost-domain-to-dnsdb: <value in [disable, enable]>
           api-gateway:
             -
                 application: <value of string>
                 http-cookie-age: <value of integer>
                 http-cookie-domain: <value of string>
                 http-cookie-domain-from-host: <value in [disable, enable]>
                 http-cookie-generation: <value of integer>
                 http-cookie-path: <value of string>
                 http-cookie-share: <value in [disable, same-ip]>
                 https-cookie-secure: <value in [disable, enable]>
                 id: <value of integer>
                 ldb-method: <value in [static, round-robin, weighted, ...]>
                 persistence: <value in [none, http-cookie]>
                 realservers:
                   -
                       addr-type: <value in [fqdn, ip]>
                       address: <value of string>
                       domain: <value of string>
                       health-check: <value in [disable, enable]>
                       health-check-proto: <value in [ping, http, tcp-connect]>
                       holddown-interval: <value in [disable, enable]>
                       http-host: <value of string>
                       id: <value of integer>
                       ip: <value of string>
                       mappedport: <value of string>
                       port: <value of integer>
                       ssh-client-cert: <value of string>
                       ssh-host-key: <value of string>
                       ssh-host-key-validation: <value in [disable, enable]>
                       status: <value in [active, standby, disable]>
                       type: <value in [tcp-forwarding, ssh]>
                       weight: <value of 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: <value of 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: <value of 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: <value of string>
                 url-map: <value of string>
                 url-map-type: <value in [sub-string, wildcard, regex]>
                 virtual-host: <value of string>
                 ssl-renegotiation: <value in [disable, enable]>
           api-gateway6:
             -
                 application: <value of string>
                 http-cookie-age: <value of integer>
                 http-cookie-domain: <value of string>
                 http-cookie-domain-from-host: <value in [disable, enable]>
                 http-cookie-generation: <value of integer>
                 http-cookie-path: <value of string>
                 http-cookie-share: <value in [disable, same-ip]>
                 https-cookie-secure: <value in [disable, enable]>
                 id: <value of integer>
                 ldb-method: <value in [static, round-robin, weighted, ...]>
                 persistence: <value in [none, http-cookie]>
                 realservers:
                   -
                       addr-type: <value in [fqdn, ip]>
                       address: <value of string>
                       domain: <value of string>
                       health-check: <value in [disable, enable]>
                       health-check-proto: <value in [ping, http, tcp-connect]>
                       holddown-interval: <value in [disable, enable]>
                       http-host: <value of string>
                       id: <value of integer>
                       ip: <value of string>
                       mappedport: <value of string>
                       port: <value of integer>
                       ssh-client-cert: <value of string>
                       ssh-host-key: <value of string>
                       ssh-host-key-validation: <value in [disable, enable]>
                       status: <value in [active, standby, disable]>
                       type: <value in [tcp-forwarding, ssh]>
                       weight: <value of 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: <value of 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: <value of 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: <value of string>
                 url-map: <value of string>
                 url-map-type: <value in [sub-string, wildcard, regex]>
                 virtual-host: <value of string>
                 ssl-renegotiation: <value in [disable, enable]>
           auth-portal: <value in [disable, enable]>
           auth-virtual-host: <value of string>
           client-cert: <value in [disable, enable]>
           decrypted-traffic-mirror: <value of string>
           empty-cert-action: <value in [block, accept, accept-unmanageable]>
           log-blocked-traffic: <value in [disable, enable]>
           name: <value of string>
           user-agent-detect: <value in [disable, enable]>
           vip: <value of string>
           http-supported-max-version: <value in [http1, http2]>
           svr-pool-multiplex: <value in [disable, enable]>
           svr-pool-server-max-request: <value of integer>
           svr-pool-ttl: <value of integer>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.