community.general.emc_vnx_sg_member module – Manage storage group member on EMC VNX

Note

This module is part of the community.general collection (version 4.8.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 community.general.

To use it in a playbook, specify: community.general.emc_vnx_sg_member.

Synopsis

  • This module manages the members of an existing storage group.

Requirements

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

  • An EMC VNX Storage device.

  • Ansible 2.7.

  • storops (0.5.10 or greater). Install using ‘pip install storops’.

Parameters

Parameter

Comments

lunid

integer / required

Lun id to be added.

name

string / required

Name of the Storage group to manage.

sp_address

string / required

Address of the SP of target/secondary storage.

sp_password

string

password for accessing SP.

Default: “sysadmin”

sp_user

string

Username for accessing SP.

Default: “sysadmin”

state

string

Indicates the desired lunid state.

present ensures specified lunid is present in the Storage Group.

absent ensures specified lunid is absent from Storage Group.

Choices:

  • present ← (default)

  • absent

Notes

Note

  • The modules prefixed with emc_vnx are built to support the EMC VNX storage platform.

Examples

- name: Add lun to storage group
  community.general.emc_vnx_sg_member:
    name: sg01
    sp_address: sp1a.fqdn
    sp_user: sysadmin
    sp_password: sysadmin
    lunid: 100
    state: present

- name: Remove lun from storage group
  community.general.emc_vnx_sg_member:
    name: sg01
    sp_address: sp1a.fqdn
    sp_user: sysadmin
    sp_password: sysadmin
    lunid: 100
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

hluid

integer

LUNID that hosts attached to the storage group will see.

Returned: success

Authors

  • Luca ‘remix_tj’ Lorenzetto (@remixtj)