fmgd_webproxy_profile – Configure web proxy profiles.

Added in version 1.1.0.

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.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • webproxy_profile - Configure web proxy profiles. type: dict
    • header_client_ip (Alias name: 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 (Alias name: 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 (Alias name: 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 (Alias name: 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 (Alias name: 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 (Alias name: 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_client_cert (Alias name: 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...
    • header_x_forwarded_for (Alias name: 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: list more...
      • 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...
      • add_option (Alias name: 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, replace, replace-when-match] more...
      • base64_encoding (Alias name: base64-encoding) Enable/disable use of base64 encoding of http content. type: str choices: [disable, enable] more...
      • content Http header content. type: str more...
      • dstaddr Destination address and address group names. type: list more...
      • dstaddr6 Destination address and address group names (ipv6). type: list more...
      • id Http forwarded header id. type: int more...
      • name Http forwarded header name. type: str more...
      • protocol Configure protocol(s) to take add-option action on (http, https, or both). type: list choices: [https, http] more...
    • log_header_change (Alias name: log-header-change) Enable/disable logging http header changes. type: str choices: [disable, enable] more...
    • max_cache_object_size (Alias name: max-cache-object-size) Max cache object size. type: int more...
    • name Profile name. type: str more...
    • strip_encoding (Alias name: strip-encoding) Enable/disable stripping unsupported encoding from the request header. type: str choices: [disable, enable] more...
    • header_client_cert (Alias name: header-client-cert) Action to take on the http client-cert/client-cert-chain headers in forwarded responses: 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure web proxy profiles.
      fortinet.fmgdevice.fmgd_webproxy_profile:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        webproxy_profile:
          name: "your value" # Required variable, string
          # 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_client_cert: <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, ...]>
          #     add_option: <value in [append, new-on-not-found, new, ...]>
          #     base64_encoding: <value in [disable, enable]>
          #     content: <string>
          #     dstaddr: <list or string>
          #     dstaddr6: <list or string>
          #     id: <integer>
          #     name: <string>
          #     protocol:
          #       - "https"
          #       - "http"
          # log_header_change: <value in [disable, enable]>
          # max_cache_object_size: <integer>
          # strip_encoding: <value in [disable, enable]>
          # header_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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)