fortios_web_proxy_forward_server – Configure forward-server addresses in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and forward_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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. type: str default: root
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- web_proxy_forward_server - Configure forward-server addresses. type: dict
- addr_type - Address type of the forwarding proxy server: IP or FQDN. type: str choices: ip, fqdn
- comment - Comment. type: str
- fqdn - Forward server Fully Qualified Domain Name (FQDN). type: str
- healthcheck - Enable/disable forward server health checking. Attempts to connect through the remote forwarding server to a destination to verify that the forwarding server is operating normally. type: str choices: disable, enable
- ip - Forward proxy server IP address. type: str
- monitor - URL for forward server health check monitoring . type: str
- name - Server name. type: str required: True
- port - Port number that the forwarding server expects to receive HTTP sessions on (1 - 65535). type: int
- server_down_option - Action to take when the forward server is found to be down: block sessions until the server is back up or pass sessions to their destination. type: str choices: block, pass
Examples¶
- 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 forward-server addresses.
fortios_web_proxy_forward_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
web_proxy_forward_server:
addr_type: "ip"
comment: "Comment."
fqdn: "<your_own_value>"
healthcheck: "disable"
ip: "<your_own_value>"
monitor: "<your_own_value>"
name: "default_name_9"
port: "10"
server_down_option: "block"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3