Waarp R66 Client

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 ici.

Commandes de gestion des transferts

Commande 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 :

-to PARTNER

obligatoire

Serveur R66 de destination

-file FILENAME

obligatoire pour démarrer un nouveau transfert

Fichier à envoyer

-rule RULE

obligatoire pour démarrer un nouveau transfert

Règle de transfert à utiliser

-id

obligatoire pour relancer un transfert

Identifiant du transfert à relancer

-info INFO

Info complémentaires sur le transfert

-block

Fixe la taille de blocs pour le transfert

-md5

Force le contrôle d’intégrité par paquet (déconseillé)

-nolog

Désactive les logs pour ce transfert

-logWarn

Loggue les messages INFO avec un niveau WARN

-notlogWarn

Loggue les messages INFO avec un niveau INFO

-nofollow

Nouveau dans la version 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 code d’erreur

Commande 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 :

-to PARTNER

obligatoire

Serveur R66 de destination

-file FILENAME

obligatoire pour démarrer un nouveau transfert

Fichier à envoyer

-rule RULE

obligatoire pour démarrer un nouveau transfert

Règle de transfert à utiliser

-id

obligatoire pour relancer un transfert

Identifiant du transfert à relancer

-info INFO

Info complémentaires sur le transfert

-block

Fixe la taille de blocs pour le transfert

-md5

Force le contrôle d’intégrité par paquet (déconseillé)

-nolog

Désactive les logs pour ce transfert

-logWarn

Loggue les messages INFO avec un niveau WARN

-notlogWarn

Loggue les messages INFO avec un niveau INFO

-start yyyyMMddHHmmss

Date à laquelle le transfert doit démarrer

-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

-nofollow

Nouveau dans la version 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 code d’erreur

Commande 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 :

-to PARTNER

obligatoire

Serveur R66 de destination

-file FILENAME

obligatoire pour démarrer un nouveau transfert

Fichier à envoyer

-rule RULE

obligatoire pour démarrer un nouveau transfert

Règle de transfert à utiliser

-id

obligatoire pour relancer un transfert

Identifiant du transfert à relancer

-info INFO

Info complémentaires sur le transfert

-block

Fixe la taille de blocs pour le transfert

-md5

Force le contrôle d’intégrité par paquet (déconseillé)

-nolog

Désactive les logs pour ce transfert

-logWarn

Loggue les messages INFO avec un niveau WARN

-notlogWarn

Loggue les messages INFO avec un niveau INFO

-nofollow

Nouveau dans la version 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

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 :

-to PARTNER

obligatoire

Serveur R66 de destination

-file FILENAME

obligatoire pour démarrer un nouveau transfert

Fichier à envoyer

-rule RULE

obligatoire pour démarrer un nouveau transfert

Règle de transfert à utiliser

-id

obligatoire pour relancer un transfert

Identifiant du transfert à relancer

-client

Doit être ajouté pour si la règle est en mode réception

-info INFO

Info complémentaires sur le transfert

-block

Fixe la taille de blocs pour le transfert

-md5

Force le contrôle d’intégrité par paquet (déconseillé)

-nolog

Désactive les logs pour ce transfert

-logWarn

Loggue les messages INFO avec un niveau WARN

-notlogWarn

Loggue les messages INFO avec un niveau INFO

-start yyyyMMddHHmmss

Date à laquelle le transfert doit démarrer

-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

-nofollow

Nouveau dans la version 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

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 :

-id

obligatoire

Identifiant du transfert

-to

Les options -to et -from sont exclusives, et l’une des deux doit être fournie

Partenaire de destination

-from

Les options -to et -from sont exclusives, et l’une des deux doit être fournie

Partenaire de d’origine

-cancel

Les options -cancel, -stop et -restart sont exclusives

Annule le transfert en cours (les fichiers temporaires sont supprimés sur le récepteur)

-stop

Les options -cancel, -stop et -restart sont exclusives

Arrête un transfert en cours

-restart

Les options -cancel, -stop et -restart sont exclusives

Redémarre un transfert en erreur

-start yyyyMMddHHmmss

Ne peut être utilisé qu’avec l’action -restart

Date à laquelle le transfert doit démarrer

-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 -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 -stop :

Code

Signification

3

L’action demandée n’a pas pu être effectuée

Codes de retour pour l’action -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

Cette commande permet d’obtenir sur les fichiers disponibles sur un partenaire distant.

Elle accepte les arguments suivants :

-to PARTNER

Obligatoire

Serveur R66 de destination

-file FILENAME

Obligatoire

Fichier à envoyer (peut contenir des caractères de subtitution « * »)

-rule RULE

Règle de transfert à utiliser

-exist

Vérifie si le fichier donné exist

-detail

Récupère des informations sur le fichie

-list

Liste les fichiers correspondant au motif donn

-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.

Avertissement

Ne fonctionne que dans un environnement graphique

Autres commandes

Commande waarp-r66client initdb

Initialise la base de données du client.

Cette commande accepte les arguments suivants :

-initdb

Initialise la base de données

-upgradeDb

Met à jour le modèle de la base de données

-dir DOSSIER

Charge les règles de transferts en base depuis le dossier DOSSIER

-auth FICHIER

Charge les données d’authentification en base depuis le fichier FICHIER

-limit FICHIER

Charge les limitation de bande passante en base depuis le fichier FICHIER

-loadAlias FICHIER

Charge les alias du serveur en base en base depuis le fichier FICHIER

-loadRoles FICHIER

Charge les rôles du serveur en base depuis le fichier FICHIER

-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

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.

Commande 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.

Avertissement

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 :

-clean

Corrige le statut des transferts terminés erronés

-purge

Supprime l’historique exporté de la base de données

-start DATE

Exporte seulement l’historique postérieur à cette date

-stop DATE

Exporte seulement l’historique antérieur à cette date

-startid ID

Valeur minimale d’identifiants de transfert à exporter

-stopid ID

Valeur maximale d’identifiants de transfert à exporter

-rule RULE

Limite l’export à une règle spécifique

-request HOST

Limite l’export à un partenaire spécifique

-pending

Limite l’export aux transferts en attente

-transfer

Limite l’export aux transferts en cours

-done

Limite l’export aux transferts terminés

-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 code d’erreur

Commande 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.

Avertissement

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 :

-hosts

Exporte les données d’authentification

-rules

Exporte les règles de transfert

-business

Exporte les données business

-alias

Exporte les alias du serveur

-role

Exporte les rôles du serveur

-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 code d’erreur

Commande waarp-r66client icaptest

Nouveau dans la version 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 :

-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é).

-to HOST
Obligatoire:

L’adresse du serveur ICAP.

-port PORT

Le port du serveur ICAP.

-service SERVICE

Au moins l’un des arguments ``-service`` ou ``-model`` doit être donné

Le nom du service à utiliser sur le serveur distant.

-model MODEL

Au moins l’un des arguments ``-service`` ou ``-model`` doit être donné

Le Modèle de service à utiliser pour le serveur distant.

-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.

-previewSize SIZE
Défaut:

Négocié avec le serveur

La taille de preview à utiliser.

-blockSize SIZE
Défaut:

8192

Spécifie la taille de bloc utilisée.

-receiveSize SIZE
Défaut:

65536

Spécifie la taille à recevoir

-timeout DURATION

Délais d’attente de réponse (en ms).

-keyPreview

Spécifie la clef à chercher dans la réponse d’un preview pour valider le fichier.

-stringPreview

Spécifie la valeur associée à la clef -keyPreview à chercher dans la réponse pour valider le fichier.

-key204

Spécifie la clef à chercher dans une réponse 204 du serveur pour valider le fichier.

-string204

Spécifie la valeur associée à la clef -key204 à chercher dans une réponse 204 du serveur pour valider le fichier.

-key200

Spécifie la clef à chercher dans une réponse 200 du serveur pour valider le fichier.

-string200

Spécifie la valeur associée à la clef -key200 à chercher dans une réponse 200 du serveur pour valider le fichier.

-stringHttp

Spécifie une valeur à rechercher dans le statut d’une réponse 200 du serveur pour valider le fichier.

-errorDelete

Supprime les fichiers considérés invalides

-errorMove PATH

Déplace les fichiers considérés invalides dans le dossier spécifié

-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 --.

-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.

-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

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