Command Line XML Restore Options - Microsoft SQL Server iDataAgent

Options
 
Task Request Information
DescriptionField NameData TypeCommandline Parameter
Tasktask
TypetaskTypeenumtaskType
Initiated FrominitiatedFromenuminitiatedFrom
Task FlagstaskFlags
Disableddisabledbooleandisabled
 
Restore Job Options
DescriptionField NameData TypeCommandline Parameter
Restore Access Control TyperestoreACLsTypeenumrestoreACLsType
Restore Netware TrusteesrestoreNetwareTrusteesenumrestoreNetwareTrustees
Browse OptionbrowseOption
Comm Cell IdcommCellIdintegercommCellId
Restore deleted itemsnoImagebooleannoImage
List MedialistMediabooleanlistMedia
Backupsetbackupset
Backupset NamebackupsetNamestringbackupset/backupsetName (b)
Typetypeenumbackupset/type
Time RangetimeRange
TypetypeenumtimeRange/type
To TimetoTimeintegertoTime
Media OptionmediaOption
Copy PrecedencemediaOption/copyPrecedence
Restore from copy precedencecopyPrecedenceApplicablebooleancopyPrecedenceApplicable
Copy Precedence TypecopyPrecedenceTypeenumcopyPrecedenceType
Synchronous Copy PrecedencesynchronousCopyPrecedenceintegersynchronousCopyPrecedence
Copy PrecedencecopyPrecedenceintegercopyPrecedence/copyPrecedence
Restore Destinationdestination
Restore to same folderinPlacebooleaninPlace
Restore only if target existsrestoreOnlyIfTargetExistsbooleanrestoreOnlyIfTargetExists
Destination clientdestClient
Client NameclientNamestringdestClient/clientName (c)
TypetypeenumdestClient/type
Destination InstancedestinationInstance
Instance NameinstanceNamestringdestinationInstance/instanceName (i)
TypetypeenumdestinationInstance/type
SQL Server Restore OptionsqlServerRstOption
Leave Database in DBO use only statedbOnlybooleandbOnly
Unconditionally overwrite existing database or filesoverWritebooleanoverWrite
Point-in-timepointOfTimeRstbooleanpointOfTimeRst
Sql Restore TypesqlRestoreTypeenumsqlRestoreType
Sql Recover TypesqlRecoverTypeenumsqlRecoverType
Stop Start SSAstopStartSSAbooleanstopStartSSA
Preserve Replication SettingspreserveReplicationSettingsbooleanpreserveReplicationSettings
Stop Mark RestorestopMarkRestorebooleanstopMarkRestore
Stop Before Mark RestorestopBeforeMarkRestorebooleanstopBeforeMarkRestore
Partial RestorepartialRestorebooleanpartialRestore
Apply Log backups onlylogShippingOnlybooleanlogShippingOnly
Ffg RestoreffgRestorebooleanffgRestore
Skip Full BackupignoreFullBackupbooleanignoreFullBackup
VSSBackupvSSBackupbooleanvSSBackup
Analysis Server Security InfoanalysisServerSecurityInfoenumanalysisServerSecurityInfo
Keep Change Data CapturekeepDataCapturebooleankeepDataCapture
Point In TimepointInTime
Timetimeintegertime
Time ZonetimeZone
Time Zone NameTimeZoneNamestringTimeZoneName
File Restore OptionfileOption
Map FilesmapFiles
Rename all restore files with suffixrenameFilesSuffixstringrenameFilesSuffix
Restore Common OptionscommonOptions
Overwrite FilesoverwriteFilesbooleanoverwriteFiles
Automatically Detect Regular ExpressionsdetectRegularExpressionbooleandetectRegularExpression
PreservepreserveSourcebooleanpreserveSource
Strip Level TypestripLevelTypeenumstripLevelType
level from end of the source pathpreserveLevelintegerpreserveLevel
Skip errors and continueskipErrorsAndContinuebooleanskipErrorsAndContinue
Do not replay transaction logsdoNotReplayTransactLogsbooleandoNotReplayTransactLogs
Skip if existsskipIfExistsbooleanskipIfExists
One Pass RestoreonePassRestorebooleanonePassRestore
Recover all protected mailsofflineMiningRestorebooleanofflineMiningRestore
Er Ex Spdb Path RestoreerExSpdbPathRestorebooleanerExSpdbPathRestore
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 NameinstanceNamestringassociations/instanceName (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
 
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
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
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
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
Destination Instance
instanceName
Type: string
Command Line Paramter: destinationInstance/instanceName
Location: taskInfo/subTasks/options/restoreOptions/destination/destinationInstance/instanceName
Instance Name
type
Type: enum
Default Value: GALAXY
Possible Values: GALAXY , NBU , NETAPP , TSM , TSM
Command Line Paramter: destinationInstance/type
Location: taskInfo/subTasks/options/restoreOptions/destination/destinationInstance/type
Type
SQL Server Restore Option
dbOnly
Type: boolean
Possible Values: true/false
Command Line Paramter: dbOnly
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/dbOnly
Leave Database in DBO use only state
overWrite
Type: boolean
Possible Values: true/false
Command Line Paramter: overWrite
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/overWrite
Unconditionally overwrite existing database or files
pointOfTimeRst
Type: boolean
Possible Values: true/false
Command Line Paramter: pointOfTimeRst
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/pointOfTimeRst
Point-in-time
sqlRestoreType
Type: enum
Default Value: DATABASE_RESTORE
Possible Values: DATABASE_RESTORE , STEP_RESTORE , RECOVER_ONLY , RECOVER_ONLY
Command Line Paramter: sqlRestoreType
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/sqlRestoreType
Sql Restore Type
sqlRecoverType
Type: enum
Default Value: STATE_RECOVER
Possible Values: STATE_RECOVER , STATE_NORECOVER , STATE_STANDBY , STATE_STANDBY
Command Line Paramter: sqlRecoverType
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/sqlRecoverType
Sql Recover Type
stopStartSSA
Type: boolean
Possible Values: true/false
Command Line Paramter: stopStartSSA
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/stopStartSSA
Stop Start SSA
preserveReplicationSettings
Type: boolean
Possible Values: true/false
Command Line Paramter: preserveReplicationSettings
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/preserveReplicationSettings
Preserve Replication Settings
stopMarkRestore
Type: boolean
Possible Values: true/false
Command Line Paramter: stopMarkRestore
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/stopMarkRestore
Stop Mark Restore
stopBeforeMarkRestore
Type: boolean
Possible Values: true/false
Command Line Paramter: stopBeforeMarkRestore
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/stopBeforeMarkRestore
Stop Before Mark Restore
partialRestore
Type: boolean
Possible Values: true/false
Command Line Paramter: partialRestore
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/partialRestore
Partial Restore
logShippingOnly
Type: boolean
Possible Values: true/false
Command Line Paramter: logShippingOnly
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/logShippingOnly
Apply Log backups only
ffgRestore
Type: boolean
Possible Values: true/false
Command Line Paramter: ffgRestore
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/ffgRestore
Ffg Restore
ignoreFullBackup
Type: boolean
Possible Values: true/false
Command Line Paramter: ignoreFullBackup
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/ignoreFullBackup
Skip Full Backup
vSSBackup
Type: boolean
Possible Values: true/false
Command Line Paramter: vSSBackup
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/vSSBackup
VSSBackup
analysisServerSecurityInfo
Type: enum
Default Value: COPY_ALL
Possible Values: COPY_ALL , SKIP_MEMBERSHIP , SKIP_MEMBERSHIP
Command Line Paramter: analysisServerSecurityInfo
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/analysisServerSecurityInfo
Analysis Server Security Info
keepDataCapture
Type: boolean
Possible Values: true/false
Command Line Paramter: keepDataCapture
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/keepDataCapture
Keep Change Data Capture
Point In Time
time
Type: integer
Command Line Paramter: time
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/pointInTime/time
Time
Time Zone
TimeZoneName
Type: string
Command Line Paramter: TimeZoneName
Location: taskInfo/subTasks/options/restoreOptions/sqlServerRstOption/timeZone/TimeZoneName
Time Zone Name
File Restore Option
Map Files
renameFilesSuffix
Type: string
Command Line Paramter: renameFilesSuffix
Location: taskInfo/subTasks/options/restoreOptions/fileOption/mapFiles/renameFilesSuffix
Rename all restore files with suffix
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
preserveSource
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: preserveSource
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/preserveSource
Preserve
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
onePassRestore
Type: boolean
Possible Values: true/false
Command Line Paramter: onePassRestore
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/onePassRestore
One Pass Restore
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
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: associations/instanceName
Location: taskInfo/associations/instanceName
Instance Name