Docs4dev
Docs
ansible / 2.4 / sf_volume_access_group_manager_module.html

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 (on host that executes module)

  • solidfire-sdk-python (1.1.0.92)

Options

parameter required default choices comments
attributes
 no None
List of Name/Value pairs in JSON object format.
hostname
 yes
The hostname or IP address of the SolidFire cluster.
initiators
 no None
List of initiators to include in the volume access group. If unspecified, the access group will start out without configured initiators.
name
 yes
Name of the volume access group. It is not required to be unique, but recommended.
password
 yes
Password for the specified user.
state
 yes
  • present
  • absent
Whether the specified volume access group should exist or not.
username
 yes
Please ensure that the user has the adequate permissions. For more information, please read the official documentation https://goo.gl/ddJa4Q.
virtual_network_id
 no None
The ID of the SolidFire Virtual Network ID to associate the volume access group with.
virtual_network_tags
 no None
The ID of the VLAN Virtual Network Tag to associate the volume access group with.
volume_access_group_id
 no None
The ID of the volume access group to modify or delete.
volumes
 no None
List of volumes to initially include in the volume access group. If unspecified, the access group will start without any volumes.

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

Notes

Note

  • The modules prefixed with sf\_ are built to support the SolidFire storage platform.

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

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