Command Line XML Data Collection Options

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
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
 
Backup Job Options
DescriptionField NameData TypeCommandline Parameter
Backup TypebackupLevelenumbackupLevel (t)
Data Backup OptiondataOpt
Create new indexcreateNewIndexbooleancreateNewIndex
Preserve Folder Sizes In IndexpreserveFolderSizesInIndexbooleanpreserveFolderSizesInIndex
 
SubTask Options
DescriptionField NameData TypeCommandline Parameter
Sub Task TypesubTaskTypeenumsubTaskType (st)
Operation TypeoperationTypeenumoperationType (op)
 
Associations
DescriptionField NameData TypeCommandline Parameter
Backupset NamebackupsetNamestringbackupsetName (b)
Subclient NamesubclientNamestringsubclientName (s)
Client NameclientNamestringclientName (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
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
 
Backup Job Options
backupLevel
Type: enum
Default Value: INCREMENTAL
Possible Values: NONE , FULL , INCREMENTAL , DIFFERENTIAL , SYNTHETIC_FULL , ASR , TRANSACTION_LOG , PRE_SELECT , QR_SNAPSHOT , QR_CREATE_QR_VOLUME , QR_INCREMENTALLY_UPDATE_QR_VOLUME , SRM_ANALYSIS , SRM_DISCOVERY , MINING , DATA_VERIFICATION , DATA_VERIFICATION
Command Line Paramter: backupLevel
Location: taskInfo/subTasks/options/backupOpts/backupLevel
Backup Type
Data Backup Option
createNewIndex
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: createNewIndex
Location: taskInfo/subTasks/options/backupOpts/dataOpt/createNewIndex
Create new index
preserveFolderSizesInIndex
Type: boolean
Possible Values: true/false
Command Line Paramter: preserveFolderSizesInIndex
Location: taskInfo/subTasks/options/backupOpts/dataOpt/preserveFolderSizesInIndex
Preserve Folder Sizes In Index
 
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: backupsetName
Location: taskInfo/associations/backupsetName
Backupset Name
subclientName
Type: string
Command Line Paramter: subclientName
Location: taskInfo/associations/subclientName
Subclient Name
clientName
Type: string
Command Line Paramter: 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