Nexpose - Create and Download Report

Use this playbook as a sub-playbook to configure a report and download it. This playbook implements polling by continuously running the `nexpose-get-report-status` command until the operation completes. The remote action should have the following structure: 1. Initiate the operation - insert the type of the report (sites, scan, or assets) and it's additional arguments if required. 2. Poll to check if the operation completed. 3. Get the results of the operation.

Rapid7 InsightVM · 10 tasks · 7 inputs · 9 outputs

Inputs

  • report_type — `sites`, `scan`, or `assets`.
  • sites — Multiple criteria of integer<int32> Site ids to create the report on, comma-separated.
  • assets — Multiple criteria of integer<int64> Asset ids to create the report on, comma-separated.
  • scan — integer <int64> The identifier of the scan.
  • name — The report name.
  • template — Report template id to create the report with. If none is provided, the first template available will be used.
  • format — The report format. Default is pdf.

Outputs

  • InfoFile.EntryId — Entry Id of the report file
  • InfoFile.Name — Name of the report file
  • InfoFile.Extension — File extension of the report file
  • InfoFile.Info — Info about the report file
  • InfoFile.Size — Size of the report file
  • InfoFile.Type — Type of the report file
  • Nexpose.Report.ID — The identifier of the report.
  • Nexpose.Report.InstanceID — The identifier of the report instance.
  • Nexpose.Report.Status — The status of the report generation process. Valid values: "aborted", "failed", "complete", "running", "unknown"

Commands used

nexpose-create-assets-report nexpose-create-scan-report nexpose-create-sites-report nexpose-download-report nexpose-get-report-status

Flowchart

Assets report Scan report Sites report yes Start Start Check input Check input GenericPolling - GenericPolling GenericPolling GenericPolling Done Done Download Report - nexpose-download-report Download Report nexpose-download-report Create Sites report - nexpose-create-sites-report Create Sites report nexpose-create-sites-report Create Assets report - nexpose-create-assets-report Create Assets report nexpose-create-assets-report Create Scan report - nexpose-create-scan-report Create Scan report nexpose-create-scan-report Get Report Status - nexpose-get-report-status Get Report Status nexpose-get-report-status Verify Status Verify Status