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

From Get docs
Ansible/docs/2.10/collections/community/general/emc vnx sg member module


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

Note

This plugin is part of the community.general collection (version 1.3.2).

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 Choices/Defaults Comments

lunid

string / 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

Default:

"sysadmin"

password for accessing SP.

sp_user

string

Default:

"sysadmin"

Username for accessing SP.

state

string

  • present

  • absent

Indicates the desired lunid state.

present ensures specified lunid is present in the Storage Group.

absent ensures specified lunid is absent from Storage Group.



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 Returned Description

hluid

integer

success

LUNID that hosts attached to the storage group will see.





Authors

  • Luca ‘remix_tj’ Lorenzetto (@remixtj)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/emc_vnx_sg_member_module.html