New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
host
-
/ required
|
FortiOS or FortiGate ip address.
|
|||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
||
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
||
username
-
/ required
|
FortiOS or FortiGate username.
|
|||
vdom
-
|
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_profile
-
|
Default: null
|
Configure web proxy profiles.
|
||
header-client-ip
-
|
|
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
|
||
header-front-end-https
-
|
|
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
|
||
header-via-request
-
|
|
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
|
||
header-via-response
-
|
|
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header.
|
||
header-x-authenticated-groups
-
|
|
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
|
||
header-x-authenticated-user
-
|
|
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
|
||
header-x-forwarded-for
-
|
|
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
|
||
headers
-
|
Configure HTTP forwarded requests headers.
|
|||
action
-
|
|
Action when HTTP the header forwarded.
|
||
content
-
|
HTTP header's content.
|
|||
id
-
/ required
|
HTTP forwarded header id.
|
|||
name
-
|
HTTP forwarded header name.
|
|||
log-header-change
-
|
|
Enable/disable logging HTTP header changes.
|
||
name
-
/ required
|
Profile name.
|
|||
state
-
|
|
Indicates whether to create or remove the object
|
||
strip-encoding
-
|
|
Enable/disable stripping unsupported encoding from the request header.
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure web proxy profiles.
fortios_web_proxy_profile:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
web_proxy_profile:
state: "present"
header-client-ip: "pass"
header-front-end-https: "pass"
header-via-request: "pass"
header-via-response: "pass"
header-x-authenticated-groups: "pass"
header-x-authenticated-user: "pass"
header-x-forwarded-for: "pass"
headers:
-
action: "add-to-request"
content: "<your_own_value>"
id: "13"
name: "default_name_14"
log-header-change: "enable"
name: "default_name_16"
strip-encoding: "enable"
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.