Documentation

sf_volume_access_group_manager - Manage SolidFire Volume Access Groups

New in version 2.3.

Synopsis

  • Create, destroy, or update volume access groups on SolidFire

Requirements

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

  • solidfire-sdk-python (1.1.0.92)

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 volume access group. If unspecified, the access group will start out without configured initiators.
name
required
Name of the volume access group. It is not required to be unique, but recommended.
password
required
Password for the specified user.
state
required
    Choices:
  • present
  • absent
Whether the specified volume 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://goo.gl/ddJa4Q.
virtual_network_id
The ID of the SolidFire Virtual Network ID to associate the volume access group with.
virtual_network_tags
The ID of the VLAN Virtual Network Tag to associate the volume access group with.
volume_access_group_id
The ID of the volume access group to modify or delete.
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 sf\_ are built to support the SolidFire storage platform.

Examples

- name: Create Volume Access Group
  sf_volume_access_group_manager:
    hostname: "{{ solidfire_hostname }}"
    username: "{{ solidfire_username }}"
    password: "{{ solidfire_password }}"
    state: present
    name: AnsibleVolumeAccessGroup
    volumes: [7,8]

- name: Modify Volume Access Group
  sf_volume_access_group_manager:
    hostname: "{{ solidfire_hostname }}"
    username: "{{ solidfire_username }}"
    password: "{{ solidfire_password }}"
    state: present
    volume_access_group_id: 1
    name: AnsibleVolumeAccessGroup-Renamed
    attributes: {"volumes": [1,2,3], "virtual_network_id": 12345}

- name: Delete Volume Access Group
  sf_volume_access_group_manager:
    hostname: "{{ solidfire_hostname }}"
    username: "{{ solidfire_username }}"
    password: "{{ solidfire_password }}"
    state: absent
    volume_access_group_id: 1

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.