aci_aaa_user – Manage AAA users (aaa:User)
aci_aaa_user – Manage AAA users (aaa:User)
New in version 2.5.
Synopsis
- Manage AAA users on Cisco ACI fabrics.
Requirements
The below requirements are needed on the host that executes this module.
- python-dateutil
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
aaa_password string |
The password of the locally-authenticated user. | |
aaa_password_lifetime integer |
The lifetime of the locally-authenticated user password. | |
aaa_password_update_required boolean |
|
Whether this account needs password update. |
aaa_user string |
The name of the locally-authenticated user user to add.
| |
certificate_name string |
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a If PEM-formatted content was provided for
| |
clear_password_history boolean |
|
Whether to clear the password history of a locally-authenticated user. |
description string |
Description for the AAA user.
| |
string |
The email address of the locally-authenticated user. | |
enabled boolean |
|
The status of the locally-authenticated user account. |
expiration string |
The expiration date of the locally-authenticated user account. | |
expires boolean |
|
Whether to enable an expiration date for the locally-authenticated user account. |
first_name string |
The first name of the locally-authenticated user. | |
host string / required |
IP Address or hostname of APIC resolvable by Ansible control host.
| |
last_name string |
The last name of the locally-authenticated user. | |
output_level string |
|
Influence the output of this ACI module.
|
password string / required |
The password to use for authentication. This option is mutual exclusive with | |
phone string |
The phone number of the locally-authenticated user. | |
port integer |
Port number to be used for REST connection. The default value depends on parameter | |
private_key string / required |
Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default This option is mutual exclusive with
| |
state string |
|
Use Use |
timeout integer |
Default: 30 |
The socket level timeout in seconds. |
use_proxy boolean |
|
If |
use_ssl boolean |
|
If |
username string |
Default: "admin" |
The username to use for authentication.
|
validate_certs boolean |
|
If This should only set to |
Notes
Note
- This module is not idempotent when
aaa_password
is being used (even if that password was already set identically). This appears to be an inconsistency wrt. the idempotent nature of the APIC REST API. The vendor has been informed. More information in the ACI documentation.
See Also
See also
- aci_aaa_user_certificate – Manage AAA user certificates (aaa:UserCert)
- The official documentation on the aci_aaa_user_certificate module.
- APIC Management Information Model reference
- More information about the internal APIC class aaa:User.
- Cisco ACI Guide
- Detailed information on how to manage your ACI infrastructure using Ansible.
- Developing Cisco ACI modules
- Detailed guide on how to write your own Cisco ACI modules to contribute.
Examples
- name: Add a user
aci_aaa_user:
host: apic
username: admin
password: SomeSecretPassword
aaa_user: dag
aaa_password: AnotherSecretPassword
expiration: never
expires: no
email: [email protected]
phone: 1-234-555-678
first_name: Dag
last_name: Wieers
state: present
delegate_to: localhost
- name: Remove a user
aci_aaa_user:
host: apic
username: admin
password: SomeSecretPassword
aaa_user: dag
state: absent
delegate_to: localhost
- name: Query a user
aci_aaa_user:
host: apic
username: admin
password: SomeSecretPassword
aaa_user: dag
state: query
delegate_to: localhost
register: query_result
- name: Query all users
aci_aaa_user:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
current list |
success |
The existing configuration from the APIC after the module has finished
Sample: [{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}] |
error dictionary |
failure |
The error information as returned from the APIC
Sample: {'code': '122', 'text': 'unknown managed object class foo'} |
filter_string string |
failure or debug |
The filter string used for the request
Sample: ?rsp-prop-include=config-only |
method string |
failure or debug |
The HTTP method used for the request to the APIC
Sample: POST |
previous list |
info |
The original configuration from the APIC before the module has started
Sample: [{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}] |
proposed dictionary |
info |
The assembled configuration from the user-provided parameters
Sample: {'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}} |
raw string |
parse error |
The raw output returned by the APIC REST API (xml or json)
Sample:
|
response string |
failure or debug |
The HTTP response from the APIC
Sample: OK (30 bytes) |
sent list |
info |
The actual/minimal configuration pushed to the APIC
Sample: {'fvTenant': {'attributes': {'descr': 'Production environment'}}} |
status integer |
failure or debug |
The HTTP status from the APIC
Sample: 200 |
url string |
failure or debug |
The HTTP url used for the request to the APIC
Sample: |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Dag Wieers (@dagwieers)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/aci_aaa_user_module.html