Note
This plugin is part of the netapp_eseries.santricity collection.
To install it use: ansible-galaxy collection install netapp_eseries.santricity.
To use it in a playbook, specify: netapp_eseries.santricity.na_santricity_volume.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| 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, cache_without_batteries==true and the storage system looses power and there is no battery backup, data will be lost! |
| 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. |
| 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. |
| 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. |
| read_cache_enable boolean |
| Indicates whether read caching should be enabled for the volume. |
| segment_size_kb integer | Default: 128 | 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 s ystem list from netapp_eseries.santricity.na_santricity_facts 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 |
| 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_unit string |
| The unit used to interpret the size parameter |
| 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. |
| ssid string | Default: 1 | The ID of the array to manage. This value must be unique for each array. |
| state string |
| Whether the specified volume should exist |
| 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. |
| 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. |
| thin_volume_growth_alert_threshold integer | Default: 95 | This is the thin provision repository utilization threshold (in percent). When the percentage 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. |
| 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 percentage 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? |
| 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. |
| workload_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 aliases: metadata | |
| 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 netapp_eseries.santricity.na_santricity_facts. | |
| write_cache_enable boolean |
| Indicates whether write-back caching should be enabled for the volume. |
Note
- 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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| msg string | always | State of volume Sample: Standard volume [workload_vol_1] has been created. |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netapp_eseries/santricity/na_santricity_volume_module.html