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. For host network activity (TCP and remote login sessions) and running scripts to collect their output, see Linux 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>
    debug:
      log:
        status: <boolean>
      console:
        status: <boolean>
      remote_console:
        status: <boolean>
      level: <numeric>

Configuration

The following fields are used to define the device:

Device

Field	Required	Default	Description
`id`	Y	-	Unique numeric identifier
`name`	Y	-	Device name
`description`	N	-	Optional description
`type`	Y	-	Must be `linux`
`tags`	N	-	Optional tags
`pipelines`	N	-	Optional pre-processor pipelines
`status`	N	`true`	Enable/disable the device

Connection

Field	Required	Default	Description
`address`	Y	-	Target server address
`port`	N	`22`	SSH port number
`username`	N	-	SSH username (resolvable via `${ENV_VAR}` or `$secret{...}`)
`password`	N	-	SSH password (resolvable via `${ENV_VAR}` or `$secret{...}`)
`private_key`	N	-	Path to SSH private key file (resolvable via `${ENV_VAR}` or `$secret{...}`)
`passphrase`	N	-	Private key passphrase (resolvable via `${ENV_VAR}` or `$secret{...}`)
`key_based`	N	`false`	When `true` and `private_key` is set, key-based authentication takes priority over password
`install_path`	N	`"/tmp"`	Remote install path for the Agent binary; the directory `<install_path>/<product>/agent/` is created if absent

Performance

Field	Required	Default	Description
`timeout`	N	`30`	SSH connection timeout in seconds

Debug

Field	Required	Default	Description
`debug.log.status`	N	`false`	Enable file-based debug logging on the deployed collector
`debug.console.status`	N	`false`	Enable console debug output on the deployed collector
`debug.remote_console.status`	N	`false`	Enable remote console debug output on the deployed collector
`debug.level`	N	`4`	Debug verbosity level; applied only when at least one debug output is enabled

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"

Synopsis​

Schema​

Configuration​

Device​

Connection​

Performance​

Debug​

Examples​

Password Authentication​

Private Key Authentication​

Custom Install Path​