netapp_eseries.santricity.na_santricity_volume module – NetApp E-Series manage storage volumes (standard and thin)

Note

This module is part of the netapp_eseries.santricity collection (version 1.3.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netapp_eseries.santricity.

To use it in a playbook, specify: netapp_eseries.santricity.na_santricity_volume.

Synopsis

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

Parameters

Parameter

Comments

allow_expansion

boolean

Allows volume size to expand to meet the required specification.

Warning, when allows_expansion==false and the existing volume needs to be expanded the module will continue with a warning.

Choices:

  • false ← (default)

  • true

api_password

string / required

The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.

api_url

string / required

The url to the SANtricity Web Services Proxy or Embedded Web Services API.

Example https://prod-1.wahoo.acme.com:8443/devmgr/v2

api_username

string / required

The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.

cache_without_batteries

boolean

Indicates whether caching should be used without battery backup.

Warning, ERROR while parsing: While parsing M() at index 10: Module name “cache_without_batteries==true” is not a FQCN and the storage system looses power and there is no battery backup, data will be lost!

Choices:

  • false ← (default)

  • true

data_assurance_enabled

boolean

Determines whether data assurance (DA) should be enabled for the volume

Only available when creating a new volume and on a storage pool with drives supporting the DA capability.

Choices:

  • false ← (default)

  • true

name

string / required

The name of the volume to manage.

owning_controller

string

Specifies which controller will be the primary owner of the volume

Not specifying will allow the controller to choose ownership.

Choices:

  • "A"

  • "B"

read_ahead_enable

boolean

Indicates whether or not automatic cache read-ahead is enabled.

This option has no effect on thinly provisioned volumes since the architecture for thin volumes cannot benefit from read ahead caching.

Choices:

  • false

  • true ← (default)

read_cache_enable

boolean

Indicates whether read caching should be enabled for the volume.

Choices:

  • false

  • true ← (default)

segment_size_kb

integer

Segment size of the volume

All values are in kibibytes.

Some common choices include 8, 16, 32, 64, 128, 256, and 512 but options are system dependent.

Retrieve the definitive system list from ERROR while parsing: While parsing M() at index 42: Module name “na_santricity_facts” is not a FQCN under segment_sizes.

When the storage pool is a raidDiskPool then the segment size must be 128kb.

Segment size migrations are not allowed in this module

Default: 128

size

float / required

Required only when state==”present”.

Size of the volume in size_unit.

Size of the virtual volume in the case of a thin volume in size_unit.

Maximum virtual volume size of a thin provisioned volume is 256tb; however other OS-level restrictions may exist.

size_tolerance_b

integer

Tolerance for total volume size measured in bytes; so, if the total volumes size is within +/- size_tolerance_b then no resizing will be expected.

This parameter can be useful in the case of existing volumes not created by na_santricity_volume since providing the exact size can be difficult due to volume alignment and overhead.

Default: 10485760

size_unit

string

The unit used to interpret the size parameter

pct unit defines a percent of total usable storage pool size.

Choices:

  • "bytes"

  • "b"

  • "kb"

  • "mb"

  • "gb" ← (default)

  • "tb"

  • "pb"

  • "eb"

  • "zb"

  • "yb"

  • "pct"

ssd_cache_enabled

boolean

Whether an existing SSD cache should be enabled on the volume (fails if no SSD cache defined)

The default value is to ignore existing SSD cache setting.

Choices:

  • false ← (default)

  • true

ssid

string

The ID of the array to manage. This value must be unique for each array.

Default: "1"

state

string

Whether the specified volume should exist

Choices:

  • "present" ← (default)

  • "absent"

storage_pool_name

string

Required only when requested state==”present”.

Name of the storage pool wherein the volume should reside.

thin_provision

boolean

Whether the volume should be thin provisioned.

Thin volumes can only be created when raid_level==”raidDiskPool”.

Generally, use of thin-provisioning is not recommended due to performance impacts.

Choices:

  • false ← (default)

  • true

thin_volume_expansion_policy

string

This is the thin volume expansion policy.

When thin_volume_expansion_policy==”automatic” and thin_volume_growth_alert_threshold is exceed the thin_volume_max_repo_size will be automatically expanded.

When thin_volume_expansion_policy==”manual” and thin_volume_growth_alert_threshold is exceeded the storage system will wait for manual intervention.

The thin volume_expansion policy can not be modified on existing thin volumes in this module.

Generally speaking you should almost always use thin_volume_expansion_policy==”automatic.

Choices:

  • "automatic" ← (default)

  • "manual"

thin_volume_growth_alert_threshold

integer

This is the thin provision repository utilization threshold (in percent).

When the pct of used storage of the maximum repository size exceeds this value then a alert will be issued and the thin_volume_expansion_policy will be executed.

Values must be between or equal to 10 and 99.

Default: 95

thin_volume_max_repo_size

float

This is the maximum amount the thin volume repository will be allowed to grow.

Only has significance when thin_volume_expansion_policy==”automatic”.

When the pct thin_volume_repo_size of thin_volume_max_repo_size exceeds thin_volume_growth_alert_threshold then a warning will be issued and the storage array will execute the thin_volume_expansion_policy policy.

Expansion operations when thin_volume_expansion_policy==”automatic” will increase the maximum repository size.

Default will be the same as size.

thin_volume_repo_size

integer

This value (in size_unit) sets the allocated space for the thin provisioned repository.

Initial value must between or equal to 4gb and 256gb in increments of 4gb.

During expansion operations the increase must be between or equal to 4gb and 256gb in increments of 4gb.

This option has no effect during expansion if thin_volume_expansion_policy==”automatic”.

Generally speaking you should almost always use thin_volume_expansion_policy==”automatic.

validate_certs

boolean

Should https certificates be validated?

Choices:

  • false

  • true ← (default)

volume_metadata

dictionary

Dictionary containing metadata for the volume itself.

Dictionary key cannot be longer than 14 characters

Dictionary values cannot be longer than 240 characters

wait_for_initialization

boolean

Forces the module to wait for expansion operations to complete before continuing.

Choices:

  • false ← (default)

  • true

workload_metadata

aliases: metadata

dictionary

Dictionary containing meta data for the use, user, location, etc of the volume (dictionary is arbitrarily defined for whatever the user deems useful)

When workload_name exists on the storage array but the metadata is different then the workload definition will be updated. (Changes will update all associated volumes!)

workload_name must be specified when metadata are defined.

Dictionary key cannot be longer than 16 characters

Dictionary values cannot be longer than 60 characters

workload_name

string

Label for the workload defined by the metadata.

When workload_name and metadata are specified then the defined workload will be added to the storage array.

When workload_name exists on the storage array but the metadata is different then the workload definition will be updated. (Changes will update all associated volumes!)

Existing workloads can be retrieved using ERROR while parsing: While parsing M() at index 43: Module name “na_santricity_facts” is not a FQCN.

write_cache_enable

boolean

Indicates whether write-back caching should be enabled for the volume.

Choices:

  • false

  • true ← (default)

write_cache_mirror_enable

boolean

Indicates whether write cache mirroring should be enabled.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.

  • Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.

  • ERROR while parsing: While parsing M() at index 1: Module name “netapp_e_storage_system” is not a FQCN may be utilized for configuring the systems managed by a WSP instance.

Examples

- name: Create simple volume with workload tags (volume meta data)
  na_santricity_volume:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: present
    name: volume
    storage_pool_name: storage_pool
    size: 300
    size_unit: gb
    workload_name: volume_tag
    metadata:
      key1: value1
      key2: value2

- name: Create a thin volume
  na_santricity_volume:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: present
    name: volume1
    storage_pool_name: storage_pool
    size: 131072
    size_unit: gb
    thin_provision: true
    thin_volume_repo_size: 32
    thin_volume_max_repo_size: 1024

- name: Expand thin volume's virtual size
  na_santricity_volume:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: present
    name: volume1
    storage_pool_name: storage_pool
    size: 262144
    size_unit: gb
    thin_provision: true
    thin_volume_repo_size: 32
    thin_volume_max_repo_size: 1024

- name: Expand thin volume's maximum repository size
  na_santricity_volume:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: present
    name: volume1
    storage_pool_name: storage_pool
    size: 262144
    size_unit: gb
    thin_provision: true
    thin_volume_repo_size: 32
    thin_volume_max_repo_size: 2048

- name: Delete volume
  na_santricity_volume:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: absent
    name: volume

Return Values

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

Key

Description

msg

string

State of volume

Returned: always

Sample: "Standard volume [workload_vol_1] has been created."

Authors

  • Nathan Swartz (@ndswartz)