Command Line XML Online Content Indexing Options

Options
 
Task Request Information
DescriptionField NameData TypeCommandline Parameter
Tasktask
Policy TypepolicyTypeenumpolicyType
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
 
Update Options
DescriptionField NameData TypeCommandline Parameter
Synchronize Remote Software CachessyncUpdateCachesbooleansyncUpdateCaches
Update Software After InstallationupdateClientAfterInstallationbooleanupdateClientAfterInstallation
Copy UpdatescopyUpdatesbooleancopyUpdates
 
Backup Job Options
DescriptionField NameData TypeCommandline Parameter
Backup TypebackupLevelenumbackupLevel (t)
Run Incremental BackuprunIncrementalBackupbooleanrunIncrementalBackup
Inc LevelincLevelenumincLevel
Do Not Truncate LogdoNotTruncateLogbooleandoNotTruncateLog
Sybase Skip Full after Log BackupsybaseSkipFullafterLogBkpbooleansybaseSkipFullafterLogBkp
Enable Granular RecoverycollectMetaInfobooleancollectMetaInfo
Srm Backup LevelsrmBackupLevelenumsrmBackupLevel
Media Backup OptionmediaOpt
Allow Other Schedules To Use Media SetallowOtherSchedulesToUseMediaSetbooleanallowOtherSchedulesToUseMediaSet
Mark Media Full On SuccessmarkMediaFullOnSuccessbooleanmarkMediaFullOnSuccess
Start New MediastartNewMediabooleanstartNewMedia
Wait For Inline Backup ResourceswaitForInlineBackupResourcesbooleanwaitForInlineBackupResources
DaysnumberofDaysintegernumberofDays
Extend Job RetentionretentionJobTypeenumretentionJobType
Data Backup OptiondataOpt
Create new indexcreateNewIndexbooleancreateNewIndex
Backup Files Protected by System File ProtectionbkpFilesProctedByFSbooleanbkpFilesProctedByFS
Follow mount pointsfollowMountPointsbooleanfollowMountPoints
HotFix InformationcollectHotFixInformationbooleancollectHotFixInformation
Stop DHCP Service when Backing up System State DatastopDhcpServicebooleanstopDhcpService
Stop WINS Service when Backing up System State DatastopWinServicebooleanstopWinService
Verify Synthetic FullverifySynthFullbooleanverifySynthFull
Ignore Error in Synthetic FullignorErrorInSynthFullbooleanignorErrorInSynthFull
Perform Consistency CheckskipConsistencyCheckbooleanskipConsistencyCheck
Throttle NUmberthrottleNUmberintegerthrottleNUmber
Include files that don’t match with destination copyoptimizedBackupbooleanoptimizedBackup
Enable Granular Recovery For Backup Copygranularrecoverybooleangranularrecovery
Vault Tracker Backup OptionvaultTrackerOpt
Exclude Media Not CopiedexcludeMediaNotCopiedbooleanexcludeMediaNotCopied
Export Media After Job FinishesexportMediaAfterJobFinishesbooleanexportMediaAfterJobFinishes
Track TransittrackTransitbooleantrackTransit
Use Virtual Mail SlotsuseVirtualMailSlotsbooleanuseVirtualMailSlots
Filter Media By RetentionfilterMediaByRetentionbooleanfilterMediaByRetention
Media with extended retention job(s)mediaWithExtendedRetentionJobsbooleanmediaWithExtendedRetentionJobs
Media StatusmediaStatus
Allallbooleanall
Activeactivebooleanactive
Fullfullbooleanfull
Overwrite ProtectedoverwriteProtectedbooleanoverwriteProtected
Badbadbooleanbad
Export Location:exportLocation
Location NamelocationNamestringexportLocation/locationName (loc)
In Transit LocationinTransitLocation
Location NamelocationNamestringinTransitLocation/locationName (loc)
Data Path Backup OptiondataPathOpt
Library Entity for DataPathlibrary
Library NamelibraryNamestringlibraryName (l)
Drive Pool Entity for DataPathdrivePool
Drive Pool NamedrivePoolNamestringdrivePoolName (d)
 
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 NamebackupsetNamestringbackupsetName (b)
Typetypeenumtype
Subclient NamesubclientNamestringsubclientName (s)
Consume LicenseconsumeLicensebooleanconsumeLicense
Client Side PackageclientSidePackagebooleanclientSidePackage
Client NameclientNamestringclientName (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
 
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
 
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
 
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
runIncrementalBackup
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: runIncrementalBackup
Location: taskInfo/subTasks/options/backupOpts/runIncrementalBackup
Run Incremental Backup
incLevel
Type: enum
Default Value: BEFORE_SYNTH
Possible Values: NONE , BEFORE_SYNTH , AFTER_SYNTH , AFTER_SYNTH
Command Line Paramter: incLevel
Location: taskInfo/subTasks/options/backupOpts/incLevel
Inc Level
doNotTruncateLog
Type: boolean
Default Value: false
Possible Values: true/false
Command Line Paramter: doNotTruncateLog
Location: taskInfo/subTasks/options/backupOpts/doNotTruncateLog
Do Not Truncate Log
sybaseSkipFullafterLogBkp
Type: boolean
Possible Values: true/false
Command Line Paramter: sybaseSkipFullafterLogBkp
Location: taskInfo/subTasks/options/backupOpts/sybaseSkipFullafterLogBkp
Sybase Skip Full after Log Backup
collectMetaInfo
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: collectMetaInfo
Location: taskInfo/subTasks/options/backupOpts/collectMetaInfo
Enable Granular Recovery
srmBackupLevel
Type: enum
Default Value: NONE
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: srmBackupLevel
Location: taskInfo/subTasks/options/backupOpts/srmBackupLevel
Srm Backup Level
Media Backup Option
allowOtherSchedulesToUseMediaSet
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: allowOtherSchedulesToUseMediaSet
Location: taskInfo/subTasks/options/backupOpts/mediaOpt/allowOtherSchedulesToUseMediaSet
Allow Other Schedules To Use Media Set
markMediaFullOnSuccess
Type: boolean
Possible Values: true/false
Command Line Paramter: markMediaFullOnSuccess
Location: taskInfo/subTasks/options/backupOpts/mediaOpt/markMediaFullOnSuccess
Mark Media Full On Success
startNewMedia
Type: boolean
Possible Values: true/false
Command Line Paramter: startNewMedia
Location: taskInfo/subTasks/options/backupOpts/mediaOpt/startNewMedia
Start New Media
waitForInlineBackupResources
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: waitForInlineBackupResources
Location: taskInfo/subTasks/options/backupOpts/mediaOpt/waitForInlineBackupResources
Wait For Inline Backup Resources
numberofDays
Type: integer
Command Line Paramter: numberofDays
Location: taskInfo/subTasks/options/backupOpts/mediaOpt/numberofDays
Days
retentionJobType
Type: enum
Default Value: STORAGE_POLICY_DEFAULT
Possible Values: INFINITE , NO_OF_DAYS , STORAGE_POLICY_DEFAULT , STORAGE_POLICY_DEFAULT
Command Line Paramter: retentionJobType
Location: taskInfo/subTasks/options/backupOpts/mediaOpt/retentionJobType
Extend Job Retention
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
bkpFilesProctedByFS
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: bkpFilesProctedByFS
Location: taskInfo/subTasks/options/backupOpts/dataOpt/bkpFilesProctedByFS
Backup Files Protected by System File Protection
followMountPoints
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: followMountPoints
Location: taskInfo/subTasks/options/backupOpts/dataOpt/followMountPoints
Follow mount points
collectHotFixInformation
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: collectHotFixInformation
Location: taskInfo/subTasks/options/backupOpts/dataOpt/collectHotFixInformation
HotFix Information
stopDhcpService
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: stopDhcpService
Location: taskInfo/subTasks/options/backupOpts/dataOpt/stopDhcpService
Stop DHCP Service when Backing up System State Data
stopWinService
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: stopWinService
Location: taskInfo/subTasks/options/backupOpts/dataOpt/stopWinService
Stop WINS Service when Backing up System State Data
verifySynthFull
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: verifySynthFull
Location: taskInfo/subTasks/options/backupOpts/dataOpt/verifySynthFull
Verify Synthetic Full
ignorErrorInSynthFull
Type: boolean
Default Value: false
Possible Values: true/false
Command Line Paramter: ignorErrorInSynthFull
Location: taskInfo/subTasks/options/backupOpts/dataOpt/ignorErrorInSynthFull
Ignore Error in Synthetic Full
skipConsistencyCheck
Type: boolean
Default Value: false
Possible Values: true/false
Command Line Paramter: skipConsistencyCheck
Location: taskInfo/subTasks/options/backupOpts/dataOpt/skipConsistencyCheck
Perform Consistency Check
throttleNUmber
Type: integer
Default Value: 20
Command Line Paramter: throttleNUmber
Location: taskInfo/subTasks/options/backupOpts/dataOpt/throttleNUmber
Throttle NUmber
optimizedBackup
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: optimizedBackup
Location: taskInfo/subTasks/options/backupOpts/dataOpt/optimizedBackup
Include files that don’t match with destination copy
granularrecovery
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: granularrecovery
Location: taskInfo/subTasks/options/backupOpts/dataOpt/granularrecovery
Enable Granular Recovery For Backup Copy
Vault Tracker Backup Option
excludeMediaNotCopied
Type: boolean
Possible Values: true/false
Command Line Paramter: excludeMediaNotCopied
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/excludeMediaNotCopied
Exclude Media Not Copied
exportMediaAfterJobFinishes
Type: boolean
Possible Values: true/false
Command Line Paramter: exportMediaAfterJobFinishes
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/exportMediaAfterJobFinishes
Export Media After Job Finishes
trackTransit
Type: boolean
Possible Values: true/false
Command Line Paramter: trackTransit
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/trackTransit
Track Transit
useVirtualMailSlots
Type: boolean
Possible Values: true/false
Command Line Paramter: useVirtualMailSlots
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/useVirtualMailSlots
Use Virtual Mail Slots
filterMediaByRetention
Type: boolean
Possible Values: true/false
Command Line Paramter: filterMediaByRetention
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/filterMediaByRetention
Filter Media By Retention
mediaWithExtendedRetentionJobs
Type: boolean
Possible Values: true/false
Command Line Paramter: mediaWithExtendedRetentionJobs
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/mediaWithExtendedRetentionJobs
Media with extended retention job(s)
Media Status
all
Type: boolean
Possible Values: true/false
Command Line Paramter: all
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/mediaStatus/all
All
active
Type: boolean
Possible Values: true/false
Command Line Paramter: active
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/mediaStatus/active
Active
full
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: full
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/mediaStatus/full
Full
overwriteProtected
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: overwriteProtected
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/mediaStatus/overwriteProtected
Overwrite Protected
bad
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: bad
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/mediaStatus/bad
Bad
Export Location:
locationName
Type: string
Command Line Paramter: exportLocation/locationName
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/exportLocation/locationName
Location Name
In Transit Location
locationName
Type: string
Command Line Paramter: inTransitLocation/locationName
Location: taskInfo/subTasks/options/backupOpts/vaultTrackerOpt/inTransitLocation/locationName
Location Name
Data Path Backup Option
Library Entity for DataPath
libraryName
Type: string
Command Line Paramter: libraryName
Location: taskInfo/subTasks/options/backupOpts/dataPathOpt/library/libraryName
Library Name
Drive Pool Entity for DataPath
drivePoolName
Type: string
Command Line Paramter: drivePoolName
Location: taskInfo/subTasks/options/backupOpts/dataPathOpt/drivePool/drivePoolName
Drive Pool Name
 
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: backupsetName
Location: taskInfo/associations/backupsetName
Backupset Name
type
Type: enum
Default Value: GALAXY
Possible Values: GALAXY , NBU , NETAPP , TSM , TSM
Command Line Paramter: type
Location: taskInfo/associations/type
Type
subclientName
Type: string
Command Line Paramter: subclientName
Location: taskInfo/associations/subclientName
Subclient Name
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: 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