Command Line XML Options for Job Summary Report

Options
 
Task Request Information
DescriptionField NameData TypeCommandline Parameter
Tasktask
TypetaskTypeenumtaskType
Initiated FrominitiatedFromenuminitiatedFrom
Task FlagstaskFlags
Disableddisabledbooleandisabled
 
Report Options
DescriptionField NameData TypeCommandline Parameter
Job OptionjobOptionbooleanjobOption
Allow Dynamic ContentallowDynamicContentbooleanallowDynamicContent
Report Common OptionscommonOpt
Report TypereportTypeenumreportType
On CSonCSbooleanonCS
Report Template TypereportTemplateTypeenumreportTemplateType
Output FormatoutputFormat
Output TypeoutputTypeenumoutputType
Localelocale
Locale NamelocaleNamestringlocaleName
Computer Selection ListcomputerSelectionList
Include AllincludeAllbooleanincludeAll
Agent ListagentList
Includeincludebooleaninclude
Run Reports betweentimeRangeOption
Typetypeenumtype
Time Zone NameTimeZoneNamestringTimeZoneName
Job Summary Report optionsjobSummaryReport
Group BygroupByenumgroupBy
Subclient FiltersubclientFilterbooleansubclientFilter
Job OptionsjobOptions
Size UnitsizeUnitenumsizeUnit
Throughput UnitisThroughputInMBbooleanisThroughputInMB
Show Time In Commserve Time ZoneisCommserveTimeZonebooleanisCommserveTimeZone
Backup TypesbackupTypes
AllallbooleanbackupTypes/all
Fullfullbooleanfull
Incrementalincrementalbooleanincremental
Differentialdifferentialbooleandifferential
Synthetic FullsyntheticFullbooleansyntheticFull
Automated System RecoveryautomatedSystemRecoverybooleanautomatedSystemRecovery
Job StatusjobStatus
AllallbooleanjobStatus/all
Increase In Data SizeincreaseInDataSize
SelectedselectedbooleanincreaseInDataSize/selected
ValuevaluelongincreaseInDataSize/value
Decrease In Data SizedecreaseInDataSize
SelectedselectedbooleandecreaseInDataSize/selected
ValuevaluelongdecreaseInDataSize/value
Retention TyperetentionType
Retention AllretentionAllbooleanretentionAll
Basic RetentionbasicRetentionbooleanbasicRetention
Extended RetentionextendedRetentionbooleanextendedRetention
Report SelectionsrptSelections
Failure ReasonfailureReasonbooleanfailureReason
Job AttemptsjobAttemptsbooleanjobAttempts
Associated EventassociatedEventbooleanassociatedEvent
Subclient Content And FilterssubclientContentAndFiltersbooleansubclientContentAndFilters
Protected ObjectsprotectedObjectsbooleanprotectedObjects
Failed ObjectsfailedObjectsbooleanfailedObjects
Content Indexing FailurescontentIndexingFailuresbooleancontentIndexingFailures
Associated MediaassociatedMediabooleanassociatedMedia
Drivedrivebooleandrive
Storage PolicystoragePolicybooleanstoragePolicy
Media AgentsmediaAgentsbooleanmediaAgents
Initializing UserinitializingUserbooleaninitializingUser
Size Change PercentagesizeChangePercentagebooleansizeChangePercentage
Descriptiondescriptionbooleandescription
Aged DataagedDatabooleanagedData
Inc Backup Copy JobsIncBackupCopyJobsbooleanIncBackupCopyJobs
Include Media Deleted JobsIncludeMediaDeletedJobsbooleanIncludeMediaDeletedJobs
Subclient Job OptsubclientJobOptenumsubclientJobOpt
Include Snap Protection Jobs OnlyincludeSnapProtectionJobsOnlybooleanincludeSnapProtectionJobsOnly
Include Backup Files OnlyincludeBackupFilesOnlybooleanincludeBackupFilesOnly
 
SubTask Options
DescriptionField NameData TypeCommandline Parameter
Sub Task TypesubTaskTypeenumsubTaskType (st)
Operation TypeoperationTypeenumoperationType (op)


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
 
Report Options
jobOption
Type: boolean
Possible Values: true/false
Command Line Paramter: jobOption
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobOption
Job Option
allowDynamicContent
Type: boolean
Possible Values: true/false
Command Line Paramter: allowDynamicContent
Location: taskInfo/subTasks/options/adminOpts/reportOption/allowDynamicContent
Allow Dynamic Content
Report Common Options
reportType
Type: enum
Possible Values: UNKNOWN , EVENT_REPORT , SCHEDULE_VIEW_REPORT , SCHEDULE_SUMMARY_REPORT , DAILY_BACKUP_REPORT , COMMCELL_GROWTH_REPORT , BACKUP_STATUS_TRACKING_REPORT , BACKUP_HISTORY_REPORT , QR_CREATION_REPORT , MIGRATION_REPORT , QR_RECOVERY_REPORT , DM_RECOVERY_REPORT , RESTORE_HISTORY_REPORT , CALENDAR_MIGRATION_REPORT , CONDENSED_MIGRATION_REPORT , MEDIA_IN_SCRATCH_POOL_REPORT , MEDIA_MGT_HOUSEKEEPING_REPORT , COMMCELL_CONFIGURATION_REPORT , STUB_RECALL_REPORT , CDR_RECOVERY_REPORT , DRIVE_AND_LIBRARY_REPORT , OFFLINE_SNAP_COPY_REPORT , MAGNETIC_LIBRARY_MAINTANENCE_REPORT , ADMIN_SRM_REPORT , SRM_DATA_COLLECTION_REPORT , INFORMATION_MGMT_JOB_REPORT , STORAGE_POLICY_REPORT , SCRATCH_POOL_REPORT , ERASE_BACKUP_ARCHIVE_DATA_REPORT , SILO_ARCHIVE_REPORT , SILO_RETRIEVE_REPORT , MEDIA_IN_LIBRARY_REPORT , MEDIA_INFORMATION_REPORT , VAULT_TRACKING_REPORT , NAS_BACKUP_ARCHIVE_REPORT , AUX_COPY_HISTORY_REPORT , DOWNLOAD_UPDATES_HISTORY_REPORT , DISTRIBUTE_UPDATES_HISTORY_REPORT , INSTALL_REMOVE_SOFTWARE_JOB_REPORT , ALL_ADMIN_JOB_HISTORY_REPORT , DATA_AGING_REPORT , DATA_VERIFICATION_REPORT , OFFLINE_CONTENT_INDEXING_REPORT , ONLINE_CONTENT_INDEXING_REPORT , SEARCH_RESTORE_HISTORY_REPORT , DR_BACKUP_HISTORY_REPORT , COMMCELL_READINESS_REPORT , CDR_REPORT , ALL_JOBS_HISTORY_REPORT , JOBS_IN_STORAGE_POLICY_REPORT , LICENSE_REPORT , GUI_AUDIT_REPORT , USER_CAPABILITY_REPORT , JOBS_ON_MEDIA_REPORT , DATA_RETENTION_FORECAST_REPORT , DATA_AGING_TROUBLESHOOTING_REPORT , MEDIA_PREDICTION_REPORT , COMMCELL_EXPORT_REPORT , COMMCELL_IMPORT_REPORT , MEDIA_REFRESHING_REPORT , DM2_REVIEWSET_POSTING_REPORT , DM2_REVIEWSET_ACTIVITY_REPORT , DM2_LEGALHOLD_SUMMARY_REPORT , DM2_SEARCH_ACTIVITY_REPORT , DM2_CHAIN_CUSTODY_REPORT , DM2_REVIEWSET_SUMMARY_REPORT , DM2_REVIEWSET_SUMMARY_REPORT
Command Line Paramter: reportType
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/reportType
Report Type
onCS
Type: boolean
Possible Values: true/false
Command Line Paramter: onCS
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/onCS
On CS
reportTemplateType
Type: enum
Default Value: Native
Possible Values: Native , NetApp , NetBackup , NetBackup
Command Line Paramter: reportTemplateType
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/reportTemplateType
Report Template Type
Output Format
outputType
Type: enum
Default Value: HTML
Possible Values: NONE , HTML , FULL_TEXT , SHORT_TEXT , SUMMARY_HTML , IRON_MOUNTAIN , PDF , TIFF , EXCEL , CSV , STYLE_SHEET , MHTML , MHTML
Command Line Paramter: outputType
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/outputFormat/outputType
Output Type
Locale
localeName
Type: string
Command Line Paramter: localeName
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/locale/localeName
Locale Name
Computer Selection List
includeAll
Type: boolean
Possible Values: true/false
Command Line Paramter: includeAll
Location: taskInfo/subTasks/options/adminOpts/reportOption/computerSelectionList/includeAll
Include All
Agent List
include
Type: boolean
Possible Values: true/false
Command Line Paramter: include
Location: taskInfo/subTasks/options/adminOpts/reportOption/agentList/flags/include
Include
Run Reports between
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: type
Location: taskInfo/subTasks/options/adminOpts/reportOption/timeRangeOption/type
Type
TimeZoneName
Type: string
Command Line Paramter: TimeZoneName
Location: taskInfo/subTasks/options/adminOpts/reportOption/timeRangeOption/TimeZoneName
Time Zone Name
Job Summary Report options
groupBy
Type: enum
Possible Values: NONE , AGENT , CLIENT , JOB_ID , STORAGE_POLICY , EVENT_ID , NEXT_SCHEDULE_TIME , ACTION , DESTINATION , SOURCE , LIBRARY , LOCATION , CONTAINER , LAST_WRITE_TIME , MEDIA_AGENT , STORAGEPOLICY_OR_SPAREGROUPNAME , QR_RECOVERY_AGENT_POLICY , BARCODE , BARCODE
Command Line Paramter: groupBy
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/groupBy
Group By
subclientFilter
Type: boolean
Possible Values: true/false
Command Line Paramter: subclientFilter
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/subclientFilter
Subclient Filter
Job Options
sizeUnit
Type: enum
Possible Values: NONE , SIZE_IN_MB , SIZE_IN_GB , SIZE_IN_GB
Command Line Paramter: sizeUnit
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/sizeUnit
Size Unit
isThroughputInMB
Type: boolean
Possible Values: true/false
Command Line Paramter: isThroughputInMB
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/isThroughputInMB
Throughput Unit
isCommserveTimeZone
Type: boolean
Possible Values: true/false
Command Line Paramter: isCommserveTimeZone
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/isCommserveTimeZone
Show Time In Commserve Time Zone
Backup Types
all
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: backupTypes/all
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/backupTypes/all
All
full
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: full
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/backupTypes/full
Full
incremental
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: incremental
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/backupTypes/incremental
Incremental
differential
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: differential
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/backupTypes/differential
Differential
syntheticFull
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: syntheticFull
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/backupTypes/syntheticFull
Synthetic Full
automatedSystemRecovery
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: automatedSystemRecovery
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/backupTypes/automatedSystemRecovery
Automated System Recovery
Job Status
all
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: jobStatus/all
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/jobStatus/all
All
Increase In Data Size
selected
Type: boolean
Possible Values: true/false
Command Line Paramter: increaseInDataSize/selected
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/increaseInDataSize/selected
Selected
value
Type: long
Command Line Paramter: increaseInDataSize/value
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/increaseInDataSize/value
Value
Decrease In Data Size
selected
Type: boolean
Possible Values: true/false
Command Line Paramter: decreaseInDataSize/selected
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/decreaseInDataSize/selected
Selected
value
Type: long
Command Line Paramter: decreaseInDataSize/value
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/decreaseInDataSize/value
Value
Retention Type
retentionAll
Type: boolean
Possible Values: true/false
Command Line Paramter: retentionAll
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/retentionType/retentionAll
Retention All
basicRetention
Type: boolean
Possible Values: true/false
Command Line Paramter: basicRetention
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/retentionType/basicRetention
Basic Retention
extendedRetention
Type: boolean
Possible Values: true/false
Command Line Paramter: extendedRetention
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/jobOptions/retentionType/extendedRetention
Extended Retention
Report Selections
failureReason
Type: boolean
Default Value: true
Possible Values: true/false
Command Line Paramter: failureReason
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/failureReason
Failure Reason
jobAttempts
Type: boolean
Possible Values: true/false
Command Line Paramter: jobAttempts
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/jobAttempts
Job Attempts
associatedEvent
Type: boolean
Possible Values: true/false
Command Line Paramter: associatedEvent
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/associatedEvent
Associated Event
subclientContentAndFilters
Type: boolean
Possible Values: true/false
Command Line Paramter: subclientContentAndFilters
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/subclientContentAndFilters
Subclient Content And Filters
protectedObjects
Type: boolean
Possible Values: true/false
Command Line Paramter: protectedObjects
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/protectedObjects
Protected Objects
failedObjects
Type: boolean
Possible Values: true/false
Command Line Paramter: failedObjects
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/failedObjects
Failed Objects
contentIndexingFailures
Type: boolean
Possible Values: true/false
Command Line Paramter: contentIndexingFailures
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/contentIndexingFailures
Content Indexing Failures
associatedMedia
Type: boolean
Possible Values: true/false
Command Line Paramter: associatedMedia
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/associatedMedia
Associated Media
drive
Type: boolean
Possible Values: true/false
Command Line Paramter: drive
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/drive
Drive
storagePolicy
Type: boolean
Possible Values: true/false
Command Line Paramter: storagePolicy
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/storagePolicy
Storage Policy
mediaAgents
Type: boolean
Possible Values: true/false
Command Line Paramter: mediaAgents
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/mediaAgents
Media Agents
initializingUser
Type: boolean
Possible Values: true/false
Command Line Paramter: initializingUser
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/initializingUser
Initializing User
sizeChangePercentage
Type: boolean
Possible Values: true/false
Command Line Paramter: sizeChangePercentage
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/sizeChangePercentage
Size Change Percentage
description
Type: boolean
Possible Values: true/false
Command Line Paramter: description
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/description
Description
agedData
Type: boolean
Possible Values: true/false
Command Line Paramter: agedData
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/agedData
Aged Data
IncBackupCopyJobs
Type: boolean
Possible Values: true/false
Command Line Paramter: IncBackupCopyJobs
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/IncBackupCopyJobs
Inc Backup Copy Jobs
IncludeMediaDeletedJobs
Type: boolean
Possible Values: true/false
Command Line Paramter: IncludeMediaDeletedJobs
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/IncludeMediaDeletedJobs
Include Media Deleted Jobs
subclientJobOpt
Type: enum
Default Value: COVERAGE
Possible Values: NONE , COVERAGE , LATEST_TREND , LATEST_TREND
Command Line Paramter: subclientJobOpt
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/subclientJobOpt
Subclient Job Opt
includeSnapProtectionJobsOnly
Type: boolean
Possible Values: true/false
Command Line Paramter: includeSnapProtectionJobsOnly
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/includeSnapProtectionJobsOnly
Include Snap Protection Jobs Only
includeBackupFilesOnly
Type: boolean
Possible Values: true/false
Command Line Paramter: includeBackupFilesOnly
Location: taskInfo/subTasks/options/adminOpts/reportOption/jobSummaryReport/rptSelections/includeBackupFilesOnly
Include Backup Files Only
 
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