models.perform_restore_task_state_proto module

class models.perform_restore_task_state_proto.PerformRestoreTaskStateProto(action_executor_target_type=None, backup_run_lock_vec=None, base=None, can_teardown=None, cdp_restore_progress_monitor_task_path=None, cdp_restore_task=None, cdp_restore_task_id=None, cdp_restore_view_name=None, child_clone_task_id=None, child_destroy_task_id=None, clone_app_view_info=None, cloud_deploy_info=None, continue_restore_on_error=None, create_view=None, datastore_entity_vec=None, deploy_vms_to_cloud_task_state=None, folder_entity=None, full_view_name=None, include_vm_config=None, mount_volumes_task_state=None, multi_restore_task_id=None, nosql_connect_params=None, nosql_recover_job_params=None, object_name_deprecated=None, objects=None, objects_progress_monitor_task_paths=None, parent_restore_job_id=None, parent_restore_task_id=None, path_prefix_deprecated=None, physical_flr_parallel_restore=None, physical_flr_use_new_locking_method=None, power_state_config=None, preserve_tags=None, progress_monitor_task_path=None, recover_disks_task_state=None, recover_volumes_task_state=None, related_restore_task_id=None, rename_restored_object_param=None, rename_restored_vapp_param=None, resource_pool_entity=None, restore_acropolis_vms_params=None, restore_app_task_state=None, restore_files_task_state=None, restore_groups_params=None, restore_hyperv_vm_params=None, restore_info=None, restore_kubernetes_namespaces_params=None, restore_kvm_vms_params=None, restore_one_drive_params=None, restore_outlook_params=None, restore_parent_source=None, restore_public_folders_params=None, restore_site_params=None, restore_standby_task_state=None, restore_sub_task_vec=None, restore_task_purged=None, restore_teams_params=None, restore_view_datastore_entity=None, restore_vmware_vm_params=None, restored_objects_network_config=None, restored_to_different_source=None, retrieve_archive_progress_monitor_task_path=None, retrieve_archive_stub_view_name=None, retrieve_archive_task_uid_vec=None, retrieve_archive_task_vec=None, retrieve_archive_view_name=None, selected_datastore_idx=None, skip_cloning_retrieve_archive_view=None, skip_image_deploy=None, stub_view_relative_dir_name=None, vault_restore_params=None, vcd_config=None, vcd_storage_profile_datastore_moref_vec=None, view_box_id=None, view_name_deprecated=None, view_params=None, volume_info_vec=None)

Bases: object

Implementation of the ‘PerformRestoreTaskStateProto’ model.

TODO: type model description here.

Attributes:

action_executor_target_type (int): Denotes the target for action

executor(Bridge / BridgeProxy) on which task on slave should execute actions.

backup_run_lock_vec (list of BackupRunId): Information about the

backup runs to lock during this restore.

base (RestoreTaskStateBaseProto): TODO: type description here. can_teardown (bool): This is set if the clone operation has created

any objects on the primary environment and teardown operation is possible. UI will disable the teardown button only if this is not set or set to false. NOTE: This won’t be reset if the teardown operation subsequently completes as teardown state is managed separately.

cdp_restore_progress_monitor_task_path (string): The path of the

progress monitor for the task that is responsible for creating the CDP hydrated view.

cdp_restore_task (PerformRestoreTaskStateProto): TODO: type

description here.

cdp_restore_task_id (long|int): The id of the task that will create

the CDP hydrated view.

cdp_restore_view_name (string): The temporary view where the hydrated

disks of the CDP restores are kept.

child_clone_task_id (long|int): The id of the child clone task

triggered by refresh op.

child_destroy_task_id (long|int): The following fields are used by

clone refresh op. These will be present only in case of refresh task op. The id of the child destroy clone task triggered by refresh op.

clone_app_view_info (CloneAppViewInfoProto): This message encapsulates

the information of Clone operation of backup view of an App.

cloud_deploy_info (CloudDeployInfoProto): Each available extension is

listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. The extension applies to both CloudDeployInfoProto as well as CloudDeployEntity. CloudDeployInfoProto extension Location Extension =================================================================== ========== aws::CloudDeployInfo::aws_cloud_deploy_info aws/aws.proto 100 azure::CloudDeployInfo::azure_cloud_deploy_info azure/azure.proto 101 gcp::CloudDeployInfo::gcp_cloud_deploy_info gcp/gcp.proto 102 aws::ReplicationInfo::aws_replication_info aws/aws.proto 103 azure::ReplicationInfo::azure_replication_info azure/azure.proto 104 =================================================================== ========== CloudDeployInfoProto.CloudDeployEntity extension Location Extension =================================================================== ========== aws::CloudDeployEntityInfo::aws_cloud_deploy_entity_info aws/aws.proto 100 vmware::RestoreEntityInfo::vmware_cloud_deploy_entity_info vmware/vmware.proto 101 azure::CloudDeployEntityInfo::azure_cloud_deploy_entity_info azure/azure.proto 102 gcp::CloudDeployEntityInfo::gcp_cloud_deploy_entity_info gcp/gcp.proto 103 hyperv::RestoreEntityInfo::hyperv_cloud_deploy_entity_info hyperv/hyperv.proto 104 aws::ReplicationEntityInfo::aws_replication_entity_info aws/aws.proto 105 aws::ReplicationEntityInfo::azure_replication_entity_info azure/azure.proto 106 =================================================================== ==========

continue_restore_on_error (bool): Whether to continue with the restore

operation if restore of any object fails.

create_view (bool): True iff the target view needs to be created. datastore_entity_vec (list of EntityProto): Please refer to comments

for the field CreateRestoreTaskArg.datastore_entity_vec for more details.

deploy_vms_to_cloud_task_state (DeployVMsToCloudTaskStateProto): TODO:

type description here.

folder_entity (EntityProto): Specifies the attributes and the latest

statistics about an entity.

full_view_name (string): The full view name (internal or external).

This is composed of an optional Cohesity specific prefix and the user provided view name.

include_vm_config (bool): This is set to true if the vm-config.xml

need to be copied in the target view/folder.

mount_volumes_task_state (MountVolumesTaskStateProto): TODO: type

description here.

multi_restore_task_id (long|int): The id of the task that is created to

restore multiple apps. For e.g., user requested to restore multiple databases or multiple AD objects. When the user requests to restore ‘n’ objects, we will create ‘n+1’ restore tasks with ‘n’ child tasks and one multi restore task. The relationship is maintained by stamping the id of the multi restore task on all the child tasks using this parameter.

nosql_connect_params (NoSqlConnectParams): Parameters to connect to

destination nosql parent entity.

nosql_recover_job_params (NoSqlRecoverJobParams): Additional

parameters for the recovery job to send to imanis server.

object_name_deprecated (string): An optional name to give to the

restored object.

objects (list of RestoreObject): Information on the exact set of

objects being restored (along with snapshots they are being recovered from). Even if the user wanted to restore an entire job from the latest snapshot, this will have individual objects and the exact snapshot they are being restored from. If specified, this can only have leaf-level entities.

objects_progress_monitor_task_paths (list of string): Vector

containing the relative task path of progress monitors of the objects in the above field ‘objects’ to be restored. There is one to one correspondence between elements in ‘objects’ and ‘objects_progress_monitor_task_paths’. Please note that this field will be set only after progress monitor is created for this restore task.

parent_restore_job_id (long|int): If this a child restore task, this

field will contain the id of the parent restore job that spawned this task. List of env and action type for which this field is applicable are: Acropolis: kRecoverVMs.

parent_restore_task_id (long|int): The id of the parent restore task

if this is a restore sub-task. List of environments that use this field: kSQL : Used for multi-stage SQL restore that supports a hot-standy. This will also be used by refresh op to mark the new clone as internal sub-task.

path_prefix_deprecated (string): TODO: type description here. physical_flr_parallel_restore (bool): If enabled, magneto physical

file restore will be enabled via job framework

physical_flr_use_new_locking_method (bool): If enabled, magneto

physical file restore will be enabled via job framework

power_state_config (PowerStateConfigProto): TODO: type description

here.

preserve_tags (bool): This field is currently used by HyperV and

VMWare.

progress_monitor_task_path (string): Root path of a Pulse task

tracking the progress of the restore task.

recover_disks_task_state (RecoverDisksTaskStateProto): TODO: type

description here.

recover_volumes_task_state (RecoverVolumesTaskStateProto): TODO: type

description here.

related_restore_task_id (long|int): The task id of a related restore

task. For example, a SQL restore operation may involve restoring a VM first and then restoring SQL databases after that. So the corresponding VM restore and SQL database restore tasks will be related, and they will each have their ‘related_restore_task_id’ set to the id of the other task.

rename_restored_object_param (RenameObjectParamProto): Message to

specify the prefix/suffix added to rename an object. At least one of prefix or suffix must be specified. Please note that both prefix and suffix can be specified.

rename_restored_vapp_param (RenameObjectParamProto): Message to

specify the prefix/suffix added to rename an object. At least one of prefix or suffix must be specified. Please note that both prefix and suffix can be specified.

resource_pool_entity (EntityProto): Specifies the attributes and the

latest statistics about an entity.

restore_acropolis_vms_params (RestoreAcropolisVMsParams): TODO: type

description here.

restore_app_task_state (RestoreAppTaskStateProto): TODO: type

description here.

restore_files_task_state (RestoreFilesTaskStateProto): This contains

information regarding restore files task state. This is set for restore type kRestoreFiles and kDownloadFiles. Restore type kConvertToPst also sets this for download zip file path.

restore_groups_params (RestoreO365GroupsParams): This field defines

the O365 groups specific params for restore task of type kRecoverO365Groups.

restore_hyperv_vm_params (RestoreHypervVMParams): TODO: type

description here.

restore_info (RestoreInfoProto): Each available extension is listed

below along with the location of the proto file (relative to magneto/connectors) where it is defined. The extension applies to both RestoreInfoProto as well as RestoreEntity. RestoreInfoProto extension Location Extension =================================================================== ========== vmware::RestoreInfo::vmware_restore_info vmware/vmware.proto 100 sql::RestoreInfo::sql_restore_info sql/sql.proto 101 pure::RestoreInfo::pure_restore_info pure/pure.proto 102 azure::RestoreInfo::azure_restore_info azure/azure.proto 103 file::RestoreInfo::file_restore_info file/file.proto 104 hyperv::RestoreInfo::hyperv_restore_info hyperv/hyperv.proto 105 acropolis::RestoreInfo::acropolis_restore_info acropolis/acropolis.proto 106 kvm::RestoreInfo::kvm_restore_info kvm/kvm.proto 107 aws::RestoreInfo::aws_restore_info aws/aws.proto 108 physical::RestoreInfo::physical_restore_info physical.proto 109 oracle::RestoreInfo::oracle_restore_info oracle/oracle.proto 110 outlook::RestoreInfo::outlook_restore_info outlook/outlook.proto 111 gcp::RestoreInfo::gcp_restore_info gcp/gcp.proto 112 ad::RestoreInfo::ad_restore_info ad/ad.proto 113 kubernetes::RestoreInfo::kubernetes_restore_info kubernetes/kubernetes.proto 114 one_drive::RestoreInfo::one_drive_restore_info ms_graph/graph.proto 115 =================================================================== ========== RestoreInfoProto.RestoreEntity extension Location Extension =================================================================== ========== vmware::RestoreEntityInfo::vmware_restore_entity_info vmware/vmware.proto 100 azure::RestoreEntityInfo::azure_restore_entity_info azure/azure.proto 101 hyperv::RestoreEntityInfo::hyperv_restore_entity_info hyperv/hyperv.proto 102 acropolis::RestoreEntityInfo::acropolis_restore_entity_info acropolis/acropolis.proto 103 kvm::RestoreEntityInfo::kvm_restore_entity_info kvm/kvm.proto 104 aws::RestoreEntityInfo::aws_restore_entity_info aws/aws.proto 105 outlook::RestoreEntityInfo::outlook_restore_entity_info outlook/outlook.proto 106 gcp::RestoreEntityInfo::gcp_restore_entity_info gcp/gcp.proto 107 kubernetes::RestoreEntityInfo::kubernetes_restore_entity_info kuebrnetes/kubernetes.proto 108 one_drive::RestoreEntityInfo::one_drive_restore_entity_info ms_graph/graph.proto 109 =================================================================== ==========

restore_kubernetes_namespaces_params

(RestoreKubernetesNamespacesParams): TODO: type description here.

restore_kvm_vms_params (RestoreKVMVMsParams): TODO: type description

here.

restore_one_drive_params (RestoreOneDriveParams): TODO: type

description here.

restore_outlook_params (RestoreOutlookParams): TODO: type description

here.

restore_parent_source (EntityProto): Specifies the attributes and the

latest statistics about an entity.

restore_public_folders_params (RestoreO365PublicFoldersParams): This

field defines the O365 Public Folders specific params for restore task of type kRecoverO365PublicFolders.

restore_site_params (RestoreSiteParams): This field defines the O365

site specific params for restore task of type kRecoverSites.

restore_standby_task_state (RestoreStandbyTaskStateProto): This

contains information regarding standby restore task state. This is currently only set for kRecoverVMs restore type for kVMware environment.

restore_sub_task_vec (list of long|int): Inside Magneto, these are

represented as regular restore tasks with their own PerformRestoreTaskStateProto. Each restore sub-task will have its parent_restore_task_id field set. List of environments that use this field: kSQL : Used for multi-stage SQL restore that supports a hot-standy. kVMware : User for standby restore to store CDPLogApplyRestoreOp id.

restore_task_purged (bool): Whether the restore task is purged. During

WAL recovery, purged restore tasks are ignored.

restore_teams_params (RestoreO365TeamsParams): This field defines team

specific params for restore task of type kRecoverO365Teams.

restore_view_datastore_entity (EntityProto): Specifies the attributes

and the latest statistics about an entity.

restore_vmware_vm_params (RestoreVmwareVMParams): TODO: type

description here.

restored_objects_network_config (RestoredObjectNetworkConfigProto):

TODO: type description here.

restored_to_different_source (bool): Whether restore is being

performed to a different parent source.

retrieve_archive_progress_monitor_task_path (string): The path of the

progress monitor for the task that is responsible for retrieving the objects from the archive.

retrieve_archive_stub_view_name (string): The stub view created by

Icebox corresponding to the archive. The stub view is used to selectively retrieve files and folders.

retrieve_archive_task_uid_vec (list of UniversalIdProto): The uid of

the tasks that will retrieve the objects from the archive. Typically we only retrieve one snapshot for an enity but for point in time restores for SQL/Oracle database, we may need to retrieve multiple snapshots typically one full, and few logs. Hence we may need multiple uids to start retrieval task.

retrieve_archive_task_vec (list of RetrieveArchiveTaskStateProto):

Proto that contains all the information about the retrieve archive task. Typically we only retrieve one snapshot for an enity but for point in time restores for SQL/Oracle database, we may need to retrieve multiple snapshots typically one full, and few logs. As we may start the multiple retrieval tasks, we need vector of RetrieveArchiveTaskStateProto for storing information of retrieved archive tasks.

retrieve_archive_view_name (string): The temporary view where the

entities that have been retrieved from an archive have been placed in by Icebox.

selected_datastore_idx (long|int): In case of restore job with

multi-vm multi-datastore this field denotes the specific datastore index in datastore_entity_vec to be selected for the task. Not going for specific datastore allocation in datastore_entity_vec so that we have required information in case of extensibility for task level retries with different datastore

skip_cloning_retrieve_archive_view (bool): Whether Magneto should use

the ‘retrieve_archive_stub_view’ above for restore without cloning it. We are currently setting it for Direct archive restores using stub views.

skip_image_deploy (bool): This flag can be set to true to just create

the image and not deploy the VM. This flag is set to true during the DR operation that is invoked via runbooks, the creation of image(AMI in case of AWS) and snapshots of the data disk is achieved by invoking a restore of type kConvertAndDeployVMs and orchestration of the VMs is achieved by runbooks.

stub_view_relative_dir_name (string): Relative directory inside the

stub view that corresponds with the archive.

vault_restore_params (VaultParamsRestoreParams): TODO: type

description here.

vcd_config (RestoredObjectVCDConfigProto): TODO: type description

here.

vcd_storage_profile_datastore_moref_vec (list of string): This field

is applicable for VCD type recovery. It defines the compatible datastores for recovery to alternate location. This field is inferred using the storage profile in restore_vmware_vm_params below.

view_box_id (long|int): The view box id to which ‘view_name’ belongs

to. In case the restore task corresponds to a backup job, this view box corresponds to the view box of the backup job.

view_name_deprecated (string): The view name as provided by the user

for this restore operation.

view_params (ViewParams): TODO: type description here. volume_info_vec (list of VolumeInfo): Information regarding volumes

that are required for the restore task. This is populated for restore files and mount virtual disk ops.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

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.

Returns:

object: An instance of this structure class.