Skip to content

Latest commit

 

History

History
421 lines (401 loc) · 17.2 KB

avi_useraccountprofile.rst

File metadata and controls

421 lines (401 loc) · 17.2 KB

vmware.alb.avi_useraccountprofile

Module for setup of UserAccountProfile Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
account_lock_timeout
int
- Lock timeout period (in minutes).
- Default is 30 minutes.
- Unit is min.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 30.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
credentials_timeout_threshold
int
- The time period after which credentials expire.
- Default is 180 days.
- Unit is days.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 180.
login_failure_count_expiry_window
int
- The configurable time window beyond which we need to pop all the login failure timestamps from the login_failure_timestamps.
- Special values are 0 - do not reset login_failure_counts on the basis of time.
- Field introduced in 22.1.1.
- Unit is min.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.
max_concurrent_sessions
int
- Maximum number of concurrent sessions allowed.
- There are unlimited sessions by default.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.
max_login_failure_count
int
- Number of login attempts before lockout.
- Default is 3 attempts.
- Allowed values are 3-20.
- Special values are 0- unlimited login attempts allowed.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 3.
max_password_history_count
int
- Maximum number of passwords to be maintained in the password history.
- Default is 4 passwords.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 4.
name
str
required: true
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create UserAccountProfile object
      avi_useraccountprofile:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_useraccountprofile

Authors