Module cvpysdk.subclients.lndbsubclient
File for operating on a Notes Database Subclient.
LNDbSubclient is the only class defined in this file.
LNDbSubclient: Derived class from Subclient Base class. Represents a notes database subclient, and performs operations on that subclient
Lndbsubclient
_get_subclient_properties() – gets subclient related properties of Notes Database subclient.
_get_subclient_properties_json() – gets all the subclient related properties of Notes Database subclient.
content() – get the content of the subclient
restore_in_place() – performs an in place restore of the subclient
restore_out_of_place() – performs and out of place restore of the subclient
backup() – run a backup job for the subclient
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 Notes Database Subclient.
LNDbSubclient is the only class defined in this file.
LNDbSubclient: Derived class from Subclient Base class.
Represents a notes database subclient, and performs operations on that subclient
LNDbSubclient:
_get_subclient_properties() -- gets subclient related properties of
Notes Database subclient.
_get_subclient_properties_json() -- gets all the subclient related properties of
Notes Database subclient.
content() -- get the content of the subclient
restore_in_place() -- performs an in place restore of the subclient
restore_out_of_place() -- performs and out of place restore of the subclient
backup() -- run a backup job for the subclient
"""
from __future__ import absolute_import
from __future__ import unicode_literals
import json
from ..subclient import Subclient
from ..exception import SDKException
class LNDbSubclient(Subclient):
"""Derived class from Subclient Base class, representing a LNDB subclient,
and to perform operations on that subclient."""
def _get_subclient_properties(self):
"""Gets the subclient related properties of LN DB subclient."""
super(LNDbSubclient, self)._get_subclient_properties()
if 'content' in self._subclient_properties:
self._content = self._subclient_properties['content']
if 'proxyClient' in self._subclient_properties:
self._proxyClient = self._subclient_properties['proxyClient']
if 'subClientEntity' in self._subclient_properties:
self._subClientEntity = self._subclient_properties['subClientEntity']
if 'commonProperties' in self._subclient_properties:
self._commonProperties = self._subclient_properties['commonProperties']
def _get_subclient_properties_json(self):
"""Get the all subclient related properties of this subclient.
Returns:
dict - all subclient properties put inside a dict
"""
subclient_json = {
"subClientProperties":
{
"proxyClient": self._proxyClient,
"subClientEntity": self._subClientEntity,
"content": self._content,
"commonProperties": self._commonProperties,
"contentOperationType": 1
}
}
return subclient_json
@property
def content(self):
"""Gets the appropriate content from the Subclient relevant to the user.
Returns:
list - list of content associated with the subclient
"""
return self._content
@content.setter
def content(self, subclient_content):
"""Creates the list of content JSON to pass to the API to add/update content of a
LNDB Subclient.
Args:
subclient_content (list) -- list of the content to add to the subclient
Returns:
list - list of the appropriate JSON for an agent to send to the POST Subclient API
"""
content = []
try:
for database in subclient_content:
if database == {}:
continue
elif 'lotusNotesDBContent' in database:
content.append(database)
else:
temp_content_dict = {}
temp_content_dict = {
"lotusNotesDBContent": {
"dbiid1": database['dbiid1'],
"dbiid2": database['dbiid2'],
"dbiid3": database['dbiid3'],
"dbiid4": database['dbiid4'],
"relativePath": database['relativePath'],
"databaseTitle": database['databaseTitle']
}
}
if temp_content_dict != {}:
content.append(temp_content_dict)
except KeyError as err:
raise SDKException('Subclient', '102', '{} not given in content'.format(err))
self._set_subclient_properties("_content", content)
def restore_in_place(
self,
paths,
overwrite=True,
restore_data_and_acl=True,
copy_precedence=None,
from_time=None,
to_time=None,
common_options_dict=None,
lndb_restore_options=None):
"""Restores the files/folders specified in the input paths list to the same location.
Args:
paths (list) -- list of full paths of files/folders to restore
overwrite (bool) -- unconditional overwrite files during restore
default: True
restore_data_and_acl (bool) -- restore data and ACL files
default: True
copy_precedence (int) -- copy precedence value of storage policy copy
default: None
from_time (str) -- time to retore the contents after
format: YYYY-MM-DD HH:MM:SS
default: None
to_time (str) -- time to retore the contents before
format: YYYY-MM-DD HH:MM:SS
default: None
common_options_dict (dict) -- dictionary for all the common options
options:
unconditionalOverwrite : overwrite the files during restore
even if they exist
recoverWait : Specifies whether this restore
operation must wait until resources become available if a database recovery
is already taking place
recoverZap : Specifies whether the IBM Domino
must change the DBIID associated with the restored database
recoverZapReplica : Specifies whether the restore
operation changes the replica id of the restored database
recoverZapIfNecessary : Specifies whether the IBM Domino
can change the DBIID associated with the restored database if necessary
doNotReplayTransactLogs : option to skip restoring or
replaying logs
Disaster Recovery special options:
skipErrorsAndContinue : enables a data recovery operation
to continue despite media errors
disasterRecovery : run disaster recovery
lndb_restore_options (dict) -- dictionary for all options specific
to an lndb restore
options:
disableReplication : disable relpication on database
disableBackgroundAgents : disable background agents
Returns:
object - instance of the Job class for this restore job
Raises:
SDKException:
if paths is not a list
if failed to initialize job
if response is empty
if response is not success
"""
if not (isinstance(paths, list) and
isinstance(overwrite, bool) and
isinstance(restore_data_and_acl, bool)):
raise SDKException('Subclient', '101')
if common_options_dict is None:
common_options_dict = {}
if lndb_restore_options is None:
lndb_restore_options = {}
paths = self._filter_paths(paths)
if paths == []:
raise SDKException('Subclient', '104')
self._backupset_object._instance_object._restore_association = self._subClientEntity
request_json = self._restore_json(
paths=paths,
overwrite=overwrite,
restore_data_and_acl=restore_data_and_acl,
copy_precedence=copy_precedence,
from_time=from_time,
to_time=to_time,
common_options_dict=common_options_dict,
lndb_restore_options=lndb_restore_options
)
return self._process_restore_response(request_json)
def restore_out_of_place(
self,
client,
destination_path,
paths,
overwrite=True,
restore_data_and_acl=True,
copy_precedence=None,
from_time=None,
to_time=None,
common_options_dict=None,
lndb_restore_options=None):
"""Restores the files/folders specified in the input paths list to the input client,
at the specified destionation location.
Args:
client (str/object) -- either the name of the client or
the instance of the Client
destination_path (str) -- full path of the restore location on client
paths (list) -- list of full paths of
files/folders to restore
overwrite (bool) -- unconditional overwrite files during restore
default: True
restore_data_and_acl (bool) -- restore data and ACL files
default: True
copy_precedence (int) -- copy precedence value of storage policy copy
default: None
from_time (str) -- time to retore the contents after
format: YYYY-MM-DD HH:MM:SS
default: None
to_time (str) -- time to retore the contents before
format: YYYY-MM-DD HH:MM:SS
default: None
common_options_dict (dict) -- dictionary for all the common options
options:
unconditionalOverwrite : overwrite the files during restore
even if they exist
recoverWait : Specifies whether this restore
operation must wait until resources become available if a database recovery
is already taking place
recoverZap : Specifies whether the IBM Domino
must change the DBIID associated with the restored database
recoverZapReplica : Specifies whether the restore
operation changes the replica id of the restored database
recoverZapIfNecessary : Specifies whether the IBM Domino
can change the DBIID associated with the restored database if necessary
doNotReplayTransactLogs : option to skip restoring or
replaying logs
Disaster Recovery special options:
skipErrorsAndContinue : enables a data recovery operation
to continue despite media errors
disasterRecovery : run disaster recovery
lndb_restore_options (dict) -- dictionary for all options specific
to an lndb restore
options:
disableReplication : disable relpication on database
disableBackgroundAgents : disable background agents
Returns:
object - instance of the Job class for this restore job
Raises:
SDKException:
if client is not a string or Client instance
if destination_path is not a string
if paths is not a list
if failed to initialize job
if response is empty
if response is not success
"""
if not (isinstance(paths, list) and
isinstance(overwrite, bool) and
isinstance(restore_data_and_acl, bool)):
raise SDKException('Subclient', '101')
if common_options_dict is None:
common_options_dict = {}
if lndb_restore_options is None:
lndb_restore_options = {}
paths = self._filter_paths(paths)
if paths == []:
raise SDKException('Subclient', '104')
self._backupset_object._instance_object._restore_association = self._subClientEntity
request_json = self._restore_json(
client=client,
destination_path=destination_path,
paths=paths,
overwrite=overwrite,
restore_data_and_acl=restore_data_and_acl,
copy_precedence=copy_precedence,
from_time=from_time,
to_time=to_time,
common_options_dict=common_options_dict,
lndb_restore_options=lndb_restore_options)
return self._process_restore_response(request_json)
def backup(self,
backup_level="Incremental",
incremental_backup=False,
incremental_level='BEFORE_SYNTH',
schedule_pattern=None):
"""Returns the JSON request to pass to the API as per the options selected by the user.
Args:
backup_level (str) -- level of backup the user wish to run
Full / Incremental / Differential / Synthetic_full
incremental_backup (bool) -- run incremental backup
only applicable in case of Synthetic_full backup
incremental_level (str) -- run incremental backup before/after
synthetic full
BEFORE_SYNTH / AFTER_SYNTH
only applicable in case of Synthetic_full backup
schedule_pattern (dict) -- scheduling options to be included for the task
Please refer schedules.schedulePattern.createSchedule()
doc for the types of Jsons
Returns:
dict - JSON request to pass to the API
"""
if schedule_pattern:
request_json = self._backup_json(
backup_level,
incremental_backup,
incremental_level,
schedule_pattern=schedule_pattern)
backup_service = self._services['CREATE_TASK']
flag, response = self._commcell_object.make_request(
'POST', backup_service, request_json
)
else:
return super(LNDbSubclient, self).backup(
backup_level=backup_level,
incremental_backup=incremental_backup,
incremental_level=incremental_level)
return self._process_backup_response(flag, response)Classes
class LNDbSubclient (backupset_object, subclient_name, subclient_id=None)-
Derived class from Subclient Base class, representing a LNDB subclient, and to perform operations on that subclient.
Initialise the Subclient object.
Args
backupset_object (object) – instance of the Backupset class
subclient_name (str) – name of the subclient
subclient_id (str) – id of the subclient default: None
Returns
object - instance of the Subclient class
Expand source code Browse git
class LNDbSubclient(Subclient): """Derived class from Subclient Base class, representing a LNDB subclient, and to perform operations on that subclient.""" def _get_subclient_properties(self): """Gets the subclient related properties of LN DB subclient.""" super(LNDbSubclient, self)._get_subclient_properties() if 'content' in self._subclient_properties: self._content = self._subclient_properties['content'] if 'proxyClient' in self._subclient_properties: self._proxyClient = self._subclient_properties['proxyClient'] if 'subClientEntity' in self._subclient_properties: self._subClientEntity = self._subclient_properties['subClientEntity'] if 'commonProperties' in self._subclient_properties: self._commonProperties = self._subclient_properties['commonProperties'] def _get_subclient_properties_json(self): """Get the all subclient related properties of this subclient. Returns: dict - all subclient properties put inside a dict """ subclient_json = { "subClientProperties": { "proxyClient": self._proxyClient, "subClientEntity": self._subClientEntity, "content": self._content, "commonProperties": self._commonProperties, "contentOperationType": 1 } } return subclient_json @property def content(self): """Gets the appropriate content from the Subclient relevant to the user. Returns: list - list of content associated with the subclient """ return self._content @content.setter def content(self, subclient_content): """Creates the list of content JSON to pass to the API to add/update content of a LNDB Subclient. Args: subclient_content (list) -- list of the content to add to the subclient Returns: list - list of the appropriate JSON for an agent to send to the POST Subclient API """ content = [] try: for database in subclient_content: if database == {}: continue elif 'lotusNotesDBContent' in database: content.append(database) else: temp_content_dict = {} temp_content_dict = { "lotusNotesDBContent": { "dbiid1": database['dbiid1'], "dbiid2": database['dbiid2'], "dbiid3": database['dbiid3'], "dbiid4": database['dbiid4'], "relativePath": database['relativePath'], "databaseTitle": database['databaseTitle'] } } if temp_content_dict != {}: content.append(temp_content_dict) except KeyError as err: raise SDKException('Subclient', '102', '{} not given in content'.format(err)) self._set_subclient_properties("_content", content) def restore_in_place( self, paths, overwrite=True, restore_data_and_acl=True, copy_precedence=None, from_time=None, to_time=None, common_options_dict=None, lndb_restore_options=None): """Restores the files/folders specified in the input paths list to the same location. Args: paths (list) -- list of full paths of files/folders to restore overwrite (bool) -- unconditional overwrite files during restore default: True restore_data_and_acl (bool) -- restore data and ACL files default: True copy_precedence (int) -- copy precedence value of storage policy copy default: None from_time (str) -- time to retore the contents after format: YYYY-MM-DD HH:MM:SS default: None to_time (str) -- time to retore the contents before format: YYYY-MM-DD HH:MM:SS default: None common_options_dict (dict) -- dictionary for all the common options options: unconditionalOverwrite : overwrite the files during restore even if they exist recoverWait : Specifies whether this restore operation must wait until resources become available if a database recovery is already taking place recoverZap : Specifies whether the IBM Domino must change the DBIID associated with the restored database recoverZapReplica : Specifies whether the restore operation changes the replica id of the restored database recoverZapIfNecessary : Specifies whether the IBM Domino can change the DBIID associated with the restored database if necessary doNotReplayTransactLogs : option to skip restoring or replaying logs Disaster Recovery special options: skipErrorsAndContinue : enables a data recovery operation to continue despite media errors disasterRecovery : run disaster recovery lndb_restore_options (dict) -- dictionary for all options specific to an lndb restore options: disableReplication : disable relpication on database disableBackgroundAgents : disable background agents Returns: object - instance of the Job class for this restore job Raises: SDKException: if paths is not a list if failed to initialize job if response is empty if response is not success """ if not (isinstance(paths, list) and isinstance(overwrite, bool) and isinstance(restore_data_and_acl, bool)): raise SDKException('Subclient', '101') if common_options_dict is None: common_options_dict = {} if lndb_restore_options is None: lndb_restore_options = {} paths = self._filter_paths(paths) if paths == []: raise SDKException('Subclient', '104') self._backupset_object._instance_object._restore_association = self._subClientEntity request_json = self._restore_json( paths=paths, overwrite=overwrite, restore_data_and_acl=restore_data_and_acl, copy_precedence=copy_precedence, from_time=from_time, to_time=to_time, common_options_dict=common_options_dict, lndb_restore_options=lndb_restore_options ) return self._process_restore_response(request_json) def restore_out_of_place( self, client, destination_path, paths, overwrite=True, restore_data_and_acl=True, copy_precedence=None, from_time=None, to_time=None, common_options_dict=None, lndb_restore_options=None): """Restores the files/folders specified in the input paths list to the input client, at the specified destionation location. Args: client (str/object) -- either the name of the client or the instance of the Client destination_path (str) -- full path of the restore location on client paths (list) -- list of full paths of files/folders to restore overwrite (bool) -- unconditional overwrite files during restore default: True restore_data_and_acl (bool) -- restore data and ACL files default: True copy_precedence (int) -- copy precedence value of storage policy copy default: None from_time (str) -- time to retore the contents after format: YYYY-MM-DD HH:MM:SS default: None to_time (str) -- time to retore the contents before format: YYYY-MM-DD HH:MM:SS default: None common_options_dict (dict) -- dictionary for all the common options options: unconditionalOverwrite : overwrite the files during restore even if they exist recoverWait : Specifies whether this restore operation must wait until resources become available if a database recovery is already taking place recoverZap : Specifies whether the IBM Domino must change the DBIID associated with the restored database recoverZapReplica : Specifies whether the restore operation changes the replica id of the restored database recoverZapIfNecessary : Specifies whether the IBM Domino can change the DBIID associated with the restored database if necessary doNotReplayTransactLogs : option to skip restoring or replaying logs Disaster Recovery special options: skipErrorsAndContinue : enables a data recovery operation to continue despite media errors disasterRecovery : run disaster recovery lndb_restore_options (dict) -- dictionary for all options specific to an lndb restore options: disableReplication : disable relpication on database disableBackgroundAgents : disable background agents Returns: object - instance of the Job class for this restore job Raises: SDKException: if client is not a string or Client instance if destination_path is not a string if paths is not a list if failed to initialize job if response is empty if response is not success """ if not (isinstance(paths, list) and isinstance(overwrite, bool) and isinstance(restore_data_and_acl, bool)): raise SDKException('Subclient', '101') if common_options_dict is None: common_options_dict = {} if lndb_restore_options is None: lndb_restore_options = {} paths = self._filter_paths(paths) if paths == []: raise SDKException('Subclient', '104') self._backupset_object._instance_object._restore_association = self._subClientEntity request_json = self._restore_json( client=client, destination_path=destination_path, paths=paths, overwrite=overwrite, restore_data_and_acl=restore_data_and_acl, copy_precedence=copy_precedence, from_time=from_time, to_time=to_time, common_options_dict=common_options_dict, lndb_restore_options=lndb_restore_options) return self._process_restore_response(request_json) def backup(self, backup_level="Incremental", incremental_backup=False, incremental_level='BEFORE_SYNTH', schedule_pattern=None): """Returns the JSON request to pass to the API as per the options selected by the user. Args: backup_level (str) -- level of backup the user wish to run Full / Incremental / Differential / Synthetic_full incremental_backup (bool) -- run incremental backup only applicable in case of Synthetic_full backup incremental_level (str) -- run incremental backup before/after synthetic full BEFORE_SYNTH / AFTER_SYNTH only applicable in case of Synthetic_full backup schedule_pattern (dict) -- scheduling options to be included for the task Please refer schedules.schedulePattern.createSchedule() doc for the types of Jsons Returns: dict - JSON request to pass to the API """ if schedule_pattern: request_json = self._backup_json( backup_level, incremental_backup, incremental_level, schedule_pattern=schedule_pattern) backup_service = self._services['CREATE_TASK'] flag, response = self._commcell_object.make_request( 'POST', backup_service, request_json ) else: return super(LNDbSubclient, self).backup( backup_level=backup_level, incremental_backup=incremental_backup, incremental_level=incremental_level) return self._process_backup_response(flag, response)Ancestors
Instance variables
var content-
Gets the appropriate content from the Subclient relevant to the user.
Returns
list - list of content associated with the subclient
Expand source code Browse git
@property def content(self): """Gets the appropriate content from the Subclient relevant to the user. Returns: list - list of content associated with the subclient """ return self._content
Methods
def backup(self, backup_level='Incremental', incremental_backup=False, incremental_level='BEFORE_SYNTH', schedule_pattern=None)-
Returns the JSON request to pass to the API as per the options selected by the user.
Args
backup_level (str) – level of backup the user wish to run
Full / Incremental / Differential / Synthetic_fullincremental_backup (bool) – run incremental backup
only applicable in case of Synthetic_full backupincremental_level (str) – run incremental backup before/after synthetic full
BEFORE_SYNTH / AFTER_SYNTH only applicable in case of Synthetic_full backupschedule_pattern (dict) – scheduling options to be included for the task
Please refer schedules.schedulePattern.createSchedule() doc for the types of JsonsReturns
dict - JSON request to pass to the API
Expand source code Browse git
def backup(self, backup_level="Incremental", incremental_backup=False, incremental_level='BEFORE_SYNTH', schedule_pattern=None): """Returns the JSON request to pass to the API as per the options selected by the user. Args: backup_level (str) -- level of backup the user wish to run Full / Incremental / Differential / Synthetic_full incremental_backup (bool) -- run incremental backup only applicable in case of Synthetic_full backup incremental_level (str) -- run incremental backup before/after synthetic full BEFORE_SYNTH / AFTER_SYNTH only applicable in case of Synthetic_full backup schedule_pattern (dict) -- scheduling options to be included for the task Please refer schedules.schedulePattern.createSchedule() doc for the types of Jsons Returns: dict - JSON request to pass to the API """ if schedule_pattern: request_json = self._backup_json( backup_level, incremental_backup, incremental_level, schedule_pattern=schedule_pattern) backup_service = self._services['CREATE_TASK'] flag, response = self._commcell_object.make_request( 'POST', backup_service, request_json ) else: return super(LNDbSubclient, self).backup( backup_level=backup_level, incremental_backup=incremental_backup, incremental_level=incremental_level) return self._process_backup_response(flag, response) def restore_in_place(self, paths, overwrite=True, restore_data_and_acl=True, copy_precedence=None, from_time=None, to_time=None, common_options_dict=None, lndb_restore_options=None)-
Restores the files/folders specified in the input paths list to the same location.
Args
paths (list) – list of full paths of files/folders to restore
overwrite (bool) – unconditional overwrite files during restore
default: Truerestore_data_and_acl (bool) – restore data and ACL files
default: Truecopy_precedence (int) – copy precedence value of storage policy copy
default: Nonefrom_time (str) – time to retore the contents after
format: YYYY-MM-DD HH:MM:SS default: Noneto_time (str) – time to retore the contents before
format: YYYY-MM-DD HH:MM:SS default: Nonecommon_options_dict (dict) – dictionary for all the common options options: unconditionalOverwrite : overwrite the files during restore even if they exist
recoverWait : Specifies whether this restore operation must wait until resources become available if a database recovery is already taking place recoverZap : Specifies whether the IBM Domino must change the DBIID associated with the restored database recoverZapReplica : Specifies whether the restore operation changes the replica id of the restored database recoverZapIfNecessary : Specifies whether the IBM Domino can change the DBIID associated with the restored database if necessary doNotReplayTransactLogs : option to skip restoring or replaying logs Disaster Recovery special options: skipErrorsAndContinue : enables a data recovery operation to continue despite media errors disasterRecovery : run disaster recoverylndb_restore_options (dict) – dictionary for all options specific to an lndb restore options: disableReplication : disable relpication on database
disableBackgroundAgents : disable background agentsReturns
object - instance of the Job class for this restore job
Raises
SDKException: if paths is not a list
if failed to initialize job if response is empty if response is not successExpand source code Browse git
def restore_in_place( self, paths, overwrite=True, restore_data_and_acl=True, copy_precedence=None, from_time=None, to_time=None, common_options_dict=None, lndb_restore_options=None): """Restores the files/folders specified in the input paths list to the same location. Args: paths (list) -- list of full paths of files/folders to restore overwrite (bool) -- unconditional overwrite files during restore default: True restore_data_and_acl (bool) -- restore data and ACL files default: True copy_precedence (int) -- copy precedence value of storage policy copy default: None from_time (str) -- time to retore the contents after format: YYYY-MM-DD HH:MM:SS default: None to_time (str) -- time to retore the contents before format: YYYY-MM-DD HH:MM:SS default: None common_options_dict (dict) -- dictionary for all the common options options: unconditionalOverwrite : overwrite the files during restore even if they exist recoverWait : Specifies whether this restore operation must wait until resources become available if a database recovery is already taking place recoverZap : Specifies whether the IBM Domino must change the DBIID associated with the restored database recoverZapReplica : Specifies whether the restore operation changes the replica id of the restored database recoverZapIfNecessary : Specifies whether the IBM Domino can change the DBIID associated with the restored database if necessary doNotReplayTransactLogs : option to skip restoring or replaying logs Disaster Recovery special options: skipErrorsAndContinue : enables a data recovery operation to continue despite media errors disasterRecovery : run disaster recovery lndb_restore_options (dict) -- dictionary for all options specific to an lndb restore options: disableReplication : disable relpication on database disableBackgroundAgents : disable background agents Returns: object - instance of the Job class for this restore job Raises: SDKException: if paths is not a list if failed to initialize job if response is empty if response is not success """ if not (isinstance(paths, list) and isinstance(overwrite, bool) and isinstance(restore_data_and_acl, bool)): raise SDKException('Subclient', '101') if common_options_dict is None: common_options_dict = {} if lndb_restore_options is None: lndb_restore_options = {} paths = self._filter_paths(paths) if paths == []: raise SDKException('Subclient', '104') self._backupset_object._instance_object._restore_association = self._subClientEntity request_json = self._restore_json( paths=paths, overwrite=overwrite, restore_data_and_acl=restore_data_and_acl, copy_precedence=copy_precedence, from_time=from_time, to_time=to_time, common_options_dict=common_options_dict, lndb_restore_options=lndb_restore_options ) return self._process_restore_response(request_json) def restore_out_of_place(self, client, destination_path, paths, overwrite=True, restore_data_and_acl=True, copy_precedence=None, from_time=None, to_time=None, common_options_dict=None, lndb_restore_options=None)-
Restores the files/folders specified in the input paths list to the input client, at the specified destionation location.
Args
client (str/object) – either the name of the client or the instance of the Client
destination_path (str) – full path of the restore location on client
paths (list) – list of full paths of files/folders to restore
overwrite (bool) – unconditional overwrite files during restore
default: Truerestore_data_and_acl (bool) – restore data and ACL files
default: Truecopy_precedence (int) – copy precedence value of storage policy copy
default: Nonefrom_time (str) – time to retore the contents after
format: YYYY-MM-DD HH:MM:SS default: Noneto_time (str) – time to retore the contents before
format: YYYY-MM-DD HH:MM:SS default: Nonecommon_options_dict (dict) – dictionary for all the common options options: unconditionalOverwrite : overwrite the files during restore even if they exist
recoverWait : Specifies whether this restore operation must wait until resources become available if a database recovery is already taking place recoverZap : Specifies whether the IBM Domino must change the DBIID associated with the restored database recoverZapReplica : Specifies whether the restore operation changes the replica id of the restored database recoverZapIfNecessary : Specifies whether the IBM Domino can change the DBIID associated with the restored database if necessary doNotReplayTransactLogs : option to skip restoring or replaying logs Disaster Recovery special options: skipErrorsAndContinue : enables a data recovery operation to continue despite media errors disasterRecovery : run disaster recoverylndb_restore_options (dict) – dictionary for all options specific to an lndb restore options: disableReplication : disable relpication on database
disableBackgroundAgents : disable background agentsReturns
object - instance of the Job class for this restore job
Raises
SDKException: if client is not a string or Client instance
if destination_path is not a string if paths is not a list if failed to initialize job if response is empty if response is not successExpand source code Browse git
def restore_out_of_place( self, client, destination_path, paths, overwrite=True, restore_data_and_acl=True, copy_precedence=None, from_time=None, to_time=None, common_options_dict=None, lndb_restore_options=None): """Restores the files/folders specified in the input paths list to the input client, at the specified destionation location. Args: client (str/object) -- either the name of the client or the instance of the Client destination_path (str) -- full path of the restore location on client paths (list) -- list of full paths of files/folders to restore overwrite (bool) -- unconditional overwrite files during restore default: True restore_data_and_acl (bool) -- restore data and ACL files default: True copy_precedence (int) -- copy precedence value of storage policy copy default: None from_time (str) -- time to retore the contents after format: YYYY-MM-DD HH:MM:SS default: None to_time (str) -- time to retore the contents before format: YYYY-MM-DD HH:MM:SS default: None common_options_dict (dict) -- dictionary for all the common options options: unconditionalOverwrite : overwrite the files during restore even if they exist recoverWait : Specifies whether this restore operation must wait until resources become available if a database recovery is already taking place recoverZap : Specifies whether the IBM Domino must change the DBIID associated with the restored database recoverZapReplica : Specifies whether the restore operation changes the replica id of the restored database recoverZapIfNecessary : Specifies whether the IBM Domino can change the DBIID associated with the restored database if necessary doNotReplayTransactLogs : option to skip restoring or replaying logs Disaster Recovery special options: skipErrorsAndContinue : enables a data recovery operation to continue despite media errors disasterRecovery : run disaster recovery lndb_restore_options (dict) -- dictionary for all options specific to an lndb restore options: disableReplication : disable relpication on database disableBackgroundAgents : disable background agents Returns: object - instance of the Job class for this restore job Raises: SDKException: if client is not a string or Client instance if destination_path is not a string if paths is not a list if failed to initialize job if response is empty if response is not success """ if not (isinstance(paths, list) and isinstance(overwrite, bool) and isinstance(restore_data_and_acl, bool)): raise SDKException('Subclient', '101') if common_options_dict is None: common_options_dict = {} if lndb_restore_options is None: lndb_restore_options = {} paths = self._filter_paths(paths) if paths == []: raise SDKException('Subclient', '104') self._backupset_object._instance_object._restore_association = self._subClientEntity request_json = self._restore_json( client=client, destination_path=destination_path, paths=paths, overwrite=overwrite, restore_data_and_acl=restore_data_and_acl, copy_precedence=copy_precedence, from_time=from_time, to_time=to_time, common_options_dict=common_options_dict, lndb_restore_options=lndb_restore_options) return self._process_restore_response(request_json)
Inherited members
Subclient:allow_multiple_readersbrowsedata_readersdeduplication_optionsdescriptiondisable_backupdisable_intelli_snapdisplay_nameenable_backupenable_backup_at_timeenable_intelli_snapenable_trueupenable_trueup_daysencryption_flagexclude_from_slafindfind_latest_jobget_ma_associated_storagepolicyis_backup_enabledis_blocklevel_backup_enabledis_default_subclientis_intelli_snap_enabledis_on_demand_subclientis_trueup_enabledlast_backup_timelist_medianamenetwork_agentnext_backup_timeplanpropertiesread_buffer_sizerefreshset_backup_nodesset_proxy_for_snapsnapshot_engine_namesoftware_compressionstorage_mastorage_ma_idstorage_policysubclient_guidsubclient_idsubclient_nameunset_proxy_for_snapupdate_properties