Docs4dev
Docs
ansible / latest / collections / netapp_eseries / santricity / netapp_e_storage_system_module.html

netapp_eseries.santricity.netapp_e_storage_system – NetApp E-Series Web Services Proxy manage storage arrays

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_storage_system.

New in version 2.2: of netapp_eseries.santricity

Synopsis

  • Manage the arrays accessible via a NetApp Web Services Proxy for NetApp E-series storage arrays.

Parameters

Parameter Choices/Defaults Comments
api_password
string / required
The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
api_url
string / required
The url to the SANtricity WebServices Proxy or embedded REST API.
api_username
string / required
The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
array_password
string
The management password of the array to manage, if set.
array_status_timeout_sec
integer
Default:
60
Array status timeout measured in seconds
array_wwn
string
The WWN of the array to manage. Only necessary if in-band managing multiple arrays on the same agent host. Mutually exclusive of controller_addresses parameter.
controller_addresses
list / elements=string / required
The list addresses for the out-of-band management adapter or the agent host. Mutually exclusive of array_wwn parameter.
enable_trace
boolean
    Choices:
  • no ←
  • yes
Enable trace logging for SYMbol calls to the storage system.
meta_tags
list / elements=string
Optional meta tags to associate to this storage system
ssid
string / required
The ID of the array to manage. This value must be unique for each array.
state
string / required
    Choices:
  • present
  • absent
Whether the specified array should be configured on the Web Services Proxy or not.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Should https certificates be validated?

Examples

---
    - name:  Presence of storage system
      netapp_e_storage_system:
        ssid: "{{ item.key }}"
        state: present
        api_url: "{{ netapp_api_url }}"
        api_username: "{{ netapp_api_username }}"
        api_password: "{{ netapp_api_password }}"
        validate_certs: "{{ netapp_api_validate_certs }}"
        controller_addresses:
          - "{{ item.value.address1 }}"
          - "{{ item.value.address2 }}"
      with_dict: "{{ storage_systems }}"
      when: check_storage_system

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
msg
string
always
State of request

Sample:
Storage system removed.


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_storage_system_module.html