Module SSH

Description

Le module « ssh » permet la communication avec un serveur SSH/SFTP. Actuellement, des fichiers quelconques peuvent être téléversés vers un serveur SFTP.

Interfaces et protocoles utilisés

• SSH/SFTP

Configuration JSON

La section suivante décrit l'intégralité de la configuration JSON du module et explique chacun des paramètres.

Exemple de configuration (authentification par nom d'utilisateur et mot de passe)

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

Exemple de configuration (authentification par clé privée)

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

Paramètres globaux du module

Nom du paramètre	Obligatoire	Type de données	Plage de valeurs utile	Défaut	Description
address	OUI	STRING	hôte réseau valide		Adresse de l'hôte SSH/SFTP
fingerprint	Non	STRING			Empreinte (fingerprint) de l'hôte SSH/SFTP à des fins de validation (comparable à un fichier known-hosts)
port	Non	INT	1 - 65535	23	Port du serveur SSH/SFTP
username	OUI	STRING			Nom d'utilisateur

Paramètres de l'authentification par mot de passe

Nom du paramètre	Obligatoire	Type de données	Plage de valeurs utile	Défaut	Description
password	OUI	STRING			Mot de passe du serveur SSH/SFTP

Paramètres de l'authentification par clé privée

Nom du paramètre	Obligatoire	Type de données	Plage de valeurs utile	Défaut	Description
privateKey	Non	STRING		"~/.ssh/id_rsa"	Nom de fichier de la clé privée, soit sous forme de chemin absolu, soit relatif au répertoire personnel de l'utilisateur
passphrase	selon la clé	STRING			Phrase secrète (passphrase) de la clé privée

Interface d'appel (Call-Interface) « sendFile »

Opt.	Paramètre	Type de données	Plage de valeurs	Signification
	src	STRING		Chemin du fichier source
	dst	STRING		Chemin du fichier cible

Informations sur le module

Information	Valeur
Auteurs	optiMEAS GmbH
depuis smartCORE	2.8
Type de module	N/A
Dépendances	AUCUNE