SSH Modul

Beschreibung

Das "ssh" Modul ermöglicht die Kommunikation mit einem SSH/SFTP-Server. Im Moment können beliebige Dateien auf einen SFTP-Server hochgeladen werden.

Verwendete Schnittstellen und Protokolle

• SSH/SFTP

JSON-Konfiguration

Im folgenden Abschnitt soll die gesamte JSON-Konfiguration des Moduls beschrieben und die einzelnen Parameter erläutert werden.

Beispielkonfiguration (Authentifizierung mit Benutzername und Passwort)

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

Beispielkonfiguration (Authentifizierung mit privatem Schlüssel)

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

Globale Modulparameter

Parametername	Erforderlich	Datentyp	sinnvoller Wertebereich	Default	Beschreibung
address	JA	STRING	gültiger Netzwerkhost		Adresse des SSH/SFTP Hosts
fingerprint	Nein	STRING			Fingerprint des SSH/SFTP Hosts zwecks Validierung (vergleichbar mit known-hosts Datei)
port	Nein	INT	1 - 65535	23	Port des SSH/SFTP-Servers
username	JA	STRING			Benutzername

Parameter der Authentifizierung mit Passwort

Parametername	Erforderlich	Datentyp	sinnvoller Wertebereich	Default	Beschreibung
password	JA	STRING			SSH/SFTP-Server-Passwort

Parameter der Authentifizierung mit privatem Schlüssel

Parametername	Erforderlich	Datentyp	sinnvoller Wertebereich	Default	Beschreibung
privateKey	Nein	STRING		"~/.ssh/id_rsa"	Dateiname des privaten Schlüssels, entweder als absoluter Pfad oder relativ zum Heimatverzeichnis des Benutzers
passphrase	abhängig vom Schlüssel	STRING			Passphrase des privaten Schlüssels

Call-Interface "sendFile"

Opt.	Parameter	Datentyp	Wertebereich	Bedeutung
	src	STRING		Pfad zur Quelldatei
	dst	STRING		Pfad zur Zieldatei

Modul-Informationen

Information	Wert
Autoren	optiMEAS Measurement and Automation Systems GmbH
seit smartCORE	2.8
Modultyp	N/A
Abhängigkeiten	KEINE