a10_aam_authentication_relay_form_based_instance

Synopsis

Form-based Authentication Relay

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 form-based authentication relay name

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

counters1

str

‘all’= all; ‘request’= Request; ‘invalid_srv_rsp’= Invalid Server Response; ‘post_fail’= POST Failed; ‘invalid_cred’= Invalid Credential; ‘bad_req’= Bad Request; ‘not_fnd’= Not Found; ‘error’= Internal Server Error; ‘other_error’= Other Error;

packet_capture_template

str

Name of the packet capture template to be bind with this object

request_uri_list

list

Field request_uri_list

match_type

str

‘equals’= URI exactly matches the string; ‘contains’= URI string contains another sub string; ‘starts-with’= URI string starts with sub string; ‘ends- with’= URI string ends with sub string;

uri

str

Specify request URI

user_variable

str

Specify username variable name

password_variable

str

Specify password variable name

domain_variable

str

Specify domain variable name

other_variables

str

Specify other variables (n1=v1&n2=v2) in form relay

max_packet_collect_size

int

Specify the max packet collection size in bytes, default is 1MB

cookie

dict

Field cookie

action_uri

str

Specify the action-URI

uuid

str

uuid of the object

user_tag

str

Customized tag

stats

dict

Field stats

request

str

Request

invalid_srv_rsp

str

Invalid Server Response

post_fail

str

POST Failed

invalid_cred

str

Invalid Credential

bad_req

str

Bad Request

not_fnd

str

Not Found

error

str

Internal Server Error

other_error

str

Other Error

name

str

Specify form-based authentication relay 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