Docs4dev
Docs
ansible / 2.4 / sf_volume_manager_module.html

sf_volume_manager - Manage SolidFire volumes

New in version 2.3.

Synopsis

  • Create, destroy, or update volumes on SolidFire

Requirements (on host that executes module)

  • solidfire-sdk-python (1.1.0.92)

Options

parameter required default choices comments
512emulation
 no
Should the volume provide 512-byte sector emulation?
Required when state=present
access
 no None
  • readOnly
  • readWrite
  • locked
  • replicationTarget
Access allowed for the volume.
readOnly: Only read operations are allowed.
readWrite: Reads and writes are allowed.
locked: No reads or writes are allowed.
replicationTarget: Identify a volume as the target volume for a paired set of volumes. If the volume is not paired, the access status is locked.
If unspecified, the access settings of the clone will be the same as the source.
account_id
 yes
Account ID for the owner of this volume.
attributes
 no None
A YAML dictionary of attributes that you would like to apply on this volume.
hostname
 yes
The hostname or IP address of the SolidFire cluster.
name
 yes
The name of the volume to manage.
password
 yes
Password for the specified user.
qos
 no None
Initial quality of service settings for this volume. Configure as dict in playbooks.
size
 no
The size of the volume in (size_unit).
Required when state = present.
size_unit
 no gb
  • bytes
  • b
  • kb
  • mb
  • gb
  • tb
  • pb
  • eb
  • zb
  • yb
The unit used to interpret the size parameter.
state
 yes
  • present
  • absent
Whether the specified volume 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.
volume_id
 no None
The ID of the volume to manage or update.
In order to create multiple volumes with the same name, but different volume_ids, please declare the volume_id parameter with an arbitrary value. However, the specified volume_id will not be assigned to the newly created volume (since it's an auto-generated property).

Examples

- name: Create Volume
  sf_volume_manager:
    hostname: "{{ solidfire_hostname }}"
    username: "{{ solidfire_username }}"
    password: "{{ solidfire_password }}"
    state: present
    name: AnsibleVol
    qos: {minIOPS: 1000, maxIOPS: 20000, burstIOPS: 50000}
    account_id: 3
    enable512e: False
    size: 1
    size_unit: gb

- name: Update Volume
  sf_volume_manager:
    hostname: "{{ solidfire_hostname }}"
    username: "{{ solidfire_username }}"
    password: "{{ solidfire_password }}"
    state: present
    name: AnsibleVol
    account_id: 3
    access: readWrite

- name: Delete Volume
  sf_volume_manager:
    hostname: "{{ solidfire_hostname }}"
    username: "{{ solidfire_username }}"
    password: "{{ solidfire_password }}"
    state: absent
    name: AnsibleVol
    account_id: 2

Return Values

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

name description returned type sample
msg
Success message
success string

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_manager_module.html