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.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
host string | FortiOS or FortiGate IP address. | ||
https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | |
password string | Default: "" | FortiOS or FortiGate password. | |
ssl_verify boolean |
| Ensures FortiGate certificate must be verified by a proper CA. | |
state string / required |
| Indicates whether to create or remove the object. | |
username string | FortiOS or FortiGate username. | ||
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 dictionary | Default: null | Configure forward-server addresses. | |
addr_type string |
| Address type of the forwarding proxy server: IP or FQDN. | |
comment string | Comment. | ||
fqdn string | Forward server Fully Qualified Domain Name (FQDN). | ||
healthcheck string |
| 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. | |
ip string | Forward proxy server IP address. | ||
monitor string | URL for forward server health check monitoring . | ||
name string / required | Server name. | ||
port integer | Port number that the forwarding server expects to receive HTTP sessions on (1 - 65535). | ||
server_down_option string |
| 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. |
Notes
Note
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure forward-server addresses. fortios_web_proxy_forward_server: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" 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 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 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_web_proxy_forward_server_module.html