fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway_realservers module – Select the real servers that this Access Proxy will distribute traffic to.

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

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
access-proxy string	Deprecated, please use “access_proxy”
access_proxy string	The parameter (access-proxy) in requested url.
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
api-gateway string	Deprecated, please use “api_gateway”
api_gateway string	The parameter (api-gateway) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
firewall_accessproxy_apigateway_realservers dictionary	The top level parameters set.
addr-type string	Deprecated, please rename it to addr_type. Type of address. Choices: "fqdn" "ip"
address string	Address or address group of the real server.
domain string	Wildcard domain name of the real server.
external-auth string	Deprecated, please rename it to external_auth. Enable/disable use of external browser as user-agent for SAML user authenti… Choices: "disable" "enable"
health-check string	Deprecated, please rename it to health_check. Enable to check the responsiveness of the real server before forwarding traffic. Choices: "disable" "enable"
health-check-proto string	Deprecated, please rename it to health_check_proto. Protocol of the health check monitor to use when polling to determine … Choices: "ping" "http" "tcp-connect"
holddown-interval string	Deprecated, please rename it to holddown_interval. Enable/disable holddown timer. Choices: "disable" "enable"
http-host string	Deprecated, please rename it to http_host. HTTP server domain name in HTTP header.
id integer / required	Real server ID.
ip string	IP address of the real server.
mappedport any	(list or str) Port for communicating with the real server.
port integer	Port for communicating with the real server.
ssh-client-cert string	Deprecated, please rename it to ssh_client_cert. Set access-proxy SSH client certificate profile.
ssh-host-key any	(list or str) Deprecated, please rename it to ssh_host_key. One or more server host key.
ssh-host-key-validation string	Deprecated, please rename it to ssh_host_key_validation. Enable/disable SSH real server host key validation. Choices: "disable" "enable"
status string	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. Choices: "active" "standby" "disable"
translate-host string	Deprecated, please rename it to translate_host. Enable/disable translation of hostname/IP from virtual server to real server. Choices: "disable" "enable"
tunnel-encryption string	Deprecated, please rename it to tunnel_encryption. Tunnel encryption. Choices: "disable" "enable"
type string	TCP forwarding server type. Choices: "tcp-forwarding" "ssh"
weight integer	Weight of the real server.
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: "present" "absent"
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)