a10_aam_authentication_captcha_instance

Synopsis

CAPTCHA Profile

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

name

str/required

Specify captcha profile name

secret_key

bool

Specify secret key

secret_key_string

str

Secret key string

encrypted

str

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

url

str

Specify verify API URL, default scheme is https

method

str

‘POST’= API uses POST method; ‘GET’= API uses GET method;

timeout

int

Specify timeout for verify API response (Specify timeout value, default is 10 seconds)

secret_key_param_name

str

Specify secret key parameter name used in API (Set parameter name)

token_param_name

str

Specify token parameter name used in API (Set parameter name)

resp_result_field_name

str

Specify result field name used in JSON response (Set field name)

resp_error_code_field_name

str

Specify error code field name used in JSON response (Set field name)

send_client_ip

bool

Send client IP address in API

client_ip_param_name

str

Specify client ip parameter name used in API (Set parameter name)

uuid

str

uuid of the object

stats

dict

Field stats

request

str

Total Request

verify_succ

str

Total Verification Success Response

parse_fail

str

Total JSON Response Parse Failure

json_fail

str

Total Failure JSON Response

attr_fail

str

Total Attibute Check Failure

timeout_error

str

Total Timeout

other_error

str

Total Other Error

name

str

Specify captcha profile name

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