hpe.nimble.hpe_nimble_access_control_record – Manage the HPE Nimble Storage access control records

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

New in version 1.0.0: of hpe.nimble

Synopsis

  • Manage the access control records 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
apply_to
string
    Choices:
  • volume
  • snapshot
  • both
The type of object to which this access control record applies.
chap_user
string
Name for the CHAP user.
host
string / required
HPE Nimble Storage IP address.
initiator_group
string / required
The initiator group name.
lun
integer
If this access control record applies to a regular volume, this attribute is the volume's LUN (Logical Unit Number).
If the access protocol is iSCSI, the LUN will be 0. However, if the access protocol is Fibre Channel, the LUN will be in the range from 0 to 2047.
password
string / required
HPE Nimble Storage password.
state
string / required
    Choices:
  • present
  • absent
  • create
The access control record operation.
username
string / required
HPE Nimble Storage user name.
volume
string / required
The name of the volume that this access control record applies to.

Notes

Note

  • This module does not support check_mode.

Examples

# If state is "create", create access control record for given volume, fails if it exist.
# if state is present, create access control record if not already present.
- name: Create access control record for volume
  hpe.nimble.hpe_nimble_access_control_record:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    volume: "{{ volume }}"
    initiator_group: "{{ initiator_group }}"
    state: "{{ state | default('present') }}"

# Delete the access control record for a given volume name
- name: Delete access control record for volume
  hpe.nimble.hpe_nimble_access_control_record:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    volume: "{{ volume }}"
    initiator_group: "{{ initiator_group }}"
    state: "absent" # fail if volume does not exist

Authors