cisco.mso.mso_user – Manage users
cisco.mso.mso_user – Manage users
Note
This plugin is part of the cisco.mso collection (version 1.1.0).
To install it use: ansible-galaxy collection install cisco.mso
.
To use it in a playbook, specify: cisco.mso.mso_user
.
Synopsis
- Manage users on Cisco ACI Multi-Site.
Requirements
The below requirements are needed on the host that executes this module.
- Multi Site Orchestrator v2.1 or newer
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
account_status string |
|
The status of the user account. |
domain string |
The domain this user belongs to. When creating new users, this defaults to | |
string |
The email address of the user. This parameter is required when creating new users. | |
first_name string |
The first name of the user. This parameter is required when creating new users. | |
host string / required |
IP Address or hostname of the ACI Multi Site Orchestrator host. If the value is not specified in the task, the value of environment variable
| |
last_name string |
The last name of the user. This parameter is required when creating new users. | |
login_domain string |
The login domain name to use for authentication. The default value is Local. If the value is not specified in the task, the value of environment variable | |
output_level string |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable |
password string / required |
The password to use for authentication. If the value is not specified in the task, the value of environment variables | |
phone string |
The phone number of the user. This parameter is required when creating new users. | |
port integer |
Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable | |
roles list / elements=string |
The roles for this user and their access types (read or write). Access type defaults to | |
state string |
|
Use Use |
timeout integer |
Default: 30 |
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable |
use_proxy boolean |
|
If If the value is not specified in the task, the value of environment variable |
use_ssl boolean |
|
If If the value is not specified in the task, the value of environment variable |
user string |
The name of the user.
| |
user_password string |
The password of the user. | |
username string |
Default: "admin" |
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
validate_certs boolean |
|
If This should only set to If the value is not specified in the task, the value of environment variable |
Notes
Note
- A default installation of ACI Multi-Site ships with admin password ‘we1come!’ which requires a password change on first login. See the examples of how to change the ‘admin’ password using Ansible.
- Please read the Cisco ACI Guide for more detailed information on how to manage your ACI infrastructure using Ansible.
- This module was written to support ACI Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.
Examples
- name: Update initial admin password
cisco.mso.mso_user:
host: mso_host
username: admin
password: initialPassword
validate_certs: false
user: admin
user_password: newPassword
state: present
delegate_to: localhost
- name: Add a new user
cisco.mso.mso_user:
host: mso_host
username: admin
password: SomeSecretPassword
validate_certs: false
user: dag
user_password: userPassword
first_name: Dag
last_name: Wieers
email: [email protected]
phone: +32 478 436 299
roles:
- name: siteManager
access_type: write
- name: schemaManager
access_type: read
state: present
delegate_to: localhost
- name: Add a new user
cisco.mso.mso_user:
host: mso_host
username: admin
password: SomeSecretPassword
validate_certs: false
user: dag
first_name: Dag
last_name: Wieers
email: [email protected]
phone: +32 478 436 299
roles:
- powerUser
delegate_to: localhost
- name: Remove a user
cisco.mso.mso_user:
host: mso_host
username: admin
password: SomeSecretPassword
validate_certs: false
user: dag
state: absent
delegate_to: localhost
- name: Query a user
cisco.mso.mso_user:
host: mso_host
username: admin
password: SomeSecretPassword
validate_certs: false
user: dag
state: query
delegate_to: localhost
register: query_result
- name: Query all users
cisco.mso.mso_user:
host: mso_host
username: admin
password: SomeSecretPassword
validate_certs: false
state: query
delegate_to: localhost
register: query_result
Authors
- Dag Wieers (@dagwieers)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/mso/mso_user_module.html