netapp_eseries.santricity.netapp_e_flashcache module – NetApp E-Series manage SSD caches

Note

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

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.netapp_e_flashcache.

New in netapp_eseries.santricity 2.2

Synopsis

  • Create or remove SSD caches on a NetApp E-Series storage array.

Parameters

Parameter

Comments

api_password

string / required

The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.

api_url

string / required

The url to the SANtricity WebServices Proxy or embedded REST API.

api_username

string / required

The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.

cache_size_min

integer

The minimum size (in size_units) of the ssd cache. The cache will be expanded if this exceeds the current size of the cache.

criteria_disk_phy_type

string

Type of physical disk

Choices:

  • "sas"

  • "sas4k"

  • "fibre"

  • "fibre520b"

  • "scsi"

  • "sata"

  • "pata"

disk_count

integer

The minimum number of disks to use for building the cache. The cache will be expanded if this number exceeds the number of disks already in place

disk_refs

list / elements=string

List of disk references

io_type

string

The type of workload to optimize the cache for.

Choices:

  • "filesystem" ← (default)

  • "database"

  • "media"

log_mode

string

Log mode

log_path

string

Log path

name

string / required

The name of the SSD cache to manage

size_unit

string

The unit to be applied to size arguments

Choices:

  • "bytes"

  • "b"

  • "kb"

  • "mb"

  • "gb" ← (default)

  • "tb"

  • "pb"

  • "eb"

  • "zb"

  • "yb"

ssid

string / required

The ID of the array to manage (as configured on the web services proxy).

state

string / required

Whether the specified SSD cache should exist or not.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

Should https certificates be validated?

Choices:

  • false

  • true ← (default)

Examples

- name: Flash Cache
  netapp_e_flashcache:
    ssid: "{{ ssid }}"
    api_url: "{{ netapp_api_url }}"
    api_username: "{{ netapp_api_username }}"
    api_password: "{{ netapp_api_password }}"
    validate_certs: "{{ netapp_api_validate_certs }}"
    name: SSDCacheBuiltByAnsible

Return Values

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

Key

Description

msg

string

Success message

Returned: success

Sample: "json for newly created flash cache"

Authors

  • Kevin Hulquest (@hulquest)