Module cvpysdk.subclients.virtualserver.oracle_cloud
File for operating on a Virtual Server OracleCloud Subclient.
OracleCloudeVirtualServerSubclient is the only class defined in this file.
OracleCloudVirtualServerSubclient: Derived class from VirtualServerSubClient Base class, representing a OracleCloud Subclient, and to perform operations on that Subclient
Oraclecloudvirtualserversubclient
full_vm_restore_out_of_place() – restores the VM specified in to the specified client, at the specified destination 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 OracleCloud Subclient.
OracleCloudeVirtualServerSubclient is the only class defined in this file.
OracleCloudVirtualServerSubclient: Derived class from VirtualServerSubClient Base class,
representing a OracleCloud Subclient, and
to perform operations on that Subclient
OracleCloudVirtualServerSubclient:
full_vm_restore_out_of_place() -- restores the VM specified in to the specified client,
at the specified destination location
"""
from ..vssubclient import VirtualServerSubclient
class OracleCloudVirtualServerSubclient(VirtualServerSubclient):
"""Derived class from VirtualServerSubclient Base class.
This represents a OracleCloud virtual server subclient,
and can perform restore operations on only that subclient.
"""
def full_vm_restore_out_of_place(
self,
vm_to_restore=None,
destination_client=None,
proxy_client=None,
new_name=None,
host=None,
power_on=True,
copy_precedence=0,
restore_option=None,
**kwargs):
"""Restores the FULL Virtual machine specified in the input list
to the provided vcenter client along with the ESX and the datastores.
If the provided client name is none then it restores the Full Virtual
Machine to the source client and corresponding ESX and datastore.
Args:
vm_to_restore (list) -- list of all VMs to restore
destination_client (str) -- name of the pseudo client where VM should be
restored
proxy_client (str) -- the proxy to be used for restore
new_name (str) -- new name to be given to the restored VM
host (str) -- destination host or cluster; restores to the
source VM ESX if this value is not
specified
power_on (bool) -- power on the restored VM
default: True
copy_precedence (int) -- copy precedence to restored from
default: 0
restore_option (dict) -- dictionary with all the advanced restore
options.
**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 inputs are not of correct type as per definition
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)
# set attr for all the option in restore xml from user inputs
self._set_restore_inputs(
restore_option,
vm_to_restore=self._set_vm_to_restore(vm_to_restore),
power_on=power_on,
copy_preceedence=copy_precedence,
volume_level_restore=1,
client_name=proxy_client,
vcenter_client=destination_client,
esx_host=host,
out_place=True,
restore_new_name=new_name
)
request_json = self._prepare_fullvm_restore_json(restore_option)
return self._process_restore_response(request_json)
Classes
class OracleCloudVirtualServerSubclient (backupset_object, subclient_name, subclient_id=None)
-
Derived class from VirtualServerSubclient Base class. This represents a OracleCloud virtual server subclient, and can perform restore operations on only that subclient.
Initialize the Instance object for the given Virtual Server instance.
Args
backupset_object (object) – instance of the backupset class
subclient_name (str) – subclient name
subclient_id (int) – subclient id
Expand source code Browse git
class OracleCloudVirtualServerSubclient(VirtualServerSubclient): """Derived class from VirtualServerSubclient Base class. This represents a OracleCloud virtual server subclient, and can perform restore operations on only that subclient. """ def full_vm_restore_out_of_place( self, vm_to_restore=None, destination_client=None, proxy_client=None, new_name=None, host=None, power_on=True, copy_precedence=0, restore_option=None, **kwargs): """Restores the FULL Virtual machine specified in the input list to the provided vcenter client along with the ESX and the datastores. If the provided client name is none then it restores the Full Virtual Machine to the source client and corresponding ESX and datastore. Args: vm_to_restore (list) -- list of all VMs to restore destination_client (str) -- name of the pseudo client where VM should be restored proxy_client (str) -- the proxy to be used for restore new_name (str) -- new name to be given to the restored VM host (str) -- destination host or cluster; restores to the source VM ESX if this value is not specified power_on (bool) -- power on the restored VM default: True copy_precedence (int) -- copy precedence to restored from default: 0 restore_option (dict) -- dictionary with all the advanced restore options. **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 inputs are not of correct type as per definition 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) # set attr for all the option in restore xml from user inputs self._set_restore_inputs( restore_option, vm_to_restore=self._set_vm_to_restore(vm_to_restore), power_on=power_on, copy_preceedence=copy_precedence, volume_level_restore=1, client_name=proxy_client, vcenter_client=destination_client, esx_host=host, out_place=True, restore_new_name=new_name ) request_json = self._prepare_fullvm_restore_json(restore_option) return self._process_restore_response(request_json)
Ancestors
Methods
def full_vm_restore_out_of_place(self, vm_to_restore=None, destination_client=None, proxy_client=None, new_name=None, host=None, power_on=True, copy_precedence=0, restore_option=None, **kwargs)
-
Restores the FULL Virtual machine specified in the input list to the provided vcenter client along with the ESX and the datastores. If the provided client name is none then it restores the Full Virtual Machine to the source client and corresponding ESX and datastore.
Args
vm_to_restore (list) – list of all VMs to restore
destination_client (str) – name of the pseudo client where VM should be restored
proxy_client (str) – the proxy to be used for restore
new_name (str) – new name to be given to the restored VM
host (str) – destination host or cluster; restores to the source VM ESX if this value is not specified
power_on (bool) – power on the restored VM default: True
copy_precedence (int) – copy precedence to restored from default: 0
restore_option (dict) – dictionary with all the advanced restore options.
**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 inputs are not of correct type as per definition
if failed to initialize job if response is empty if response is not success
Expand source code Browse git
def full_vm_restore_out_of_place( self, vm_to_restore=None, destination_client=None, proxy_client=None, new_name=None, host=None, power_on=True, copy_precedence=0, restore_option=None, **kwargs): """Restores the FULL Virtual machine specified in the input list to the provided vcenter client along with the ESX and the datastores. If the provided client name is none then it restores the Full Virtual Machine to the source client and corresponding ESX and datastore. Args: vm_to_restore (list) -- list of all VMs to restore destination_client (str) -- name of the pseudo client where VM should be restored proxy_client (str) -- the proxy to be used for restore new_name (str) -- new name to be given to the restored VM host (str) -- destination host or cluster; restores to the source VM ESX if this value is not specified power_on (bool) -- power on the restored VM default: True copy_precedence (int) -- copy precedence to restored from default: 0 restore_option (dict) -- dictionary with all the advanced restore options. **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 inputs are not of correct type as per definition 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) # set attr for all the option in restore xml from user inputs self._set_restore_inputs( restore_option, vm_to_restore=self._set_vm_to_restore(vm_to_restore), power_on=power_on, copy_preceedence=copy_precedence, volume_level_restore=1, client_name=proxy_client, vcenter_client=destination_client, esx_host=host, out_place=True, restore_new_name=new_name ) request_json = self._prepare_fullvm_restore_json(restore_option) return self._process_restore_response(request_json)
Inherited members
VirtualServerSubclient
:allow_multiple_readers
amazon_defaults
backup
browse
browse_in_time
cbtvalue
content
data_readers
deduplication_options
description
disable_backup
disable_intelli_snap
disk_level_browse
disk_pattern
display_name
enable_backup
enable_backup_at_time
enable_intelli_snap
enable_trueup
enable_trueup_days
encryption_flag
exclude_from_sla
find
find_latest_job
get_ma_associated_storagepolicy
get_nics_from_browse
guest_file_restore
guest_files_browse
index_server
instance_proxy
is_backup_enabled
is_blocklevel_backup_enabled
is_default_subclient
is_intelli_snap_enabled
is_on_demand_subclient
is_trueup_enabled
last_backup_time
list_media
live_sync
metadata
name
network_agent
next_backup_time
parse_nics_xml
plan
preview_content
properties
quiesce_file_system
read_buffer_size
refresh
restore_in_place
restore_out_of_place
set_advanced_attach_disk_restore_options
set_advanced_vm_restore_options
set_backup_nodes
set_proxy_for_snap
snapshot_engine_name
software_compression
storage_ma
storage_ma_id
storage_policy
subclient_guid
subclient_id
subclient_name
subclient_proxy
unset_proxy_for_snap
update_properties
vm_diskfilter
vm_files_browse
vm_files_browse_in_time
vm_filter