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_profile_headers
.
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 | |
profile string / required | the parameter (profile) in requested url | ||
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_profile_headers dictionary | the top level parameters set | ||
action string |
| Action when HTTP the header forwarded. | |
add-option string |
| Configure options to append content to existing HTTP header or add new HTTP header. | |
base64-encoding string |
| Enable/disable use of base64 encoding of HTTP content. | |
content string | HTTP headers content. | ||
dstaddr string | Destination address and address group names. | ||
dstaddr6 string | Destination address and address group names (IPv6). | ||
id integer | HTTP forwarded header id. | ||
name string | HTTP forwarded header name. | ||
protocol list / elements=string |
| no description | |
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 HTTP forwarded requests headers. fmgr_webproxy_profile_headers: 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> profile: <your own value> state: <value in [present, absent]> webproxy_profile_headers: action: <value in [add-to-request, add-to-response, remove-from-request, ...]> content: <value of string> id: <value of integer> name: <value of string> add-option: <value in [append, new-on-not-found, new]> base64-encoding: <value in [disable, enable]> dstaddr: <value of string> dstaddr6: <value of string> protocol: - https - http
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_profile_headers_module.html