Documentation

netapp_e_storage_system - Add/remove arrays from the Web Services Proxy

New in version 2.2.

Synopsis

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

Options

parameter required default choices comments
api_password
 yes
The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
api_url
 yes
The url to the SANtricity WebServices Proxy or embedded REST API.
api_username
 yes
The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
array_password
 no
The management password of the array to manage, if set.
array_wwn
 no
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
 yes
The list addresses for the out-of-band management adapter or the agent host. Mutually exclusive of array_wwn parameter.
enable_trace
 no
Enable trace logging for SYMbol calls to the storage system.
meta_tags
 no None
Optional meta tags to associate to this storage system
ssid
 yes
The ID of the array to manage. This value must be unique for each array.
state
 yes
  • present
  • absent
Whether the specified array should be configured on the Web Services Proxy or not.
validate_certs
 no True
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 Return Values, the following are the fields unique to this module:

name description returned type sample
msg
State of request
 always string Storage system removed.


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.