a10_aam_authentication_logon_form_based
Synopsis
Form-based Authentication Logon
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 logon name |
||
portal dict |
Field portal |
||
default_portal bool |
Use default portal |
||
portal_name str |
Specify portal name |
||
logon str |
Specify logon page name |
||
failpage str |
Specify logon fail page name (portal fail page name) |
||
changepasswordpage str |
Specify change password page name |
||
notifychangepasswordpage str |
Specify change password notification page name |
||
challenge_page str |
Specify challenge page name for RSA-RADIUS |
||
new_pin_page str |
Specify new PIN page name for RSA-RADIUS |
||
next_token_page str |
Specify next token page name for RSA-RADIUS |
||
logon_page_cfg dict |
Field logon_page_cfg |
||
action_url str |
Specify form submission action url |
||
username_variable str |
Specify username variable name in form submission |
||
password_variable str |
Specify password variable name in form submission |
||
passcode_variable str |
Specify passcode variable name in form submission |
||
captcha_variable str |
Specify captcha variable name in form submission |
||
login_failure_message str |
Specify login failure message shown in logon page (Specify error string, default is ‘Invalid username or password. Please try again.’) |
||
authz_failure_message str |
Specify authorization failure message shown in logon page (Specify error string, default is ‘Authorization failed. Please contact your system administrator.’) |
||
disable_change_password_link bool |
Don’t display change password link on logon page forcibly even backend authentication server supports it (LDAP or Kerberos) |
||
cp_page_cfg dict |
Field cp_page_cfg |
||
changepassword_url str |
Specify changepassword form submission action url (changepassword action url) |
||
cp_user_enum str |
‘changepassword-username-variable’= Specify username variable name in form submission; |
||
cp_user_var str |
Specify username variable name |
||
cp_old_pwd_enum str |
‘changepassword-old-password-variable’= Specify old password variable name in form submission; |
||
cp_old_pwd_var str |
Specify old password variable name |
||
cp_new_pwd_enum str |
‘changepassword-new-password-variable’= Specify new password variable name in form submission; |
||
cp_new_pwd_var str |
Specify new password variable name |
||
cp_cfm_pwd_enum str |
‘changepassword-password-confirm-variable’= Specify password confirm variable name in form submission; |
||
cp_cfm_pwd_var str |
Specify password confirm variable name |
||
notify_cp_page_cfg dict |
Field notify_cp_page_cfg |
||
notifychangepassword_change_url str |
Specify change password action url for notifychangepassword form |
||
notifychangepassword_continue_url str |
Specify continue action url for notifychangepassword form |
||
challenge_variable str |
Specify challenge variable name in form submission |
||
new_pin_variable str |
Specify new-pin variable name in form submission |
||
next_token_variable str |
Specify next-token variable name in form submission |
||
retry int |
Maximum number of consecutive failed logon attempts (default 3) |
||
account_lock bool |
Lock the account when the failed logon attempts is exceeded |
||
duration int |
The time an account remains locked in seconds (default 1800) |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
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.