Parameter |
Choices/Defaults |
Comments |
account_lock_timeout
|
|
Lock timeout period (in minutes).
Default is 30 minutes.
Default value when not specified in API or module is interpreted by Avi Controller as 30.
Units(MIN).
|
api_context
(added in 2.5) |
|
Avi API context that includes current session ID and CSRF Token.
This allows user to perform single login and re-use the session.
|
api_version
|
Default:
16.4.4
|
Avi API version of to use for Avi API and objects.
|
avi_api_patch_op
(added in 2.5) |
Choices:
- add
- replace
- delete
|
Patch operation to use when using avi_api_update_method as patch.
|
avi_api_update_method
(added in 2.5) |
|
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
|
avi_credentials
(added in 2.5) |
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
|
controller
|
Default:
|
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER .
|
credentials_timeout_threshold
|
|
The time period after which credentials expire.
Default is 180 days.
Default value when not specified in API or module is interpreted by Avi Controller as 180.
Units(DAYS).
|
max_concurrent_sessions
|
|
Maximum number of concurrent sessions allowed.
There are unlimited sessions by default.
Default value when not specified in API or module is interpreted by Avi Controller as 0.
|
max_login_failure_count
|
|
Number of login attempts before lockout.
Default is 3 attempts.
Default value when not specified in API or module is interpreted by Avi Controller as 3.
|
max_password_history_count
|
|
Maximum number of passwords to be maintained in the password history.
Default is 4 passwords.
Default value when not specified in API or module is interpreted by Avi Controller as 4.
|
name
required |
|
Name of the object.
|
password
|
Default:
|
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD .
|
state
|
Choices:
- absent
present ←
|
The state that should be applied on the entity.
|
tenant
|
Default:
admin
|
Name of tenant used for all Avi API calls and context of object.
|
tenant_uuid
|
Default:
|
UUID of tenant used for all Avi API calls and context of object.
|
url
|
|
Avi controller URL of the object.
|
username
|
Default:
|
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME .
|
uuid
|
|
Unique object identifier of the object.
|