Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_web_proxy_forward_server_group
.
New in version 2.10: of fortinet.fortios
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
enable_log boolean |
| Enable/Disable logging for task. | ||
state string / required |
| Indicates whether to create or remove the object. | ||
vdom string | Default: "root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. | ||
web_proxy_forward_server_group dictionary | Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing. | |||
affinity string |
| Enable/disable affinity, attaching a source-ip"s traffic to the assigned forwarding server until the forward-server-affinity-timeout is reached (under web-proxy global). | ||
group_down_option string |
| Action to take when all of the servers in the forward server group are down: block sessions until at least one server is back up or pass sessions to their destination. | ||
ldb_method string |
| Load balance method: weighted or least-session. | ||
name string / required | Configure a forward server group consisting one or multiple forward servers. Supports failover and load balancing. | |||
server_list list / elements=string | Add web forward servers to a list to form a server group. Optionally assign weights to each server. | |||
name string / required | Forward server name. Source web-proxy.forward-server.name. | |||
weight integer | Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100) |
Note
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing. fortios_web_proxy_forward_server_group: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" web_proxy_forward_server_group: affinity: "enable" group_down_option: "block" ldb_method: "weighted" name: "default_name_6" server_list: - name: "default_name_8 (source web-proxy.forward-server.name)" weight: "9"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_web_proxy_forward_server_group_module.html