netapp_e_auth - Sets or updates the password for a storage array.
New in version 2.2.
Synopsis
- Sets or updates the password for a storage array. When the password is updated on the storage array, it must be updated on the SANtricity Web Services proxy. Note, all storage arrays do not have a Monitor or RO role.
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| api_password | no | The password used to authenticate against the API This can optionally be set via an environment variable, API_PASSWORD | ||
| api_url | no | The full API url. Example: http://ENDPOINT:8080/devmgr/v2 This can optionally be set via an environment variable, API_URL | ||
| api_username | no | The username used to authenticate against the API This can optionally be set via an environment variable, API_USERNAME | ||
| current_password | no | The current admin password. This is not required if the password hasn't been set before. | ||
| name | no | The name of the storage array. Note that if more than one storage array with this name is detected, the task will fail and you'll have to use the ID instead. | ||
| new_password | yes | The password you would like to set. Cannot be more than 30 characters. | ||
| set_admin | no | Boolean value on whether to update the admin password. If set to false then the RO account is updated. | ||
| ssid | no | the identifier of the storage array in the Web Services Proxy. | ||
| validate_certs | no | True | Should https certificates be validated? |
Examples
- name: Test module
netapp_e_auth:
name: trex
current_password: OldPasswd
new_password: NewPasswd
set_admin: yes
api_url: '{{ netapp_api_url }}'
api_username: '{{ netapp_api_username }}'
api_password: '{{ netapp_api_password }}'
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| msg | Success message | success | string | Password Updated Successfully |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/netapp_e_auth_module.html