W3cubDocs

/Ansible

netapp.elementsw.na_elementsw_access_group_volumes – NetApp Element Software Add/Remove Volumes to/from Access Group

Note

This plugin is part of the netapp.elementsw collection (version 21.6.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.elementsw.

To use it in a playbook, specify: netapp.elementsw.na_elementsw_access_group_volumes.

New in version 20.1.0: of netapp.elementsw

Synopsis

  • Add or remove volumes to/from access group on Element Software Cluster.

Requirements

The below requirements are needed on the host that executes this module.

  • The modules were developed with SolidFire 10.1
  • solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’

Parameters

Parameter Choices/Defaults Comments
access_group
string / required
Name or id for the access group to add volumes to, or remove volumes from
account_id
string / required
Account ID for the owner of this volume.
It accepts either account_name or account_id
if account_id is numeric, look up for account_id first, then look up for account_name
If account_id is not numeric, look up for account_name
hostname
string / required
The hostname or IP address of the SolidFire cluster.
For na_elementsw_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from.
password
string / required
Password for the specified user.

aliases: pass
state
string
    Choices:
  • present ←
  • absent
Whether the specified volumes should exist or not for this access group.
username
string / required
Please ensure that the user has the adequate permissions. For more information, please read the official documentation https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US.

aliases: user
volumes
list / elements=string / required
List of volumes to add/remove from/to the access group.
It accepts either volume_name or volume_id

Notes

Note

  • The modules prefixed with na\_elementsw are built to support the SolidFire storage platform.

Examples

- name:  Add Volumes to Access Group
  na_elementsw_access_group:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: present
    access_group: AnsibleAccessGroup
    volumes: ['vol7','vol8','vol9']
    account_id: '1'

- name:  Remove Volumes from Access Group
  na_elementsw_access_group:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: absent
    access_group: AnsibleAccessGroup
    volumes: ['vol7','vol9']
    account_id: '1'

Return Values

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

Key Returned Description
msg
string
success
Success message


Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/elementsw/na_elementsw_access_group_volumes_module.html