ansible.builtin.netapp_e_hostgroup (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - 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

Inputs

    
id:
    description:
    - The id number of the host group to manage. Either this or C(name) must be supplied.
    required: false

name:
    description:
    - The name of the host group to manage. Either this or C(id_num) must be supplied.
    required: false

ssid:
    description:
    - The ID of the array to manage (as configured on the web services proxy).
    required: true

hosts:
    description:
    - a list of host names/labels to add to the group
    required: false

state:
    choices:
    - present
    - absent
    description:
    - Whether the specified host group should exist or not.
    required: true

api_url:
    description:
    - The url to the SANtricity WebServices Proxy or embedded REST API.
    required: true

new_name:
    description:
    - specify this when you need to update the name of a host group
    required: false

api_password:
    description:
    - The password to authenticate with the SANtricity WebServices Proxy or embedded REST
      API.
    required: true

api_username:
    description:
    - The username to authenticate with the SANtricity WebServices Proxy or embedded REST
      API.
    required: true

validate_certs:
    default: true
    description:
    - Should https certificates be validated?
    required: false

Outputs

clusterRef:
  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: '3233343536373839303132333100000000000000'
  type: str
confirmLUNMappingCreation:
  description: 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
  type: bool
hosts:
  description: 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
  type: list
id:
  description: The id number of the hostgroup
  returned: always except when state is absent
  sample: '3233343536373839303132333100000000000000'
  type: str
isSAControlled:
  description: 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
  type: bool
label:
  description: The user-assigned, descriptive label string for the cluster.
  returned: always
  sample: MyHostGroup
  type: str
name:
  description: same as label
  returned: always except when state is absent
  sample: MyHostGroup
  type: str
protectionInformationCapableAccessMethod:
  description: This field is true if the host has a PI capable access method.
  returned: always except when state is absent
  sample: true
  type: bool