Command Line XML Options for Scratch Pool Report

Options
 
Task Request Information
DescriptionField NameData TypeCommandline Parameter
Tasktask
TypetaskTypeenumtaskType
Initiated FrominitiatedFromenuminitiatedFrom
Task FlagstaskFlags
Disableddisabledbooleandisabled
 
Schedule Pattern
DescriptionField NameData TypeCommandline Parameter
Freqfreq_typeenumfreq_type
Freqfreq_intervalintegerfreq_interval
Freqfreq_recurrence_factorintegerfreq_recurrence_factor
Freqfreq_subday_intervalintegerfreq_subday_interval
Activeactive_start_dateintegeractive_start_date
Activeactive_start_timeintegeractive_start_time
Activeactive_end_timeintegeractive_end_time
Activeactive_end_occurenceintegeractive_end_occurence
Descriptiondescriptionstringdescription
Time ZonetimeZone
Time Zone NameTimeZoneNamestringTimeZoneName
 
Report Options
DescriptionField NameData TypeCommandline Parameter
Report Common OptionscommonOpt
Report TypereportTypeenumreportType
On CSonCSbooleanonCS
Report Template TypereportTemplateTypeenumreportTemplateType
Output FormatoutputFormat
Output TypeoutputTypeenumoutputType
Saved TosavedTo
Is Network DriveisNetworkDrivebooleanisNetworkDrive
Location URLlocationURLstringlocationURL
Ftp Upload LocationftpUploadLocationstringftpUploadLocation
Report Saved To ClientreportSavedToClient
Client NameclientNamestringclientName (c)
Localelocale
Locale NamelocaleNamestringlocaleName
Scratch Pool ReportscratchPoolReport
Spare GroupspareGroupenumspareGroup
Include MediaincludeMediabooleanincludeMedia
Exclude Standalone LibrariesexcludeStandaloneLibrariesbooleanexcludeStandaloneLibraries
 
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
 
Schedule Pattern
freq_type
Type: enum
Default Value: Daily
Possible Values: One_Time , On_Demand , Daily , Weekly , Monthly , Monthly_Relative , Yearly , Yearly_Relative , Smart_Schedule , Automatic_Schedule , Automatic_Schedule
Command Line Paramter: freq_type
Location: taskInfo/subTasks/pattern/freq_type
Freq
freq_interval
Type: integer
Default Value: 0
Command Line Paramter: freq_interval
Location: taskInfo/subTasks/pattern/freq_interval
Freq
freq_recurrence_factor
Type: integer
Default Value: 0
Command Line Paramter: freq_recurrence_factor
Location: taskInfo/subTasks/pattern/freq_recurrence_factor
Freq
freq_subday_interval
Type: integer
Default Value: 0
Command Line Paramter: freq_subday_interval
Location: taskInfo/subTasks/pattern/freq_subday_interval
Freq
active_start_date
Type: integer
Default Value: 0
Command Line Paramter: active_start_date
Location: taskInfo/subTasks/pattern/active_start_date
Active
active_start_time
Type: integer
Default Value: 0
Command Line Paramter: active_start_time
Location: taskInfo/subTasks/pattern/active_start_time
Active
active_end_time
Type: integer
Default Value: 0
Command Line Paramter: active_end_time
Location: taskInfo/subTasks/pattern/active_end_time
Active
active_end_occurence
Type: integer
Default Value: 0
Command Line Paramter: active_end_occurence
Location: taskInfo/subTasks/pattern/active_end_occurence
Active
description
Type: string
Command Line Paramter: description
Location: taskInfo/subTasks/pattern/description
Description
Time Zone
TimeZoneName
Type: string
Command Line Paramter: TimeZoneName
Location: taskInfo/subTasks/pattern/timeZone/TimeZoneName
Time Zone Name
 
Report Options
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 , RECONSTRUCT_DEDUPE_DATABASE_JOB_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 , SRM_AGENTLESS_JOB_REPORT , SRM_AGENTLESS_JOB_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 , NetBackup , NetBackup
Command Line Paramter: reportTemplateType
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/reportTemplateType
Report Template Type
Output Format
outputType
Type: enum
Default Value: MHTML
Possible Values: NONE , HTML , FULL_TEXT , SHORT_TEXT , SUMMARY_HTML , IRON_MOUNTAIN , PDF , TIFF , EXCEL , CSV , STYLE_SHEET , MHTML , XML , XML
Command Line Paramter: outputType
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/outputFormat/outputType
Output Type
Saved To
isNetworkDrive
Type: boolean
Possible Values: true/false
Command Line Paramter: isNetworkDrive
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/savedTo/isNetworkDrive
Is Network Drive
locationURL
Type: string
Command Line Paramter: locationURL
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/savedTo/locationURL
Location URL
ftpUploadLocation
Type: string
Default Value: SimpanaReports
Command Line Paramter: ftpUploadLocation
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/savedTo/ftpUploadLocation
Ftp Upload Location
Report Saved To Client
clientName
Type: string
Command Line Paramter: clientName
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/savedTo/reportSavedToClient/clientName
Client Name
Locale
localeName
Type: string
Command Line Paramter: localeName
Location: taskInfo/subTasks/options/adminOpts/reportOption/commonOpt/locale/localeName
Locale Name
Scratch Pool Report
spareGroup
Type: enum
Default Value: ALL_SPARE_GROUPS
Possible Values: NONE , ALL_SPARE_GROUPS , SCRATCHPOOLS_LESS_THAN_MEDIA , SCRATCHPOOLS_BELOW_LOW_WATERMARK , SCRATCHPOOLS_BELOW_LOW_WATERMARK
Command Line Paramter: spareGroup
Location: taskInfo/subTasks/options/adminOpts/reportOption/scratchPoolReport/spareGroup
Spare Group
includeMedia
Type: boolean
Possible Values: true/false
Command Line Paramter: includeMedia
Location: taskInfo/subTasks/options/adminOpts/reportOption/scratchPoolReport/includeMedia
Include Media
excludeStandaloneLibraries
Type: boolean
Possible Values: true/false
Command Line Paramter: excludeStandaloneLibraries
Location: taskInfo/subTasks/options/adminOpts/reportOption/scratchPoolReport/excludeStandaloneLibraries
Exclude Standalone Libraries
 
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