<< Click to Display Table of Contents >> RunAutoReport |
Manually triggers an auto report to run immediately, executing all configured reports, file saves, and email notifications. By default the command returns once the auto report is queued. Use -Wait to block until all reports complete and display per-report results.
NOTE: This command requires a PDQ Inventory Enterprise license.
PDQInventory RunAutoReport -Name <autoReport> [-Wait] [-Timeout <seconds>]
PDQInventory RunAutoReport -Id <id> [-Wait] [-Timeout <seconds>]
Parameter |
Required |
Description |
|---|---|---|
-Name <autoReport> |
Yes* |
The name of the auto report to run. Required if -Id is not specified. If neither is specified, available auto reports are listed. |
-Id <id> |
Yes* |
The numeric ID of the auto report to run. Required if -Name is not specified. |
-Wait |
No |
Blocks until all reports in the auto report complete, then displays per-report results including status and any errors. Without this flag the command returns immediately after queuing. |
-Timeout <seconds> |
No |
Maximum number of seconds to wait before returning. If the auto report has not completed within this period the command exits with code 2; the auto report continues running in the background. Requires -Wait. |
* Either -Name or -Id is required.
Code |
Description |
|---|---|
0 |
Auto report queued successfully, or all reports completed successfully when using -Wait. |
1 |
Auto report not found, or one or more reports failed. Only returned when using -Wait. |
2 |
Timeout reached before the auto report completed. Only returned when using -Wait with -Timeout. |
3 |
User cancelled the wait with Ctrl+C. Only returned when using -Wait. |
Queue an auto report by name:
PDQInventory RunAutoReport -Name "Weekly Report"
Queue an auto report and wait for all reports to complete:
PDQInventory RunAutoReport -Name "Weekly Report" -Wait
Wait up to 10 minutes for the auto report to complete before returning:
PDQInventory RunAutoReport -Name "Weekly Report" -Wait -Timeout 600
Queue an auto report by ID:
PDQInventory RunAutoReport -Id 5
List all available auto reports:
PDQInventory RunAutoReport
NOTE: Running this command generates an audit log entry recording that the auto report was triggered via the CLI.
© 2026 PDQ.com Corporation. All rights reserved.
PDQ.com is a trademark of PDQ.com Corporation. All other product and company names are the property of their respective owners.
Help Version: 20.0.22.0