Documentation

avi_useraccountprofile - Module for setup of UserAccountProfile Avi RESTful Object

New in version 2.4.

Synopsis

Options

parameter required default choices comments
account_lock_timeout
no
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.
api_version
no
Avi API version of to use for Avi API and objects.
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
credentials_timeout_threshold
no
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.
max_concurrent_sessions
no
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
no
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
no
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
yes
Name of the object.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
state
no present
  • absent
  • present
The state that should be applied on the entity.
tenant
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Unique object identifier of the object.

Examples

- name: Example to create UserAccountProfile object
  avi_useraccountprofile:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_useraccountprofile

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj UserAccountProfile (api/useraccountprofile) object success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.