Skip to main content

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.

Dependencies#

This playbook uses the following sub-playbooks, integrations, and scripts.

Sub-playbooks#

  • GenericPolling

Integrations#

  • Rapid7_Nexpose

Scripts#

This playbook does not use any scripts.

Commands#

  • nexpose-create-scan-report
  • nexpose-download-report
  • nexpose-create-sites-report
  • nexpose-create-assets-report

Playbook Inputs#


NameDescriptionDefault ValueRequired
report_type`sites`, `scan`, or `assets`.Required
sitesMultiple criteria of integer<int32> Site ids to create the report on, comma-separated.Optional
assetsMultiple criteria of integer<int64> Asset ids to create the report on, comma-separated.Optional
scaninteger <int64> The identifier of the scan.Optional
nameThe report name.Optional
templateReport template id to create the report with. If none is provided, the first template available will be used.Optional
formatThe report format. Default is pdf.Optional

Playbook Outputs#


PathDescriptionType
InfoFile.EntryIdEntry Id of the report filestring
InfoFile.NameName of the report filestring
InfoFile.ExtensionFile extension of the report filestring
InfoFile.InfoInfo about the report filestring
InfoFile.SizeSize of the report filenumber
InfoFile.TypeType of the report filestring

Playbook Image#


Nexpose - Create and download a report