ibm.spectrum_virtualize.ibm_svc_manage_migration module – This module manages volume migration between clusters on IBM Spectrum Virtualize family storage systems

Note

This module is part of the ibm.spectrum_virtualize collection (version 2.0.0).

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

To use it in a playbook, specify: ibm.spectrum_virtualize.ibm_svc_manage_migration.

New in ibm.spectrum_virtualize 1.6.0

Synopsis
Parameters
Notes
Examples

Synopsis

Ansible interface to manage the migration commands.

Parameters

Parameter	Comments
clustername string / required	The hostname or management IP of the Spectrum Virtualize storage system.
domain string	Domain for the Spectrum Virtualize storage system. Valid when hostname is used for the parameter clustername.
log_path string	Path of debug log file.
new_pool string added in ibm.spectrum_virtualize 1.11.0	Specifies the pool on which the volume has to be migrated. Valid only when type_of_migration=across_pools.
password string	REST API password for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user on the local system.
relationship_name string	Name of the migration relationship. Required when state=initiate or state=switch.
remote_cluster string	Specifies the name of the remote cluster. Required when state=initiate.
remote_password string	REST API password for the partner Spectrum Virtualize storage system. The parameters remote_username and remote_password are required if not using remote_token to authenticate a user on the partner system. Valid when state=initiate.
remote_pool string	Specifies the pool on which the volume on Partner Spectrum Virtualize storage system should get created. Required when state=initiate.
remote_token string	The authentication token to verify a user on the partner Spectrum Virtualize storage system. To generate a token, use the ibm_svc_auth module. Valid when state=initiate.
remote_username string	REST API username for the partner Spectrum Virtualize storage system. The parameters remote_username and remote_password are required if not using remote_token to authenticate a user on the partner system. Valid when `state=initiate`.
remote_validate_certs boolean	Validates certification for partner Spectrum Virtualize storage system. Valid when state=initiate. Choices: `false` ← (default) `true`
replicate_hosts boolean	Replicates the hosts mapped to a source volume on the source system, to the target system, and maps the hosts to the target volume. The user can use ibm_svc_host and ibm_svc_vol_map modules to create and map hosts to the target volume for an existing migration relationship. Valid when state=initiate. Choices: `false` ← (default) `true`
source_volume string	Specifies the name of the existing source volume to be used in migration. Required when state=initiate or state=cleanup or type_of_migration=across_pools.
state string	Specifies the different states of the migration process when type_of_migration=across_clusters. `initiate`, creates a volume on remote cluster; optionally used to replicate hosts, and to create and start a migration relationship. `switch`, switches the migration relationship direction allowing write access on the target volume. `cleanup`, deletes the source volume and migration relationship after a ‘switch’. Choices: `"initiate"` `"switch"` `"cleanup"`
target_volume string	Specifies the name of the volume to be created on the target system. Required when state=initiate.
token string	The authentication token to verify a user on the Spectrum Virtualize storage system. To generate a token, use the ibm_svc_auth module.
type_of_migration string added in ibm.spectrum_virtualize 1.11.0	Specifies the type of migration whether it is migration across pools or migration across clusters Choices: `"across_pools"` `"across_clusters"` ← (default)
username string	REST API username for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user on the local system.
validate_certs boolean	Validates certification. Choices: `false` ← (default) `true`

Notes

Note

This module supports check_mode.
This module supports both volume migration across pools and volume migration across clusters.
In case, user does not specify type_of_migration, the module shall proceed with migration across clusters by default.
In case of type_of_migration=across_pools, the only parameters allowed are new_pool and source_volume along with cluster credentials.

Examples

- name: Create a target volume
        Create a relationship
        Replicate hosts from source volume to target volume
        Start a relationship
  ibm.spectrum_virtualize.ibm_svc_manage_migration:
    source_volume: "src_vol"
    target_volume: "target_vol"
    clustername: "{{ source_cluster }}"
    remote_cluster: "{{ remote_cluster }}"
    token: "{{ source_cluster_token }}"
    state: initiate
    replicate_hosts: true
    remote_token: "{{ partner_cluster_token }}"
    relationship_name: "migrate_vol"
    log_path: /tmp/ansible.log
    remote_pool: "{{ remote_pool }}"
- name: Switch replication direction
  ibm.spectrum_virtualize.ibm_svc_manage_migration:
    relationship_name: "migrate_vol"
    clustername: "{{ source_cluster }}"
    token: "{{ source_cluster_token }}"
    state: switch
    log_path: /tmp/ansible.log
- name: Delete source volume and migration relationship
  ibm.spectrum_virtualize.ibm_svc_manage_migration:
    clustername: "{{ source_cluster }}"
    state: cleanup
    source_volume: "src_vol"
    token: "{{ source_cluster_token }}"
    log_path : /tmp/ansible.log
- name: Migration an existing vol from pool0 to pool1
  ibm.spectrum_virtualize.ibm_svc_manage_migration:
    clustername: "{{ source_cluster }}"
    token: "{{ source_cluster_token }}"
    log_path : /tmp/ansible.log
    type_of_migration : across_pools
    source_volume : vol1
    new_pool : pool1

Authors

Rohit Kumar(@rohitk-github)
Shilpi Jain(@Shilpi-J)

Collection links

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