:source: fmgd_firewall_accessproxy6.py :orphan: .. _fmgd_firewall_accessproxy6: fmgd_firewall_accessproxy6 -- Configure IPv6 access proxy. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.1.0 .. contents:: :local: :depth: 1 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 v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 FortiManager Version Compatibility ---------------------------------- .. raw:: html

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters ---------- .. raw:: html 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 -------- .. code-block:: yaml+jinja - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi gather_facts: false vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure IPv6 access proxy. fortinet.fmgdevice.fmgd_firewall_accessproxy6: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: state: present # firewall_accessproxy6: name: "your value" # Required variable, string # vip: # decrypted_traffic_mirror: # empty_cert_action: # svr_pool_server_max_request: # svr_pool_ttl: # user_agent_detect: # api_gateway: # - application: # h2_support: # h3_support: # http_cookie_age: # http_cookie_domain: # http_cookie_domain_from_host: # http_cookie_generation: # http_cookie_path: # http_cookie_share: # https_cookie_secure: # id: # ldb_method: # persistence: # quic: # ack_delay_exponent: # active_connection_id_limit: # active_migration: # grease_quic_bit: # max_ack_delay: # max_datagram_frame_size: # max_idle_timeout: # max_udp_payload_size: # realservers: # - addr_type: # address: # domain: # external_auth: # health_check: # health_check_proto: # holddown_interval: # http_host: # id: # ip: # mappedport: # port: # ssh_client_cert: # ssh_host_key: # ssh_host_key_validation: # status: # translate_host: # tunnel_encryption: # type: # verify_cert: # weight: # saml_redirect: # saml_server: # service: # ssl_algorithm: # ssl_cipher_suites: # - cipher: # priority: # versions: # - "tls-1.0" # - "tls-1.1" # - "tls-1.2" # - "tls-1.3" # ssl_dh_bits: # ssl_max_version: # ssl_min_version: # ssl_renegotiation: # ssl_vpn_web_portal: # url_map: # url_map_type: # virtual_host: # client_cert: # svr_pool_multiplex: # auth_virtual_host: # log_blocked_traffic: # add_vhost_domain_to_dnsdb: # auth_portal: # api_gateway6: # - application: # h2_support: # h3_support: # http_cookie_age: # http_cookie_domain: # http_cookie_domain_from_host: # http_cookie_generation: # http_cookie_path: # http_cookie_share: # https_cookie_secure: # id: # ldb_method: # persistence: # quic: # ack_delay_exponent: # active_connection_id_limit: # active_migration: # grease_quic_bit: # max_ack_delay: # max_datagram_frame_size: # max_idle_timeout: # max_udp_payload_size: # realservers: # - addr_type: # address: # domain: # external_auth: # health_check: # health_check_proto: # holddown_interval: # http_host: # id: # ip: # mappedport: # port: # ssh_client_cert: # ssh_host_key: # ssh_host_key_validation: # status: # translate_host: # tunnel_encryption: # type: # verify_cert: # weight: # saml_redirect: # saml_server: # service: # ssl_algorithm: # ssl_cipher_suites: # - cipher: # priority: # versions: # - "tls-1.0" # - "tls-1.1" # - "tls-1.2" # - "tls-1.3" # ssl_dh_bits: # ssl_max_version: # ssl_min_version: # ssl_renegotiation: # ssl_vpn_web_portal: # url_map: # url_map_type: # virtual_host: # svr_pool_server_max_concurrent_request: # http_supported_max_version: 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: .. raw:: html
  • 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 sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
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)