Skip to main content

Data import

The SSH data import (collector) executes defined SSH commands. The command returns data in the tabular CSV format, where each row represents a single object. Under the hood, the SSH data import works similarly to the Flat File CSV data import, but instead of reading data from the file, it reads data from the SSH command output.

You can use other commands than the built-in system commands. It can be any kind of command available in the target system (for example, a Python script).

Connection details

ParameterDescription
Host nameName or IP address of the host.
User nameUser name used to log to target machine.
Authentication methodAuthentication method to use for the SSH server.
Host Key FingerprintProvide the host key fingerprint used for the host key validation. If the value is not provided, validation is skipped. MD5 and SHA256 fingerprints are supported.
Format: algorithm:fingerprint
Example: SHA256:jlDPKCCRr1TkufVsZJf02ejXNQ7RB/vg09uGwKeSwnU
PortProvides the communication port. Default value is 22.
Test connectionSelect this option to test the connection to the target system with the connection details you have provided. If the data is correct, the connection will be established.

Authentication methods

The following authentication methods are provided:

  • Password: Used to connect to the SSH server with the password authentication method. If the server is configured with a single method authentication, the server accepts this method, and the password is correct, the connection will be established successfully. If the server is configured with the multifactor authentication, the connection will not be established.
  • Password and Private Key: Used to connect to the SSH server with the password and private key authentication methods. If the server is configured with a single method authentication, the connection will be established if at least one of the two methods works successfully. If the server is configured with the multifactor authentication, the connection will be established only if both methods work successfully.
  • Private Key: Used to connect to the SSH server with the private key authentication method. If the server is configured with a single method authentication, the server accepts this method, and the private key is correct, the connection will be established successfully. If the server is configured with the multifactor authentication, the connection will not be established.

Queries and mappings

Define the following parameters to enable data import:

ParameterValue
SSH CommandThe SSH command to execute.
SSH ParametersThe SSH command parameters.
SeparatorThe character used as the column separator in the file. For tabs use \t.
First row to importThe number of the first row to be imported. Rows are counted from 0 (in many cases, row 0 stores headers/column names).
DistinctThis option allows query to yield more rows with the same values.
Treat double quotes as normal characterBy default, double quotes are interpreted as a special character used to mark start and end of the field that contains, for example, a separator. When this option is enabled, double quotes will be treated as a standard character without any special behavior.
HeadersThe column names. Fill it in only if the first line of the command output does not contain this information or is not valid. The list can be comma or semicolon-separated. It is required to specify them to use those names in the mappings.