netapp_e_hostgroup – NetApp E-Series manage array host groups

From Get docs
Ansible/docs/2.8/modules/netapp e hostgroup module


netapp_e_hostgroup – NetApp E-Series manage array host groups

New in version 2.2.


Synopsis

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

Parameters

Parameter Choices/Defaults Comments

api_password

- / required

The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.

api_url

- / required

The url to the SANtricity WebServices Proxy or embedded REST API.

api_username

- / required

The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.

hosts

-

a list of host names/labels to add to the group

id

-

The id number of the host group to manage. Either this or name must be supplied.

name

-

The name of the host group to manage. Either this or id_num must be supplied.

new_name

-

specify this when you need to update the name of a host group

ssid

- / required

The ID of the array to manage (as configured on the web services proxy).

state

- / required

  • present
  • absent

Whether the specified host group should exist or not.

validate_certs

-

Default:

"yes"

Should https certificates be validated?



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 Returned Description

clusterRef

string

always except when state is absent

The unique identification value for this object. Other objects may use this reference value to refer to the cluster.


Sample:

3233343536373839303132333100000000000000

confirmLUNMappingCreation

boolean

always

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.


hosts

list

always except when state is absent

A list of the hosts that are part of the host group after all operations.


Sample:

['HostA', 'HostB']

id

string

always except when state is absent

The id number of the hostgroup


Sample:

3233343536373839303132333100000000000000

isSAControlled

boolean

always except when state is absent

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.


label

string

always

The user-assigned, descriptive label string for the cluster.


Sample:

MyHostGroup

name

string

always except when state is absent

same as label


Sample:

MyHostGroup

protectionInformationCapableAccessMethod

boolean

always except when state is absent

This field is true if the host has a PI capable access method.


Sample:

True




Status

Authors

  • Kevin Hulquest (@hulquest)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/netapp_e_hostgroup_module.html