ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Communication / SSH functions
  • Propriétés spécifiques à la description des variables de type sshSession
  • Mode d'authentification
  • Utilisation des variables de type sshSession
WINDEV
WindowsLinuxJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget IOSApple WatchMac Catalyst
Autres
Procédures stockées
Le type sshSession permet de définir toutes les caractéristiques d'une connexion à un serveur SSH. Les caractéristiques de cette connexion sont décrites à l'aide de différentes propriétés WLangage.
Remarque : Pour plus de détails sur la déclaration de ce type de variable et l'utilisation des propriétés WLangage, consultez Déclaration d'une variable.
Exemple
cMaSession est une sshSession
cMaSession.Adresse = "127.0.0.1"
cMaSession.Port = 22
cMaSession.Utilisateur = "login"
cMaSession.MotDePasseUtilisateur = "pass"
Propriétés

Propriétés spécifiques à la description des variables de type sshSession

Les propriétés suivantes peuvent être utilisées pour définir une connexion à un serveur SSH :
Nom de la propriétéType manipuléEffet
AdresseChaîne de caractèresAdresse du serveur SSH.
Cette adresse peut être donnée sous la forme :
  • Adresse IP au format XXX.XXX.XXX.XXX ( par exemple, 125.5.110.100).
  • Adresse IP contenant le nom du serveur (par exemple, ServeurSSH). Cette syntaxe est conseillée.
CléPrivéeChaîne de caractères ou variable de type Certificatou
  • Chemin du fichier qui contient la clé privée au format OpenSSH (pour connexion par clé privée).
Si cette propriété est renseignée, une authentification par clé est réalisée : seules les propriétés Utilisateur, CléPrivée et MotDePasseCléPrivée sont prises en compte.
Nouveauté 2025
IntervalleKeepAlive
Entier ou DuréeTemps d'attente entre deux envois d'une requête spécifique permettant de maintenir la connexion ouverte et de vérifier que le serveur SSH répond toujours. Si le serveur SSH s'arrête brutalement lors d'une commande "longue" exécutée via la fonction SSHCommande, l'activation du "Keep Alive" peut permettre de détecter la déconnexion de l'application au serveur.
Cette propriété peut correspondre à :
  • un entier correspondant au nombre de secondes,
  • une variable de type Durée,
  • l'indication directe de la durée (par exemple 20 s ou 20000 ms).
Si cette propriété vaut :
  • 0, le "Keep Alive" sera désactivé.
  • une durée en dessous de 2 secondes, cette durée sera fixée à 2 secondes pour des contraintes techniques.
MotDePasseCléPrivéeChaîne de caractères ou Chaîne secrèteMot de passe du fichier de clés (dans le cas d'une connexion par clé privée). La propriété CléPrivée correspond à la clé privée à utiliser.
Nouveauté 2025
Utilisation de chaînes secrètes : Si vous utilisez le coffre-fort de chaînes secrètes, le type de la chaîne secrète utilisable pour ce paramètre doit être "Chaîne Ansi - Latin".
Pour plus de détails sur les chaînes secrètes et l'utilisation du coffre-fort, consultez Coffre-fort de chaînes secrètes.
MotDePasseUtilisateurChaîne de caractères ou Chaîne secrèteMot de passe de l'utilisateur utilisé dans le cadre d'une authentification par mot de passe (la propriété Utilisateur correspond au nom de l'utilisateur).
Nouveauté 2025
Utilisation de chaînes secrètes : Si vous utilisez le coffre-fort de chaînes secrètes, le type de la chaîne secrète utilisable pour ce paramètre doit être "Chaîne Ansi ou Unicode".
Pour plus de détails sur les chaînes secrètes et l'utilisation du coffre-fort, consultez Coffre-fort de chaînes secrètes.
PortEntierPort de connexion (par défaut, 22).
TimeoutConnexionEntier ou DuréeTemps d'attente de connexion exprimé en millisecondes (par défaut 20 secondes, soit 20000 millisecondes). Cette propriété peut correspondre à :
  • un entier correspondant au nombre de millisecondes,
  • une variable de type Durée,
  • l'indication directe de la durée (par exemple 20 s ou 20000 ms).
UtilisateurChaîne de caractèresNom de l'utilisateur.
Remarques

Mode d'authentification

L'authentification par clé est prioritaire sur l'authentification par mot de passe.
L'authentification par clé est tentée si :
  • le serveur supporte ce mode d'authentification.
  • la propriété CléPrivée est renseignée.
L'authentification par mot de passe est tentée si :
  • le serveur supporte ce mode d'authentification.
  • la propriété MotDePasseUtilisateur est renseignée.

Utilisation des variables de type sshSession

Les variables de type sshSession peuvent être utilisées dans les fonctions WLangage :
  • syntaxe classique :
    SCPEnvoieFichierEnvoie un fichier via le protocole SCP.
    SCPRécupèreFichierRécupère un fichier via le protocole SCP.
    SSHCommandeEnvoie une commande à un serveur SSH. La session est ouverte et refermée automatiquement après l'envoi de la commande.
    Nouveauté SaaS
    SSHConnecteCommande
    Permet de conserver la session SSH active entre plusieurs envois de commandes (via la fonction SSHCommande) à un serveur SSH.
    Cette fonction est une nouveauté disponible à partir de WINDEV Suite SaaS 2025 Update 2.
    SSHConnecteShellOuvre une nouvelle session SSH de type "Shell".
    Nouveauté SaaS
    SSHDéconnecteCommande
    Permet d'arrêter la session SSH qui était active pour permettre l'envoi groupé de plusieurs commandes.
    Cette fonction est une nouveauté disponible à partir de WINDEV Suite SaaS 2025 Update 2.
    SSHDéconnecteShellFerme une session SSH précédemment ouverte grâce à la fonction SSHConnecteShell.
    SSHEcritEcrit des données dans la session SSH spécifiée.
    SSHLitLit les données présentes sur le buffer de sortie de la session SSH.
  • syntaxe préfixée :
    Envoie une commande à un serveur SSH. La session est ouverte et refermée automatiquement après l'envoi de la commande.
    Permet de conserver la session SSH active entre plusieurs envois de commandes (via la fonction SSHCommande) à un serveur SSH.
    Cette fonction est une nouveauté disponible à partir de WINDEV Suite SaaS 2025 Update 2.
    <Variable sshSession>.ConnecteShellOuvre une nouvelle session SSH de type "Shell".
    Permet d'arrêter la session SSH qui était active pour permettre l'envoi groupé de plusieurs commandes.
    Cette fonction est une nouveauté disponible à partir de WINDEV Suite SaaS 2025 Update 2.
    <Variable sshSession>.DéconnecteShellFerme une session SSH précédemment ouverte grâce à la fonction SSHConnecteShell.
    <Variable sshSession>.EcritEcrit des données dans la session SSH spécifiée.
    <Variable sshSession>.LitLit les données présentes sur le buffer de sortie de la session SSH.
Minimum version required
  • Version 20
Comments
Click [Add] to post a comment

Last update: 03/20/2025

Send a report | Local help