Skip to main content

Netdata Agent CLI

The netdatacli executable offers a straightforward way to manage the Netdata Agent's operations.

It is located in the same directory as the netdata binary.

Available commands:

CommandDescription
helpDisplay usage information and exit.
reload-healthReloads the Netdata health configuration, updating alerts based on changes made to configuration files.
reload-labelsReloads host labels from netdata.conf.
reopen-logsClose and reopen log files.
shutdown-agentGracefully shut down the Netdata Agent.
fatal-agentLog the current state and forcefully halt the Netdata Agent.
reload-claiming-stateReload the Agent's claiming state from disk.
pingChecks the Agent's status. If the Agent is alive, it exits with status code 0 and prints 'pong' to standard output. Exits with status code 255 otherwise.
aclk-state [json]Return the current state of ACLK and Cloud connection. Optionally in JSON.
dumpconfigDisplay the current netdata.conf configuration.
mark-stale-nodes-ephemeral <node_id | machine_guid | hostname | ALL_NODES>Marks one or all disconnected nodes, including virtual nodes, as ephemeral, while keeping their previously collected metrics data available for queries on both this Netdata Agent dashboard and Netdata Cloud.12
remove-stale-node <node_id | machine_guid | hostname | ALL_NODES>Marks one or all disconnected nodes, including virtual nodes, as ephemeral, and removes them so that they are no longer available for queries, from both this Netdata Agent dashboard and Netdata Cloud. This is useful to remove decommissioned nodes that have stopped streaming, but for which the Agent still holds metric data.13
versionDisplay the Netdata Agent version.

See also the Netdata daemon command line options.

Footnotes

  1. This also clears any active alerts. 2

  2. The Agent may be configured to automatically clean up ephemeral nodes when they have been offline for longer than the configured time interval.

  3. If a node is represented by multiple Parent Agents in a HA setup, this command must be executed on each Parent Agent.


Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.