cisco.mso.mso_user module – Manage users
Note
This module is part of the cisco.mso collection (version 2.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.mso
.
You need further requirements to be able to use this module,
see Requirements for details.
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 |
Comments |
---|---|
The status of the user account. Choices:
|
|
The domain this user belongs to. When creating new users, this defaults to |
|
The email address of the user. This parameter is required when creating new users. |
|
The first name of the user. This parameter is required when creating new users. |
|
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 |
|
The last name of the user. This parameter is required when creating new users. |
|
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 |
|
Influence the output of this MSO module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
The password to use for authentication. If the value is not specified in the task, the value of environment variables |
|
The phone number of the user. This parameter is required when creating new users. |
|
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 |
|
The roles for this user and their access types (read or write). Access type defaults to |
|
Use Use Choices:
|
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable Default: |
|
If If the value is not specified in the task, the value of environment variable The default is Choices:
|
|
If If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable The default is Choices:
|
|
The name of the user. |
|
The password of the user. |
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default is Choices:
|
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.
This module was written to support 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