Docs4dev
Docs
ansible / latest / collections / netapp_eseries / santricity / netapp_e_flashcache_module.html

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

Note

This plugin is part of the netapp_eseries.santricity collection (version 1.2.13).

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 version 2.2: of netapp_eseries.santricity

Synopsis

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

Parameters

Parameter Choices/Defaults 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
    Choices:
  • sas
  • sas4k
  • fibre
  • fibre520b
  • scsi
  • sata
  • pata
Type of physical disk
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
    Choices:
  • filesystem ←
  • database
  • media
The type of workload to optimize the cache for.
log_mode
string
Log mode
log_path
string
Log path
name
string / required
The name of the SSD cache to manage
size_unit
string
    Choices:
  • bytes
  • b
  • kb
  • mb
  • gb ←
  • tb
  • pb
  • eb
  • zb
  • yb
The unit to be applied to size arguments
ssid
string / required
The ID of the array to manage (as configured on the web services proxy).
state
string / required
    Choices:
  • present ←
  • absent
Whether the specified SSD cache should exist or not.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Should https certificates be validated?

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 Returned Description
msg
string
success
Success message

Sample:
json for newly created flash cache


Authors

  • Kevin Hulquest (@hulquest)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp_eseries/santricity/netapp_e_flashcache_module.html