ScanCollections

<< Click to Display Table of Contents >>

ScanCollections

Queues a scan for all computers in one or more collections. By default the command returns once scans are queued. Use -Wait to block until all scans complete and display per-computer results. If no scan profile is specified, the default scan profile is used.

NOTE: This command requires a PDQ Inventory Enterprise license.

Syntax

PDQInventory ScanCollections -Collections <collection1> [<collection2> ...] [-ScanProfile <profile>] [-Wait] [-Quiet] [-Timeout <seconds>] [-Json | -Csv | -Brief]

Parameters

Parameter

Required

Description

-Collections <collection> ...

Yes

One or more collection names or paths to scan, separated by spaces. Use GetAllCollections to find collection names.

-ScanProfile <profile>

No

The name or ID of the scan profile to use. Defaults to the default scan profile if not specified. Use GetAllScanProfiles to find profile names.

-Wait

No

Blocks until all scans complete, then displays per-computer results including status, duration, and any errors. Without this flag the command returns immediately after queuing scans.

-Quiet

No

Suppresses the real-time progress display while waiting. Requires -Wait.

-Timeout <seconds>

No

Maximum number of seconds to wait before returning current status. Incomplete scans are reported as Timeout. Requires -Wait.

-Json

No

Outputs scan results in JSON format. Mutually exclusive with -Csv and -Brief. Requires -Wait.

-Csv

No

Outputs scan results in CSV format. Mutually exclusive with -Json and -Brief. Requires -Wait.

-Brief

No

Outputs one status line per computer. Mutually exclusive with -Json and -Csv. Requires -Wait.

Exit Codes

Code

Description

0

All scans queued successfully, or all scans completed successfully when using -Wait.

1

One or more scans failed. Only returned when using -Wait.

2

Timeout reached before all scans completed. Only returned when using -Wait with -Timeout.

3

User cancelled the wait with Ctrl+C. Running scans are aborted. Only returned when using -Wait.

Examples

Scan all computers in the "Windows 10" collection using the default scan profile:

PDQInventory ScanCollections -Collections "Windows 10"

Scan multiple collections using a specific scan profile:

PDQInventory ScanCollections -Collections "Windows 10" Servers -ScanProfile "Standard"

Scan and wait for completion before continuing:

PDQInventory ScanCollections -Collections "Windows 10" -Wait

Scan, wait up to 5 minutes, and output results as JSON for automated processing:

PDQInventory ScanCollections -Collections Servers -ScanProfile "Standard" -Wait -Timeout 300 -Json

 

 

 

© 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