fadcos_waf_http_header_security – Configuring an HTTP Header Security policy¶

New in version 1.3.0.

Synopsis
Requirements
FortiADC Version Compatibility
Parameters
Examples
Return Values
Status
Authors

Synopsis ¶

Configuring an HTTP Header Security policy

Requirements ¶

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

ansible>=2.8

FortiADC Version Compatibility ¶

	`v7.1.4`	`v7.2.2`	`v7.4.0`
fadcos_waf_http_header_security	yes	yes	yes

Parameters ¶

action - Type of action to perform on the object. type: str required: true
name - Enter a unique HTTP Header Security policy name. Valid characters are A-Z, a-z, 0-9, _, and -. No space is allowed. type: str required: true
mode - Specify header operation mode for the response from the back-end server(s).type: str required: false
request_status - Enable/disable request URL match. This is disabled by default.type: int required: false
request_url - The Request URL option is available if Request Status is enabled. Specify the URL used to match requests so that security headers can be applied to responses of the matched requests.type: int required: false
vdom - VDOM name if enabled.type: str required: true(if VDOM is enabled)

Examples ¶

- name:
  hosts: all
  vars:
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Add WAF http_header_security
      fadcos_waf_http_header_security:
        action: add
        name: hts1
        mode: add-always
        request_status: enable
        request_url: /test/hhs1

    - name: Add duplicate WAF http_header_security
      fadcos_waf_http_header_security:
        action: add
        name: hts2

    - name: edit WAF http_header_security
      fadcos_waf_http_header_security:
        action: edit
        name: hts1
        mode: add-replace
        request_status: enable
        request_url: /test/adac1

    - name: get WAF http_header_security
      fadcos_waf_http_header_security:
        action: get
        name: hts1

    - name: delete WAF http_header_security
      fadcos_waf_http_header_security:
        action: delete
        name: hts2

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:

200 - OK: Request returns successful.
400 - Bad Request: Request cannot be processed by the API.
401 - Not Authorized: Request without successful login session.
403 - Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
404 - Resource Not Found: Unable to find the specified resource.
405 - Method Not Allowed: Specified HTTP method is not allowed for this resource.
413 - Request Entity Too Large: Request cannot be processed due to large entity.
424 - Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, or invalid attribute value.
429 - Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
500 - Internal Server Error: Internal error when processing the request.

For errorcode please check FortiADC API errorcode at : https://fndn.fortinet.net/index.php?/fortiapi/981-fortiadc/

Status ¶

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

Authors ¶

Joseph Chen

Hint

If you notice any issues in this documentation, you can create a pull request to improve it at: https://github.com/fortinet-ansible-dev/ansible-galaxy-fortiadc-sphinxdoc/pulls