Ansible Collection - ibm.storage_virtualize

This collection provides a series of Ansible modules and plugins for interacting with the IBM Storage Virtualize family products. These products include the IBM SAN Volume Controller, IBM FlashSystem family members built with IBM Storage Virtualize (FlashSystem 5xxx, 7xxx, 9xxx), IBM Storwize family, and IBM Storage Virtualize for Public Cloud. For more information regarding these products, see IBM Documentation.

Communication

Join the Ansible forum:
- Get Help: get help or help others. Please use appropriate tags.
- Social Spaces: gather and interact with fellow enthusiasts.
- News & Announcements: track project-wide announcements including social events.
The Ansible Bullhorn newsletter: used to announce releases and important changes.

For more information about communication, see the Ansible communication guide.

Requirements

Ansible version 2.15 or higher
Python 3.9 or higher for controller nodes

Installation

To install the IBM Storage Virtualize collection hosted in Galaxy:

ansible-galaxy collection install ibm.storage_virtualize

To upgrade to the latest version of the IBM Storage Virtualize collection:

ansible-galaxy collection install ibm.storage_virtualize --force

Usage

Playbooks

To use a module from the IBM Storage Virtualize collection, please reference the full namespace, collection name, and module name that you want to use:

---
- name: Using the IBM Storage Virtualize collection
  hosts: localhost
  tasks:
    - name: Gather info from storage
      ibm.storage_virtualize.ibm_svc_info:
        clustername: x.x.x.x
        domain:
        username: username
        password: password
        log_path: /tmp/playbook.debug
        gather_subset: all

Alternatively, you can add a full namepsace and collection name in the collections element:

---
- name: Using the IBM Storage Virtualize collection
  collections:
    - ibm.storage_virtualize
  gather_facts: no
  connection: local
  hosts: localhost
  tasks:
    - name: Gather info from storage
      ibm_svc_info:
        clustername: x.x.x.x
        domain:
        username: username
        password: password
        log_path: /tmp/playbook.debug
        gather_subset: all

Supported Resources

Modules

ibm_svc_auth - Generates an authentication token for a user on Storage Virtualize systems
ibm_svc_complete_initial_setup - Completes the initial setup configuration for LMC systems
ibm_svc_host - Manages hosts on Storage Virtualize systems
ibm_svc_hostcluster - Manages host cluster on Storage Virtualize systems
ibm_svc_info - Collects information on Storage Virtualize systems
ibm_svc_initial_setup - Manages initial setup configuration on Storage Virtualize systems
ibm_svc_manage_callhome - Manages configuration of Call Home feature on Storage Virtualize systems
ibm_svc_manage_consistgrp_flashcopy - Manages FlashCopy consistency groups on Storage Virtualize systems
ibm_svc_manage_cv - Manages the change volume in remote copy replication on Storage Virtualize systems
ibm_svc_manage_flashcopy - Manages FlashCopy mappings on Storage Virtualize systems
ibm_svc_manage_ip - Manages IP provisioning on Storage Virtualize systems
ibm_svc_manage_migration - Manages volume migration between clusters on Storage Virtualize systems
ibm_svc_manage_mirrored_volume - Manages mirrored volumes on Storage Virtualize systems
ibm_svc_manage_ownershipgroup - Manages ownership groups on Storage Virtualize systems
ibm_svc_manage_portset - Manages IP portset on Storage Virtualize systems
ibm_svc_manage_replication - Manages remote copy replication on Storage Virtualize systems
ibm_svc_manage_replicationgroup - Manages remote copy consistency groups on Storage Virtualize systems
ibm_svc_manage_safeguarded_policy - Manages safeguarded policy configuration on Storage Virtualize systems
ibm_svc_manage_sra - Manages the remote support assistance configuration on Storage Virtualize systems
ibm_svc_manage_user - Manages user on Storage Virtualize systems
ibm_svc_manage_usergroup - Manages user groups on Storage Virtualize systems
ibm_svc_manage_volume - Manages standard volumes on Storage Virtualize systems
ibm_svc_manage_volumegroup - Manages volume groups on Storage Virtualize systems
ibm_svc_mdisk - Manages MDisks for Storage Virtualize systems
ibm_svc_mdiskgrp - Manages pools for Storage Virtualize systems
ibm_svc_start_stop_flashcopy - Starts or stops FlashCopy mapping and consistency groups on Storage Virtualize systems
ibm_svc_start_stop_replication - Starts or stops remote-copy independent relationships or consistency groups on Storage Virtualize systems
ibm_svc_vol_map - Manages volume mapping for Storage Virtualize systems
ibm_svcinfo_command - Runs svcinfo CLI command on Storage Virtualize systems over SSH session
ibm_svctask_command - Runs svctask CLI command(s) on Storage Virtualize systems over SSH session
ibm_sv_manage_awss3_cloudaccount - Manages Amazon S3 cloud account configuration on Storage Virtualize systems
ibm_sv_manage_cloud_backup - Manages cloud backups on Storage Virtualize systems
ibm_sv_manage_drive - Manages drive state changes, tasks and dump
ibm_sv_manage_fc_partnership - Manages Fibre Channel (FC) partnership on Storage Virtualize systems
ibm_sv_manage_fcportsetmember - Manages addition or removal of ports from the Fibre Channel (FC) portsets on Storage Virtualize systems
ibm_sv_manage_ip_partnership - Manages IP partnership configuration on Storage Virtualize systems
ibm_sv_manage_provisioning_policy - Manages provisioning policy configuration on Storage Virtualize systems
ibm_sv_manage_replication_policy - Manages policy-based replication configuration on Storage Virtualize systems
ibm_sv_manage_security - Manages configuration of security options on IBM Storage Virtualize family storage systems
ibm_sv_manage_snapshot - Manages snapshots (mutual consistent images of a volume) on Storage Virtualize systems
ibm_sv_manage_snapshotpolicy - Manages snapshot policy configuration on Storage Virtualize systems
ibm_sv_manage_ssl_certificate - Exports an existing system certificate on to Storage Virtualize systems
ibm_sv_manage_storage_partition - Manages storage partition configuration on Storage Virtualize systems
ibm_sv_manage_syslog_server - Manages syslog server configuration on Storage Virtualize systems
ibm_sv_manage_truststore_for_replication - Manages certificate trust stores for replication on Storage Virtualize family systems
ibm_sv_restore_cloud_backup - Restores cloud backups on Storage Virtualize systems
ibm_sv_switch_replication_direction - Switches the replication direction on Storage Virtualize systems

Other Feature Information

SV Ansible Collection v1.8.0 provides the new 'ibm_svc_complete_initial_setup' module, to complete the automation of Day 0 configuration on Licensed Machine Code (LMC) systems. For non-LMC systems, login to the user-interface is required in order to complete the automation of Day 0 configuration.
SV Ansible Collection v1.7.0 provided Setup and Configuration Automation through different modules. This feature helps user to automate Day 0 configuration. This feature includes three modules:
- ibm_svc_initial_setup
- ibm_svc_manage_callhome
- ibm_svc_manage_sra
By proceeding and using these modules, the user acknowledges that IBM Privacy Statement has been read and understood.

Prerequisite

Paramiko must be installed to use ibm_svctask_command and ibm_svcinfo_command modules.

Limitation

The modules in the IBM Storage Virtualize Ansible collection leverage REST APIs to connect to the IBM Storage Virtualize system. This has following limitations:

Using the REST APIs to list more than 2000 objects may create a loss of service from the API side, as it automatically restarts due to memory constraints.
It is not possible to access REST APIs using an IPv6 address on a cluster.
The Ansible collection can run on all IBM Storage Virtualize system versions above 8.1.3, except versions 8.3.1.3, 8.3.1.4 and 8.3.1.5.
At time of release of the SV Ansible v1.8.0 collection, no module is available for non LMC systems to automate license agreements acceptance, including EULA. User will be presented with a GUI setup wizard upon user-interface login, whether the Ansible modules have been used for initial configuration or not.

Releasing, Versioning, and Deprecation

IBM Storage Virtualize Ansible Collection releases follow a quarterly release cycle.
IBM Storage Virtualize Ansible Collection releases follow semantic versioning.
IBM Storage Virtualize Ansible modules deprecation cycle is aligned with Ansible.

Contributing

Currently we are not accepting community contributions. Though, you may periodically review this content to learn when and how contributions can be made in the future. IBM Storage Virtualize Ansible Collection maintainers can follow the Maintainer guidelines.

License

GNU General Public License v3.0

ansible-collections / ibm.storage_virtualize

readme