a10_aam_authentication_portal

Synopsis 

Authentication portal 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
name str/required			‘default-portal’= Default portal configuration;
logo_cfg dict			Field logo_cfg
	logo str		Specify logo image filename
	width int		Specify logo image width (Default= 134)
	height int		Specify logo image height (Default= 71)
uuid str			uuid of the object
user_tag str			Customized tag
logon dict			Field logon
	background dict		Field background
	fail_msg_cfg dict		Field fail_msg_cfg
	action_url str		Specify form action URL in default logon page (Default= /logon.fo)
	username_cfg dict		Field username_cfg
	username_var str		Specify username variable name in default logon page (Default= user)
	password_cfg dict		Field password_cfg
	password_var str		Specify password variable name in default logon page (Default= pwd)
	enable_passcode bool		Enable passcode field in default logon page
	passcode_cfg dict		Field passcode_cfg
	passcode_var str		Specify passcode variable name in default logon page (Default= passcode)
	enable_CAPTCHA bool		Enable CAPTCHA in deafult logon page
	captcha_type str		‘reCAPTCHAv2-checkbox’= Google reCAPTCHAv2 Checkbox; ‘reCAPTCHAv2-invisible’= Google reCAPTCHAv2 Invisible; ‘reCAPTCHAv3’= Google reCAPTCHAv3;
	site_key_string str		Site key string
	encrypted str		Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)
	reCAPTCHA_cfg dict		Field reCAPTCHA_cfg
	submit_text str		Specify submit button text in default logon page (Default= Log In)
	uuid str		uuid of the object
change_password dict			Field change_password
	background dict		Field background
	title_cfg dict		Field title_cfg
	action_url str		Specify form action URL in default change password page (Default= /change.fo)
	username_cfg dict		Field username_cfg
	username_var str		Specify username variable name in default change password page (Default= cp_usr)
	old_pwd_cfg dict		Field old_pwd_cfg
	old_password_var str		Specify old password variable name in default change password page (Default= cp_old_pwd)
	new_pwd_cfg dict		Field new_pwd_cfg
	new_password_var str		Specify new password variable name in default change password page (Default= cp_new_pwd)
	cfm_pwd_cfg dict		Field cfm_pwd_cfg
	confirm_password_var str		Specify confirm password variable name in default change password page (Default= cp_cfm_pwd)
	submit_text str		Specify submit button text in default change password page (Default= Submit)
	reset_text str		Specify reset button text in default change password page (Default= Reset)
	uuid str		uuid of the object
notify_change_password dict			Field notify_change_password
	background dict		Field background
	continue_url str		Specify continue action URL in default change password notification page (Default= /continue.fo)
	change_url str		Specify change password action URL in default change password notification page (Default= /notify_change.fo)
	username_cfg dict		Field username_cfg
	username_var str		Specify username variable name in default change password notification page (Default= cp_usr)
	old_pwd_cfg dict		Field old_pwd_cfg
	old_password_var str		Specify old password variable name in default change password notification page (Default= cp_old_pwd)
	new_pwd_cfg dict		Field new_pwd_cfg
	new_password_var str		Specify new password variable name in default change password notification page (Default= cp_new_pwd)
	cfm_pwd_cfg dict		Field cfm_pwd_cfg
	confirm_password_var str		Specify confirm password variable name in default change password notification page (Default= cp_cfm_pwd)
	change_text str		Specify change button text in default change password notification page (Default= Change)
	continue_text str		Specify continue button text in default change password notification page (Default= Continue)
	uuid str		uuid of the object
logon_fail dict			Field logon_fail
	background dict		Field background
	title_cfg dict		Field title_cfg
	fail_msg_cfg dict		Field fail_msg_cfg
	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