Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
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.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_webproxy_forwardserver.
New in version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | ||
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
| enable_log boolean |
| Enable/Disable logging for task | |
| proposed_method string |
| The overridden method for the underlying Json RPC request | |
| rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | ||
| rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | ||
| state string / required |
| the directive to create, update or delete an object | |
| webproxy_forwardserver dictionary | the top level parameters set | ||
| 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 ve... | |
| ip string | Forward proxy server IP address. | ||
| monitor string | URL for forward server health check monitoring (default = http://www.google.com). | ||
| name string | Server name. | ||
| password string | no description | ||
| port integer | Port number that the forwarding server expects to receive HTTP sessions on (1 - 65535, default = 3128). | ||
| 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 the... | |
| username string | HTTP authentication user name. | ||
| workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | ||
| workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | |
Note
- 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: Configure forward-server addresses.
fmgr_webproxy_forwardserver:
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>
state: <value in [present, absent]>
webproxy_forwardserver:
addr-type: <value in [fqdn, ip]>
comment: <value of string>
fqdn: <value of string>
healthcheck: <value in [disable, enable]>
ip: <value of string>
monitor: <value of string>
name: <value of string>
port: <value of integer>
server-down-option: <value in [block, pass]>
password: <value of string>
username: <value of string>
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url string | always | The full url requested Sample: /sys/login/user |
| response_code integer | always | The status of api request |
| response_message string | always | The descriptive message of the api response Sample: OK. |
© 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/fortimanager/fmgr_webproxy_forwardserver_module.html