Docs4dev
Docs
ansible / latest / collections / hpe / nimble / hpe_nimble_shelf_module.html

hpe.nimble.hpe_nimble_shelf – Manage the HPE Nimble Storage shelves

Note

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

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 hpe.nimble.

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

New in version 1.0.0: of hpe.nimble

Synopsis

  • Manage the shelves 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
accept_dedupe_impact
boolean
    Choices:
  • no
  • yes
Accept the reduction or elimination of deduplication capability on the system as a result of activating a shelf that does not meet the necessary deduplication requirements.
accept_foreign
boolean
    Choices:
  • no
  • yes
Accept the removal of data on the shelf disks and activate foreign shelf.
activated
boolean / required
    Choices:
  • no
  • yes
Activated state for shelf or disk set means it is available to store date on. An activated shelf may not be deactivated.
driveset
integer
Driveset to activate.
force
boolean
    Choices:
  • no
  • yes
Forcibly activate shelf.
host
string / required
HPE Nimble Storage IP address.
last_request
boolean
    Choices:
  • no
  • yes
Indicates this is the last request in a series of shelf add requests.
password
string / required
HPE Nimble Storage password.
shelf_serial
string / required
Serial number of shelf.
state
string / required
    Choices:
  • present
The shelf operation.
username
string / required
HPE Nimble Storage user name.

Notes

Note

  • This module does not support check_mode.

Examples

- name: Update shelf
  hpe.nimble.hpe_nimble_shelf:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    shelf_serial: "{{ shelf_serial | mandatory }}"
    accept_foreign: "{{ accept_foreign }}"
    force: "{{ force }}"
    activated: "{{ activated }}"
    state: present

Authors

© 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/hpe/nimble/hpe_nimble_shelf_module.html