cohesity.dataprotect.cohesity_cancel_migration (1.1.9) — module

Install collection

Install with ansible-galaxy collection install cohesity.dataprotect:==1.1.9

Add to requirements.yml

  collections:
    - name: cohesity.dataprotect
      version: 1.1.9

Description

Ansible Module used to Cancel a Cohesity Migration Job on a Cohesity Cluster.

When executed in a playbook, the Cohesity migration Job will be Canceld.

Requirements

• python >= 3.6
• cohesity_management_sdk >= 1.6.0

Usage examples

Scanned by Steampunk Spotter

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

# Cancel migration.
- name: Cancel a Virtual Machine Migration
  cohesity_cancel_migration:
    cluster: cohesity.lab
    username: admin
    password: password
    state: present
    task_name: "Ansible Test VM Restore"

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines the state of the Recovery Job.
    - (C)present a recovery job will be created and started.
    - (C)absent is currently not implemented
    type: str

cluster:
    aliases:
    - cohesity_server
    description:
    - IP or FQDN for the Cohesity Cluster
    type: str

task_id:
    description:
    - Task Id of the migrate job.
    type: str

task_name:
    description:
    - Name of the recovery task name.
    type: str

cohesity_admin:
    aliases:
    - admin_name
    - cohesity_user
    - username
    description:
    - Username with which Ansible will connect to the Cohesity Cluster. Domain Specific
      credentails can be configured in following formats
    - AD.domain.com/username
    - AD.domain.com/username@tenant
    - LOCAL/username@tenant
    type: str

validate_certs:
    aliases:
    - cohesity_validate_certs
    default: true
    description:
    - Switch determines if SSL Validation should be enabled.
    type: bool

cohesity_password:
    aliases:
    - password
    - admin_pass
    description:
    - Password belonging to the selected Username.  This parameter will not be logged.
    type: str