fmgr_firewall_accessproxy_apigateway6_realservers – Select the real servers that this Access Proxy will distribute traffic to.¶
New in version 2.10.
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- access-proxy - The parameter in requested url type: str required: true
- api-gateway6 - The parameter in requested url type: str required: true
- firewall_accessproxy_apigateway6_realservers - no description type: dict
- 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...
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: no description
fmgr_firewall_accessproxy_apigateway6_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-gateway6: <your own value>
state: <value in [present, absent]>
firewall_accessproxy_apigateway6_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>
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict