PDQ Deploy Command Line Reference

<< Click to Display Table of Contents >>

PDQ Deploy Command Line Reference

PDQ Deploy includes a command line interface (CLI) that allows you to automate and script common operations. All commands are run through PDQDeploy.exe, which is located in the PDQ Deploy installation directory (typically C:\Program Files\Admin Arsenal\PDQ Deploy).

To use the CLI, open a cmd.exe or PowerShell window as Administrator, then run commands using the syntax:

PDQDeploy <command> [parameters]

To see a list of all available commands, run:

PDQDeploy Help

To see usage details for a specific command, run:

PDQDeploy Help <command> 

Available Commands

Command

License

Description

BackgroundService

Free

Manages the background service, including starting, stopping, and updating service account credentials.

CheckDatabase

Free

Runs a SQLite integrity check and reports whether the database is healthy or corrupt.

CleanUnusedRepoFiles

Free

Identifies and removes files in the repository that are no longer referenced by any package.

ConsoleUsers

Enterprise

Lists, adds, or removes Windows accounts authorized to connect to the background service.

CreateCustomVariable

Enterprise

Creates a new custom variable with the specified name and value.

Database

Free

Opens the database directly in the sqlite3.exe command line tool.

DatabaseCleanup

Enterprise

Runs a multi-step cleanup process to remove stale data and improve database performance.

DeletePackages

Enterprise

Deletes one or more packages by name or wildcard pattern.

DeleteScheduleHistory

Enterprise

Deletes deployment history for a computer from one or all schedules.

Deploy

Enterprise

Deploys a package to one or more target computers.

ExportPackages

Enterprise

Exports one or more package definitions to XML files for backup or synchronization.

GetDeploymentStatus

Enterprise

Returns status information for deployments, with support for querying by ID, package name, or status.

GetPackageNames

Free

Lists the names of all packages.

GetSchedules

Enterprise

Lists all schedules with their IDs and names.

Help

Free

Displays available commands and their license requirements, or usage details for a specific command.

ImportPackages

Enterprise

Imports one or more package definitions from XML files.

OptimizeDatabase

Free

Runs a SQLite VACUUM on the database to reclaim disk space and improve performance.

ProfileBackgroundService

Free

Captures a CPU performance profile of the background service for support diagnostics.

RepairDatabase

Free

Exports and re-imports the database to recover from corruption.

RestoreDatabase

Free

Restores the database from a backup file.

SendDatabase

Free

Packages and uploads the database and support files to PDQ support.

SetServiceMode

Enterprise

Configures PDQ Deploy to run in Local, Client, or Server mode.

SetServiceCredentials

Free

Updates the Windows service account credentials used by the PDQ Deploy background service.

Settings

Free

Reads or writes internal settings and feature flags.

StartSchedule

Enterprise

Triggers an existing schedule to run immediately.

SystemInfo

Free

Outputs information about the PDQ Deploy installation, such as version and database path.

TestCredential

Free

Tests a deployment credential by connecting to a target computer.

UpdateCustomVariable

Enterprise

Updates the value of an existing custom variable.

UpdateDeployCredential

Free

Updates an existing deployment credential stored in PDQ Deploy by name.

General Usage Notes

All commands must be run from a command prompt or PowerShell window opened as Administrator.

The PDQ Deploy background service must be running for most commands. OptimizeDatabase and RepairDatabase require the service to be stopped and will prompt you to stop it if it is running.

Parameter names are case-insensitive and can be abbreviated to any unique prefix (e.g., -T instead of -Targets).

String values containing spaces must be wrapped in double quotes.

NOTE: Commands marked Enterprise require a PDQ Deploy Enterprise license. Running them with a lower license tier will return an error.

 

 

 

© 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