.. _waarp-r66client: ################ Waarp R66 Client ################ .. todo:: faire la distinction entre archives et packages .. todo:: ajouter les commandes manquantes Le script ``waarp-r66client`` (ou ``./bin/waarp-r66client.sh`` dans les archives portables) exécutent des appels ``java`` qui utilisent les commandes fournies par Waarp R66. L'utilisation des scripts est préférée pour les raisons suivantes : - Ils construisent automatiquement les commandes java, qui sont laborieuses à saisir ; - Ils fournissent une indirection pour gérer les installations multi-instances - Ils sont plus ergonomiques. Le détail des commandes java brutes est disponible :ref:`ici `. .. contents:: Commandes de gestion des transferts =================================== Commande ``waarp-r66client send`` --------------------------------- .. program:: waarp-r66client send Démarre un transfert synchrone (attend le résultat du transfert avant de rendre la main). Cette commande accepte les arguments suivants : .. option:: -to PARTNER *obligatoire* Serveur R66 de destination .. option:: -file FILENAME *obligatoire pour démarrer un nouveau transfert* Fichier à envoyer .. option:: -rule RULE *obligatoire pour démarrer un nouveau transfert* Règle de transfert à utiliser .. option:: -id *obligatoire pour relancer un transfert* Identifiant du transfert à relancer .. option:: -info INFO Info complémentaires sur le transfert .. option:: -block Fixe la taille de blocs pour le transfert .. option:: -md5 Force le contrôle d'intégrité par paquet (déconseillé) .. option:: -nolog Désactive les logs pour ce transfert .. option:: -logWarn Loggue les messages INFO avec un niveau WARN .. option:: -notlogWarn Loggue les messages INFO avec un niveau INFO .. option:: -nofollow .. versionadded:: 3.4.0 Désactive l'assignation d'un identifiant de suivi de transfert pour ce fichier Codes de retour : ====== ============= Code Signification ====== ============= ``0`` Succès ``2`` Les arguments sont incorrects ou le fichier de configuration contient une erreur ``66`` Une erreur inattendue s'est produite ``N`` Les autres codes de sortie correspondent à une erreur de transfert. Il s'agit de la valeur numérique du :ref:`code d'erreur ` ====== ============= Commande ``waarp-r66client asend`` ---------------------------------- .. program:: waarp-r66client asend Démarre un transfert asynchrone (enregistre le démarrage du transfert et de rendre la main). Cette commande accepte les arguments suivants : .. option:: -to PARTNER *obligatoire* Serveur R66 de destination .. option:: -file FILENAME *obligatoire pour démarrer un nouveau transfert* Fichier à envoyer .. option:: -rule RULE *obligatoire pour démarrer un nouveau transfert* Règle de transfert à utiliser .. option:: -id *obligatoire pour relancer un transfert* Identifiant du transfert à relancer .. option:: -info INFO Info complémentaires sur le transfert .. option:: -block Fixe la taille de blocs pour le transfert .. option:: -md5 Force le contrôle d'intégrité par paquet (déconseillé) .. option:: -nolog Désactive les logs pour ce transfert .. option:: -logWarn Loggue les messages INFO avec un niveau WARN .. option:: -notlogWarn Loggue les messages INFO avec un niveau INFO .. option:: -start yyyyMMddHHmmss Date à laquelle le transfert doit démarrer .. option:: -delay timestamp|+NNN Si un timestamp est fourni, date à laquelle le transfert doit démarrer (sous la forme d'un timestamp UNIX en ms). Si une valeur de la forme +NNN est fournie, délais en seconde à partir de l'exécution de la commande après lequel le transfert doit démarrer .. option:: -nofollow .. versionadded:: 3.4.0 Désactive l'assignation d'un identifiant de suivi de transfert pour ce fichier Codes de retour : ====== ============= Code Signification ====== ============= ``0`` Succès ``1`` Les arguments sont incorrects ou le fichier de configuration contient une erreur ``N`` Les autres codes de sortie correspondent à une erreur de transfert. Il s'agit de la valeur numérique du :ref:`code d'erreur ` ====== ============= Commande ``waarp-r66client msend`` ---------------------------------- .. program:: waarp-r66client msend Démarre plusieurs transferts synchrones (attend le résultat du transfert avant de rendre la main). Cette commande fonctionne sensiblement comme la commande ``send``, mais permet de lister plusieurs fichiers et plusieurs hôtes de destination : - En séparant les valeurs dans les arguments ``-to`` et ``-file`` par des virgules (``,``) - En utilisant des "jokers" dans l'argument ``file`` (``*`` pour remplacer plusieurs caractères ou ``?`` pour remplacer un caractère unique.) Cette commande accepte les arguments suivants : .. option:: -to PARTNER *obligatoire* Serveur R66 de destination .. option:: -file FILENAME *obligatoire pour démarrer un nouveau transfert* Fichier à envoyer .. option:: -rule RULE *obligatoire pour démarrer un nouveau transfert* Règle de transfert à utiliser .. option:: -id *obligatoire pour relancer un transfert* Identifiant du transfert à relancer .. option:: -info INFO Info complémentaires sur le transfert .. option:: -block Fixe la taille de blocs pour le transfert .. option:: -md5 Force le contrôle d'intégrité par paquet (déconseillé) .. option:: -nolog Désactive les logs pour ce transfert .. option:: -logWarn Loggue les messages INFO avec un niveau WARN .. option:: -notlogWarn Loggue les messages INFO avec un niveau INFO .. option:: -nofollow .. versionadded:: 3.4.0 Désactive l'assignation d'un identifiant de suivi de transfert pour ce fichier Codes de retour : ====== ============= Code Signification ====== ============= ``0`` Succès ``2`` Les arguments sont incorrects ou le fichier de configuration contient une erreur ``22`` Erreur inconnue ``N`` Nombre de transferts en erreur ====== ============= Commande ``waarp-r66client masend`` ----------------------------------- .. program:: waarp-r66client masend Démarre plusieurs transferts asynchrones (enregistre le démarrage du transfert et de rendre la main). Cette commande fonctionne sensiblement comme la commande ``asend``, mais permet de lister plusieurs fichiers et plusieurs hôtes de destination : - En séparant les valeurs deans les arguments ``-to`` et ``-file`` par des virgules (',') - En utilisant des "jokers" dans l'argument ``file`` (``*`` pour remplacer plusieurs caractères ou ``?`` pour remplacer un caractère unique.) Cette commande accepte les arguments suivants : .. option:: -to PARTNER *obligatoire* Serveur R66 de destination .. option:: -file FILENAME *obligatoire pour démarrer un nouveau transfert* Fichier à envoyer .. option:: -rule RULE *obligatoire pour démarrer un nouveau transfert* Règle de transfert à utiliser .. option:: -id *obligatoire pour relancer un transfert* Identifiant du transfert à relancer .. option:: -client Doit être ajouté pour si la règle est en mode réception .. option:: -info INFO Info complémentaires sur le transfert .. option:: -block Fixe la taille de blocs pour le transfert .. option:: -md5 Force le contrôle d'intégrité par paquet (déconseillé) .. option:: -nolog Désactive les logs pour ce transfert .. option:: -logWarn Loggue les messages INFO avec un niveau WARN .. option:: -notlogWarn Loggue les messages INFO avec un niveau INFO .. option:: -start yyyyMMddHHmmss Date à laquelle le transfert doit démarrer .. option:: -delay timestamp|+NNN Si un timestamp est fourni, date à laquelle le transfert doit démarrer (sous la forme d'un timestamp UNIX en ms). Si une valeur de la forme +NNN est fournie, délais en seconde à partir de l'exécution de la commande après lequel le transfert doit démarrer .. option:: -nofollow .. versionadded:: 3.4.0 Désactive l'assignation d'un identifiant de suivi de transfert pour ce fichier Codes de retour : ====== ============= Code Signification ====== ============= ``0`` Succès ``1`` Les arguments sont incorrects ou le fichier de configuration contient une erreur ``2`` Erreur de connexion à la base de données ou absence de l'argument -client ``N`` Nombre de transferts dont la programmation est en erreur ====== ============= Commande ``waarp-r66client transfer`` ------------------------------------- .. program:: waarp-r66client transfer Cette commande permet d'obtenir des informations sur un transfert en cours ou terminé, et d'agir sur ces transferts Elle accepte les arguments suivants : .. option:: -id *obligatoire* Identifiant du transfert .. option:: -to *Les options -to et -from sont exclusives, et l'une des deux doit être fournie* Partenaire de destination .. option:: -from *Les options -to et -from sont exclusives, et l'une des deux doit être fournie* Partenaire de d'origine .. option:: -cancel *Les options -cancel, -stop et -restart sont exclusives* Annule le transfert en cours (les fichiers temporaires sont supprimés sur le récepteur) .. option:: -stop *Les options -cancel, -stop et -restart sont exclusives* Arrête un transfert en cours .. option:: -restart *Les options -cancel, -stop et -restart sont exclusives* Redémarre un transfert en erreur .. option:: -start yyyyMMddHHmmss *Ne peut être utilisé qu'avec l'action -restart* Date à laquelle le transfert doit démarrer .. option:: -delay timestamp|+NNN Si un timestamp est fourni, date à laquelle le transfert doit démarrer (sous la forme d'un timestamp UNIX en ms). Si une valeur de la forme +NNN est fournie, délais en seconde à partir de l'exécution de la commande après lequel le transfert doit démarrer Codes de retour communs : ====== ============= Code Signification ====== ============= ``0`` Succès ``1`` Les arguments sont incorrects ou le fichier de configuration contient une erreur ``99`` Une erreur inattendue s'est produite ====== ============= Codes de retour pour l'action :option:`-cancel` : ====== ============= Code Signification ====== ============= ``3`` Le transfert est déjà terminé ``4`` L'action demandée n'a pas pu être effectuée ====== ============= Codes de retour pour l'action :option:`-stop` : ====== ============= Code Signification ====== ============= ``3`` L'action demandée n'a pas pu être effectuée ====== ============= Codes de retour pour l'action :option:`-restart` : ====== ============= Code Signification ====== ============= ``3`` L'action demandée n'a pas pu être effectuée ``4`` Le transfert est déjà terminé ``5`` Le partenaire distant a renvoyé une erreur ====== ============= Commande ``waarp-r66client getinfo`` ------------------------------------ .. program:: waarp-r66client getinfo Cette commande permet d'obtenir sur les fichiers disponibles sur un partenaire distant. Elle accepte les arguments suivants : .. option:: -to PARTNER *Obligatoire* Serveur R66 de destination .. option:: -file FILENAME *Obligatoire* Fichier à envoyer (peut contenir des caractères de subtitution "*") .. option:: -rule RULE Règle de transfert à utiliser .. option:: -exist Vérifie si le fichier donné exist .. option:: -detail Récupère des informations sur le fichie .. option:: -list Liste les fichiers correspondant au motif donn .. option:: -mlsx Liste les fichiers et récupère leurs détails Codes de retour communs : ====== ============= Code Signification ====== ============= ``0`` Succès ``1`` Les arguments sont incorrects ou le fichier de configuration contient une erreur ``2`` Une erreur s'est produite durant l'interrogation du partenaire ``3`` Une erreur inattendue s'est produite ====== ============= Commande ``waarp-r66client gui`` -------------------------------- Ouvre un client graphique pour démarrer un transfert. .. warning:: Ne fonctionne que dans un environnement graphique Autres commandes ================ Commande ``waarp-r66client initdb`` ----------------------------------- .. program:: waarp-r66client initdb Initialise la base de données du client. Cette commande accepte les arguments suivants : .. option:: -initdb Initialise la base de données .. option:: -upgradeDb Met à jour le modèle de la base de données .. option:: -dir DOSSIER Charge les règles de transferts en base depuis le dossier DOSSIER .. option:: -auth FICHIER Charge les données d'authentification en base depuis le fichier FICHIER .. option:: -limit FICHIER Charge les limitation de bande passante en base depuis le fichier FICHIER .. option:: -loadAlias FICHIER Charge les alias du serveur en base en base depuis le fichier FICHIER .. option:: -loadRoles FICHIER Charge les rôles du serveur en base depuis le fichier FICHIER .. option:: -loadBusiness FICHIER Charge les données business en base depuis le fichier FICHIER Codes de retour : ===== ============= Code Signification ===== ============= ``0`` Succès ``1`` Les arguments sont incorrects ou le fichier de configuration contient une erreur ``2`` Une erreur SQL s'est produite durant l'initialisation de la base ===== ============= Commande ``waarp-r66client loadconf`` ------------------------------------- .. program:: waarp-r66client loadconf Charge la configuration (authentification et règles de transfert) depuis des fichiers XML dans la base de données de WaarpR66 Server. Il s'agit d'un raccourci vers les deux commandes ``loadauth`` et ``loadrule``. Les fichiers attendus par la commande sont les suivants : - ``/comp/waarp/wrs/etc/authent-server.xml`` : fichier contenant les données d'authentification - ``/comp/waarp/wrs/etc/`` : dossier contenant les définitions de règles Une fois les données chargées en base de données, les fichiers peuvent être supprimés sans risque. Codes de retour : ===== ============= Code Signification ===== ============= ``0`` Succès ``1`` WaarpR66 a retourné une erreur durant le chargement des données en base. ===== ============= .. _r66client-log-export: Commande ``waarp-r66client log-export`` --------------------------------------- .. program:: waarp-r66client log-export Cette commande permet d'exporter l'historique de transfert du serveur WaarpR66 associé au client, et le cas échéant de purger l'historique. Les fichiers XML produit sont déposés dans le dossier ``arch`` définitions dans la configuration du serveur. .. warning:: Cette commande ne fonctionne que pour les clients associés à un serveur WaarpR66. Elle sera déplacée dans le script waarp-r66server.sh dans une version future Cette commande accepte les arguments suivants : .. option:: -clean Corrige le statut des transferts terminés erronés .. option:: -purge Supprime l'historique exporté de la base de données .. option:: -start DATE Exporte seulement l'historique postérieur à cette date .. option:: -stop DATE Exporte seulement l'historique antérieur à cette date .. option:: -startid ID Valeur minimale d'identifiants de transfert à exporter .. option:: -stopid ID Valeur maximale d'identifiants de transfert à exporter .. option:: -rule RULE Limite l'export à une règle spécifique .. option:: -request HOST Limite l'export à un partenaire spécifique .. option:: -pending Limite l'export aux transferts en attente .. option:: -transfer Limite l'export aux transferts en cours .. option:: -done Limite l'export aux transferts terminés .. option:: -error Limite l'export aux transferts en erreur Les valeurs ``DATE`` doivent avoir le format ``yyyyMMddHHmmssSSS``. La date peut omettre les derniers éléments (ex: ``20150815``). Codes de retour : ====== ============= Code Signification ====== ============= ``0`` Succès ``1`` Les arguments sont incorrects ou le fichier de configuration contient une erreur ``10`` Le serveur WaarpR66 associé au client n'est pas trouvé ``20`` Warning ``N`` Les autres codes de sortie correspondent à une erreur de transfert. Il s'agit de la valeur numérique du :ref:`code d'erreur ` ====== ============= Commande ``waarp-r66client config-export`` ------------------------------------------ .. program:: waarp-r66client config-export Cette commande permet d'exporter la configuration enregistrée en base de données du serveur WaarpR66 associé au client. Les fichiers XML produit sont déposés dans le dossier ``arch`` définitions dans la configuration du serveur. .. warning:: Cette commande ne fonctionne que pour les clients associés à un serveur WaarpR66. Elle sera déplacée dans le script waarp-r66server.sh dans une version future Cette commande accepte les arguments suivants : .. option:: -hosts Exporte les données d'authentification .. option:: -rules Exporte les règles de transfert .. option:: -business Exporte les données business .. option:: -alias Exporte les alias du serveur .. option:: -role Exporte les rôles du serveur .. option:: -host HOST Envoi la demande d'export au serveur HOST Codes de retour : ====== ============= Code Signification ====== ============= ``0`` Succès ``1`` Les arguments sont incorrects ou le fichier de configuration contient une erreur ``10`` Le serveur WaarpR66 associé au client n'est pas trouvé ``20`` Warning ``N`` Les autres codes de sortie correspondent à une erreur de transfert. Il s'agit de la valeur numérique du :ref:`code d'erreur ` ====== ============= Commande ``waarp-r66client icaptest`` ------------------------------------- .. program:: waarp-r66client icaptest .. versionadded:: 3.4.0 Cette commande permet de tester les arguments d'une tâche ICAP en envoyant un fichier local à un serveur ICAP. Cette commande accepte les arguments suivants : .. option:: -file FILENAME :Obligatoire: Spécifie le chemin du fichier à envoyer au serveur ICAP. Si la valeur donnée est ``EICARTEST``, un faux virus basé sur le test EICAR sera envoyé). .. option:: -to HOST :Obligatoire: L'adresse du serveur ICAP. .. option:: -port PORT Le port du serveur ICAP. .. option:: -service SERVICE *Au moins l'un des arguments ``-service`` ou ``-model`` doit être donné* Le nom du service à utiliser sur le serveur distant. .. option:: -model MODEL *Au moins l'un des arguments ``-service`` ou ``-model`` doit être donné* Le Modèle de service à utiliser pour le serveur distant. .. option:: -maxSize SIZE :Défaut: 2147483647 La taille maximale du fichier à envoyer. Si le fichier donné à l'option ``-file`` a une taille supérieure à cette valeur, rien ne sera transmis au serveur. .. option:: -previewSize SIZE :Défaut: Négocié avec le serveur La taille de *preview* à utiliser. .. option:: -blockSize SIZE :Défaut: 8192 Spécifie la taille de bloc utilisée. .. option:: -receiveSize SIZE :Défaut: 65536 Spécifie la taille à recevoir .. option:: -timeout DURATION Délais d'attente de réponse (en ms). .. option:: -keyPreview Spécifie la clef à chercher dans la réponse d'un *preview* pour valider le fichier. .. option:: -stringPreview Spécifie la valeur associée à la clef ``-keyPreview`` à chercher dans la réponse pour valider le fichier. .. option:: -key204 Spécifie la clef à chercher dans une réponse 204 du serveur pour valider le fichier. .. option:: -string204 Spécifie la valeur associée à la clef ``-key204`` à chercher dans une réponse 204 du serveur pour valider le fichier. .. option:: -key200 Spécifie la clef à chercher dans une réponse 200 du serveur pour valider le fichier. .. option:: -string200 Spécifie la valeur associée à la clef ``-key200`` à chercher dans une réponse 200 du serveur pour valider le fichier. .. option:: -stringHttp Spécifie une valeur à rechercher dans le statut d'une réponse 200 du serveur pour valider le fichier. .. option:: -errorDelete Supprime les fichiers considérés invalides .. option:: -errorMove PATH Déplace les fichiers considérés invalides dans le dossier spécifié .. option:: -sendOnError Retransfère les fichiers considérés comme invalides avec R66. Les arguments de lancement du transfert doivent arriver à la fin de la commande, précédés du marqueur ``--``. .. option:: -ignoreNetworkError Ignore les erreurs réseau lors de l'envoi de la requête vers le serveur ICAP. Si une se produit, le fichier est considéré comme valide. .. option:: -logger LEVEL Spécifie le niveau de logs. Les valeurs possibles sont ``DEBUG``, ``INFO``, ``WARN`` et ``ERROR``. Codes de retour : ====== ============= Code Signification ====== ============= 0 Le fichier est valide 1 Mauvais arguments dans la ligne de commande 2 Erreur de protocole ICAP 3 Erreur réseau 4 Le fichier est invalide 5 Le fichier est invalide, et une erreur s'est produite durant les post-traitements ====== ============= .. _error-codes: Les codes d'erreurs de manières générales indiquent : - 0 : pour OK - 1 : pour Warning - 2 et au-delà : pour une erreur différenciée et bloquante