W3cubDocs

/Ansible

ibm.storage_virtualize.ibm_sv_manage_flashsystem_grid module – This module manages flashsystem-grid operations on IBM Storage Virtualize family storage systems

Note

This module is part of the ibm.storage_virtualize collection (version 2.7.4).

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 ibm.storage_virtualize.

To use it in a playbook, specify: ibm.storage_virtualize.ibm_sv_manage_flashsystem_grid.

New in ibm.storage_virtualize 2.7.0

Synopsis

  • Ansible interface to manage flashsystem-grid operations.

Parameters

Parameter

Comments

action

string

Specifies action to be run.

Choices:

  • "join"
  • "accept"
  • "remove"

clustername

string / required

The hostname or management IP of the Storage Virtualize storage system.

domain

string

Domain for the Storage Virtualize storage system.

Valid when hostname is used for the parameter clustername.

log_path

string

Path of debug log file.

name

string

Specifies the name of the flashsystem-grid.

password

string

REST API password for the Storage Virtualize storage system.

The parameters username and password are required if not using token to authenticate a user.

state

string / required

Specify as present to create, and to update, and absent to remove a flashsystem-grid.

Choices:

  • "present"
  • "absent"

target_cluster_name

string

The FQDN name or IP of the flashsystem-grid coordinator (in case of join action) or member cluster (in case of accept or remove action).

token

string

The authentication token to verify a user on the Storage Virtualize storage system.

To generate a token, use the ibm_svc_auth module.

truststore

string

Specifies the truststore name to be used for join or accept.

username

string

REST API username for the Storage Virtualize storage system.

The parameters username and password are required if not using token to authenticate a user.

validate_certs

boolean

Validates certification.

Choices:

  • false ← (default)
  • true

Notes

Note

  • This module supports check_mode.
  • This module requires root-certificate exchange between coordinator and member as a pre-requisite for join/accept.
  • If user tries to create flashsystem grid on a cluster that is already part of a flashsystem-grid or a flashsystem grid member tries to join another flashsystem-grid, the module will fail with error “CMMVC1265E The command failed as this system is already a member of a Flash Grid”.
  • If a flashsystem grid coordinator tries to join another flashsystem grid, the module will fail with error “CMMVC6036E This system is flashsystem grid coordinator”.

Examples

- name: Create flashsystem-grid fg0 (this cluster becomes flashsystem-grid owner, also called coordinator)
  ibm.storage_virtualize.ibm_sv_manage_flashsystem_grid:
   clustername: "{{ clustername }}"
   username: "{{ username }}"
   password: "{{ password }}"
   domain: "{{ domain }}"
   name: "fg0"
   state: present
   log_path: /tmp/playbook.debug
- name: Send a join request from requestor to a flashsystem-grid owner
  ibm.storage_virtualize.ibm_sv_manage_flashsystem_grid:
   clustername: "{{ requestor_ip }}"
   username: "{{ requestor_username }}"
   password: "{{ requestor_password }}"
   log_path: /tmp/playbook.debug
   target_cluster_name: "{{ flashsystemgrid_owner_ip_or_fqdn }}"
   truststore: "{{ flashsystemgrid_owner_truststore }}"
   action: join
   state: present
- name: Accept incoming join request
  ibm.storage_virtualize.ibm_sv_manage_flashsystem_grid:
   clustername: "{{ flashsystemgrid_owner_ip }}"
   username: "{{ flashsystemgrid_owner_username }}"
   password: "{{ flashsystemgrid_owner_password }}"
   log_path: /tmp/playbook.debug
   target_cluster_name: "{{ requestor_member_ip_or_fqdn }}"
   truststore: "{{ requestor_truststore }}"
   action: accept
   state: present
- name: Remove a member from flashsystem-grid
  ibm.storage_virtualize.ibm_sv_manage_flashsystem_grid:
   clustername: "{{ flashsystemgrid_owner_ip }}"
   username: "{{ flashsystemgrid_owner_username }}"
   password: "{{ flashsystemgrid_owner_password }}"
   target_cluster_name: "{{ requestor_ip }}"
   log_path: /tmp/playbook.debug
   action: remove
   state: present
- name: Delete flashsystem-grid fg0
  ibm.storage_virtualize.ibm_sv_manage_flashsystem_grid:
   clustername: "{{ flashsystemgrid_owner_ip }}"
   username: "{{ flashsystemgrid_owner_username }}"
   password: "{{ flashsystemgrid_owner_password }}"
   log_path: /tmp/playbook.debug
   state: absent

Authors

  • Sumit Kumar Gupta (@sumitguptaibm)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ibm/storage_virtualize/ibm_sv_manage_flashsystem_grid_module.html