Adaptateur SFTP

Avec l'adaptateur SFTP (Secure File Transfer Protocol), vous pouvez envoyer et extraire des fichiers en toute sécurité depuis et vers un serveur SFTP.

Présentation

Lorsque vous utilisez l'adaptateur SFTP comme source, vous pouvez lire les données d'un fichier et extraire une liste de fichiers présents dans n'importe quel répertoire d'un emplacement de serveur SFTP. Lorsque vous utilisez l'adaptateur SFTP comme cible, vous pouvez envoyer des données vers un fichier spécifié sur le serveur SFTP. Vous pouvez, au choix :

  • Créer un nouveau fichier.
  • Remplacer un fichier existant.
  • Ajouter des données à un fichier existant.

Si vous avez configuré l'adaptateur pour remplacer un fichier ou ajouter des données à un fichier qui n'existe pas, mais si la structure du répertoire dans le chemin d'accès au fichier est valide, le fichier est automatiquement créé. Si la structure de répertoire dans le chemin de fichier spécifié n'existe pas, l'opération d'écriture échoue, sauf si vous avez configuré l'adaptateur pour créer un nouveau répertoire au cas où le chemin d'accès au fichier spécifié n'existerait pas. Dans ce cas, l'adaptateur crée automatiquement les répertoires manquants.

Introduction

SFTP est un protocole de transfert de données de fichiers sécurisé sur des réseaux informatiques. L’adaptateur SFTP obéit à ce protocole et peut être configuré pour agir en tant que client SFTP afin de transférer et d’accéder aux données du fichier depuis et vers des serveurs SFTP.

Alias de commande

Vous pouvez spécifier les commandes d'adaptateur à l'aide d'une chaîne de commande sur la ligne de commande ou en créant un fichier de commandes contenant les commandes d'adaptateur. La syntaxe de la commande est :

-IA[alias]card_num
-OA[alias]card_num
Dans la syntaxe de commande, -IA est la commande d'exécution Input Source Override et -OA est la commande d'exécution Output Target Override, alias est l'alias d'adaptateur et card_num est le numéro de carte de la mappe. L'alias d'adapteur SFTP et les commandes d'exécution correspondantes sont répertoriés dans le tableau suivant.
Adaptateur Alias Comme entrée Comme sortie
SFTP SFTP -IASFTP -OASFTP

Authentification des connexions

SFTP (Secure File Transfer Protocol) est un protocole de transfert de données de fichiers sécurisé sur des réseaux informatiques. L’adaptateur SFTP obéit à ce protocole et peut être configuré pour agir en tant que client SFTP afin de transférer et d’accéder aux données du fichier depuis et vers des serveurs SFTP.

L'adaptateur SFTP offre les deux méthodes suivantes pour authentifier un utilisateur afin qu'il se connecte à un serveur SFTP :
  • Basée sur un mot de passe - Vous devez fournir le mot de passe correct.
  • Basée sur une paire de clés - Vous devez entrer le chemin d'accès au fichier de clé privée, le chemin d'accès au fichier de clé publique, le nom de paire de clés et le mot de passe.

Vous pouvez sélectionner l'une des deux méthodes d'authentification de votre choix. L'adaptateur essaie d'abord la méthode d'authentification préférée. Si cette tentative échoue, l'adaptateur tente alors de vous authentifier avec l'autre méthode.

Remarque : Pour la méthode d'authentification basée sur une paire de clés, seul le chemin du fichier de clé privée est requis. Le chemin d'accès au fichier de clé publique, le nom de paire de clés et le mot de passe sont facultatifs. Le nom d'utilisateur est requis pour les deux méthodes d'authentification.

Une fois la connexion à un serveur SFTP effectuée, vous pouvez envoyer et recevoir des fichiers depuis et vers le serveur.

Adaptateur SFTP en tant que source

L'adaptateur SFTP en tant que source prend en charge :
  • Liste de fichiers - Utilisez ce mode pour extraire tous les fichiers de n'importe quel répertoire sur un emplacement de serveur SFTP.
  • Données de fichier - Utilisez ce mode pour extraire le contenu d'un fichier spécifié à partir d'un emplacement de serveur SFTP.

Adaptateur SFTP en tant que cible

L'adaptateur SFTP en tant que cible prend en charge :
  • Créer - Utilisez ce mode pour créer un nouveau fichier dans l'emplacement du serveur SFTP et y écrire des données, ou signaler une erreur si le fichier existe déjà.
  • Remplacer - Utilisez ce mode pour remplacer un fichier par toutes les nouvelles données si le fichier existe déjà ; ou pour créer un fichier et y écrire des données, si le fichier spécifié n'existe pas.
  • Ajouter - Utilisez ce mode pour ajouter de nouvelles données à un fichier existant dans l'emplacement du serveur SFTP, ou pour créer un fichier et y écrire des données, s'il n'existe aucun fichier du nom spécifié.
Remarque : Lorsque vous récupérez un fichier, celui-ci est laissé sur le serveur ou supprimé en fonction de la valeur spécifiée dans la propriété Action de réussite du fichier.

Propriétés et commandes de l'adaptateur

Cette section répertorie les propriétés prises en charge par l'adaptateur.

Host

Spécifie le nom d'hôte ou l'adresse IP du serveur SFTP. Cette propriété est obligatoire. La commande d'adaptateur correspondante est -HOSTnom (ou -HOSTNAMEnom).

Port

Spécifie le port sur lequel le serveur SFTP écoute les connexions entrantes. La valeur par défaut est 22. La commande d'adaptateur correspondante est -PORT numéro (ou -PORTNUMBER numéro).

Authentification préférée

Spécifie la méthode d'authentification à essayer d'utiliser en premier lors de l'établissement d'une connexion. Les valeurs prises en charge sont Mot de passe et Clé publique. La valeur par défaut est Mot de passe. La commande d'adaptateur correspondante est -PA méthode (ou -PREFERREDAUTHENTICATION méthode) où méthode est Mot de passe ou Clé publique.

Utilisateur

Indique le nom d'utilisateur pour la connexion. Cette propriété est obligatoire. La commande d'adaptateur correspondante est -USR nom (ou -USERNAME nom).

Mot de passe

Spécifie la valeur de mot de passe à utiliser lors de l'authentification basée sur un mot de passe. La commande d'adaptateur correspondante est -PWD valeur (ou -PASSWORD valeur).

Chemin d'accès au fichier d'hôtes connu

Spécifie l'emplacement du fichier d'hôtes connus. La valeur est facultative et, lorsqu'elle est spécifiée, entraîne l'application de la vérification stricte du nom d'hôte par rapport au fichier spécifié lors de l'établissement des connexions. Si elle n'est pas spécifiée, la vérification du nom d'hôte n'est pas stricte. La commande d'adaptateur correspondante est -KHFP chemin (ou -KNOWNHOSTSFILEPATH chemin).

Nom de la paire de clés

Spécifie le nom de la paire de clés à utiliser lors de l'authentification basée sur une paire de clés. La valeur est facultative et, lorsqu'elle n'est pas spécifiée, le nom identifiant la paire de clés est dérivé du nom du fichier de clé privée. La commande d'adaptateur correspondante est -KPN nom (ou -KEYPAIRNAME nom).

Chemin d'accès au fichier de clé privée
Spécifie l'emplacement du fichier de clé privée à utiliser lors de l'exécution de l'authentification basée sur les paires de clés. La commande d'adaptateur correspondante est -PRKFP chemin (ou -PRIVATEKEYFILEPATH chemin).
Phrase secrète

Spécifie la phrase de passe permet d'accéder aux données de clé lors de l'authentification basée sur une paire de clés. La valeur est facultative et, lorsqu'elle n'est pas spécifiée, on suppose que la clé n'est pas protégée par une phrase de passe. La commande d'adaptateur correspondante est -PSP valeur (ou -PASSPHRASE valeur).

Délai de connexion

Spécifie la durée d'attente, en secondes, pour que le serveur réponde lors de l'établissement d'une connexion, avant de considérer la tentative de connexion comme ayant échoué. La valeur par défaut est 30. La valeur 0 indique qu'aucun délai d'attente n'est défini. La commande d'adaptateur correspondante est -CT durée (ou -CONNECTIONTIMEOUT durée).

Nombre de tentatives de reconnexion

Spécifie le nombre de nouvelles tentatives de reconnexion au serveur avant d'abandonner et de signaler l'erreur. La valeur par défaut est 0, ce qui indique qu'il n'y a pas de nouvelles tentatives. Ce paramètre n'est pas applicable lors de l'exécution d'une opération de test de connexion dans l'interface utilisateur de conception, et la valeur 0 est automatiquement appliquée dans ce cas. La commande d'adaptateur correspondante est -RCC nombre (ou -RETRYCONNECTIONCOUNTnombre).

Intervalle de reconnexion

Spécifie la durée d'attente, en secondes, entre deux nouvelles tentatives de connexion successives. La valeur par défaut est 60. Ce paramètre n'est applicable que lorsque le paramètre Nombre de nouvelles tentatives de connexion est défini sur une valeur supérieure à 0.

La commande d'adaptateur correspondante est -RCI durée (ou -RETRYCONNECTIONINTERVAL durée).

Chemin

Spécifie le chemin du fichier ou du répertoire sur le serveur SFTP. Le caractère barre oblique (/) est utilisé comme séparateur de fichier. Si la valeur de chemin indiquée commence par une barre oblique, elle est traitée comme un chemin d'accès absolu ; Sinon, elle est traitée comme un chemin relatif au répertoire par défaut actuel pour la connexion. La commande d'adaptateur correspondante est -P chemin ou (-PATH chemin).

Créer un répertoire

Spécifie le paramètre qui, lorsqu'il est activé, entraîne la création automatique de tous les répertoires manquants dans le chemin d'accès au répertoire spécifié. Lorsqu'il n'est pas activé, l'adaptateur signale une erreur si la structure de répertoire spécifiée n'existe pas sur le serveur SFTP. Le paramètre est applicable uniquement lorsque l'adaptateur est utilisé en tant que cible. La commande d'adaptateur correspondante est -CD (ou -CREATEDIRECTORY).

Mode lecture

Cette propriété spécifie le mode dans lequel l'adaptateur doit être utilisé en tant que source. Le mode Données de fichier permet de lire le contenu du fichier spécifié dans le paramètre Chemin. Le mode Liste de fichiers permet d'extraire la liste des chemins absolus des fichiers situés dans le répertoire spécifié dans le paramètre Chemin. La valeur par défaut est Données de fichier. La commande d'adaptateur correspondante est -RM mode (ou -READMODE mode), où mode est file_data ou file_list.

Mode écriture

Spécifie le mode dans lequel l'adaptateur doit être utilisé en tant que source. Le mode Données de fichier permet de lire le contenu du fichier spécifié dans le paramètre Chemin. Le mode Liste de fichiers permet d'extraire la liste des chemins absolus des fichiers situés dans le répertoire spécifié dans le paramètre Chemin. La valeur par défaut est Données de fichier. La commande d'adaptateur correspondante est -WM mode (ou -WRITEMODE mode), où mode est create, overwrite ou append.

Action de réussite du fichier

Spécifie l'action de réussite à effectuer par l'adaptateur sur le fichier, c'est-à-dire ce qu'il doit en faire après l'exécution réussie d'une transaction. La valeur par défaut est Keep.

La commande d'adaptateur correspondante est -FILESUCCESSACTION (ou-FSA). Les actions suivantes sont prises en charge :

  • Conserver : Conserve le fichier au niveau de la source après l'exécution réussie d'une transaction. La valeur de la commande d'adaptateur correspondante est keep.
  • Toujours supprimer : Supprime le fichier au niveau de la source en cas d'exécution réussie d'une transaction. La valeur de la commande d'adaptateur correspondante est delete_always.
  • Supprimer si vide : supprime le fichier au niveau de la source en cas d'exécution réussie. Vérifie si le fichier est vide ou non. Si le fichier est vide, il est supprimé, sinon il est conservé. La valeur de la commande d'adaptateur correspondante est delete_if_empty.
Action en cas d'échec

Indique l'action d'échec à effectuer par l'adaptateur sur le fichier quant à l'endroit où il doit être placé après l'échec de l'exécution d'une mappe. La valeur par défaut est Commit.

Les actions suivantes sont prises en charge :

  • Valider : Cette option valide la transaction en cas d'échec.
  • Annuler : Cette option permet d'annuler la transaction en cas d'échec.

La liste suivante présente les résultats des différentes combinaisons de valeurs de propriété Action de réussite de fichier et Action d'échec :

  • conserver + valider = conserver
  • toujours supprimer + valider = supprimer
  • supprimer si vide + valider (lorsque le fichier contient des données) = conserver
  • supprimer si vide + valider (lorsque le fichier ne contient pas de données) = supprimer
  • conserver + annuler = conserver
  • supprimer + annuler = conserver
  • supprimer si vide + annuler (lorsque le fichier contient des données) = conserver
  • supprimer si vide + annuler (lorsque le fichier ne contient pas de données) = conserver
Journalisation

Cette propriété spécifie le niveau de journalisation à utiliser pour le fichier journal (fichier de trace) produit par l'adaptateur. La valeur par défaut est Désactivé. La valeur Informatif permet de consigner les messages d'information et d'erreur, la valeur Erreurs uniquement permet de consigner uniquement les messages d'erreur et la valeur Prolixe permet de consigner les messages de débogage et de niveau de trace en plus des messages d'information et d'erreur.

La commande d'adaptateur correspondante est :

-T [E|V] [+] [file_path]

-T -> Consignation des messages d'information de l'adaptateur.

-TE -> Consignation des erreurs de l'adaptateur uniquement.

-TV -> Utilisation de la consignation prolixe (débogage). Le fichier journal consigne toute l'activité lorsque l'adaptateur génère ou consomme des messages.

+ -> Ajout des informations de trace à un fichier existant. Omettez cet argument pour créer un nouveau fichier journal.

file_path -> Le chemin d'accès complet au journal de trace de l'adaptateur. Si vous omettez ce mot clé, l'adaptateur crée le fichier journal m4sftp.mtr dans le répertoire de mappe.

Ajouter un journal

Indicateur spécifiant l'action à effectuer si le fichier journal spécifié existe déjà. Lorsque la valeur est true, les messages du journal sont ajoutés au fichier. Lorsque la valeur est false, le fichier est tronqué et les messages sont écrits dans le fichier vide. La valeur par défaut est true.

Chemin du fichier journal

Indique l'emplacement du fichier journal dans lequel les messages doivent être consignés. S'il n'est pas spécifié, le système utilise le nom de fichier journal par défaut m4sftp.mtr et stocke le fichier dans le répertoire où se trouve la mappe compilée exécutée.

Exemples

Exemples de fonction de mappe GET
Dans l'exemple suivant, supposons que l'adaptateur est utilisé dans une fonction GET.
  • Lorsque l'adaptateur est utilisé pour extraire du contenu de fichier :
    GET("SFTP", "-USR testUser -HOST host1 -PORT 22 -PA Password -PWD pwd1 -P /myDirectory/MyFile.txt -RM file_data -TV /tmp/logfile.log")
  • Lorsque l'adaptateur est utilisé pour extraire la liste de fichiers :
    GET("SFTP", "-USR testUser -HOST host1 -PORT 22 -PA Password -PWD pwd1 -P /myDirectory/ -RM file_list -TV /tmp/logfile.log")
  • Lorsque l'adaptateur est utilisé pour l'action de réussite du fichier :
    GET("SFTP", "-USR testUser -HOST host1 -PORT 22 -PA Password -PWD pwd1 -P /myDirectory/MyFile.txt -RM file_data -FSA keep -TV/tmp/logfile.log")
Exemples de fonction de mappe PUT
Dans l'exemple suivant, supposons que l'adaptateur est utilisé dans une fonction PUT.
  • Lorsque l'adaptateur est utilisé pour créer un nouveau fichier, si le fichier n'est pas présent :
    PUT ("SFTP", "-USR testUser -HOST host1 -PORT 22 -PA Password -PWD pwd1 -P /myDirectory/MyFile.txt -WM create -TV /tmp/logfile.log", in_data_type)
  • Lorsque l'adaptateur est utilisé pour remplacer un fichier existant :
    PUT ("SFTP", "-USR testUser -HOST host1 -PORT 22 -PA Password -PWD pwd1 -P /myDirectory/MyFile.txt -WM overwrite -TV /tmp/logfile.log", in_data_type)
  • Lorsque l'adaptateur est utilisé pour ajouter des données à un fichier existant :
    PUT ("SFTP", "-USR testUser -HOST host1 -PORT 22 -PA Password -PWD pwd1 -P /myDirectory/MyFile.txt -WM append -TV /tmp/logfile.log", in_data_type)
  • Lorsque l'adaptateur est invité à créer automatiquement des répertoires manquants :
    PUT ("SFTP", "-USR testUser -HOST host1 -PORT 22 -PA Password -PWD pwd1 -P /myDirectory/MyFile.txt -WM create -CD -TV /tmp/logfile.log", in_data_type)
Exemple de fonction RUN() dans une règle de mappe
  • Voici un exemple d'utilisation de fonction RUN() dans une règle de mappe afin d'exécuter une mappe map1 et de remplacer sa carte en sortie 1 pour utiliser l'adaptateur SFTP :

    =RUN("map1", "-OASFTP1 '-HOST server1 -PORT 10022 -USR user1 -PWD password1 -PATH /tmp/test.txt -WM overwrite -TV'")
  • Voici le même exemple, mais cette fois en utilisant le serveur de commande à partir de la ligne de commande sous Linux pour exécuter la mappe map1.lnx et effectuer le même remplacement :

    dtxcmdsv map1.lnx "-OASFTP1 '-HOST server1 -PORT 10022 -USR user1 -PWD password1 -PATH /tmp/test.txt -WM overwrite -TV'"