ibm.storage_virtualize.ibm_svc_manage_migration (2.3.1) — module

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1

Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

Ansible interface to manage the migration commands.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a target volume
        Create a relationship
        Replicate hosts from source volume to target volume
        Start a relationship
  ibm.storage_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 }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Switch replication direction
  ibm.storage_virtualize.ibm_svc_manage_migration:
    relationship_name: "migrate_vol"
    clustername: "{{ source_cluster }}"
    token: "{{ source_cluster_token }}"
    state: switch
    log_path: /tmp/ansible.log

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete source volume and migration relationship
  ibm.storage_virtualize.ibm_svc_manage_migration:
    clustername: "{{ source_cluster }}"
    state: cleanup
    source_volume: "src_vol"
    token: "{{ source_cluster_token }}"
    log_path : /tmp/ansible.log

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Migration an existing vol from pool0 to pool1
  ibm.storage_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

Inputs

    
state:
    choices:
    - initiate
    - switch
    - cleanup
    description:
    - Specifies the different states of the migration process when I(type_of_migration=across_clusters).
    - C(initiate), creates a volume on remote cluster; optionally used to replicate hosts,
      and to create and start a migration relationship.
    - C(switch), switches the migration relationship direction allowing write access on
      the target volume.
    - C(cleanup), deletes the source volume and migration relationship after a 'switch'.
    type: str

token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the ibm_svc_auth module.
    type: str

domain:
    description:
    - Domain for the Storage Virtualize system.
    - Valid when hostname is used for the parameter I(clustername).
    type: str

log_path:
    description:
    - Path of debug log file.
    type: str

new_pool:
    description:
    - Specifies the pool on which the volume has to be migrated.
    - Valid only when I(type_of_migration=across_pools).
    type: str
    version_added: 1.11.0
    version_added_collection: ibm.storage_virtualize

password:
    description:
    - REST API password for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user on the local system.
    type: str

username:
    description:
    - REST API username for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user on the local system.
    type: str

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

remote_pool:
    description:
    - Specifies the pool on which the volume on Partner Storage Virtualize system should
      get created.
    - Required when I(state=initiate).
    type: str

remote_token:
    description:
    - The authentication token to verify a user on the partner Storage Virtualize system.
    - To generate a token, use the ibm_svc_auth module. Valid when I(state=initiate).
    type: str

source_volume:
    description:
    - Specifies the name of the existing source volume to be used in migration.
    - Required when I(state=initiate) or I(state=cleanup) or I(type_of_migration=across_pools).
    type: str

target_volume:
    description:
    - Specifies the name of the volume to be created on the target system.
    - Required when I(state=initiate).
    type: str

remote_cluster:
    description:
    - Specifies the name of the remote cluster.
    - Required when I(state=initiate).
    type: str

validate_certs:
    default: false
    description:
    - Validates certification.
    type: bool

remote_password:
    description:
    - REST API password for the partner Storage Virtualize system.
    - The parameters I(remote_username) and I(remote_password) are required if not using
      I(remote_token) to authenticate a user on the partner system.
    - Valid when I(state=initiate).
    type: str

remote_username:
    description:
    - REST API username for the partner Storage Virtualize system.
    - The parameters I(remote_username) and I(remote_password) are required if not using
      I(remote_token) to authenticate a user on the partner system.
    - Valid when C(state=initiate).
    type: str

replicate_hosts:
    default: false
    description:
    - 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 I(state=initiate).
    type: bool

relationship_name:
    description:
    - Name of the migration relationship. Required when I(state=initiate) or I(state=switch).
    type: str

type_of_migration:
    choices:
    - across_pools
    - across_clusters
    default: across_clusters
    description:
    - Specifies the type of migration whether it is migration across pools or migration
      across clusters
    type: str
    version_added: 1.11.0
    version_added_collection: ibm.storage_virtualize

remote_validate_certs:
    default: false
    description:
    - Validates certification for partner Storage Virtualize system.
    - Valid when I(state=initiate).
    type: bool