Command Line XML Restore Options - Microsoft SharePoint Server iDataAgents

Options
 
Task Request Information
DescriptionField NameData TypeCommandline Parameter
Tasktask
TypetaskTypeenumtaskType
Initiated FrominitiatedFromenuminitiatedFrom
Task FlagstaskFlags
Disableddisabledbooleandisabled
 
Common Job Options
DescriptionField NameData TypeCommandline Parameter
StartUp OptionsstartUpOpts
Startup in suspended statestartInSuspendedStatebooleanstartInSuspendedState
Prioritypriorityintegerpriority
Use Default PriorityuseDefaultPrioritybooleanuseDefaultPriority
 
Restore Job Options
DescriptionField NameData TypeCommandline Parameter
Restore Access Control TyperestoreACLsTypeenumrestoreACLsType
Restore Netware TrusteesrestoreNetwareTrusteesenumrestoreNetwareTrustees
Browse OptionbrowseOption
Comm Cell IdcommCellIdintegercommCellId
Restore deleted itemsnoImagebooleannoImage
Specify Restore TimespecifyRestoreTimebooleanspecifyRestoreTime
List MedialistMediabooleanlistMedia
Backupsetbackupset
Backupset NamebackupsetNamestringbackupset/backupsetName (b)
Typetypeenumbackupset/type
Time RangetimeRange
TypetypeenumtimeRange/type
To TimetoTimeintegertoTime
Media OptionmediaOption
Use MediaAgentmediaAgent
Media Agent NamemediaAgentNamestringmediaAgentName (m)
Copy PrecedencemediaOption/copyPrecedence
Restore from copy precedencecopyPrecedenceApplicablebooleancopyPrecedenceApplicable
Copy Precedence TypecopyPrecedenceTypeenumcopyPrecedenceType
Synchronous Copy PrecedencesynchronousCopyPrecedenceintegersynchronousCopyPrecedence
Copy PrecedencecopyPrecedenceintegercopyPrecedence/copyPrecedence
Time ZonetimeZone
Time Zone NameTimeZoneNamestringTimeZoneName
Restore Destinationdestination
Restore to same folderinPlacebooleaninPlace
Restore only if target existsrestoreOnlyIfTargetExistsbooleanrestoreOnlyIfTargetExists
Destination clientdestClient
Client NameclientNamestringdestClient/clientName (c)
TypetypeenumdestClient/type
SharePoint Restore OptionsharePointRstOption
Restore SQL DB torestoreSqlDBTObooleanrestoreSqlDBTO
Volume Restore OptionvolumeRstOption
Volume Leve RestorevolumeLeveRestorebooleanvolumeLeveRestore
Volume Level Restore TypevolumeLevelRestoreTypeenumvolumeLevelRestoreType
File Restore OptionfileOption
Source ItemsourceItemlist:stringsourceItem
Restore Common OptionscommonOptions
Overwrite FilesoverwriteFilesbooleanoverwriteFiles
Automatically Detect Regular ExpressionsdetectRegularExpressionbooleandetectRegularExpression
Restore device files as regular filesrestoreDeviceFilesAsRegularFilesbooleanrestoreDeviceFilesAsRegularFiles
PreservepreserveSourcebooleanpreserveSource
Skipskipbooleanskip
Restore Space RestrictionsrestoreSpaceRestrictionsbooleanrestoreSpaceRestrictions
Ignore Namespace RequirementsignoreNamespaceRequirementsbooleanignoreNamespaceRequirements
Restore All VersionsallVersionbooleanallVersion
Unconditional OverwriteunconditionalOverwritebooleanunconditionalOverwrite
Strip Level TypestripLevelTypeenumstripLevelType
level from end of the source pathpreserveLevelintegerpreserveLevel
Skip errors and continueskipErrorsAndContinuebooleanskipErrorsAndContinue
Do not replay transaction logsdoNotReplayTransactLogsbooleandoNotReplayTransactLogs
Skip if existsskipIfExistsbooleanskipIfExists
Power RestorepowerRestorebooleanpowerRestore
One Pass RestoreonePassRestorebooleanonePassRestore
Use hardware revert capability if availablerevertbooleanrevert
Recover All Protected MailsrecoverAllProtectedMailsbooleanrecoverAllProtectedMails
Recover all protected mailsofflineMiningRestorebooleanofflineMiningRestore
Er Ex Spdb Path RestoreerExSpdbPathRestorebooleanerExSpdbPathRestore
Is From Browse BackupisFromBrowseBackupbooleanisFromBrowseBackup
Cluster DBBackedupclusterDBBackedupbooleanclusterDBBackedup
Use Rman RestoreuseRmanRestorebooleanuseRmanRestore
 
SubTask Options
DescriptionField NameData TypeCommandline Parameter
Sub Task IdsubTaskIdintegersubTaskId
Sub Task TypesubTaskTypeenumsubTaskType (st)
Operation TypeoperationTypeenumoperationType (op)
Flagsflagsintegerflags
Sub Task OrdersubTaskOrderintegersubTaskOrder
 
Associations
DescriptionField NameData TypeCommandline Parameter
Backupset NamebackupsetNamestringassociations/backupsetName (b)
Typetypeenumassociations/type
Consume LicenseconsumeLicensebooleanconsumeLicense
Client Side PackageclientSidePackagebooleanclientSidePackage
Client NameclientNamestringassociations/clientName (c)
App NameappNamestringappName (a)
Instance NameinstanceNamestringinstanceName (i)


Usage
 
Task Request Information
Task
taskType
Type: enum
Default Value: IMMEDIATE
Possible Values: NONE , IMMEDIATE , SCHEDULE , SAVED_REPORT , SCHEDULE_POLICY , WORKFLOW , PREVIEW , AUTOMATIC_COPY , AGENTLESS_SRM , AGENTLESS_SRM
Command Line Paramter: taskType
Location: taskInfo/task/taskType
Type
initiatedFrom
Type: enum
Default Value: GUI
Possible Values: NONE , GUI , COMMANDLINE , SYSTEM , SCRIPT , SCHEDULE , SCHEDULE
Command Line Paramter: initiatedFrom
Location: taskInfo/task/initiatedFrom
Initiated From
Task Flags
disabled
Type: boolean
Possible Values: true/false
Command Line Paramter: disabled
Location: taskInfo/task/taskFlags/disabled
Disabled
 
Common Job Options
StartUp Options
startInSuspendedState
Type: boolean
Possible Values: true/false
Command Line Paramter: startInSuspendedState
Location: taskInfo/subTasks/options/commonOpts/startUpOpts/startInSuspendedState
Startup in suspended state
priority
Type: integer
Command Line Paramter: priority
Location: taskInfo/subTasks/options/commonOpts/startUpOpts/priority
Priority
useDefaultPriority
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: useDefaultPriority
Location: taskInfo/subTasks/options/commonOpts/startUpOpts/useDefaultPriority
Use Default Priority
 
Restore Job Options
restoreACLsType
Type: enum
Default Value: ACL_DATA
Possible Values: NONE , ACL_ONLY , DATA_ONLY , ACL_DATA , ACL_DATA
Command Line Paramter: restoreACLsType
Location: taskInfo/subTasks/options/restoreOptions/restoreACLsType
Restore Access Control Type
restoreNetwareTrustees
Type: enum
Default Value: DATA_TRUSTEE
Possible Values: NONE , DATA_TRUSTEE , DATA_ONLY , TRUSTEE_ONLY , TRUSTEE_ONLY
Command Line Paramter: restoreNetwareTrustees
Location: taskInfo/subTasks/options/restoreOptions/restoreNetwareTrustees
Restore Netware Trustees
Browse Option
commCellId
Type: integer
Command Line Paramter: commCellId
Location: taskInfo/subTasks/options/restoreOptions/browseOption/commCellId
Comm Cell Id
noImage
Type: boolean
Possible Values: true/false
Command Line Paramter: noImage
Location: taskInfo/subTasks/options/restoreOptions/browseOption/noImage
Restore deleted items
specifyRestoreTime
Type: boolean
Possible Values: true/false
Command Line Paramter: specifyRestoreTime
Location: taskInfo/subTasks/options/restoreOptions/browseOption/specifyRestoreTime
Specify Restore Time
listMedia
Type: boolean
Possible Values: true/false
Command Line Paramter: listMedia
Location: taskInfo/subTasks/options/restoreOptions/browseOption/listMedia
List Media
Backupset
backupsetName
Type: string
Command Line Paramter: backupset/backupsetName
Location: taskInfo/subTasks/options/restoreOptions/browseOption/backupset/backupsetName
Backupset Name
type
Type: enum
Default Value: GALAXY
Possible Values: GALAXY , NBU , NETAPP , TSM , TSM
Command Line Paramter: backupset/type
Location: taskInfo/subTasks/options/restoreOptions/browseOption/backupset/type
Type
Time Range
type
Type: enum
Default Value: IS
Possible Values: NONE , AFTER , BEFORE , BETWEEN , IS , ANY , TODAY , YESTERDAY , THIS_WEEK , THIS_MONTH , THIS_YEAR , RELATIVE_DAYS , RELATIVE_WEEKS , RELATIVE_HOURS , RELATIVE , RELATIVE
Command Line Paramter: timeRange/type
Location: taskInfo/subTasks/options/restoreOptions/browseOption/timeRange/type
Type
toTime
Type: integer
Command Line Paramter: toTime
Location: taskInfo/subTasks/options/restoreOptions/browseOption/timeRange/toTime
To Time
Media Option
Use MediaAgent
mediaAgentName
Type: string
Command Line Paramter: mediaAgentName
Location: taskInfo/subTasks/options/restoreOptions/browseOption/mediaOption/mediaAgent/mediaAgentName
Media Agent Name
Copy Precedence
copyPrecedenceApplicable
Type: boolean
Possible Values: true/false
Command Line Paramter: copyPrecedenceApplicable
Location: taskInfo/subTasks/options/restoreOptions/browseOption/mediaOption/copyPrecedence/copyPrecedenceApplicable
Restore from copy precedence
copyPrecedenceType
Type: enum
Default Value: SYNCHRONOUS
Possible Values: SYNCHRONOUS , SELECTIVE , SELECTIVE
Command Line Paramter: copyPrecedenceType
Location: taskInfo/subTasks/options/restoreOptions/browseOption/mediaOption/copyPrecedence/copyPrecedenceType
Copy Precedence Type
synchronousCopyPrecedence
Type: integer
Command Line Paramter: synchronousCopyPrecedence
Location: taskInfo/subTasks/options/restoreOptions/browseOption/mediaOption/copyPrecedence/synchronousCopyPrecedence
Synchronous Copy Precedence
copyPrecedence
Type: integer
Command Line Paramter: copyPrecedence/copyPrecedence
Location: taskInfo/subTasks/options/restoreOptions/browseOption/mediaOption/copyPrecedence/copyPrecedence
Copy Precedence
Time Zone
TimeZoneName
Type: string
Command Line Paramter: TimeZoneName
Location: taskInfo/subTasks/options/restoreOptions/browseOption/timeZone/TimeZoneName
Time Zone Name
Restore Destination
inPlace
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: inPlace
Location: taskInfo/subTasks/options/restoreOptions/destination/inPlace
Restore to same folder
restoreOnlyIfTargetExists
Type: boolean
Default Value: false
Possible Values: true/false
Command Line Paramter: restoreOnlyIfTargetExists
Location: taskInfo/subTasks/options/restoreOptions/destination/restoreOnlyIfTargetExists
Restore only if target exists
Destination client
clientName
Type: string
Command Line Paramter: destClient/clientName
Location: taskInfo/subTasks/options/restoreOptions/destination/destClient/clientName
Client Name
type
Type: enum
Default Value: GALAXY
Possible Values: GALAXY , NBU , NETAPP , TSM , TSM
Command Line Paramter: destClient/type
Location: taskInfo/subTasks/options/restoreOptions/destination/destClient/type
Type
SharePoint Restore Option
restoreSqlDBTO
Type: boolean
Possible Values: true/false
Command Line Paramter: restoreSqlDBTO
Location: taskInfo/subTasks/options/restoreOptions/sharePointRstOption/restoreSqlDBTO
Restore SQL DB to
Volume Restore Option
volumeLeveRestore
Type: boolean
Possible Values: true/false
Command Line Paramter: volumeLeveRestore
Location: taskInfo/subTasks/options/restoreOptions/volumeRstOption/volumeLeveRestore
Volume Leve Restore
volumeLevelRestoreType
Type: enum
Default Value: NONE
Possible Values: NONE , VIRTUAL_MACHINE , PHYSICAL_VOLUME , VMDK_FILES , VIRTUAL_HARD_DISKS , VDI_OBJECT , VDI_OBJECT
Command Line Paramter: volumeLevelRestoreType
Location: taskInfo/subTasks/options/restoreOptions/volumeRstOption/volumeLevelRestoreType
Volume Level Restore Type
File Restore Option
sourceItem
Type: list:string
Command Line Paramter: sourceItem
Location: taskInfo/subTasks/options/restoreOptions/fileOption/sourceItem
Source Item
Restore Common Options
overwriteFiles
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: overwriteFiles
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/overwriteFiles
Overwrite Files
detectRegularExpression
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: detectRegularExpression
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/detectRegularExpression
Automatically Detect Regular Expressions
restoreDeviceFilesAsRegularFiles
Type: boolean
Possible Values: true/false
Command Line Paramter: restoreDeviceFilesAsRegularFiles
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/restoreDeviceFilesAsRegularFiles
Restore device files as regular files
preserveSource
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: preserveSource
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/preserveSource
Preserve
skip
Type: boolean
Possible Values: true/false
Command Line Paramter: skip
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/skip
Skip
restoreSpaceRestrictions
Type: boolean
Possible Values: true/false
Command Line Paramter: restoreSpaceRestrictions
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/restoreSpaceRestrictions
Restore Space Restrictions
ignoreNamespaceRequirements
Type: boolean
Possible Values: true/false
Command Line Paramter: ignoreNamespaceRequirements
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/ignoreNamespaceRequirements
Ignore Namespace Requirements
allVersion
Type: boolean
Possible Values: true/false
Command Line Paramter: allVersion
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/allVersion
Restore All Versions
unconditionalOverwrite
Type: boolean
Possible Values: true/false
Command Line Paramter: unconditionalOverwrite
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/unconditionalOverwrite
Unconditional Overwrite
stripLevelType
Type: enum
Default Value: PRESERVE_LEVEL
Possible Values: PRESERVE_LEVEL , REMOVE_LEVEL , REMOVE_LEVEL
Command Line Paramter: stripLevelType
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/stripLevelType
Strip Level Type
preserveLevel
Type: integer
Default Value: 1
Command Line Paramter: preserveLevel
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/preserveLevel
level from end of the source path
skipErrorsAndContinue
Type: boolean
Default Value: false
Possible Values: true/false
Command Line Paramter: skipErrorsAndContinue
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/skipErrorsAndContinue
Skip errors and continue
doNotReplayTransactLogs
Type: boolean
Default Value: false
Possible Values: true/false
Command Line Paramter: doNotReplayTransactLogs
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/doNotReplayTransactLogs
Do not replay transaction logs
skipIfExists
Type: boolean
Default Value: false
Possible Values: true/false
Command Line Paramter: skipIfExists
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/skipIfExists
Skip if exists
powerRestore
Type: boolean
Possible Values: true/false
Command Line Paramter: powerRestore
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/powerRestore
Power Restore
onePassRestore
Type: boolean
Possible Values: true/false
Command Line Paramter: onePassRestore
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/onePassRestore
One Pass Restore
revert
Type: boolean
Possible Values: true/false
Command Line Paramter: revert
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/revert
Use hardware revert capability if available
recoverAllProtectedMails
Type: boolean
Possible Values: true/false
Command Line Paramter: recoverAllProtectedMails
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/recoverAllProtectedMails
Recover All Protected Mails
offlineMiningRestore
Type: boolean
Default Value: false
Possible Values: true/false
Command Line Paramter: offlineMiningRestore
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/offlineMiningRestore
Recover all protected mails
erExSpdbPathRestore
Type: boolean
Default Value: false
Possible Values: true/false
Command Line Paramter: erExSpdbPathRestore
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/erExSpdbPathRestore
Er Ex Spdb Path Restore
isFromBrowseBackup
Type: boolean
Possible Values: true/false
Command Line Paramter: isFromBrowseBackup
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/isFromBrowseBackup
Is From Browse Backup
clusterDBBackedup
Type: boolean
Possible Values: true/false
Command Line Paramter: clusterDBBackedup
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/clusterDBBackedup
Cluster DBBackedup
useRmanRestore
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: useRmanRestore
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/useRmanRestore
Use Rman Restore
 
SubTask Options
subTaskId
Type: integer
Default Value: 1
Command Line Paramter: subTaskId
Location: taskInfo/subTasks/subTask/subTaskId
Sub Task Id
subTaskType
Type: enum
Possible Values: NONE , ADMIN , BACKUP , RESTORE , WORKFLOW , COMPLIANCE_POLICY , COMPLIANCE_POLICY
Command Line Paramter: subTaskType
Location: taskInfo/subTasks/subTask/subTaskType
Sub Task Type
operationType
Type: enum
Default Value: NONE
Possible Values: NONE , ALL_BACKUP_JOBS , BACKUP , RECOVERY_POINT_CREATION , CONSISTENTCY_POINT_CREATION , SRM , ARCHIVE , CONTENT_INDEXING , ALL_RESTORE_JOBS , RESTORE , POWER_RESTORE , BROWSE , RESTORE_BY_JOB , ONETOUCH_RECOVERY , ADMIN , WORK_FLOW , COMPLIANCE , SEARCH , SAVE , EMAIL , TAGGING , LEGAL_HOLDS , COMP_RESTORE , MOSS , PRUNE , DRBACKUP , AUX_COPY , REPORT , MEDIA_INVENTORY , SCHED_EXPORT , ARCHIVE_CHECK , MEDIA_PREDICTION , TAPE_ERASE , VT , SELECTIVE_DELETE , DRIVE_VALIDATION , DRIVE_CLEANING , STAMP_MEDIA , BROWSE_DELETE , CATALOGUE_MEDIA , DATA_AGING , DOWNLOAD_UPDATES , INSTALL_UPDATES , SRM_REPORT , OFFLINE_CONTENT_INDEX , MAGLIBMAINTENANCE , SHELF_MANAGEMENT , INFOMGMT , INSTALL_CLIENT , UNINSTALL_CLIENT , SNAP_TO_TAPE , CCM_CAPTURE , CCM_MERGE , EXTERNAL_DATA_PROCESSOR , MEDIA_REFRESHING , PREPARATION , FDC , MAGLIBVOLRECON , DEDUPDBSYNC , TAPEIMPORT , WORKFLOW , QR , FS_BACKUP , IMAGE_BACKUP , SERVERLESS_BACKUP , MOUNT_SNAPSHOT , UNMOUNT_SNAPSHOT , DELETE_SNAPSHOT , MINING_BACKUP , SRM_AGENTLESS , SRM_AGENTLESS
Command Line Paramter: operationType
Location: taskInfo/subTasks/subTask/operationType
Operation Type
flags
Type: integer
Default Value: 0
Command Line Paramter: flags
Location: taskInfo/subTasks/subTask/flags
Flags
subTaskOrder
Type: integer
Default Value: 0
Command Line Paramter: subTaskOrder
Location: taskInfo/subTasks/subTask/subTaskOrder
Sub Task Order
 
Associations
backupsetName
Type: string
Command Line Paramter: associations/backupsetName
Location: taskInfo/associations/backupsetName
Backupset Name
type
Type: enum
Default Value: GALAXY
Possible Values: GALAXY , NBU , NETAPP , TSM , TSM
Command Line Paramter: associations/type
Location: taskInfo/associations/type
Type
consumeLicense
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: consumeLicense
Location: taskInfo/associations/consumeLicense
Consume License
clientSidePackage
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: clientSidePackage
Location: taskInfo/associations/clientSidePackage
Client Side Package
clientName
Type: string
Command Line Paramter: associations/clientName
Location: taskInfo/associations/clientName
Client Name
appName
Type: string
Command Line Paramter: appName
Location: taskInfo/associations/appName
App Name
instanceName
Type: string
Command Line Paramter: instanceName
Location: taskInfo/associations/instanceName
Instance Name