a10_ddos_notification_template_api

Synopsis

Violation action notification api configuration

Parameters

Parameters

Choices/Defaults

Comment

state

str/required

[‘noop’, ‘present’, ‘absent’]

State of the object to be created.

ansible_host

str/required

Host for AXAPI authentication

ansible_username

str/required

Username for AXAPI authentication

ansible_password

str/required

Password for AXAPI authentication

ansible_port

int/required

Port for AXAPI authentication

a10_device_context_id

int

[‘1-8’]

Device ID for aVCS configuration

a10_partition

str

Destination/target partition for object/command

notification_template_name

str/required

Key to identify parent object

host_ipv4_address

str

Configure the host IPv4 address to send notification (IPv4 address of the host)

host_ipv6_address

str

Configure the host IPv6 address to send notification (IPv6 address of the host)

hostname

str

host name(e.g www.a10networks.com)

http_protocol

str

‘http’= Use http protocol; ‘https’= Use https protocol(default); (http protocol)

http_port

int

Configure the http port to use(default 80) (http port(default 80))

https_port

int

Configure the https port to use(default 443) (https port(default 443))

timeout

int

Configure the api execution timeout(default 10secs) (api timeout)

relative_uri

str

Configure the relative uri for the api(e.g /example , default /) (api relative uri)

disable_authentication

bool

Disable authentication to communicate to the host

use_mgmt_port

bool

Use management port to send out notification

uuid

str

uuid of the object

authentication

dict

Field authentication

relative_login_uri

str

Configure the authentication login uri

relative_logoff_uri

str

Configure the authentication logoff uri

auth_username

str

Configure the authentication user name

auth_password

bool

Configure the authentication user password (Authentication password)

auth_password_val

str

Configure the authentication user password (Authentication password)

encrypted

str

Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

api_key

bool

Configure api-key as a mode of authentication

api_key_string

str

Configure api-key as a mode of authentication

api_key_encrypted

str

Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

uuid

str

uuid of the object

Examples


Return Values

modified_values (changed, dict, )

Values modified (or potential changes if using check_mode) as a result of task operation

axapi_calls (always, list, )

Sequential list of AXAPI calls made by the task

endpoint (, str, [‘/axapi/v3/slb/virtual_server’, ‘/axapi/v3/file/ssl-cert’])

The AXAPI endpoint being accessed.

http_method (, str, [‘POST’, ‘GET’])

HTTP method being used by the primary task to interact with the AXAPI endpoint.

request_body (, complex, )

Params used to query the AXAPI

response_body (, complex, )

Response from the AXAPI

Status

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

  • This module is maintained by community.

Authors

  • A10 Networks