netapp_eseries.santricity.na_santricity_hostgroup module – NetApp E-Series manage array host groups

Note

This module is part of the netapp_eseries.santricity collection (version 1.4.1).

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

Synopsis

• Create, update or destroy host groups on a NetApp E-Series storage array.

Parameters

Parameter	Comments
api_password string / required	The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
api_url string / required	The url to the SANtricity Web Services Proxy or Embedded Web Services API. Example https://prod-1.wahoo.acme.com:8443/devmgr/v2
api_username string / required	The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
hosts list / elements=string	List of host names/labels to add to the group
name string / required	Name of the host group to manage
ssid string	The ID of the array to manage. This value must be unique for each array. Default: "1"
state string	Whether the specified host group should exist or not. Choices: "present" ← (default) "absent"
validate_certs boolean	Should https certificates be validated? Choices: false true ← (default)

Notes

Note

• The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.

• Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.

• netapp_eseries.santricity.netapp_e_storage_system may be utilized for configuring the systems managed by a WSP instance.

Examples

- name: Configure Hostgroup
  na_santricity_hostgroup:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: present
    name: example_hostgroup
    hosts:
      - host01
      - host02

Return Values

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

Key	Description
clusterRef string	The unique identification value for this object. Other objects may use this reference value to refer to the cluster. Returned: always except when state is absent Sample: "3233343536373839303132333100000000000000"
confirmLUNMappingCreation boolean	If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other clusters, in addition to this one. Returned: always Sample: false
hosts list / elements=string	A list of the hosts that are part of the host group after all operations. Returned: always except when state is absent Sample: ["HostA", "HostB"]
id string	The id number of the hostgroup Returned: always except when state is absent Sample: "3233343536373839303132333100000000000000"
isSAControlled boolean	If true, indicates that I/O accesses from this cluster are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the cluster are subject to cluster-specific LUN-to-volume mappings. Returned: always except when state is absent Sample: false
label string	The user-assigned, descriptive label string for the cluster. Returned: always Sample: "MyHostGroup"
name string	same as label Returned: always except when state is absent Sample: "MyHostGroup"
protectionInformationCapableAccessMethod boolean	This field is true if the host has a PI capable access method. Returned: always except when state is absent Sample: true

Authors

• Kevin Hulquest (@hulquest)

• Nathan Swartz (@swartzn)

• Vu Tran (@VuTran007)

Collection links

• Issue Tracker
• Repository (Sources)