<< Click to Display Table of Contents >> GetDeploymentStatus |
Returns status information for one or more deployments. Use this command to monitor deployment progress, integrate with automation workflows, or generate reports on deployment outcomes.
NOTE: This command requires a PDQ Deploy Enterprise license.
PDQDeploy GetDeploymentStatus -Id <id[,id,...]> [-Status <status>] [-Since <value>] [-Limit <count>] [-IncludeTargets] [-Json]
PDQDeploy GetDeploymentStatus -Id <id[,id,...]> [-Status <status>] [-Since <value>] [-Limit <count>] [-Csv]
PDQDeploy GetDeploymentStatus -Name <packageName> [-All] [-Status <status>] [-Since <value>] [-Limit <count>] [-IncludeTargets] [-Json]
PDQDeploy GetDeploymentStatus -Name <packageName> [-All] [-Status <status>] [-Since <value>] [-Limit <count>] [-Csv]
PDQDeploy GetDeploymentStatus -PackageId <id> [-All] [-Status <status>] [-Since <value>] [-IncludeTargets] [-Json]
PDQDeploy GetDeploymentStatus -PackageId <id> [-All] [-Status <status>] [-Since <value>] [-Csv]
PDQDeploy GetDeploymentStatus -Running [-Status <status>] [-Since <value>] [-Limit <count>] [-Json | -Csv]
PDQDeploy GetDeploymentStatus -Status <status> [-Since <value>] [-Limit <count>] [-Json | -Csv]
Parameter |
Required |
Description |
|---|---|---|
-Id |
No* |
Deployment ID or comma-separated list of IDs to query. |
-Name |
No* |
Package name. Returns the most recent deployment for that package. Use -All to return the full deployment history. Supports wildcard patterns (e.g., Adobe*), which return the most recent deployment for each matching package (or all deployments with -All). |
-PackageId |
No* |
Package ID. Returns the most recent deployment for that package. Use -All to return the full deployment history. |
-Running |
No* |
Show all currently running or queued deployments. |
-All |
No |
Return all deployments instead of only the most recent. Only valid with -Name or -PackageId. |
-Status |
No |
Filter results by status. Accepted values: Succeeded, Failed, Running. Can be used alone to list all deployments matching that status. |
-Since |
No |
Filter to deployments created on or after a point in time. Accepts a date string (e.g., 2026-01-01) or ISO 8601 duration relative to now (e.g., P1D for the past day, PT2H for the past 2 hours). |
-Json |
No |
Output results in JSON format for parsing by external tools. |
-Csv |
No |
Output results in CSV format for spreadsheet import. |
-IncludeTargets |
No |
Include per-target status details in the output. Supported with default text and -Json output. Cannot be combined with -Csv. |
-Limit |
No |
Maximum number of deployments to return when listing results (default: 500). Must be a positive integer. |
* At least one of -Id, -Name, -PackageId, -Running, -Status, or -Since is required.
Code |
Meaning |
|---|---|
0 |
Deployment succeeded (all targets successful), or list shown successfully. |
1 |
Deployment failed (one or more targets failed). Only applies when querying a single deployment by -Id. |
2 |
Deployment is still running or queued. Only applies when querying a single deployment by -Id. |
3 |
Deployment not found. |
Check the status of a specific deployment:
PDQDeploy GetDeploymentStatus -Id 42
Check multiple deployments at once:
PDQDeploy GetDeploymentStatus -Id 42,43,44
Get the most recent deployment for a package by name:
PDQDeploy GetDeploymentStatus -Name "Adobe Reader"
Get the most recent deployment for all packages matching a wildcard:
PDQDeploy GetDeploymentStatus -Name "Adobe*"
Get the most recent deployment for a package by ID:
PDQDeploy GetDeploymentStatus -PackageId 7
List all currently running or queued deployments:
PDQDeploy GetDeploymentStatus -Running
List all failed deployments from the past 7 days:
PDQDeploy GetDeploymentStatus -Status Failed -Since P7D
Get deployment status in JSON format for script processing:
PDQDeploy GetDeploymentStatus -Id 42 -Json
List running deployments as CSV for a spreadsheet:
PDQDeploy GetDeploymentStatus -Running -Csv
Show per-target details for a deployment:
PDQDeploy GetDeploymentStatus -Id 42 -IncludeTargets
Use the exit code in a script to wait for completion:
PDQDeploy GetDeploymentStatus -Id 42
if ($LASTEXITCODE -eq 2) { Write-Host "Still running..." }
if ($LASTEXITCODE -eq 1) { Write-Host "Deployment failed!" }
NOTE: Exit codes 1 and 2 only apply when querying a single deployment by ID. When listing multiple deployments or using -Running, -Status, or -Since, the command always exits with code 0 on success.
© 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