community.general.sf_volume_manager (1.3.14) — module

Install collection

Install with ansible-galaxy collection install community.general:==1.3.14

Add to requirements.yml

  collections:
    - name: community.general
      version: 1.3.14

Description

Create, destroy, or update volumes on SolidFire

Requirements

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

   - name: Create Volume
     community.general.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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
qos:
    description: Initial quality of service settings for this volume. Configure as dict
      in playbooks.

name:
    description:
    - The name of the volume to manage.
    required: true

size:
    description:
    - The size of the volume in (size_unit).
    - Required when C(state = present).

state:
    choices:
    - present
    - absent
    description:
    - Whether the specified volume should exist or not.
    required: true

access:
    choices:
    - readOnly
    - readWrite
    - locked
    - replicationTarget
    description:
    - 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.

hostname:
    description:
    - The hostname or IP address of the SolidFire cluster.
    required: true

password:
    aliases:
    - pass
    description:
    - Password for the specified user.
    required: true

username:
    aliases:
    - user
    description:
    - Please ensure that the user has the adequate permissions. For more information,
      please read the official documentation U(https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US).
    required: true

size_unit:
    choices:
    - bytes
    - b
    - kb
    - mb
    - gb
    - tb
    - pb
    - eb
    - zb
    - yb
    default: gb
    description:
    - The unit used to interpret the size parameter.

volume_id:
    description:
    - 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 I(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).

account_id:
    description:
    - Account ID for the owner of this volume.
    required: true

attributes:
    description: A YAML dictionary of attributes that you would like to apply on this
      volume.

512emulation:
    description:
    - Should the volume provide 512-byte sector emulation?
    - Required when C(state=present)

Outputs

msg:
  description: Success message
  returned: success
  type: str