Skip to main content

Linux

Agentless

Synopsis​

Creates a collector that connects to Linux servers via SSH to deploy and run the VirtualMetric Agent. Supports password, private-key, and key-based authentication.

note

To collect logs from arbitrary files on a Linux host (application logs, syslog, container logs, etc.), see File Log Datasets.

Schema​

- id: <numeric>
  name: <string>
  description: <string>
  type: linux
  tags: <string[]>
  pipelines: <pipeline[]>
  status: <boolean>
  properties:
    address: <string>
    port: <numeric>
    username: <string>
    password: <string>
    private_key: <string>
    passphrase: <string>
    key_based: <boolean>
    install_path: <string>
    timeout: <numeric>

Configuration​

Device​

FieldRequiredDefaultDescription
idY-Unique numeric identifier
nameY-Device name
descriptionN-Optional description
typeY-Must be linux
tagsN-Optional tags
pipelinesN-Optional pre-processor pipelines
statusNtrueEnable/disable the device

Connection​

FieldRequiredDefaultDescription
addressY-Target server address
portN22SSH port number
usernameN-SSH username (resolvable via ${ENV_VAR} or $secret{...})
passwordN-SSH password (resolvable via ${ENV_VAR} or $secret{...})
private_keyN-Path to SSH private key file (resolvable via ${ENV_VAR} or $secret{...})
passphraseN-Private key passphrase (resolvable via ${ENV_VAR} or $secret{...})
key_basedNfalseWhen true and private_key is set, key-based authentication takes priority over password
install_pathN"/tmp"Remote install path for the Agent binary; the directory <install_path>/<product>/agent/ is created if absent

Performance​

FieldRequiredDefaultDescription
timeoutN30SSH connection timeout in seconds

Examples​

Password Authentication​

Connecting to a Linux server with username and password...

- id: 1
  name: linux_server
  type: linux
  properties:
    address: "192.168.1.100"
    username: "admin"
    password: "secret"

Private Key Authentication​

Using an SSH private key with passphrase for authentication...

- id: 2
  name: secure_linux
  type: linux
  properties:
    address: "10.0.0.50"
    port: 2222
    username: "monitor"
    private_key: "/path/to/private_key"
    passphrase: "private_key_passphrase"
    key_based: true
warning

The private key file must be readable by the service user and have appropriate permissions (600 or more restrictive).

Custom Install Path​

Deploying the Agent to a non-default location (e.g., when /tmp is restricted)...

- id: 3
  name: linux_custom_path
  type: linux
  properties:
    address: "192.168.1.101"
    username: "admin"
    password: "secret"
    install_path: "/opt"