fmgr_webproxy_profile – Configure web proxy profiles.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
webproxy_profile yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • webproxy_profile - no description type: dict
    • 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...
    • 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...
    • 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...
    • 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...
    • 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...
    • 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...
    • 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...
    • headers - Headers. type: array more...
      • action - Action when HTTP the header forwarded. type: str choices: [add-to-request, add-to-response, remove-from-request, remove-from-response] more...
      • content - HTTP headers content. type: str more...
      • id - HTTP forwarded header id. type: int more...
      • name - HTTP forwarded header name. type: str more...
      • 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...
      • base64-encoding - Enable/disable use of base64 encoding of HTTP content. type: str choices: [disable, enable] more...
      • dstaddr - Destination address and address group names. type: str more...
      • dstaddr6 - Destination address and address group names (IPv6). type: str more...
      • protocol - Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). type: array choices: [https, http] more...
    • log-header-change - Enable/disable logging HTTP header changes. type: str choices: [disable, enable] more...
    • name - Profile name. type: str more...
    • strip-encoding - Enable/disable stripping unsupported encoding from the request header. type: str choices: [disable, enable] more...
    • 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...

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: no description
     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>
                 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
           log-header-change: <value in [disable, enable]>
           name: <value of string>
           strip-encoding: <value in [disable, enable]>
           header-x-forwarded-client-cert: <value in [pass, add, remove]>

Return Values

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:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.