sentry

Retrieves the list of sentries connected to the local server along with each sentry's system information and performance metrics.

Note

This command is deprecated. Use the `system sentries` command instead.

Command properties

Property	Description
Command type	Driver query
Required permission	Administrator
License usage	Not counted toward license
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

sentry

Options

None

Output fields

Field	Type	Description
`guid`	string	Sentry unique identifier.
`host_name`	string	Hostname of the system where the sentry is installed.
`remote_ip`	string	Remote IP address of the sentry.
`is_connected`	boolean	Whether the sentry is currently connected.
`pkg_ver`	string	Sentry package name and version.
`description`	string	Sentry description.
`cpu_usage`	double	Total CPU usage (unit: %).
`mem_usage`	double	Physical memory usage (unit: %).
`disk_usage`	double	Disk usage of the highest-utilized disk (unit: %).
`nic_rx_usage`	double	Receive usage of the highest-bandwidth NIC (unit: %).
`nic_tx_usage`	double	Transmit usage of the highest-bandwidth NIC (unit: %).
`user_dir`	string	Working directory path of the sentry process.
`cpu_kernel`	double	Kernel-mode CPU usage (unit: %).
`cpu_user`	double	User-mode CPU usage (unit: %).
`phy_used`	long	Physical memory in use (unit: bytes).
`phy_free`	long	Available physical memory (unit: bytes).
`phy_total`	long	Total physical memory (unit: bytes).
`swap_used`	long	Swap memory in use (unit: bytes).
`swap_free`	long	Available swap memory (unit: bytes).
`swap_total`	long	Total swap memory (unit: bytes).
`last_connect_at`	timestamp	Time of the last connection.
`os`	string	Operating system name.
`os_ver`	string	Operating system version.
`arch`	string	CPU architecture.
`jvm_name`	string	JVM name.
`jvm_version`	string	JVM version.
`ip_addrs`	array	List of IP addresses of the sentry's network interfaces.
`disks`	array	List of disk usage information.
`nics`	array	List of network interface speed metrics.

Error codes

Parsing errors

Error code	Message	Description
no-read-permission	-	A user without administrator privileges ran the command.

Runtime errors

N/A

Description

The sentry command retrieves metadata, connection status, and real-time performance metrics for all sentries registered on the local server in a single query.

When a sentry is currently connected (is_connected=true), performance metrics such as CPU, memory, disk, and network usage are included in the output. Disconnected sentries output only metadata; performance metric fields are not output.

Performance metrics reflect the most recently collected values from the sentry and are not real-time measurements.

This command retrieves only sentries directly connected to the current server. To retrieve sentries from all Data Nodes in a cluster environment, use the system sentries command.

Examples

Retrieve all sentry listings
```
sentry
```
Retrieves the list and performance metrics of all sentries connected to the local server.
Filter only connected sentries
```
sentry | search is_connected == true
```
Filters and retrieves only sentries that are currently connected.
Sort by CPU usage descending
```
sentry | sort -cpu_usage
```
Retrieves all sentries sorted by CPU usage in descending order.