New in version 2.2.
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. | ||
hosts: |
no | a list of host names/labels to add to the group | ||
id |
no | The id number of the host group to manage. Either this or name must be supplied. | ||
name |
no | The name of the host group to manage. Either this or id_num must be supplied. | ||
new_name |
no | specify this when you need to update the name of a host group | ||
ssid |
yes | The ID of the array to manage (as configured on the web services proxy). | ||
state |
yes |
|
Whether the specified host group should exist or not. | |
validate_certs |
no | True | Should https certificates be validated? |
- 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
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
isSAControlled | 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. | always except when state is absent | boolean | False |
name | same as label | always except when state is absent | string | MyHostGroup |
confirmLUNMappingCreation | 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. | always | boolean | False |
label | The user-assigned, descriptive label string for the cluster. | always | string | MyHostGroup |
clusterRef | The unique identification value for this object. Other objects may use this reference value to refer to the cluster. | always except when state is absent | string | 3233343536373839303132333100000000000000 |
hosts | A list of the hosts that are part of the host group after all operations. | always except when state is absent | list | ['HostA', 'HostB'] |
id | The id number of the hostgroup | always except when state is absent | string | 3233343536373839303132333100000000000000 |
protectionInformationCapableAccessMethod | This field is true if the host has a PI capable access method. | always except when state is absent | boolean | True |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.