ansible / ansible.builtin / v2.9.0 / module / mso_user Manage users | "added in version" 2.8 of ansible.builtin" Authors: Dag Wieers (@dagwieers) preview | supported by communityansible.builtin.mso_user (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Manage users on Cisco ACI Multi-Site.
- name: Update initial admin password mso_user: host: mso_host username: admin password: we1come! user_name: admin user_password: SomeSecretPassword state: present delegate_to: localhost
- name: Add a new user mso_user: host: mso_host username: admin password: SomeSecretPassword user_name: dag description: Test user first_name: Dag last_name: Wieers email: dag@wieers.com phone: +32 478 436 299 state: present delegate_to: localhost
- name: Remove a user mso_user: host: mso_host username: admin password: SomeSecretPassword user_name: dag state: absent delegate_to: localhost
- name: Query a user mso_user: host: mso_host username: admin password: SomeSecretPassword user_name: dag state: query delegate_to: localhost register: query_result
- name: Query all users mso_user: host: mso_host username: admin password: SomeSecretPassword state: query delegate_to: localhost register: query_result
host: aliases: - hostname description: - 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 C(MSO_HOST) will be used instead. type: str port: description: - 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 C(MSO_PORT) will be used instead. type: int user: aliases: - name description: - The name of the user. required: true type: str email: description: - The email address of the user. - This parameter is required when creating new users. type: str phone: description: - The phone number of the user. - This parameter is required when creating new users. type: str roles: description: - The roles for this user. type: list state: choices: - absent - present - query default: present description: - Use C(present) or C(absent) for adding or removing. - Use C(query) for listing an object or multiple objects. type: str domain: description: - The domain this user belongs to. - When creating new users, this defaults to C(Local). type: str timeout: default: 30 description: - The socket level timeout in seconds. - If the value is not specified in the task, the value of environment variable C(MSO_TIMEOUT) will be used instead. type: int use_ssl: description: - If C(no), an HTTP connection will be used instead of the default HTTPS connection. - If the value is not specified in the task, the value of environment variable C(MSO_USE_SSL) will be used instead. - When using a HTTPAPI connection plugin the inventory variable C(ansible_httpapi_use_ssl) will be used if this attribute is not specified. - The default is C(no) when using a HTTPAPI connection plugin (mso or nd) and C(yes) when using the legacy connection method (only for mso). type: bool password: description: - The password to use for authentication. - If the value is not specified in the task, the value of environment variables C(MSO_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. type: str username: description: - The username to use for authentication. - If the value is not specified in the task, the value of environment variables C(MSO_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. type: str last_name: description: - The last name of the user. - This parameter is required when creating new users. type: str use_proxy: description: - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. - If the value is not specified in the task, the value of environment variable C(MSO_USE_PROXY) will be used instead. - The default is C(yes). type: bool first_name: description: - The first name of the user. - This parameter is required when creating new users. type: str login_domain: description: - 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 C(MSO_LOGIN_DOMAIN) will be used instead. type: str output_level: choices: - debug - info - normal default: normal description: - Influence the output of this MSO module. - C(normal) means the standard output, incl. C(current) dict - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information - If the value is not specified in the task, the value of environment variable C(MSO_OUTPUT_LEVEL) will be used instead. type: str user_password: description: - The password of the user. type: str account_status: choices: - active description: - The status of the user account. type: str validate_certs: description: - If C(no), SSL certificates will not be validated. - This should only set to C(no) when used on personally controlled sites using self-signed certificates. - If the value is not specified in the task, the value of environment variable C(MSO_VALIDATE_CERTS) will be used instead. - The default is C(yes). type: bool