Scheduling an alert details report using the CLI

Prev Next

Use the commands in this section to schedule a consolidated Alert Details report.

Note

Before you can schedule an Alert Details report to be generated and sent through email, ensure that the SMTP server or domain is configured. You must also specify the email address of the report recipient. For details about configuring these report settings, refer to theFile Protect System Administration Guide.

To schedule an Alert Details report for automatic generation and email distribution:
hostname (config) # show report schedule
Periodicity  MonthDay       WeekDay  Time    Transport Command
3 weekly       -            Sun      12:00   file     common/Alert_Details       report_format xml time_frame past_week

Total reporting jobs scheduled: 1.
  1. Go to CLI configuration mode.

    hostname > enable 
    hostname # configure terminal
  2. Specify an Alert Details report.

    hostname (config) # report schedule run <frequency> type Alert_Details
  3. Specify how often to run the report.

    • To update daily:

      hostname (config) # report schedule run daily at <hh:mm>

      where <hh:mm> specifies the time to start based on a 24-hour clock.

    • To update hourly:

      hostname (config) # report schedule run hourly at <mm>

      where <mm> is the number of minutes within the hour.

    • To update monthly:

      hostname (config) # report schedule run monthly on {<date> | end of month} at <hh:mm>

      where:

      <date> is the day of the month when the update should occur.

      <hh:mm> specifies the time to start based on a 24-hour clock.

    • To update weekly:

      hostname (config) # report schedule run weekly every <day> at <hh:mm>

      where:

      <day> is the day of the week the when update should occur.

      <hh:mm> specifies the time to start based on a 24-hour clock.

  4. Specify a report format.

    • To generate a report in .xml format:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format xml
    • To generate a report in .json format:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format json
    • To generate a report in .csv format:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format csv
    • To generate a report in text format:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format text
  5. Specify the level of detail for the report.

    • To send basic information:

      hostname (config) # report schedule run <frequency> Alert_Details report_format <report_format> report_detail concise
    • To send detailed information and abstracts:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format <report_format> report_detail normal
    • To send detailed information and abstracts about files and objects:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format <report_format> report_detail extended
  6. Specify the malware object as the alert type.

    hostname (config) # report schedule run <frequency> Alert_Details report_format <report_format> report_detail <report_detail> alert_type malware-object
  7. Specify the time period for the reports.

    • To specify for the past day:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format <report_format> report_detail <report_detail> alert_type malware-objecttime_frame past_day
    • To specify for the past week:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format <report_format> report_detail <report_detail> alert_type malware-objecttime_frame past_week
    • To specify for the past month:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format <report_format> report_detail <report_detail> alert_type malware-objecttime_frame past_month
    • To specify for the past three months:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format <report_format> report_detail <report_detail> alert_type malware-objecttime_frame past_3_months
  8. Specify the delivery method for the report. The default delivery is email.

    • To deliver the report through email:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format <report_format> report_detail <report_detail> alert_type malware-object time_frame <time_frame> transport email
    • To deliver the report as a file:

      hostname (config) # report schedule run <frequency> type Alert_Details report_format <report_format> report_detail <report_detail> alert_type malware-object time_frame <time_frame> transport file
  9. Verify the configuration for the report schedule.