hpe.nimble.hpe_nimble_array – Manage the HPE Nimble Storage array

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

New in version 1.0.0: of hpe.nimble

Synopsis

  • Manage the array 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
allow_lower_limits
boolean
    Choices:
  • no
  • yes
A True setting will allow you to add an array with lower limits to a pool with higher limits.
change_name
string
Change the name of the existing array.
create_pool
boolean
    Choices:
  • no
  • yes
Whether to create an associated pool during the array creation.
ctrlr_a_support_ip
string
Controller A Support IP Address. Four numbers in the range (0,255) separated by periods.
ctrlr_b_support_ip
string
Controller B Support IP Address. Four numbers in the range (0,255) separated by periods.
failover
boolean
    Choices:
  • no
  • yes
Perform a failover on the specified array.
force
boolean
    Choices:
  • no
  • yes
Forcibly delete the specified array.
halt
boolean
    Choices:
  • no
  • yes
Halt the specified array. Restarting the array will require physically powering it back on.
host
string / required
HPE Nimble Storage IP address.
name
string / required
The user-provided name of the array. It is also the array's hostname.
nic_list
list / elements=dictionary
List NICs information. Used when creating an array.
password
string / required
HPE Nimble Storage password.
pool_description
string
Text description of the pool to be created during array creation.
pool_name
string
Name of pool to which this is a member.
reboot
boolean
    Choices:
  • no
  • yes
Reboot the specified array.
secondary_mgmt_ip
string
Secondary management IP address for the group.
serial
string
Serial number of the array.
state
string / required
    Choices:
  • create
  • present
  • absent
The array 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 array if not present. Fails if already present.
# if state is present, then create a array if not present. Succeed if it already exists.
- name: Create array if not present
  hpe.nimble.hpe_nimble_array:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: "{{ state | default('present') }}"
    name: "{{ name }}"
    ctrlr_b_support_ip: "{{ ctrlr_b_support_ip | mandatory}}"
    ctrlr_a_support_ip: "{{ ctrlr_a_support_ip | mandatory}}"
    serial: "{{ serial | mandatory}}"
    nic_list: "{{ nic_list | mandatory}}"
    pool_name: "{{ pool_name | mandatory}}"

- name: Delete array
  hpe.nimble.hpe_nimble_array:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    vol_name: "{{ansible_default_ipv4['address']}}-{{ vol_name }}"
    name: "{{ name }}"
    state: absent

- name: Failover array
  hpe.nimble.hpe_nimble_array:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    failover: true
    state: present

- name: Halt array
  hpe.nimble.hpe_nimble_array:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: present
    halt: true

- name: Reboot array
  hpe.nimble.hpe_nimble_array:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: present
    reboot: true

Authors