prb device command reference
Reference for 8 commands under prb device, including usage, flag types and defaults, required flags, source examples, and implementation links
Manage ITAM devices. This page documents 8 commands under prb device.
Flags and examples below come from the command definitions. A Required flag is explicitly marked required by Cobra; an unmarked flag can still be needed by runtime validation or a non-interactive workflow. Empty strings and empty lists are registered defaults, not sample values.
Every command also inherits the global flags. Run prb <command> --help to check your installed version. Replace placeholder IDs and names in source examples before running them. Return to the complete CLI command reference to browse another command.
Commands
Section titled “Commands”| Command | Description | Usage | Source |
|---|---|---|---|
prb device | Manage ITAM devices. | prb device <command> | View implementation |
prb device create | Create a PENDING ITAM device and enrollment token. | prb device create | View implementation |
prb device delete | Delete one or more revoked ITAM devices. | prb device delete <id>... | View implementation |
prb device download | Download device evidence as a PDF. | prb device download <id>... | View implementation |
prb device list | List ITAM devices in an organization. | prb device list | View implementation |
prb device revoke | Revoke one or more ITAM device enrollments. | prb device revoke <id>... | View implementation |
prb device set-owner | Set or clear the owner of an ITAM device. | prb device set-owner <id> | View implementation |
prb device view | View an ITAM device. | prb device view <id> | View implementation |
prb device
Section titled “prb device”Manage ITAM devices.
prb device <command>prb device create
Section titled “prb device create”Create a PENDING ITAM device and enrollment token.
prb device createAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--org | string | "" | — | Organization ID |
--owner | string | "" | — | Owner profile ID |
Examples
Section titled “Examples”# Create a device for the default organizationprb device create
# Create a device with an ownerprb device create --owner <profile-id>prb device delete
Section titled “prb device delete”Delete one or more revoked ITAM devices.
prb device delete <id>...Requires at least 1 positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--yes, -y | boolean | false | — | Skip confirmation prompt |
Examples
Section titled “Examples”# Revoke devices, then delete themprb device revoke <device-id> [<device-id>...]prb device delete <device-id> [<device-id>...]prb device download
Section titled “prb device download”Download device evidence as a PDF.
prb device download <id>...Requires at least 1 positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--json | boolean | false | — | Output JSON (same as —output json) |
--output, -o | string | "" | — | Output format: json, table (default) |
prb device list
Section titled “prb device list”List ITAM devices in an organization.
prb device listAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--agent-version | string list | [] | — | Filter by agent version; repeat or comma-separate for multiple |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit, -L | integer | 30 | — | Maximum number of devices to list |
--order-by | string | "" | — | Order by field (CREATED_AT, UPDATED_AT, HOSTNAME, LAST_SEEN_AT) |
--order-direction | string | "DESC" | — | Sort direction (ASC, DESC) |
--org | string | "" | — | Organization ID |
--output, -o | string | "" | — | Output format: json, table (default) |
--platform | string list | [] | — | Filter by platform; repeat or comma-separate for multiple (DARWIN, LINUX, FREEBSD, WINDOWS) |
--posture-warnings | boolean | false | — | Only devices whose latest posture for some check is FAIL or UNKNOWN |
--postures | boolean | false | — | Include latest posture check results |
--query | string | "" | — | Search devices by owner name |
--state | string list | [] | — | Filter by state; repeat or comma-separate for multiple (PENDING, ACTIVE, REVOKED) |
Examples
Section titled “Examples”# List devices in the default organizationprb device list
# List devices with latest posture check resultsprb device ls --postures
# List devices sorted by last seen timeprb device ls --order-by LAST_SEEN_AT --output json
# Search devices by owner nameprb device ls --query "Ada"
# List active macOS devicesprb device ls --state ACTIVE --platform DARWIN
# List active and pending devicesprb device ls --state ACTIVE --state PENDINGprb device revoke
Section titled “prb device revoke”Revoke one or more ITAM device enrollments.
prb device revoke <id>...Requires at least 1 positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--yes, -y | boolean | false | — | Skip confirmation prompt |
Examples
Section titled “Examples”prb device revoke <device-id> [<device-id>...]prb device set-owner
Section titled “prb device set-owner”Set or clear the owner of an ITAM device.
prb device set-owner <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--owner | string | "" | — | Owner profile ID (empty to clear) |
Examples
Section titled “Examples”# Assign an ownerprb device set-owner <device-id> --owner <profile-id>
# Clear the ownerprb device set-owner <device-id> --owner ""prb device view
Section titled “prb device view”View an ITAM device.
prb device view <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--json | boolean | false | — | Output JSON (same as —output json) |
--output, -o | string | "" | — | Output format: json, table (default) |