community.network.avi_useraccount – Avi UserAccount Module

From Get docs
Ansible/docs/2.10/collections/community/network/avi useraccount module


community.network.avi_useraccount – Avi UserAccount Module

Note

This plugin is part of the community.network collection (version 1.3.0).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.avi_useraccount.


Synopsis

  • This module can be used for updating the password of a user.
  • This module is useful for setting up admin password for Controller bootstrap.

Requirements

The below requirements are needed on the host that executes this module.

  • avisdk

Parameters

Parameter Choices/Defaults Comments

api_context

dictionary

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

string

Default:

"16.4.4"

Avi API version of to use for Avi API and objects.

avi_credentials

dictionary

Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.

api_version

string

Default:

"16.4.4"

Avi controller version

controller

string

Avi controller IP or SQDN

csrftoken

string

Avi controller API csrftoken to reuse existing session with session id

password

string

Avi controller password

port

string

Avi controller port

session_id

string

Avi controller API session id to reuse existing session with csrftoken

tenant

string

Default:

"admin"

Avi controller tenant

tenant_uuid

string

Avi controller tenant UUID

timeout

string

Default:

300

Avi controller request timeout

token

string

Avi controller API token

username

string

Avi controller username

avi_disable_session_cache_as_fact

boolean

  • no

  • yes

It disables avi session information to be cached as a fact.

controller

string

Default:

""

IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.

force_change

string

Default:

"no"

If specifically set to true then old password is tried first for controller and then the new password is tried. If not specified this flag then the new password is tried first.

old_password

string

Old password for update password or default password for bootstrap.

password

string

Default:

""

Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.

tenant

string

Default:

"admin"

Name of tenant used for all Avi API calls and context of object.

tenant_uuid

string

Default:

""

UUID of tenant used for all Avi API calls and context of object.

username

string

Default:

""

Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.



Notes

Note


Examples

- name: Update user password
  community.network.avi_useraccount:
    controller: ""
    username: ""
    password: new_password
    old_password: ""
    api_version: ""
    force_change: false

- name: Update user password using avi_credentials
  community.network.avi_useraccount:
    avi_credentials: ""
    old_password: ""
    force_change: false

Return Values

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

Key Returned Description

obj

dictionary

success, changed

Avi REST resource





Authors

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/avi_useraccount_module.html