SSH module

Description

The "ssh" module enables communication with an SSH/SFTP server. At the moment, any files can be uploaded to an SFTP server.

Interfaces and protocols used

• SSH/SFTP

JSON configuration

The following section describes the entire JSON configuration of the module and explains the individual parameters.

Example configuration (authentication with user name and password)

{
  "module": "SSH",
  "factory": "ssh",
  "config":{
    "address": "some.ssh.host.name",
    "fingerprint": "aa:bb:cc:dd:...",
    "port":23,
    "username": "someSSHUser",
    "password": "somePassword"
  }
}

Example configuration (authentication with private key)

{
  "module": "SSH",
  "factory": "ssh",
  "config":{
    "address": "some.ssh.host.name",
    "fingerprint": "aa:bb:cc:dd:...",
    "port":23,
    "username": "someSSHUser",
    "privateKey": "somePrivateKey",
    "passphrase": "somePrivateKeyPassphrase"
  }
}

Global module parameters

Parameter Name	Required	Data Type	Meaningful Value Range	Default	Description
address	YES	STRING	valid network host		address of the SSH/SFTP host
fingerprint	No	STRING			Fingerprint of the SSH/SFTP host for validation (comparable to known-hosts file)
port	No	INT	1 - 65535	23	Port of the SSH/SFTP server
username	YES	STRING			username

Parameters for authentication with password

Parameter Name	Required	Data Type	Meaningful Value Range	Default	Description
password	YES	STRING			SSH/SFTP server password

Parameters for authentication with private key

Parameter name	Required	Data type	Meaningful value range	Default	Description
privateKey	No	STRING		"~/.ssh/id_rsa"	File name of the private key, either as an absolute path or relative to the user's home directory
passphrase	depending on the key	STRING			Passphrase of the private key

Call interface "sendFile"

Opt.	Parameter	Data type	Value range	Meaning
	src	STRING		Path to source file
	dst	STRING		Path to destination file

Module information

Information	Value
Authors	optiMEAS GmbH
since smartCORE	2.8
Module type	N/A
Dependencies	NONE