models.clone_task_request module

class models.clone_task_request.CloneTaskRequest(name=None, mtype=None, clone_view_parameters=None, continue_on_error=None, glacier_retrieval_type=None, hyperv_parameters=None, new_parent_id=None, objects=None, target_view_name=None, vlan_parameters=None, vmware_parameters=None)[source]

Bases: object

Implementation of the ‘CloneTaskRequest’ model.

Specifies the settings for a Restore Task that clones VMs or Views.

clone_view_parameters (CloneViewRequest): Specifies settings for

cloning an existing View. This field is required for a ‘kCloneView’ Restore Task.

continue_on_error (bool): Specifies if the Restore Task should

continue when some operations on some objects fail. If true, the Cohesity Cluster ignores intermittent errors and restores as many objects as possible.

glacier_retrieval_type (GlacierRetrievalTypeEnum): Specifies the way

data needs to be retrieved from the external target. This information will be filled in by Iris and Magneto will pass it along to the Icebox as it is to support bulk retrieval from Glacier. Specifies the type of Restore Task. ‘kStandard’ specifies retrievals that allow to access any of your archives within several hours. Standard retrievals typically complete within 3–5 hours.This is the default option for retrieval requests that do not specify the retrieval option. ‘kBulk’ specifies retrievals that are Glacier’s lowest-cost retrieval option, which can be use to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrieval typically complete within 5–12 hours. ‘kExpedited’ specifies retrievals that allows to quickly access your data when occasional urgent requests for a subset of archives are required. For all but the largest archives (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes.

hyperv_parameters (HypervCloneParameters): Specifies information

needed when cloning VMs in HyperV enviroment. This field defines the HyperV specific params for restore tasks of type kCloneVMs.

name (string): Specifies the name of the Restore Task. This field must

be set and must be a unique name.

new_parent_id (long|int): Specify a new registered parent Protection

Source. If specified the selected objects are cloned or recovered to this new Protection Source. If not specified, objects are cloned or recovered to the original Protection Source that was managing them.

objects (list of RestoreObjectDetails): Array of Objects. Specifies a

list of Protection Source objects or Protection Job objects (with specified Protection Source objects).

target_view_name (string): Specifies the name of the View where the

cloned VMs are stored. This field is required for a ‘kCloneVMs’ Restore Task.

mtype (TypeCloneTaskRequestEnum): Specifies the type of Restore Task

such as ‘kCloneVMs’ or ‘kCloneView’. ‘kCloneVMs’ specifies a Restore Task that clones VMs. ‘kCloneView’ specifies a Restore Task that clones a View.

vlan_parameters (VlanParameters): Specifies VLAN parameters for the

restore operation.

vmware_parameters (VmwareCloneParameters): Specifies the information

required for recovering or cloning VmWare VMs.

classmethod from_dictionary(dictionary)[source]

Creates an instance of this model from a dictionary


dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.


object: An instance of this structure class.