hpe.nimble.hpe_nimble_performance_policy – Manage the HPE Nimble Storage performance policies

Note

This plugin is part of the hpe.nimble collection (version 1.1.3).

To install it use: ansible-galaxy collection install hpe.nimble.

To use it in a playbook, specify: hpe.nimble.hpe_nimble_performance_policy.

New in version 1.0.0: of hpe.nimble

Synopsis

  • Manage the performance policies on an HPE Nimble Storage group.

Requirements

The below requirements are needed on the host that executes this module.

  • Ansible 2.9 or later

  • Python 3.6 or later

  • HPE Nimble Storage SDK for Python

  • HPE Nimble Storage arrays running NimbleOS 5.0 or later

Parameters

Parameter Choices/Defaults Comments
app_category
string
Specifies the application category of the associated volume.
block_size
integer
Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created.
cache
boolean
    Choices:
  • no
  • yes
Flag denoting if data in the associated volume should be cached.
cache_policy
string
    Choices:
  • disabled
  • normal
  • aggressive
  • no_write
  • aggressive_read_no_write
Specifies how data of associated volume should be cached. Normal policy caches data but skips in certain conditions such as sequential I/O. Aggressive policy will accelerate caching of all data belonging to this volume, regardless of sequentiality.
change_name
string
Change name of the existing performance policy.
compress
boolean
    Choices:
  • no
  • yes
Flag denoting if data in the associated volume should be compressed.
dedupe
boolean
    Choices:
  • no
  • yes
Specifies if dedupe is enabled for volumes created with this performance policy.
description
string
Description of a performance policy.
host
string / required
HPE Nimble Storage IP address.
name
string / required
Name of the performance policy.
password
string / required
HPE Nimble Storage password.
space_policy
string
    Choices:
  • invalid
  • offline
  • non_writable
  • read_only
  • login_only
Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'.
state
string / required
    Choices:
  • present
  • absent
  • create
The performance policy operation.
username
string / required
HPE Nimble Storage user name.

Notes

Note

  • This module does not support check_mode.

Examples

# if state is create , then create a performance policy if not present. Fails if already present.
# if state is present, then create a performance policy if not present. Succeed if it already exists.
- name: Create performance policy if not present
  hpe.nimble.hpe_nimble_performance_policy:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: "{{ state | default('present') }}"
    name: "{{ name }}"
    description: "{{ description }}"
    block_size: "{{ block_size }}"
    compress: "{{ compress }}"

- name: Delete performance policy
  hpe.nimble.hpe_nimble_performance_policy:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: absent

Authors