Launch And Fetch Compliance Policy Report - Qualys
Launches a compliance policy report and then fetches the report when it's ready.
- Pack
- qualys
- Tasks
- 4
Inputs
- template_id — The template ID of the report you want to launch. Can be found by running the command qualys-report-template-list.
- output_format — One output format can be specified. When output_format=pdf is specified, the Secure PDF Distribution can be used.
- 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 — (Required for secure PDF distribution, Manager or Unit Manager only) Used for secure PDF report distribution when this feature is enabled in the user's account (under Reports > Setup > Report Share). The password to be used for encryption. - 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 (under Users > Setup > Security)
- recipient_group — Used for secure PDF distribution. The report recipients in the form of one or more distribution group names, as defined using the Qualys UI. Multiple distribution groups are comma separated. A maximum of 50 distribution groups may be entered.
- ips — (Optional for compliance report) For a compliance report (except a PCI report), specify the IPs/ranges you want to include in the report. Multiple IPs and/or ranges are comma separated.
- asset_group_ids — (Optional for compliance report) For a compliance report (except a PCI report), specify asset groups IDs which identify hosts to include in the report. Multiple asset group IDs are comma separated. Looking for asset group IDs? Use the asset_group_list.php function (in the API v1 User Guide).
- policy_id — Specifies the policy to run the report on. A valid policy ID must be entered.
- host_id — In the policy report output, show only results for a single host instance. Specify the ID for the host to include in the report. A valid host ID must be entered.
- instance_string — Specifies a single instance on the selected host. The instance string may be “os” or a string like “oracle10:1:1521:ora10204u”.
Commands used
- qualys-report-fetch
- qualys-report-launch-compliance-policy