fortinet.fortimanager.fmgr_webproxy_profile – Configure web proxy profiles.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_webproxy_profile.

New in version 2.10: of fortinet.fortimanager

Synopsis

• This module is able to configure a FortiManager device.

• Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter			Choices/Defaults	Comments
adom string / required				the parameter (adom) in requested url
bypass_validation boolean			Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
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			Choices: present absent	the directive to create, update or delete an object
webproxy_profile dictionary				the top level parameters set
	header-client-ip string		Choices: pass add remove	Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
	header-front-end-https string		Choices: pass add remove	Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
	header-via-request string		Choices: pass add remove	Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
	header-via-response string		Choices: pass add remove	Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header.
	header-x-authenticated-groups string		Choices: pass add remove	Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP hea...
	header-x-authenticated-user string		Choices: pass add remove	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 string		Choices: pass add remove	Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header.
	headers list / elements=string			no description
		action string	Choices: add-to-request add-to-response remove-from-request remove-from-response	Action when HTTP the header forwarded.
		content string		HTTP headers content.
		id integer		HTTP forwarded header id.
		name string		HTTP forwarded header name.
	log-header-change string		Choices: disable enable	Enable/disable logging HTTP header changes.
	name string			Profile name.
	strip-encoding string		Choices: disable enable	Enable/disable stripping unsupported encoding from the request header.
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

Notes

Note

• Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

• To create or update an object, use state present directive.

• To delete an object, use state absent directive.

• Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- 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 web proxy profiles.
     fmgr_webproxy_profile:
        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_profile:
           header-client-ip: <value in [pass, add, remove]>
           header-front-end-https: <value in [pass, add, remove]>
           header-via-request: <value in [pass, add, remove]>
           header-via-response: <value in [pass, add, remove]>
           header-x-authenticated-groups: <value in [pass, add, remove]>
           header-x-authenticated-user: <value in [pass, add, remove]>
           header-x-forwarded-for: <value in [pass, add, remove]>
           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>
           log-header-change: <value in [disable, enable]>
           name: <value of string>
           strip-encoding: <value in [disable, enable]>

Return Values

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.

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)