Try SpotterSelect the real servers that this Access Proxy will distribute traffic to.
| "added in version" 2.1.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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]>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
api-gateway:
description: Deprecated, please use "api_gateway"
type: str
api_gateway:
description: The parameter (api-gateway) in requested url.
type: str
access-proxy:
description: Deprecated, please use "access_proxy"
type: str
access_proxy:
description: The parameter (access-proxy) in requested url.
type: str
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
firewall_accessproxy_apigateway_realservers:
description: The top level parameters set.
required: false
suboptions:
addr-type:
choices:
- fqdn
- ip
description: Deprecated, please rename it to addr_type. Type of address.
type: str
address:
description: Address or address group of the real server.
type: str
domain:
description: Wildcard domain name of the real server.
type: str
external-auth:
choices:
- disable
- enable
description: Deprecated, please rename it to external_auth. Enable/disable use
of external browser as user-agent for SAML user authenti...
type: str
health-check:
choices:
- disable
- enable
description: Deprecated, please rename it to health_check. Enable to check the
responsiveness of the real server before forwarding traffic.
type: str
health-check-proto:
choices:
- ping
- http
- tcp-connect
description: Deprecated, please rename it to health_check_proto. Protocol of the
health check monitor to use when polling to determine ...
type: str
holddown-interval:
choices:
- disable
- enable
description: Deprecated, please rename it to holddown_interval. Enable/disable
holddown timer.
type: str
http-host:
description: Deprecated, please rename it to http_host. HTTP server domain name
in HTTP header.
type: str
id:
description: Real server ID.
required: true
type: int
ip:
description: IP address of the real server.
type: str
mappedport:
description: (list or str) Port for communicating with the real server.
type: raw
port:
description: Port for communicating with the real server.
type: int
ssh-client-cert:
description: Deprecated, please rename it to ssh_client_cert. Set access-proxy
SSH client certificate profile.
type: str
ssh-host-key:
description: (list or str) Deprecated, please rename it to ssh_host_key.
type: raw
ssh-host-key-validation:
choices:
- disable
- enable
description: Deprecated, please rename it to ssh_host_key_validation. Enable/disable
SSH real server host key validation.
type: str
status:
choices:
- active
- standby
- disable
description: 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
translate-host:
choices:
- disable
- enable
description: Deprecated, please rename it to translate_host. Enable/disable translation
of hostname/IP from virtual server to real server.
type: str
tunnel-encryption:
choices:
- disable
- enable
description: Deprecated, please rename it to tunnel_encryption. Tunnel encryption.
type: str
type:
choices:
- tcp-forwarding
- ssh
description: TCP forwarding server type.
type: str
weight:
description: Weight of the real server.
type: int
type: dict
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list