ansible.builtin.netapp_e_volume (v2.3.3.0-1) — module

Manage storage volumes (standard and thin)

| "added in version" 2.2 of ansible.builtin"

Authors: Kevin Hulquest (@hulquest)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

Create or remove volumes (standard and thin) for NetApp E/EF-series storage arrays.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: No thin volume
      netapp_e_volume:
        ssid: "{{ ssid }}"
        name: NewThinVolumeByAnsible
        state: absent
        log_path: /tmp/volume.log
        api_url: "{{ netapp_api_url }}"
        api_username: "{{ netapp_api_username }}"
        api_password: "{{ netapp_api_password }}"
        validate_certs: "{{ netapp_api_validate_certs }}"
      when: check_volume
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.

    - name: No fat volume
      netapp_e_volume:
        ssid: "{{ ssid }}"
        name: NewVolumeByAnsible
        state: absent
        log_path: /tmp/volume.log
        api_url: "{{ netapp_api_url }}"
        api_username: "{{ netapp_api_username }}"
        api_password: "{{ netapp_api_password }}"
        validate_certs: "{{ netapp_api_validate_certs }}"
      when: check_volume

Inputs

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

size:
    description:
    - Required only when state = 'present'.  The size of the volume in (size_unit).
    required: true

ssid:
    description:
    - The ID of the array to manage (as configured on the web services proxy).
    required: true

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

api_url:
    description:
    - The url to the SANtricity WebServices Proxy or embedded REST API.
    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

api_password:
    description:
    - The password to authenticate with the SANtricity WebServices Proxy or embedded REST
      API.
    required: true

api_username:
    description:
    - The username to authenticate with the SANtricity WebServices Proxy or embedded REST
      API.
    required: true

thin_provision:
    choices:
    - 'yes'
    - 'no'
    - 'true'
    - 'false'
    default: false
    description:
    - Whether the volume should be thin provisioned.  Thin volumes can only be created
      on disk pools (raidDiskPool).

validate_certs:
    default: true
    description:
    - Should https certificates be validated?
    required: false

segment_size_kb:
    default: 512
    description:
    - The segment size of the new volume

ssd_cache_enabled:
    choices:
    - 'yes'
    - 'no'
    - 'true'
    - 'false'
    default: None (ignores existing SSD cache setting)
    description:
    - Whether an existing SSD cache should be enabled on the volume (fails if no SSD cache
      defined)

storage_pool_name:
    description:
    - Required only when requested state is 'present'.  The name of the storage pool the
      volume should exist on.
    required: true

thin_volume_repo_size:
    description:
    - Initial size of the thin volume repository volume (in size_unit)
    required: true

data_assurance_enabled:
    default: false
    description:
    - If data assurance should be enabled for the volume

thin_volume_max_repo_size:
    default: same as size (in size_unit)
    description:
    - Maximum size that the thin volume repository volume will automatically expand to

Outputs

msg: Volume [workload_vol_1] already exists.