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.8.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 |
|---|---|
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. |
|
Deprecated, please use “api_gateway” |
|
The parameter (api-gateway) 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. |
|
Type of address. Choices:
|
|
Address or address group of the real server. |
|
Wildcard domain name of the real server. |
|
Enable/disable use of external browser as user-agent for SAML user authentication. Choices:
|
|
Enable to check the responsiveness of the real server before forwarding traffic. Choices:
|
|
Protocol of the health check monitor to use when polling to determine servers connectivity status. Choices:
|
|
Enable/disable holddown timer. Choices:
|
|
HTTP server domain name in HTTP header. |
|
Real server ID. |
|
IP address of the real server. |
|
(list or str) Port for communicating with the real server. |
|
Port for communicating with the real server. |
|
Set access-proxy SSH client certificate profile. |
|
(list or str) One or more server host key. |
|
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 is sent. Choices:
|
|
Enable/disable translation of hostname/IP from virtual server to real server. Choices:
|
|
Tunnel encryption. Choices:
|
|
TCP forwarding server type. Choices:
|
|
Weight of the real server. |
|
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: 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 |
|---|---|
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 |