Agent
VirtualMetric Agent™ is the lightweight collection endpoint of the DataStream platform. The vmetric-agent executable runs the collector on the monitored host, and provides the command-line tools for enrolment, service management, validation, and console monitoring.
The Agent exposes a smaller option set than the Director. It has no equivalent of -service-name, -config-path, -license-info, -pfx2pem, -install-command, or of the pipeline, generator, sentinel, snmpwalk, dcr, ocsf, cert, and capture-profile modes — those belong to Director alone.
Synopsis
vmetric-agent [OPTIONS]
Help output is mode-dependent. vmetric-agent -h lists only the options valid outside a mode; a mode's own options are listed alongside it, e.g. vmetric-agent -mode console -h.
General Options
These options are valid outside a mode.
| Option | Default | Description |
|---|---|---|
-compare-version | - | Compare with specified version |
-config | - | Apply an enrolment string and write the local configuration file |
-export | - | Report format for -license (json, csv, md, license) |
-license | - | Show license information |
-path | - | Installation path when used with -service install; auto resolves to the user home directory |
-read | - | Display the configuration hash of the enrolled agent |
-validate | - | Validate configuration files. Equivalent to -mode validate |
-version | - | Display version information |
The argument to -config is a base64-encoded string of semicolon-separated fields — director address, director token, device ID, and enrolment ID — of which the device ID and the enrolment ID may not both be empty. Run vmetric-director -install-command on the Director to obtain the full installation command carrying this string.
-read requires an argument, but its value is not used. The hash it prints is derived from the device ID, director address, and director token.
Service Management
| Option | Default | Description |
|---|---|---|
-agentless | - | Run without installing as a service |
-background | - | Run in background mode |
-info | - | Display service information |
-service | - | Service operation (install, uninstall, start, stop, restart) |
-stop | - | Stop the running process |
-vpc | - | Display product code |
-service and -agentless are mutually exclusive, as are -service and -background. Combining -service install with -path relocates the installation: the agent and supervisor services are uninstalled, the executable is copied to the target path, and the services are reinstalled from there.
Modes
A mode is selected with -mode <name>, or with the equivalent shorthand option. Mode names are matched case-insensitively. Passing more than one mode option in a single invocation is not supported.
| Mode | Shorthand | Purpose |
|---|---|---|
agent | - | Run the collector. This is the default |
supervisor | -supervisor | Run the service watchdog |
console | -console | Tail the live console output |
validate | -validate | Validate the configuration files |
update | -update | Run the update process |
restart | -restart | Restart the service via a detached child |
Only the console mode takes options of its own. The supervisor mode accepts the service management options, so it can be installed and run as its own service:
vmetric-agent -mode supervisor -service install
vmetric-agent -mode supervisor -service start
Console
vmetric-agent -mode console [OPTIONS]
| Option | Default | Description |
|---|---|---|
-agent-id | 0 | Device ID of the managed agent whose console to tail; 0 tails the Director |
-debug-level | 3 | Set debug verbosity level (1-5) |
-filter | - | Filter console output by keywords |
The debug level is a threshold: entries at or below the given level are shown. The levels are 1 Error, 2 Warning, 3 Information, 4 Debug, and 5 Verbose.
Option Index
Every option, with the section documenting it. Defaults and descriptions are given there, not here.
| Option | Documented under |
|---|---|
-agent-id | Console |
-agentless | Service Management |
-background | Service Management |
-compare-version | General Options |
-config | General Options |
-console | Modes |
-debug-level | Console |
-export | General Options |
-filter | Console |
-info | Service Management |
-license | General Options |
-mode | Modes |
-path | General Options |
-read | General Options |
-restart | Modes |
-service | Service Management |
-stop | Service Management |
-supervisor | Modes |
-update | Modes |
-validate | General Options |
-version | General Options |
-vpc | Service Management |