fadcos_waf_api_gateway_policy – Configuring an API Gateway policy¶

New in version 1.3.0.

Synopsis
Requirements
FortiADC Version Compatibility
Parameters
Examples
Return Values
Status
Authors

Synopsis ¶

Configuring an API Gateway 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_api_gateway_policy	yes	yes	yes

Parameters ¶

action - Type of action to perform on the object. type: str required: true
name - Specify the name of the API gateway policy. type: str required: true
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_api_gateway_policy
      fadcos_waf_api_gateway_policy:
        action: add
        name: test_gp1

    - name: get waf_api_gateway_policy
      fadcos_waf_api_gateway_policy:
        action: get
        name: test_gp1

    - name: delete waf_api_gateway_policy
      fadcos_waf_api_gateway_policy:
        action: delete
        name: test_gp1

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