UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

UIP RPA à distance

Syntaxe et options de `uip rpa remote`, qui configure et pilote un robot non assisté Orchestrator à distance — configuration cible, sessions UI Automation, exécution de processus et transfert de fichiers.

uip rpa remote fonctionne sur un robot Unattended Orchestrator distant: configurez la machine/le robot/le runtime à cibler, démarrez ou arrêtez une session de conception UI Automation à distance dessus, exécutez des commandes shell et transférez des fichiers vers/depuis celui-ci. Une fois configurés, uip rpa run --remote et debug start --remote acheminent l'exécution vers cette machine au lieu de l'exécuter localement.

Nécessite une connexion à Orchestrator (uip login) pour chaque verbe.

Synthèse​

uip rpa remote configure --machine <name> [--folder-path <path>] [--robot <name>] [--runtime <name>] [--live-authoring | --remote-run-only]
uip rpa remote status
uip rpa remote start
uip rpa remote stop
uip rpa remote echo --message <text>
uip rpa remote exec --command <cmd> [--package-id <id> --package-version <v>] [--working-directory <dir>] [--timeout <seconds>]
uip rpa remote upload-file --local-path <path> --remote-path <path>
uip rpa remote download-file --remote-path <path> --local-path <path>
uip rpa remote configure --machine <name> [--folder-path <path>] [--robot <name>] [--runtime <name>] [--live-authoring | --remote-run-only]
uip rpa remote status
uip rpa remote start
uip rpa remote stop
uip rpa remote echo --message <text>
uip rpa remote exec --command <cmd> [--package-id <id> --package-version <v>] [--working-directory <dir>] [--timeout <seconds>]
uip rpa remote upload-file --local-path <path> --remote-path <path>
uip rpa remote download-file --remote-path <path> --local-path <path>

configuration à distance uip rpa​

Résolvez et stockez la cible de débogage à distance (dossier → robot → machine → runtime) et démarrez la session de conception UI Automation à distance dessus. remote stop désactive la session.

Options​

LongValeur (Value)RequisDescription
--machine <name>stringouiNom de la machine Orchestrator sur laquelle exécuter le Unattended Robot.
--folder-path <path>stringnonDossier Orchestrator complet auquel appartient le robot/la machine (par exemple Shared/Finance) — le robot, la machine et le runtime sont résolus à l'intérieur. La valeur par défaut est le dossier actuel du backend.
--robot <name>stringnonCompte Robot/utilisateur sous lequel exécuter. Par défaut, l'identité par défaut de la machine.
--runtime <name>stringnonNom du runtime connecté (hôte/session). Ignoré pour les machines sans serveur; définissez-le pour cibler une session connectée spécifique sur une machine classique.
--live-authoringDrapeaunonUtiliser la cible pour la création en direct: une tâche de session à distance de longue durée sert chaque session de commande, d’exécution et de débogage à distance; la session de conception UI Automation à distance devient disponible et l'écran distant est diffusé. Capture mutuellement exclusive avec --remote-run-only. Obligatoire avant que remote echo ne fonctionne.
--remote-run-onlyDrapeaunonUtiliser la cible pour les exécutions à distance uniquement: une session d'exécution ou de débogage est sa propre tâche Orchestrator, sans session UIAutomation à distance. Il s’agit de la valeur par défaut pour une cible qui n’a jamais eu de mode stocké. Capture mutuellement exclusive avec --live-authoring.

La transmission de --live-authoring et de --remote-run-only échoue côté client — ce sont les deux modes d'une même connexion; transmettez au moins un. Le fait de ne pas passer ne laisse pas le mode stocké inchangé.

Exemple​

uip rpa remote configure --machine BotMachine --folder-path "Shared/Finance"
uip rpa remote configure --machine BotMachine --folder-path "Shared/Finance"

Format des données (--sortie json)​

Autorisation brute de la charge utile { success, ...resolved-config } du backend - inclut le dossier/robot/machine/runtime résolu une fois mis en correspondance.

Statut à distance de l'UIP RPA​

Affichez la connexion à distance actuellement configurée pour le locataire connecté, telle qu'elle a été résolue avec Orchestrator. En lecture seule — ne modifie pas ni ne démarre rien. Aucune option.

Exemple​

uip rpa remote status
uip rpa remote status

Démarrage à distance de l’UIP RPA​

Démarrer l’automatisation UI Automation à distance: configurez une session d’expérience de conception UIA sur l’agent distant configuré, de façon à ce que les commandes uip rpa uia avec --remote entraînent cette machine. Échoue si aucune cible n’est configurée (remote configure en premier). Le démarrage d’une session déjà en cours d’exécution n’est pas compatible; la reconfiguration vers une cible différente la redémarre. Aucune option.

Exemple​

uip rpa remote start
uip rpa remote start

arrêt à distance uip rpa​

Supprimez la session UIA à distance actuelle et libérez l’agent. Idempotente: réussit même lorsqu’aucune session n’est en cours d’exécution ou que la cible n’est plus configurée. Un appel uia --remote ultérieur démarre automatiquement une nouvelle session. Aucune option.

Exemple​

uip rpa remote stop
uip rpa remote stop

Écho à distance de l’UIP RPA​

Faites pivoter un message depuis RemoteSessionAgent exécuté sur l’agent distant configuré et imprimez la réponse — une vérification de la connectivité. Création en direct uniquement (remote configure --live-authoring); L’exécution à distance uniquement n’a aucun agent auquel répondre. Démarre l'agent lors de la première utilisation; chaque écho se déplace sur son propre canal privé, de sorte que les appelants simultanés ne voient jamais leur propre réponse.

Options​

LongValeur (Value)RequisDescription
--message <text>stringouiTexte renvoyé par l'AgentSession: utile pour différencier les réponses des appelants simultanés.

Exemple​

uip rpa remote echo --message "ping"
uip rpa remote echo --message "ping"

Exécution à distance RPA UiP​

Exécutez une commande shell sur l’agent distant configuré (cmd.exe /c sous Windows, /bin/sh -c dans le cas contraire), en streaming la sortie en direct. Il n'y a pas de mode local, il s'exécute toujours sur la machine distante.

Options​

LongValeur (Value)RequisDescription
--command <cmd>stringouiLigne de commande Shell à exécuter à distance (par exemple dir, ls -la). Lorsqu'un package est restauré (voir ci-dessous), il peut s'agir d'un chemin d'accès relatif au dossier du package.
--package-id <id>stringConditionnelPackage NuGet à restaurer sur la machine distante avant l'exécution de la commande. Nécessite --package-version ensemble.
--package-version <v>stringConditionnelVersion de --package-id à restaurer. Requis lorsque --package-id est défini — la transmission de l'un sans l'autre échoue côté client.
--working-directory <dir>stringnonRépertoire de travail pour la commande. Par défaut, le dossier de packages restauré lorsqu’un package est restauré, sinon le répertoire actuel de la machine distante.
--timeout <seconds>NumériquenonForcez l'arrêt de la commande après ce nombre de secondes. Omettez pour aucun délai d'attente.

Exemple​

uip rpa remote exec --command "dir" --timeout 30
uip rpa remote exec --command "dir" --timeout 30

uip rpa - fichier de téléchargement distant​

Chargez un fichier local dans l'agent distant configuré, transféré via un compartiment de stockage Orchestrator temporaire (créé et supprimé automatiquement).

Options​

LongValeur (Value)RequisDescription
--local-path <path>stringouiChemin d’accès au fichier local à charger.
--remote-path <path>stringouiChemin de destination sur la machine distante. Les répertoires parents sont créés.

Exemple​

uip rpa remote upload-file --local-path ./data.csv --remote-path "C:\Bots\data.csv"
uip rpa remote upload-file --local-path ./data.csv --remote-path "C:\Bots\data.csv"

fichier-téléchargement à distance uip rpa​

Télécharge un fichier depuis l'agent distant configuré vers un chemin local, transféré via un compartiment de stockage Orchestrator temporaire.

Options​

LongValeur (Value)RequisDescription
--remote-path <path>stringouiChemin du fichier sur la machine distante à télécharger.
--local-path <path>stringouiChemin de destination local. Les répertoires parents sont créés.

Exemple​

uip rpa remote download-file --remote-path "C:\Bots\output.log" --local-path ./output.log
uip rpa remote download-file --remote-path "C:\Bots\output.log" --local-path ./output.log
  • uip rpa run/debug — le --remote indicateur des configurations cibles de ce groupe.
  • uip rpa uia — piloté à distance une fois que remote start est actif.

Voir également​

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour