W3cubDocs

/Ansible 2.7

na_elementsw_access_group - NetApp Element Software Manage Access Groups

New in version 2.7.

Synopsis

  • Create, destroy, or update access groups 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
attributes
List of Name/Value pairs in JSON object format.
hostname
required
The hostname or IP address of the SolidFire cluster.
initiators
List of initiators to include in the access group. If unspecified, the access group will start out without configured initiators.
new_name
New name for the access group for create and modify operation.
Required for create operation.
password
required
Password for the specified user.

aliases: pass
src_access_group_id
ID or Name of the access group to modify or delete.
Required for delete and modify operations.
state
required
    Choices:
  • present
  • absent
Whether the specified access group should exist or not.
username
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
virtual_network_id
The ID of the Element SW Software Cluster Virtual Network ID to associate the access group with.
virtual_network_tags
The ID of the VLAN Virtual Network Tag to associate the access group with.
volumes
List of volumes to initially include in the volume access group. If unspecified, the access group will start without any volumes.

Notes

Note

  • The modules prefixed with na_elementsw are built to support the SolidFire storage platform.

Examples

- name: Create Access Group
  na_elementsw_access_group:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: present
    new_name: AnsibleAccessGroup
    volumes: [7,8]

- name: Modify Access Group
  na_elementsw_access_group:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: present
    src_access_group_id: AnsibleAccessGroup
    new_name: AnsibleAccessGroup-Renamed
    attributes: {"volumes": [1,2,3], "virtual_network_id": 12345}

- name: Delete Access Group
  na_elementsw_access_group:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: absent
    src_access_group_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


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Hint

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

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