netapp_eseries.santricity.netapp_e_hostgroup module – NetApp E-Series manage array host groups
Note
This module is part of the netapp_eseries.santricity collection (version 1.4.0).
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_hostgroup.
New in netapp_eseries.santricity 2.2
Synopsis
Create, update or destroy host groups on a NetApp E-Series storage array.
Parameters
Parameter |
Comments |
|---|---|
The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. |
|
The url to the SANtricity Web Services Proxy or Embedded Web Services API. Example https://prod-1.wahoo.acme.com/devmgr/v2 |
|
The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. |
|
List of host names/labels to add to the group |
|
Host reference identifier for the host group to manage. This option is mutually exclusive with name. |
|
Name of the host group to manage This option is mutually exclusive with id. |
|
Specify this when you need to update the name of a host group |
|
The ID of the array to manage. This value must be unique for each array. Default: |
|
Whether the specified host group should exist or not. Choices:
|
|
Should https certificates be validated? Choices:
|
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.
ERROR while parsing
M('netapp_e_storage_system'): parameter ‘netapp_e_storage_system’ is not a FQCN may be utilized for configuring the systems managed by a WSP instance.
Examples
- name: Configure Hostgroup
netapp_e_hostgroup:
ssid: "{{ ssid }}"
api_url: "{{ netapp_api_url }}"
api_username: "{{ netapp_api_username }}"
api_password: "{{ netapp_api_password }}"
validate_certs: "{{ netapp_api_validate_certs }}"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
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: |
|
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: |
|
A list of the hosts that are part of the host group after all operations. Returned: always except when state is absent Sample: |
|
The id number of the hostgroup Returned: always except when state is absent Sample: |
|
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: |
|
The user-assigned, descriptive label string for the cluster. Returned: always Sample: |
|
same as label Returned: always except when state is absent Sample: |
|
This field is true if the host has a PI capable access method. Returned: always except when state is absent Sample: |