Command Line XML Backup Options - Virtual Server iDataAgent

Options
 
Task Request Information
DescriptionField NameData TypeCommandline Parameter
Tasktask
Policy TypepolicyTypeenumpolicyType
TypetaskTypeenumtaskType
Initiated FrominitiatedFromenuminitiatedFrom
Task FlagstaskFlags
Disableddisabledbooleandisabled
 
Update Options
DescriptionField NameData TypeCommandline Parameter
Synchronize Remote Software CachessyncUpdateCachesbooleansyncUpdateCaches
Update Software After InstallationupdateClientAfterInstallationbooleanupdateClientAfterInstallation
Copy UpdatescopyUpdatesbooleancopyUpdates
 
Restore Job Options
DescriptionField NameData TypeCommandline Parameter
Restore Access Control TyperestoreACLsTypeenumrestoreACLsType
Restore Netware TrusteesrestoreNetwareTrusteesenumrestoreNetwareTrustees
Browse OptionbrowseOption
Comm Cell IdcommCellIdintegercommCellId
List MedialistMediabooleanlistMedia
Backupsetbackupset
Backupset NamebackupsetNamestringbackupset/backupsetName (b)
Typetypeenumbackupset/type
Time RangetimeRange
TypetypeenumtimeRange/type
Media OptionmediaOption
Copy PrecedencemediaOption/copyPrecedence
Restore from copy precedencecopyPrecedenceApplicablebooleancopyPrecedenceApplicable
Copy Precedence TypecopyPrecedenceTypeenumcopyPrecedenceType
Synchronous Copy PrecedencesynchronousCopyPrecedenceintegersynchronousCopyPrecedence
Copy PrecedencecopyPrecedenceintegercopyPrecedence/copyPrecedence
Restore Destinationdestination
Specify destination pathdestPathlist:stringdestPath
Restore to same folderinPlacebooleaninPlace
Restore only if target existsrestoreOnlyIfTargetExistsbooleanrestoreOnlyIfTargetExists
Destination clientdestClient
Client NameclientNamestringdestClient/clientName (c)
TypetypeenumdestClient/type
Virtual Server Restore OptionvirtualServerRstOption
Is File BrowseisFileBrowsebooleanisFileBrowse
Is Disk BrowseisDiskBrowsebooleanisDiskBrowse
Is Volume BrowseisVolumeBrowsebooleanisVolumeBrowse
File Restore OptionfileOption
Source ItemsourceItemlist:stringsourceItem
Restore Common OptionscommonOptions
Overwrite FilesoverwriteFilesbooleanoverwriteFiles
Automatically Detect Regular ExpressionsdetectRegularExpressionbooleandetectRegularExpression
PreservepreserveSourcebooleanpreserveSource
Unconditional OverwriteunconditionalOverwritebooleanunconditionalOverwrite
Strip Level TypestripLevelTypeenumstripLevelType
level from end of the source pathpreserveLevelintegerpreserveLevel
level from begining of the source pathstripLevelintegerstripLevel
Restore ACLsrestoreACLsbooleanrestoreACLs
Skip errors and continueskipErrorsAndContinuebooleanskipErrorsAndContinue
Do not replay transaction logsdoNotReplayTransactLogsbooleandoNotReplayTransactLogs
Skip if existsskipIfExistsbooleanskipIfExists
System State BackupsystemStateBackupbooleansystemStateBackup
Recover all protected mailsofflineMiningRestorebooleanofflineMiningRestore
Er Ex Spdb Path RestoreerExSpdbPathRestorebooleanerExSpdbPathRestore
Cluster DBBackedupclusterDBBackedupbooleanclusterDBBackedup
Use Rman RestoreuseRmanRestorebooleanuseRmanRestore
 
SubTask Options
DescriptionField NameData TypeCommandline Parameter
Sub Task IdsubTaskIdintegersubTaskId
Sub Task TypesubTaskTypeenumsubTaskType (st)
Operation TypeoperationTypeenumoperationType (op)
FlagsflagsintegersubTask/flags
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
policyType
Type: enum
Default Value: DATA_PROTECTION
Possible Values: DATA_PROTECTION , AUX_COPY , SRM_REPORT , SINGLE_INSTANCING , SRM_JOBS , SUBCLIENT_FILTER , CONTENT_INDEX , CONTENT_INDEX
Command Line Paramter: policyType
Location: taskInfo/task/policyType
Policy Type
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
 
Update Options
syncUpdateCaches
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: syncUpdateCaches
Location: taskInfo/subTasks/options/adminOpts/updateOption/syncUpdateCaches
Synchronize Remote Software Caches
updateClientAfterInstallation
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: updateClientAfterInstallation
Location: taskInfo/subTasks/options/adminOpts/updateOption/updateClientAfterInstallation
Update Software After Installation
copyUpdates
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: copyUpdates
Location: taskInfo/subTasks/options/adminOpts/updateOption/copyUpdates
Copy Updates
 
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
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
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
destPath
Type: list:string
Command Line Paramter: destPath
Location: taskInfo/subTasks/options/restoreOptions/destination/destPath
Specify destination path
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
Virtual Server Restore Option
isFileBrowse
Type: boolean
Possible Values: true/false
Command Line Paramter: isFileBrowse
Location: taskInfo/subTasks/options/restoreOptions/virtualServerRstOption/isFileBrowse
Is File Browse
isDiskBrowse
Type: boolean
Possible Values: true/false
Command Line Paramter: isDiskBrowse
Location: taskInfo/subTasks/options/restoreOptions/virtualServerRstOption/isDiskBrowse
Is Disk Browse
isVolumeBrowse
Type: boolean
Possible Values: true/false
Command Line Paramter: isVolumeBrowse
Location: taskInfo/subTasks/options/restoreOptions/virtualServerRstOption/isVolumeBrowse
Is Volume Browse
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
preserveSource
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: preserveSource
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/preserveSource
Preserve
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
restoreACLs
Type: boolean
Possible Values: true/false
Command Line Paramter: restoreACLs
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/restoreACLs
Restore ACLs
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
systemStateBackup
Type: boolean
Possible Values: true/false
Command Line Paramter: systemStateBackup
Location: taskInfo/subTasks/options/restoreOptions/commonOptions/systemStateBackup
System State Backup
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
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: subTask/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