HelloWorld Scan

This Playbook simulates a vulnerability scan using the "HelloWorld" sample integration. It's used to demonstrate how to use the GenericPolling mechanism to run jobs that take several seconds or minutes to complete. It is designed to be used as a subplaybook, but you can also use it as a standalone playbook, by providing the ${Endpoint.Hostname} input in the Context.

Other inputs include the report output format (JSON context or File attached), and the Interval/Timeouts to use for polling the scan status until it's complete.

Dependencies

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

Sub-playbooks

  • GenericPolling

Integrations

  • HelloWorld

Scripts

  • PrintErrorEntry

Commands

  • helloworld-scan-start
  • helloworld-scan-results
  • helloworld-scan-status

Playbook Inputs


NameDescriptionDefault ValueSourceRequired
HostnameHostname to run the scan against. By default takes ${Endpoint.Hostname} from the context as the input.Hostname}${EndpointRequired
Report FormatOutput report format: can be "json" (output parsed and written in the Context) or "file" (saved as an attachment). By default is "json".jsonRequired
IntervalHow often to check for the scan to be completed (minutes)1Required
TimeoutHow long to wait for the scan to be completed before timing out (minutes)15Required

Playbook Outputs


PathDescriptionType
HelloWorld.Scan.entity.entity-idScanned entity ID.unknown
HelloWorld.Scan.entity.ip_addressScanned entity IP address.unknown
HelloWorld.Scan.entity.typeScanned entity type.unknown
HelloWorld.Scan.entity.vulnerability_statusScanned entity vulnerability status.unknown
HelloWorld.Scan.entity.vulnsScanned entity CVE.unknown
CVE.IDThe ID of the CVE.unknown
InfoFile.EntryIDThe EntryID of the report file.unknown
InfoFile.ExtensionThe extension of the report file.unknown
InfoFile.NameThe name of the report file.unknown
InfoFile.InfoThe info of the report file.unknown
InfoFile.SizeThe size of the report file.unknown
InfoFile.TypeThe type of the report file.unknown

Playbook Image