Launch And Fetch Scan Based Findings Report - Qualys

Launches a scan based report and fetcesh the report when it's ready.

Qualys · 7 tasks · 9 inputs · 6 outputs

Inputs

  • template_id — The template ID of the report you want to launch. Can be found by running qualys-report-template-list.
  • output_format — One output format may be specified. When output_format=pdf is specified, the Secure PDF Distribution may be used.
  • report_refs — This parameter specifies the scan references to include. A scan reference starts with the string "scan/" followed by a reference ID number. Multiple scan references are comma separated. Reference can be found by running the command qualys-vm-scan-list.
  • report_title — A user-defined report title. The title may have a maximum of 128 characters. For a PCI compliance report, the report title is provided by Qualys and cannot be changed.
  • hide_header — (Valid for CSV format report only). Specify hide_header=1 to omit the header information from the report. By default this information is included.
  • recipient_group_id — Specify users who will receive the email notification when the report is complete (i.e. supply a distribution group ID). Where do I find this ID? Log in to your Qualys account, go to Users > Distribution Groups and select Info for a group in the list.
  • pdf_password — '(Optional; Required for secure PDF distribution) The password to be used for encryption. Requirements: - the password must have a minimum of 8 characters (ascii), and a maximum of 32 characters - the password must contain alpha and numeric characters - the password cannot match the password for the user’s Qualys account. - the password must follow the password security guidelines defined for your subscription (log in and go to Subscription Setup—>Security Options).'
  • recipient_group — Optional; Optional for secure PDF distribution) The report recipients in the form of one or more distribution groups, as defined using the Qualys UI. Multiple distribution groups are comma separated. A maximum of 50 distribution groups may be entered. Chapter 4 — Report API Launch Report recipient_group={value}
  • ip_restriction — For a scan report, the report content will be restricted to the specified IPs/ranges. Multiple IPs and/or ranges are comma separated.

Outputs

  • InfoFile.Name — The file name.
  • InfoFile.EntryID — The ID for locating the file in the War Room.
  • InfoFile.Size — The size of the file (in bytes).
  • InfoFile.Type — The file type, as determined by libmagic (same as displayed in file entries).
  • InfoFile.Extension — The file extension.
  • InfoFile.Info — Basic information about the file.

Commands used

qualys-report-fetch qualys-report-launch-scan-based-findings qualys-report-list

Flowchart

yes Start Start qualys-report-launch-scan-based-findings - qualys-report-launch-scan-based-findings qualys-report-launch-scan... qualys-report-launch-scan-bas... qualys-report-fetch - qualys-report-fetch qualys-report-fetch qualys-report-fetch GenericPolling - GenericPolling GenericPolling GenericPolling Get the created scan metadata - qualys-report-list Get the created scan meta... qualys-report-list Check if scan metadata returned Check if scan metadata re... Print Error - PrintErrorEntry Print Error PrintErrorEntry