W3cubDocs

/Ansible

netapp_eseries.santricity.netapp_e_auth – NetApp E-Series set or update the password for a storage array.

Note

This plugin is part of the netapp_eseries.santricity collection (version 1.2.13).

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 netapp_eseries.santricity.

To use it in a playbook, specify: netapp_eseries.santricity.netapp_e_auth.

New in version 2.2: of netapp_eseries.santricity

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.

Parameters

Parameter Choices/Defaults Comments
api_password
string
The password used to authenticate against the API
This can optionally be set via an environment variable, API_PASSWORD
api_url
string
The full API url.
Example: http://ENDPOINT:8080/devmgr/v2
This can optionally be set via an environment variable, API_URL
api_username
string
The username used to authenticate against the API
This can optionally be set via an environment variable, API_USERNAME
current_password
string
The current admin password. This is not required if the password hasn't been set before.
name
string
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
string / required
The password you would like to set. Cannot be more than 30 characters.
set_admin
boolean
    Choices:
  • no ←
  • yes
Boolean value on whether to update the admin password. If set to false then the RO account is updated.
ssid
string
the identifier of the storage array in the Web Services Proxy.
validate_certs
boolean
    Choices:
  • no
  • yes ←
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, the following are the fields unique to this module:

Key Returned Description
msg
string
success
Success message

Sample:
Password Updated Successfully


Authors

  • Kevin Hulquest (@hulquest)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp_eseries/santricity/netapp_e_auth_module.html