fmgr_firewall_accessproxy6_apigateway_realservers.rst

source

fmgr_firewall_accessproxy6_apigateway_realservers.py

orphan

fmgr_firewall_accessproxy6_apigateway_realservers -- Select the real servers that this Access Proxy will distribute traffic to.

2.2.0

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

• Argument name before 3.0.0: var-name, var name, var.name
• New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.15.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.1 -> latest

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
• access-proxy6 - The parameter in requested url type: str required: true
• api-gateway - The parameter in requested url type: str required: true
• firewall_accessproxy6_apigateway_realservers - Select the real servers that this Access Proxy will distribute traffic to. type: dict
• addr_type (Alias name: addr-type) Type of address. type: str choices: [fqdn, ip] more...

  Supported Version Ranges: v7.2.1 -> latest

• address Address or address group of the real server. type: str more...

  Supported Version Ranges: v7.2.1 -> latest

• domain Wildcard domain name of the real server. type: str more...

  Supported Version Ranges: v7.2.1 -> latest

• health_check (Alias name: health-check) Enable to check the responsiveness of the real server before forwarding traffic. type: str choices: [disable, enable] more...

  Supported Version Ranges: v7.2.1 -> latest

• health_check_proto (Alias name: 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...

  Supported Version Ranges: v7.2.1 -> latest

• holddown_interval (Alias name: holddown-interval) Enable/disable holddown timer. type: str choices: [disable, enable] more...

  Supported Version Ranges: v7.2.1 -> latest

• http_host (Alias name: http-host) Http server domain name in http header. type: str more...

  Supported Version Ranges: v7.2.1 -> latest

• id Real server id. type: int more...

  Supported Version Ranges: v7.2.1 -> latest

• ip Ip address of the real server. type: str more...

  Supported Version Ranges: v7.2.1 -> latest

• mappedport Port for communicating with the real server. type: list or str more...

  Supported Version Ranges: v7.2.1 -> latest

• port Port for communicating with the real server. type: int more...

  Supported Version Ranges: v7.2.1 -> latest

• ssh_client_cert (Alias name: ssh-client-cert) Set access-proxy ssh client certificate profile. type: str more...

  Supported Version Ranges: v7.2.1 -> latest

• ssh_host_key (Alias name: ssh-host-key) type: list more...

  Supported Version Ranges: v7.2.1 -> latest

• ssh_host_key_validation (Alias name: ssh-host-key-validation) Enable/disable ssh real server host key validation. type: str choices: [disable, enable] more...

  Supported Version Ranges: v7.2.1 -> latest

• 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...

  Supported Version Ranges: v7.2.1 -> latest

• type Tcp forwarding server type. type: str choices: [tcp-forwarding, ssh] more...

  Supported Version Ranges: v7.2.1 -> latest

• weight Weight of the real server. type: int more...

  Supported Version Ranges: v7.2.1 -> latest

• translate_host (Alias name: translate-host) Enable/disable translation of hostname/ip from virtual server to real server. type: str choices: [disable, enable] more...

  Supported Version Ranges: v7.2.2 -> latest

• external_auth (Alias name: external-auth) Enable/disable use of external browser as user-agent for saml user authentication. type: str choices: [disable, enable] more...

  Supported Version Ranges: v7.4.0 -> latest

• tunnel_encryption (Alias name: tunnel-encryption) Tunnel encryption. type: str choices: [disable, enable] more...

  Supported Version Ranges: v7.4.0 -> latest

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

- 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: Select the real servers that this Access Proxy will distribute traffic to.
      fortinet.fortimanager.fmgr_firewall_accessproxy6_apigateway_realservers:
        # 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_proxy6: <your own value>
        api_gateway: <your own value>
        state: present # <value in [present, absent]>
        firewall_accessproxy6_apigateway_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]>

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 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)