hpe.nimble.hpe_nimble_fc – Manage the HPE Nimble Storage Fibre Channel

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

New in version 1.0.0: of hpe.nimble

Synopsis

  • Manage storage Fibre Channel 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
array_name_or_serial
string / required
Name or serial number of array where the interface is hosted.
controller
string
Name (A or B) of the controller where the interface is hosted.
host
string / required
HPE Nimble Storage IP address.
hw_upgrade
boolean
    Choices:
  • no
  • yes
Update fibre channel configuration after hardware changes. Possible values:- 'true' 'false'.
name
string
Name of fibre channel interface
online
boolean
    Choices:
  • no
  • yes
Identify whether the fibre channel interface is online. Possible values:- 'true' 'false'.
password
string / required
HPE Nimble Storage password.
precheck
boolean
    Choices:
  • no
  • yes
Check if the interfaces are offline before regenerating the WWNN. Possible values:- 'true' 'false'.
regenerate
boolean
    Choices:
  • no
  • yes
Regenerate fibre channel configuration. Possible values:- 'true' 'false'.
state
string / required
    Choices:
  • present
The fibre channel operation.
username
string / required
HPE Nimble Storage user name.
wwnn_base_str
string
Base WWNN. Six bytes expressed in hex separated by colons. Example:- 'af:32:f1'.

Notes

Note

  • This module does not support check_mode.

Examples

- name: Update fibre channel interface
  hpe.nimble.hpe_nimble_fc:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    array_name_or_serial: "{{ array_name_or_serial | mandatory }}"
    name: "{{ name | mandatory }}"
    controller: "{{ controller | mandatory }}"
    online: "{{ online | mandatory }}"
    state: "{{ 'present' }}"

- name: Regenerate fibre channel config
  hpe.nimble.hpe_nimble_fc:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    array_name_or_serial: "{{ array_name_or_serial | mandatory }}" # provide the group_leader_array name
    wwnn_base_str: "{{ wwnn_base_str | mandatory }}"
    regenerate: true
    precheck: true
    state: "{{ 'present' }}"

- name: Hardware upgrade for fibre channel
  hpe.nimble.hpe_nimble_fc:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    array_name_or_serial: "{{ array_name_or_serial | mandatory }}"
    hw_upgrade: true
    state: "{{ 'present' }}"

Authors