Module cvpysdk.subclients.virtualserver.azure_stack
File for operating on a Virtual Server AzureStack Subclient.
AzureStackSubclient is the only class defined in this file.
AzureStackSubclient: Derived class from VirtualServerSubClient Base class, representing a AzureStack Subclient, and to perform operations on that Subclient
Azurestacksubclient
full_vm_restore_out_of_place() – restores the VM specified in to the specified client, at the specified destination location
full_vm_restore_in_place() – restores the VM specified by the user to the same location
Expand source code Browse git
# -*- coding: utf-8 -*-
# --------------------------------------------------------------------------
# Copyright Commvault Systems, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# --------------------------------------------------------------------------
"""File for operating on a Virtual Server AzureStack Subclient.
AzureStackSubclient is the only class defined in this file.
AzureStackSubclient: Derived class from VirtualServerSubClient Base class, representing a
AzureStack Subclient, and to perform operations on that Subclient
AzureStackSubclient:
full_vm_restore_out_of_place() -- restores the VM specified in
to the specified client, at the
specified destination location
full_vm_restore_in_place() -- restores the VM specified by the
user to the same location
"""
from ..vssubclient import VirtualServerSubclient
from .azure_resource_manager import AzureRMSubclient
class AzureStackSubclient(VirtualServerSubclient):
"""Derived class from VirtualServerSubclient Base class, representing a
AzureStack virtual server subclient,and to perform operations on that subclient."""
def __init__(self, backupset_object, subclient_name, subclient_id=None):
"""Initialize the Instance object for the given Virtual Server instance.
Args
class_object (backupset_object, subclient_name, subclient_id) -- instance of the
backupset class, subclient name, subclient id
"""
self.diskExtension = [".vhd", ".avhd"]
super(AzureStackSubclient, self).__init__(
backupset_object, subclient_name, subclient_id)
def full_vm_restore_out_of_place(self,
vm_to_restore=None,
resource_group=None,
storage_account=None,
proxy_client=None,
restore_new_name=None,
overwrite=False,
power_on=False,
instance_size=None,
public_ip=True,
restore_as_managed=True,
copy_precedence=0,
restore_option=None,
**kwargs):
"""Restores the FULL Virtual machine specified in the input list to the client,
at the specified destination location.
Args:
vm_to_restore (list) -- provide the list of VM name(s) to restore
resource_group (str) -- provide the resource group to restore
storage_account (str) -- provide the storage account to restore
proxy_client (str) -- provide the proxy client to restore
restore_new_name (str) -- provide the new restore name
instance_size (str) -- provide the instance size of the restore VM
createPublicIP
default:True (bool) -- creates the Public IP of the new VM
restoreAsManagedVM
default:False (bool) -- new VM will be restored as unmanaged VM
overwrite
default:False (bool) -- overwrite the existing VM
poweron
default:False (bool) -- power on the restored VM
restore_option (dict) -- complete dictionary with all advanced optio
default: {}
**kwargs : Arbitrary keyword arguments Properties as of
full_vm_restore_out_of_place
eg:
v2_details (dict) -- details for v2 subclient
eg: check clients.vmclient.VMClient._child_job_subclient_details
Returns:
object - instance of the Job class for this restore job
Raises:
SDKException:
if destination_path is not a string
if failed to initialize job
if response is empty
if response is not success
"""
if not restore_option:
restore_option = {}
restore_option["v2_details"] = kwargs.get("v2_details", None)
AzureRMSubclient.full_vm_restore_out_of_place(
self, vm_to_restore, resource_group, storage_account,
proxy_client, restore_new_name, restore_option, overwrite, power_on,
instance_size, public_ip, restore_as_managed,
copy_precedence)
def full_vm_restore_in_place(self,
vm_to_restore=None,
overwrite=True,
power_on=True,
public_ip=True,
restore_as_managed=False,
copy_precedence=0):
"""Restores the FULL Virtual machine specified in the input list to the client,
to the location same as source .
Args:
vm_to_restore (list) -- provide the of list VM name(s) to restore
createPublicIP
default:True (bool) -- creates the Public IP of the new VM
restoreAsManagedVM
default:False (bool) -- new VM will be restored as unmanaged VM
overwrite
default:true (bool) -- overwrite the existing VM
poweron
default:true (bool) -- power on the restored VM
Returns:
object - instance of the Job class for this restore job
Raises:
SDKException:
if failed to initialize job
if response is empty
if response is not success
"""
AzureRMSubclient.full_vm_restore_in_place(
self, overwrite, power_on,
public_ip, restore_as_managed, copy_precedence)Classes
class AzureStackSubclient (backupset_object, subclient_name, subclient_id=None)-
Derived class from VirtualServerSubclient Base class, representing a AzureStack virtual server subclient,and to perform operations on that subclient.
Initialize the Instance object for the given Virtual Server instance. Args class_object (backupset_object, subclient_name, subclient_id) – instance of the backupset class, subclient name, subclient id
Expand source code Browse git
class AzureStackSubclient(VirtualServerSubclient): """Derived class from VirtualServerSubclient Base class, representing a AzureStack virtual server subclient,and to perform operations on that subclient.""" def __init__(self, backupset_object, subclient_name, subclient_id=None): """Initialize the Instance object for the given Virtual Server instance. Args class_object (backupset_object, subclient_name, subclient_id) -- instance of the backupset class, subclient name, subclient id """ self.diskExtension = [".vhd", ".avhd"] super(AzureStackSubclient, self).__init__( backupset_object, subclient_name, subclient_id) def full_vm_restore_out_of_place(self, vm_to_restore=None, resource_group=None, storage_account=None, proxy_client=None, restore_new_name=None, overwrite=False, power_on=False, instance_size=None, public_ip=True, restore_as_managed=True, copy_precedence=0, restore_option=None, **kwargs): """Restores the FULL Virtual machine specified in the input list to the client, at the specified destination location. Args: vm_to_restore (list) -- provide the list of VM name(s) to restore resource_group (str) -- provide the resource group to restore storage_account (str) -- provide the storage account to restore proxy_client (str) -- provide the proxy client to restore restore_new_name (str) -- provide the new restore name instance_size (str) -- provide the instance size of the restore VM createPublicIP default:True (bool) -- creates the Public IP of the new VM restoreAsManagedVM default:False (bool) -- new VM will be restored as unmanaged VM overwrite default:False (bool) -- overwrite the existing VM poweron default:False (bool) -- power on the restored VM restore_option (dict) -- complete dictionary with all advanced optio default: {} **kwargs : Arbitrary keyword arguments Properties as of full_vm_restore_out_of_place eg: v2_details (dict) -- details for v2 subclient eg: check clients.vmclient.VMClient._child_job_subclient_details Returns: object - instance of the Job class for this restore job Raises: SDKException: if destination_path is not a string if failed to initialize job if response is empty if response is not success """ if not restore_option: restore_option = {} restore_option["v2_details"] = kwargs.get("v2_details", None) AzureRMSubclient.full_vm_restore_out_of_place( self, vm_to_restore, resource_group, storage_account, proxy_client, restore_new_name, restore_option, overwrite, power_on, instance_size, public_ip, restore_as_managed, copy_precedence) def full_vm_restore_in_place(self, vm_to_restore=None, overwrite=True, power_on=True, public_ip=True, restore_as_managed=False, copy_precedence=0): """Restores the FULL Virtual machine specified in the input list to the client, to the location same as source . Args: vm_to_restore (list) -- provide the of list VM name(s) to restore createPublicIP default:True (bool) -- creates the Public IP of the new VM restoreAsManagedVM default:False (bool) -- new VM will be restored as unmanaged VM overwrite default:true (bool) -- overwrite the existing VM poweron default:true (bool) -- power on the restored VM Returns: object - instance of the Job class for this restore job Raises: SDKException: if failed to initialize job if response is empty if response is not success """ AzureRMSubclient.full_vm_restore_in_place( self, overwrite, power_on, public_ip, restore_as_managed, copy_precedence)Ancestors
Methods
def full_vm_restore_in_place(self, vm_to_restore=None, overwrite=True, power_on=True, public_ip=True, restore_as_managed=False, copy_precedence=0)-
Restores the FULL Virtual machine specified in the input list to the client, to the location same as source .
Args
vm_to_restore (list) – provide the of list VM name(s) to restore
createPublicIP default:True (bool) – creates the Public IP of the new VM
restoreAsManagedVM default:False (bool) – new VM will be restored as unmanaged VM
overwrite default:true (bool) – overwrite the existing VM
poweron default:true (bool) – power on the restored VM
Returns
object - instance of the Job class for this restore job
Raises
SDKException:
if failed to initialize job if response is empty if response is not successExpand source code Browse git
def full_vm_restore_in_place(self, vm_to_restore=None, overwrite=True, power_on=True, public_ip=True, restore_as_managed=False, copy_precedence=0): """Restores the FULL Virtual machine specified in the input list to the client, to the location same as source . Args: vm_to_restore (list) -- provide the of list VM name(s) to restore createPublicIP default:True (bool) -- creates the Public IP of the new VM restoreAsManagedVM default:False (bool) -- new VM will be restored as unmanaged VM overwrite default:true (bool) -- overwrite the existing VM poweron default:true (bool) -- power on the restored VM Returns: object - instance of the Job class for this restore job Raises: SDKException: if failed to initialize job if response is empty if response is not success """ AzureRMSubclient.full_vm_restore_in_place( self, overwrite, power_on, public_ip, restore_as_managed, copy_precedence) def full_vm_restore_out_of_place(self, vm_to_restore=None, resource_group=None, storage_account=None, proxy_client=None, restore_new_name=None, overwrite=False, power_on=False, instance_size=None, public_ip=True, restore_as_managed=True, copy_precedence=0, restore_option=None, **kwargs)-
Restores the FULL Virtual machine specified in the input list to the client, at the specified destination location.
Args
vm_to_restore (list) – provide the list of VM name(s) to restore
resource_group (str) – provide the resource group to restore
storage_account (str) – provide the storage account to restore
proxy_client (str) – provide the proxy client to restore
restore_new_name (str) – provide the new restore name
instance_size (str) – provide the instance size of the restore VM
createPublicIP default:True (bool) – creates the Public IP of the new VM
restoreAsManagedVM default:False (bool) – new VM will be restored as unmanaged VM
overwrite default:False (bool) – overwrite the existing VM
poweron default:False (bool) – power on the restored VM
restore_option (dict) – complete dictionary with all advanced optio default: {}
**kwargs : Arbitrary keyword arguments Properties as of full_vm_restore_out_of_place eg: v2_details (dict) – details for v2 subclient eg: check clients.vmclient.VMClient._child_job_subclient_details
Returns
object - instance of the Job class for this restore job
Raises
SDKException:
if destination_path is not a string if failed to initialize job if response is empty if response is not successExpand source code Browse git
def full_vm_restore_out_of_place(self, vm_to_restore=None, resource_group=None, storage_account=None, proxy_client=None, restore_new_name=None, overwrite=False, power_on=False, instance_size=None, public_ip=True, restore_as_managed=True, copy_precedence=0, restore_option=None, **kwargs): """Restores the FULL Virtual machine specified in the input list to the client, at the specified destination location. Args: vm_to_restore (list) -- provide the list of VM name(s) to restore resource_group (str) -- provide the resource group to restore storage_account (str) -- provide the storage account to restore proxy_client (str) -- provide the proxy client to restore restore_new_name (str) -- provide the new restore name instance_size (str) -- provide the instance size of the restore VM createPublicIP default:True (bool) -- creates the Public IP of the new VM restoreAsManagedVM default:False (bool) -- new VM will be restored as unmanaged VM overwrite default:False (bool) -- overwrite the existing VM poweron default:False (bool) -- power on the restored VM restore_option (dict) -- complete dictionary with all advanced optio default: {} **kwargs : Arbitrary keyword arguments Properties as of full_vm_restore_out_of_place eg: v2_details (dict) -- details for v2 subclient eg: check clients.vmclient.VMClient._child_job_subclient_details Returns: object - instance of the Job class for this restore job Raises: SDKException: if destination_path is not a string if failed to initialize job if response is empty if response is not success """ if not restore_option: restore_option = {} restore_option["v2_details"] = kwargs.get("v2_details", None) AzureRMSubclient.full_vm_restore_out_of_place( self, vm_to_restore, resource_group, storage_account, proxy_client, restore_new_name, restore_option, overwrite, power_on, instance_size, public_ip, restore_as_managed, copy_precedence)
Inherited members
VirtualServerSubclient:allow_multiple_readersamazon_defaultsbackupbrowsebrowse_in_timecbtvaluecontentdata_readersdeduplication_optionsdescriptiondisable_backupdisable_intelli_snapdisk_level_browsedisk_patterndisplay_nameenable_backupenable_backup_at_timeenable_intelli_snapenable_trueupenable_trueup_daysencryption_flagexclude_from_slafindfind_latest_jobget_ma_associated_storagepolicyget_nics_from_browseguest_file_restoreguest_files_browseindex_serverinstance_proxyis_backup_enabledis_blocklevel_backup_enabledis_default_subclientis_intelli_snap_enabledis_on_demand_subclientis_trueup_enabledlast_backup_timelist_medialive_syncmetadatanamenetwork_agentnext_backup_timeparse_nics_xmlplanpreview_contentpropertiesquiesce_file_systemread_buffer_sizerefreshrestore_in_placerestore_out_of_placeset_advanced_attach_disk_restore_optionsset_advanced_vm_restore_optionsset_backup_nodesset_proxy_for_snapsnapshot_engine_namesoftware_compressionstorage_mastorage_ma_idstorage_policysubclient_guidsubclient_idsubclient_namesubclient_proxyunset_proxy_for_snapupdate_propertiesvm_diskfiltervm_files_browsevm_files_browse_in_timevm_filter