source: | fortios_web_proxy_profile.py |
---|---|
orphan: |
.. versionadded:: 2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_web_proxy_profile | v6.0.0 -> latest |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- web_proxy_profile - Configure web proxy profiles. type: dict
more...
Supported Version Ranges web_proxy_profile v6.0.0 -> latest
- header_client_ip - Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. type: str choices: pass, add, remove
more...
Supported Version Ranges header_client_ip v6.0.0 -> latest
[pass] v6.0.0 -> latest
[add] v6.0.0 -> latest
[remove] v6.0.0 -> latest
- 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. type: str choices: pass, add, remove
more...
Supported Version Ranges header_front_end_https v6.0.0 -> latest
[pass] v6.0.0 -> latest
[add] v6.0.0 -> latest
[remove] v6.0.0 -> latest
- header_via_request - Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. type: str choices: pass, add, remove
more...
Supported Version Ranges header_via_request v6.0.0 -> latest
[pass] v6.0.0 -> latest
[add] v6.0.0 -> latest
[remove] v6.0.0 -> latest
- header_via_response - Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. type: str choices: pass, add, remove
more...
Supported Version Ranges header_via_response v6.0.0 -> latest
[pass] v6.0.0 -> latest
[add] v6.0.0 -> latest
[remove] v6.0.0 -> latest
- 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. type: str choices: pass, add, remove
more...
Supported Version Ranges header_x_authenticated_groups v6.0.0 -> latest
[pass] v6.0.0 -> latest
[add] v6.0.0 -> latest
[remove] v6.0.0 -> latest
- 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. type: str choices: pass, add, remove
more...
Supported Version Ranges header_x_authenticated_user v6.0.0 -> latest
[pass] v6.0.0 -> latest
[add] v6.0.0 -> latest
[remove] v6.0.0 -> latest
- header_x_forwarded_client_cert - Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. type: str choices: pass, add, remove
more...
Supported Version Ranges header_x_forwarded_client_cert v7.0.1 -> latest
[pass] v6.0.0 -> latest
[add] v6.0.0 -> latest
[remove] v6.0.0 -> latest
- 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. type: str choices: pass, add, remove
more...
Supported Version Ranges header_x_forwarded_for v6.0.0 -> latest
[pass] v6.0.0 -> latest
[add] v6.0.0 -> latest
[remove] v6.0.0 -> latest
- headers - Configure HTTP forwarded requests headers. type: list member_path: headers:id
more...
Supported Version Ranges headers v6.0.0 -> latest
- action - Configure adding, removing, or logging of the HTTP header entry in HTTP requests and responses. type: str choices: add-to-request, add-to-response, remove-from-request, remove-from-response, monitor-request, monitor-response
more...
Supported Version Ranges action v6.0.0 -> latest
[add-to-request] v6.0.0 -> latest
[add-to-response] v6.0.0 -> latest
[remove-from-request] v6.0.0 -> latest
[remove-from-response] v6.0.0 -> latest
[monitor-request] v7.4.0 -> latest
[monitor-response] v7.4.0 -> latest
- add_option - Configure options to append content to existing HTTP header or add new HTTP header. type: str choices: append, new-on-not-found, new
more...
Supported Version Ranges add_option v6.2.0 -> latest
[append] v6.0.0 -> latest
[new-on-not-found] v6.0.0 -> latest
[new] v6.0.0 -> latest
- base64_encoding - Enable/disable use of base64 encoding of HTTP content. type: str choices: disable, enable
more...
Supported Version Ranges base64_encoding v6.2.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- content - HTTP header content. type: str
more...
Supported Version Ranges content v6.0.0 -> latest
- dstaddr - Destination address and address group names. type: list member_path: headers:id/dstaddr:name
more...
Supported Version Ranges dstaddr v6.2.0 -> latest
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true
more...
Supported Version Ranges name v6.2.0 -> latest
- dstaddr6 - Destination address and address group names (IPv6). type: list member_path: headers:id/dstaddr6:name
more...
Supported Version Ranges dstaddr6 v6.2.0 -> latest
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true
more...
Supported Version Ranges name v6.2.0 -> latest
- id - HTTP forwarded header id. see Notes. type: int required: true
more...
Supported Version Ranges id v6.0.0 -> latest
- name - HTTP forwarded header name. type: str
more...
Supported Version Ranges name v6.0.0 -> latest
- protocol - Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). type: list choices: https, http
more...
Supported Version Ranges protocol v6.2.0 -> latest
[https] v6.0.0 -> latest
[http] v6.0.0 -> latest
- log_header_change - Enable/disable logging HTTP header changes. type: str choices: enable, disable
more...
Supported Version Ranges log_header_change v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- name - Profile name. type: str required: true
more...
Supported Version Ranges name v6.0.0 -> latest
- strip_encoding - Enable/disable stripping unsupported encoding from the request header. type: str choices: enable, disable
more...
Supported Version Ranges strip_encoding v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure web proxy profiles.
fortinet.fortios.fortios_web_proxy_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
web_proxy_profile:
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_client_cert: "pass"
header_x_forwarded_for: "pass"
headers:
-
action: "add-to-request"
add_option: "append"
base64_encoding: "disable"
content: "<your_own_value>"
dstaddr:
-
name: "default_name_17 (source firewall.address.name firewall.addrgrp.name)"
dstaddr6:
-
name: "default_name_19 (source firewall.address6.name firewall.addrgrp6.name)"
id: "20"
name: "default_name_21"
protocol: "https"
log_header_change: "enable"
name: "default_name_24"
strip_encoding: "enable"
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
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.