Using the Command Line Interface › caadvreports - Advanced Report Generator Command › caadvreports - Options

caadvreports - Options

The caadvreports command provides various options for generating advanced reports and sending alerts via the CA ARCserve Backup Alert Manager.

The caadvreports command includes the following options:

• -ReportType <n>

  Specifies the type of report to be generated. This parameter is required for all the reports.

  The value of <n> determines the type of report that will be generated.

  The following list provides the value of <n> and the report that it generates.

Note: For more information about each report, see caadvreports - Reports.

• -OutFile [set the File Name variable]

  Specifies the full path of the file where the generated report will be saved. This is a required parameter for all the reports.

  If '-AutoName' is used, this switch is not needed.

• -StartDate <mm/dd/yyyy> [hh:mm:ss]

  Specifies the start date and time of the reporting duration. The time parameter 'hh:mm:ss' is optional. If the time is not specified, it is assumed to be '00:00:00' (12:00 AM). If time is specified, it should be specified in 24 hour format.

  Note: If the "-PastDays <n>" switch is included, then this switch is not needed.

• -EndDate <mm/dd/yyyy> [hh:mm:ss]

  Specifies the end date and time of the reporting duration. The time parameter 'hh:mm:ss' is optional. If the time is not specified, it is assumed to be '11:59:00' (11:59 PM). If time is specified, it should be specified in 24 hour format.

  Note: If the "-PastDays <n>" switch is included, then this switch is not needed.

• -Server <remote server>

  Specifies the remote server on which the report is to be executed. Typically, reports are executed on the Primary server. This is included if the report is to be executed on a remote Member server.

• -JobDesc <string text> [-XML | -CSV]

  Specifies the job description string text. This is included by some reports to limit the output to include only certain jobs with job description matching the string text.

• -XML

  Specifies to generate a report in XML format. Generated XML reports can be used in conjunction with the provided response .xsl file to generate an HTML report.

  This is a default option if no other overwriting option is specified and cannot be combined with -CSV parameter.

• -CSV

  Specifies to generate a report in Comma Separated Value format.

• -Percent <percent value>

  Specifies the percent value that can be used for filtering the report.

• -Top <n>

  Specifies to limit the report output to just the top 'n' count.

• -Serial <serial>

  Specifies to limit the report output to only those drives whose serial number matches the specified serial string pattern. Serial numbers are compared against device serial numbers in the Drive Throughput Report.

• -PastDays <n>

  Specifies the past number of days for which the report is to be generated starting from the current time. This switch can be used in place of the '‑StartDate' and '‑EndDate' switches to generate a report for a fixed duration.

  For example, to generate a weekly report, the value of 'n' would be set to 7 and this specifies to generate a report for the last seven days.

• -AutoName

  Specifies that the output report name will be automatically generated. The auto generated file name is created by combining the report name and the execution date and time.

• -Alert

  Sends an alert message when the report is completed. The alert messages should be set from Alert Manager, under "ARCserve" configuration.

• -VaultCycle

  Used with the Vaulting Report to auto-run the Vaulting Cycle before generating the report.

  Important! If using this switch, do not manually run the Vault Cycle before or after the report on the day on which this report is generated.