a10_aam_authentication_relay_saml

Synopsis

SAML 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 SAML authentication relay name
relay_acs_uri str			Specify the backend server assertion consuming service URI
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;
match_uri str			Match URI
server_cookie_name str			Specify the cookie name that used by backend server for authenticated users
idp_auth_uri str			Specify the URI for IDP to handle SAML authentication request
value str			Use the fixed string as the RelayState
method str			‘get-from-backend’= Get RelayState parameter from backend server; ‘request- uri’= Use the (URL encoded) current request-uri as the RelayState;
retry_number int			Specify how many continuous fail for SAML relay will trigger. Default will not retry.
uuid str			uuid of the object
user_tag str			Customized tag
sampling_enable list			Field sampling_enable
	counters1 str		‘all’= all; ‘request’= Request; ‘success’= Success; ‘failure’= Failure; ‘error’= Error;
stats dict			Field stats
	request str		Request
	success str		Success
	failure str		Failure
	error str		Error
	name str		Specify SAML 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