device

Device management commands for NDCLI. These commands allow you to list, approve, rename, and remove firewall devices in your organization.

Commands

Command	Description
device list	List devices
device describe	Show device details
device approve	Approve a pending device
device approve-all	Approve all pending devices
device rename	Rename a device
device remove	Remove a device

---

device list

List devices in your organization with optional filtering and sorting.

ndcli device list [flags]

Flags

Flag	Type	Default	Description
--name	string		Filter by name (regex pattern)
--status	string		Filter by status: PENDING, ENABLED, DISABLED
--ou	string		Filter by organizational unit
--created-after	string		Filter by created date
--created-before	string		Filter by created date
--heartbeat-after	string		Filter by last heartbeat
--heartbeat-before	string		Filter by last heartbeat
--synced-after	string		Filter by last sync
--synced-before	string		Filter by last sync
--sort-by	string	name:asc	Sort field and direction
--page	int	1	Page number
--per-page	int	30	Items per page

Date Filter Formats

Date filters accept two formats:

1. Relative: 30m, 2h, 7d, 2w (minutes, hours, days, weeks ago)
2. ISO 8601: 2024-01-15T10:30:00Z

Sort Fields

Available sort fields: name, status, created_at, heartbeat, synced_at

Direction: asc or desc (e.g., name:asc, created_at:desc)

Examples

ndcli device list

ndcli device list --status PENDING

ndcli device list --ou production

ndcli device list --heartbeat-before 7d

ndcli device list --created-after 24h

ndcli device list --name "fw-.*-prod"

ndcli device list --sort-by heartbeat:desc

ndcli device list --page 2 --per-page 50

---

device describe

Show detailed information about a specific device.

ndcli device describe [device]

Arguments

Argument	Required	Description
device	Yes	Device name

Output

Shows comprehensive device information:

• Device name and UUID
• Status (PENDING, ENABLED, DISABLED)
• Organizational unit assignment
• Last heartbeat timestamp
• Last sync timestamp
• Creation date
• Hardware/software details

Examples

ndcli device describe my-firewall

ndcli device describe my-firewall -f json

---

device approve

Approve a pending device, allowing it to receive configurations and participate in the organization.

ndcli device approve [device]

Arguments

Argument	Required	Description
device	Yes	Device name to approve

Examples

ndcli device approve new-firewall

Notes

• Only devices with PENDING status can be approved
• After approval, the device status changes to ENABLED
• Approved devices can receive configuration syncs

---

device approve-all

Approve all pending devices in the organization at once.

ndcli device approve-all

Examples

ndcli device approve-all

Caution

This approves all pending devices without individual confirmation. Review pending devices with ndcli device list --status PENDING before running.

---

device rename

Rename a device.

ndcli device rename [device] [new-name]

Arguments

Argument	Required	Description
device	Yes	Current device name
new-name	Yes	New name for the device

Examples

ndcli device rename old-name new-name

Notes

• Device names must be unique within the organization
• The rename takes effect immediately
• The device UUID remains unchanged

---

device remove

Remove a device from the organization.

ndcli device remove [device]

Arguments

Argument	Required	Description
device	Yes	Device name to remove

Examples

ndcli device remove decommissioned-firewall

Danger

This permanently removes the device from the organization. The device will need to re-register and be approved again if you want to add it back.