fadcos_waf_openapi_validation_detection – Configuring OpenAPI Detection

New in version 1.3.0.

Synopsis

• Configuring OpenAPI Detection

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_openapi_validation_detection	yes	yes	yes

Parameters

• action - Type of action to perform on the object. type: str required: true
• name - Configure the name. Valid characters are A-Z, a-z, 0-9, _, and -. Whitespaces not allowed.type: str required: true
• severity - When FortiADC records violations of this rule in the attack log, each log message contains a Severity Level (severity_level) field. type: str required: false
• security_action - Select the action profile that you want to apply.type: str required: false
• exception_id - Specify the ID of an exception configuration object. type: str required: false
• openapi_format_checks - Enable to use OpenAPI format to validate OpenAPI content. type: str required: false
• openapi_schema_checks - Enable to use OpenAPI schema to validate OpenAPI content. type: str 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_openapi_validation_detection
      fadcos_waf_openapi_validation_detection:
        action: add
        name: test_vd1
        security_action: alert
        exception_id: n1
        openapi_format_checks: enable
        openapi_schema_checks: enable
        severity: low

    - name: edit waf_openapi_validation_detection
      fadcos_waf_openapi_validation_detection:
        action: edit
        name: test_vd1
        security_action: block
        exception_id: n1
        openapi_format_checks: enable
        openapi_schema_checks: enable
        severity: high

    - name: get waf_openapi_validation_detection
      fadcos_waf_openapi_validation_detection:
        action: get
        name: test_vd1

    - name: delete waf_openapi_validation_detection
      fadcos_waf_openapi_validation_detection:
        action: delete
        name: test_vd1

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