Command Line XML Restore Options - Exchange Database iDataAgent

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
Job Retry OptionsjobRetryOpts
Kill Running Job When Total Running Time ExpireskillRunningJobWhenTotalRunningTimeExpiresbooleankillRunningJobWhenTotalRunningTimeExpires
Enable Number Of RetriesenableNumberOfRetriesbooleanenableNumberOfRetries
Number Of RetriesnumberOfRetriesintegernumberOfRetries
Running TimerunningTime
Enable Total Running TimeenableTotalRunningTimebooleanenableTotalRunningTime
Total Running TimetotalRunningTimeintegertotalRunningTime
Pre Post Command OptionsprePostOpts
Run Post Restore Process for all attemptsrunPostWhenFailbooleanrunPostWhenFail
Impersonation for PrePost CommandprePostOpts/impersonation
PrePost Command Impersonation Levellevelenumlevel
 
Restore Job Options
DescriptionField NameData TypeCommandline Parameter
Restore Access Control TyperestoreACLsTypeenumrestoreACLsType
Browse OptionbrowseOption
Comm Cell IdcommCellIdintegercommCellId
Restore deleted itemsnoImagebooleannoImage
Specify Restore TimespecifyRestoreTimebooleanspecifyRestoreTime
List MedialistMediabooleanlistMedia
Backupsetbackupset
Backupset NamebackupsetNamestringbackupset/backupsetName (b)
Client NameclientNamestringbackupset/clientName (c)
Media OptionmediaOption
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)
File Restore OptionfileOption
Source ItemsourceItemlist:stringsourceItem
Map FilesmapFiles
Use map fileuseMapFilebooleanuseMapFile
Restore unmapped filesrestoreUnmappedFilesbooleanrestoreUnmappedFiles
Restore ImpersonationrestoreOptions/impersonation
Impersonate UseruseImpersonationbooleanuseImpersonation
Restore Common OptionscommonOptions
Overwrite FilesoverwriteFilesbooleanoverwriteFiles
Automatically Detect Regular ExpressionsdetectRegularExpressionbooleandetectRegularExpression
Restore device files as regular filesrestoreDeviceFilesAsRegularFilesbooleanrestoreDeviceFilesAsRegularFiles
Restore Space RestrictionsrestoreSpaceRestrictionsbooleanrestoreSpaceRestrictions
Ignore Namespace RequirementsignoreNamespaceRequirementsbooleanignoreNamespaceRequirements
Unconditional OverwriteunconditionalOverwritebooleanunconditionalOverwrite
Strip Level TypestripLevelTypeenumstripLevelType
level from end of the source pathpreserveLevelintegerpreserveLevel
level from begining of the source pathstripLevelintegerstripLevel
Mount database after restorerecreateMountPointsbooleanrecreateMountPoints
Skip errors and continueskipErrorsAndContinuebooleanskipErrorsAndContinue
Do Not Overwrite File On DiskdoNotOverwriteFileOnDiskbooleandoNotOverwriteFileOnDisk
System State BackupsystemStateBackupbooleansystemStateBackup
Use hardware revert capability if availablerevertbooleanrevert
Recover All Protected MailsrecoverAllProtectedMailsbooleanrecoverAllProtectedMails
Is From Browse BackupisFromBrowseBackupbooleanisFromBrowseBackup
Cluster DBBackedupclusterDBBackedupbooleanclusterDBBackedup
Restore data instead of stubrestoreDataInsteadOfStubbooleanrestoreDataInsteadOfStub
 
SubTask Options
DescriptionField NameData TypeCommandline Parameter
Sub Task TypesubTaskTypeenumsubTaskType (st)
Operation TypeoperationTypeenumoperationType (op)
 
Associations
DescriptionField NameData TypeCommandline Parameter
Backupset NamebackupsetNamestringassociations/backupsetName (b)
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
Job Retry Options
killRunningJobWhenTotalRunningTimeExpires
Type: boolean
Possible Values: true/false
Command Line Paramter: killRunningJobWhenTotalRunningTimeExpires
Location: taskInfo/subTasks/options/commonOpts/jobRetryOpts/killRunningJobWhenTotalRunningTimeExpires
Kill Running Job When Total Running Time Expires
enableNumberOfRetries
Type: boolean
Possible Values: true/false
Command Line Paramter: enableNumberOfRetries
Location: taskInfo/subTasks/options/commonOpts/jobRetryOpts/enableNumberOfRetries
Enable Number Of Retries
numberOfRetries
Type: integer
Default Value: 0
Command Line Paramter: numberOfRetries
Location: taskInfo/subTasks/options/commonOpts/jobRetryOpts/numberOfRetries
Number Of Retries
Running Time
enableTotalRunningTime
Type: boolean
Possible Values: true/false
Command Line Paramter: enableTotalRunningTime
Location: taskInfo/subTasks/options/commonOpts/jobRetryOpts/runningTime/enableTotalRunningTime
Enable Total Running Time
totalRunningTime
Type: integer
Default Value: 3600
Command Line Paramter: totalRunningTime
Location: taskInfo/subTasks/options/commonOpts/jobRetryOpts/runningTime/totalRunningTime
Total Running Time
Pre Post Command Options
runPostWhenFail
Type: boolean
Possible Values: true/false
Command Line Paramter: runPostWhenFail
Location: taskInfo/subTasks/options/commonOpts/prePostOpts/runPostWhenFail
Run Post Restore Process for all attempts
Impersonation for PrePost Command
level
Type: enum
Possible Values: NO_SELECTION , USE_LOCAL_SYS_ADMIN , USE_IMPERSONATION , USE_IMPERSONATION
Command Line Paramter: level
Location: taskInfo/subTasks/options/commonOpts/prePostOpts/impersonation/level
PrePost Command Impersonation Level
 
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
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
clientName
Type: string
Command Line Paramter: backupset/clientName
Location: taskInfo/subTasks/options/restoreOptions/browseOption/backupset/clientName
Client Name
Media Option
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
File Restore Option
sourceItem
Type: list:string
Command Line Paramter: sourceItem
Location: taskInfo/subTasks/options/restoreOptions/fileOption/sourceItem
Source Item
Map Files
useMapFile
Type: boolean
Possible Values: true/false
Command Line Paramter: useMapFile
Location: taskInfo/subTasks/options/restoreOptions/fileOption/mapFiles/useMapFile
Use map file
restoreUnmappedFiles
Type: boolean
Possible Values: true/false
Command Line Paramter: restoreUnmappedFiles
Location: taskInfo/subTasks/options/restoreOptions/fileOption/mapFiles/restoreUnmappedFiles
Restore unmapped files
Restore Impersonation
useImpersonation
Type: boolean
Default Value: false
Possible Values: true/false
Command Line Paramter: useImpersonation
Location: taskInfo/subTasks/options/restoreOptions/impersonation/useImpersonation
Impersonate User
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
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
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
stripLevel
Type: integer
Command Line Paramter: stripLevel
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/stripLevel
level from begining of the source path
recreateMountPoints
Type: boolean
Possible Values: true/false
Command Line Paramter: recreateMountPoints
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/recreateMountPoints
Mount database after restore
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
doNotOverwriteFileOnDisk
Type: boolean
Possible Values: true/false
Command Line Paramter: doNotOverwriteFileOnDisk
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/doNotOverwriteFileOnDisk
Do Not Overwrite File On Disk
systemStateBackup
Type: boolean
Possible Values: true/false
Command Line Paramter: systemStateBackup
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/systemStateBackup
System State Backup
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
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
restoreDataInsteadOfStub
Type: boolean
Possible Values: true/false
Command Line Paramter: restoreDataInsteadOfStub
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/restoreDataInsteadOfStub
Restore data instead of stub
 
SubTask Options
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
 
Associations
backupsetName
Type: string
Command Line Paramter: associations/backupsetName
Location: taskInfo/associations/backupsetName
Backupset Name
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