Modifier une règle

waarp-gateway rule update <RULE> <DIRECTION>

Remplace les attributs de la règle donnée en paramètre par ceux fournis ci-dessous. Les attributs omis resteront inchangés.

<RULE>

Le nom de la règle à modifier.

<DIRECTION>

Le sens de la règle à modifier. Peut être send ou receive.

-n <NAME>, --name=<NAME>

Le nom de la règle de transfert. Doit être unique.

-c <COMMENT>, --comment=<COMMENT>

Un commentaire optionnel décrivant la règle.

-d <DIRECTION>, --direction=<DIRECTION>

Le sens de transfert des fichiers utilisant cette règle. Une règle peut être utilisée pour la réception (receive) ou l’envoi (send) de fichiers.

-p <PATH>, --path=<PATH>

Le chemin associé à la règle. Ce chemin sert à identifier la règle lors d’un transfert lorsque le protocole ne le permet pas. Par conséquent, ce chemin doit être unique.

--local-dir=<DIRECTORY>

Le chemin du dossier local des fichiers transférés. Dans le cas d’une règle d’envoi, ce dossier est utilisé comme source des fichiers. Dans le cas d’une règle de réception, ce dossier est utilisé comme destination des fichiers. Peut être un chemin relatif ou absolu. Le format du chemin dépend de l’OS de la gateway.

--remote-dir=<DIRECTORY>

Le chemin d’accès sur le serveur distant des fichiers transférés. Dans le cas d’une règle d’envoi, ce dossier est utilisé comme destination des fichiers. Dans le cas d’une règle de réception, ce dossier est utilisé comme source des fichiers. Ce chemin faisant partie d’un URI, il doit toujours être au format Unix standard.

--tmp-dir=<DIRECTORY>

Le chemin du dossier local temporaire des fichiers an cours de réception. Par conséquent, ce dossier n’est utile que pour les règles de réception. Le format du chemin dépend de l’OS de la gateway.

-r <TASK>, --pre=<TASK>

Un pré-traitement associé à la règle. Peut être répété plusieurs fois pour ajouter plusieurs traitements. Ces traitements seront exécutés avant chaque transfert dans l’ordre dans lequel ils ont été renseignés. Les traitements doivent être renseignés sous la forme d’un objet JSON avec 2 champs: le champ type et le champ args. Le premier est une string contenant la commande a exécuter, le second est un objet JSON contenant les arguments de la commande.

-s <TASK>, --post=<TASK>

Un post-traitement associé à la règle. Peut être répété plusieurs fois pour ajouter plusieurs traitements. Ces traitements seront exécutés après chaque transfert dans l’ordre dans lequel ils ont été renseignés. Les traitements doivent être renseignés sous la forme d’un objet JSON avec 2 champs: le champ type et le champ args. Le premier est une string contenant la commande a exécuter, le second est un objet JSON contenant les arguments de la commande.

-e <TASK>, --err=<TASK>

Un traitement d’erreur associé à la règle. Peut être répété plusieurs fois pour ajouter plusieurs traitements. Ces traitements seront exécutés en cas d’erreur dans l’ordre dans lequel ils ont été renseignés. Les traitements doivent être renseignés sous la forme d’un objet JSON avec 2 champs: le champ type et le champ args. Le premier est une string contenant la commande a exécuter, le second est un objet JSON contenant les arguments de la commande.

-o <PATH>, --out_path=<PATH>

OBSOLÈTE: remplacé par les options --local-dir et --remote-dir.

-i <PATH>, --in_path=<PATH>

OBSOLÈTE: remplacé par les options --local-dir et --remote-dir.

-w <PATH>, --work_path=<PATH>

OBSOLÈTE: remplacé par --tmp-dir.

Exemple

waarp-gateway -a 'http://user:password@localhost:8080' rule update règle_1 'send' -n 'règle_1_new' -c 'nouvelle règle de réception des fichiers avec SFTP' -p '/règle_1_new' -i '/règle_1_new/in' -o '/règle_1_new/out' --pre '{"type":"COPY","args":{"path":"chemin/copie"}}' --post '{"type":"DELETE","args":{}}' --err '{"type":"MOVE","args":{"path":"chemin/déplacement"}}'