UiPath Documentation
uipath-cli
latest
false
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.

Guide de l'utilisateur de UiPath CLI

UIP ou

uip or est l'outil d'Orchestrator: il gère les tâches, les dossiers, les processus, les packages, les machines, les utilisateurs, les rôles, les licences, les flux et les pièces jointes sur un locataire UiPath Orchestrator. Installez-le avec uip tools install or, ou invoquez uip or … et laissez l'installation automatique s'exécuter. Voir Outils pour le modèle d'installation et Outils uip pour la commande qui gère l'installation de l'outil.

Ressources

Chaque ressource a sa propre page de référence. Le verbe défini sur chaque page correspond aux commandes enregistrées par uip or — exécutez uip or --help pour confirmer la surface complète de votre installation.

RessourceObjectif
Tâches (Jobs)Démarrer, arrêter, redémarrer, reprendre et inspecter les exécutions de processus; récupérer les journaux, les traces, les données de réparation et l'historique de l'état.
DossiersCréer, répertorier, déplacer, modifier et supprimer des dossiers; inspecter l'affectation du runtime.
ProcessusLier des packages à des dossiers en tant que processus exécutables; mettre à jour, restaurer et modifier.
PaquetsCharger, télécharger, répertorier et inspecter .nupkg les packages d'automatisation et leurs points d'entrée.
MachinesGérer les modèles de machine et les affectations d'emplacements; affecter des machines à des dossiers.
UtilisateursCréer, modifier, supprimer et affecter des utilisateurs d'Orchestrator; gérez les attributions de rôles au niveau des locataires.
RôlesGérer les rôles, les autorisations et l’appartenance à un rôle d’utilisateur au niveau du locataire et du dossier.
LicencesLister les attributions de licences d’exécution et d’utilisateur nommé; activer/désactiver les licences de machine; Afficher le résumé de la licence du locataire.
FluxRépertorie les flux de packages disponibles de l’utilisateur actuel.
Pièces jointes (Attachments)Répertorier et télécharger les pièces jointes de tâche.

Synthèse

uip or <resource> <verb> [options]
uip or <resource> <verb> [options]

Toujours uip or, jamais uip orchestrator. or est le préfixe de commande de l'outil (voir la colonne commandPrefix dans uip tools list).

Comment lire cette section

Chaque page de ressource est structurée de la même manière:

  1. Syntaxe — la forme de la commande uip or <resource> <verb> .
  2. Verbes — une table en une ligne de chaque verbe exposé par la ressource.
  3. Un H2 par verbe — description, les arguments de position (le cas échéant), la table des indicateurs, trois exemples (simples, cas courants, scripts conviviaux avec --output-filter) et la forme Data renvoyée sous --output json
  4. Codes de sortie — un pointeur vers le contrat de codes de sortie partagé, avec tous les remplacements spécifiques aux verbes appelés en ligne.
  5. Commandes connexes et Voir aussi — liens croisés vers des ressources frères et des pages de concept pertinentes.

Le format de sortie par défaut est --output json. Les formes de données de chaque page reflètent la charge utile JSON - les rendus table, yaml et simple sont dérivés du même objet Data .

Indicateurs communs

Un petit ensemble d'indicateurs est récurrent dans la plupart des ressources. Elles se comportent de la même manière partout où elles apparaissent:

DrapeauUtilisé parObjectif
-t, --tenant <tenant-name>chaque verbeRemplacer le locataire sélectionné au moment de l’authentification. Facultatif; omettez d’utiliser la session par défaut. Voir Authentification.
--folder-path <path>la plupart des verbes qui se situent dans un dossierDossier cible par le chemin complet (par exemple, Shared, Production/EU).
--folder-key <key>la plupart des verbes qui se situent dans un dossierDossier cible par GUID. Utilisable avec --folder-path; soit résout le même dossier.
-l, --limit <number>chaque verbe de listeTaille de la page. La valeur par défaut est le DEFAULT_PAGE_SIZE de la CLI (50 au moment de la rédaction).
--offset <number>chaque verbe de listeNombre d'éléments à ignorer avant de revenir. La valeur par défaut est 0.
--order-by <field>la plupart des verbes de listeExpression de tri OData (par exemple, Name asc, Id desc). Chaque verbe documente sa valeur par défaut.
--all-fieldsplusieurs list / get verbesRenvoyez la réponse d'API brute au lieu du résumé sélectionné. Utile lorsque vous avez besoin de champs que la forme par défaut omet.

Les indicateurs au niveau des verbes (filtres, chemins d'entrée/de sortie, stratégies, priorités) sont documentés sur chaque page de ressource.

Options globales et codes de sortie

Tous les verbes uip or respectent les quatre options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat partagé; tout remplacement spécifique à un verbe est appelé sur la page de ressource pertinente.

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