cohesity.dataprotect.cohesity_clone_vm (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 clone the Virtual Machine.

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.

# Restore a single Virtual Machine
- name: Restore a Virtual Machine
  cohesity_clone_vm:
    cluster: cohesity.lab
    username: admin
    password: password
    state: present
    name: "Ansible Test VM Restore"
    endpoint: "myvcenter.cohesity.demo"
    environment: "VMware"
    job_name: "myvcenter.cohesity.demo"
    vm_names:
      - chs-win-01

Scanned by Steampunk Spotter

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

# Restore multiple Virtual Machines from a specific snapshot with a new prefix and disable the network
- name: Restore a Virtual Machine
  cohesity_clone_vm:
    cluster: cohesity.lab
    username: admin
    password: password
    state: present
    name: "Ansible Test VM Restore"
    endpoint: "myvcenter.cohesity.demo"
    environment: "VMware"
    job_name: "myvcenter.cohesity.demo"
    backup_id: "48291"
    vm_names:
      - chs-win-01
      - chs-win-02
    prefix: "rst-"
    network_connected: no

Inputs

    
name:
    description:
    - Descriptor to assign to the Recovery Job.  The Recovery Job name will consist of
      the job_name:name format.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines if the clone vm should be C(present) or C(absent) from the cluster
    type: str

prefix:
    description:
    - Specifies a prefix to prepended to the source object name to derive a new name for
      the recovered or cloned object.
    type: str

suffix:
    description: Specifies a suffix to appended to the original source object name to
      derive a new name      for the recovered or cloned object.
    type: str

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

job_name:
    description: Name of the Protection Job
    required: true
    type: str

power_on:
    default: true
    description:
    - Specifies the power state of the cloned or recovered objects. By default, the cloned
      or recovered objects are powered off.
    type: bool

vm_names:
    description:
    - List of virtual machines
    elements: str
    required: true
    type: list

view_name:
    description:
    - Name of the view
    type: str

environment:
    choices:
    - VMware
    default: VMware
    description:
    - Optional directory path to which the installer will be downloaded.  If not selected,
      then a temporary
    - directory will be created in the default System Temp Directory.  When choosing an
      alternate directory,
    - the directory and installer will not be deleted at the end of the execution.
    type: str

wait_for_job:
    default: true
    description:
    - Should wait until the Restore Job completes
    type: bool

wait_minutes:
    default: 30
    description:
    - Number of minutes to wait until the job completes.
    type: int

end_timestamp:
    description:
    - Option to identify backups based on a end timestamp
    required: false
    type: str

resource_pool:
    description:
    - Specifies the resource pool where the cloned or recovered objects are attached.
    required: true
    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
    - 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

start_timestamp:
    description:
    - Option to identify backups based on a start timestamp.
    required: false
    type: str

backup_timestamp:
    description:
    - Option to identify backups based on a timestamp
    required: false
    type: str

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

network_connected:
    default: true
    description:
    - Specifies whether the network should be left in disabled state. Attached network
      is enabled by default. Set this flag to true to disable it.
    type: bool