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 ou

Gérez les tâches, les dossiers, les processus, les packages, les machines, les utilisateurs, les rôles, les licences et les ressources de runtime d’Orchestrator à l’aide de l’outil `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, les pièces jointes, la configuration ROI métier des processus et des files d'attente et les ressources d'exécution dépendent des automatisations (ressources, compartiments , files d'attente, déclencheurs, bibliothèques, webhooks) sur un locataire UiPath Orchestrator. Installez-le avec uip tools install or, ou invoquez uip or … et laissez l'installation automatique s'exécuter. Reportez-vous à 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 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.
ROI du processusObtenir, créer, mettre à jour et supprimer la configuration ROI métier d'un processus.
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.
SessionsAffichez et gérez les connexions de robots en direct à Orchestrator.
CalendriersCalendriers de dates exclues utilisés par les déclencheurs de temps.
journaux-auditRépertorie le journal d'audit du locataire.
paramètresLisez et écrivez les paramètres d'Orchestrator au niveau du locataire par clé pointillée.
ActifsValeurs de configuration nommées (Texte, Booléen, Integer, Credential, Secret) utilisées par les automatisations au moment du runtime. Étendue du dossier.
CompartimentsConteneurs de stockage pour les fichiers utilisés par les automatisations. Étendue du dossier.
Compartiment-fichiersFichiers individuels dans un compartiment. Répertorier, charger, télécharger, supprimer, récupérer des URL pré-signées.
BibliothèquesPackages .nupkg réutilisables (activités et logique partagées). À l’échelle du locataire.
Files d'attente (Queues)Conteneurs pour les éléments de travail transactionnels. Étendue du dossier.
ROI de la file d'attenteRécupérez, créez, mettez à jour et supprimez la configuration ROI métier d'une file d'attente.
éléments de la file d'attenteTransactions individuelles dans des files d'attente, avec des contrôles complets de la machine d'état. Étendue du dossier.
Déclencheurs (Triggers)Déclencheurs de temps, de file d'attente et d'API qui démarrent les tâches. Étendue du dossier.
WebhooksRappels HTTP déclenchés lors d'événements de la plateforme (achèvement de la tâche, échec de l'élément de la file d'attente, ...) . À l’échelle du locataire.
magasins d'informations d’identificationRépertorier et inspecter les configurations du magasin d'informations d'identification externes utilisées par les ressources Credential/Secret et les compartiments Azure/Amazon.

Évaluation du runtime des packages déployés — soumission des exécutions, notation des sorties et gestion des évaluateurs/ensembles d'évaluation/planifications par rapport à un processus Orchestrator — est un outil autonome distinct: uip eval (package @uipath/eval-tool, pas une sous-commande uip or , même si chaque verbe fonctionne dans un processus/dossier Orchestrator).

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
--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.
--all-folderslist sur certaines ressources de dossier (par exemple, assets, buckets)Lister dans chaque dossier accessible à l'appelant au lieu de se limiter à un seul. Lorsque cette option est prise en charge, l'une de --folder-path, --folder-key ou --all-folders est requise.
-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.
--sort-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.
-y, --yeschaque verbe destructrice (delete)Confirmez l’opération. Requis: la CLI ne demande jamais une action irréversible de manière interactive.

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.

Conventions runtime-ressources​

Les pages de ressources de runtime (ressources, compartiments, fichiers de compartiment, bibliothèques, files d'attente, éléments de file d'attente, déclencheurs, webhooks) partagent quelques conventions supplémentaires en plus de celles ci-dessus:

  • Étendue des dossiers. Les ressources, les compartiments, les files d'attente, les éléments de file d'attente et les déclencheurs (heure, file d'attente et API) sont couverts par dossier. Indiquez --folder-path <path> (par ex "Shared") ou --folder-key <guid> sur list, create et les appels connexes — ou --all-folders où cet indicateur est pris en charge. get, update et delete résolvent les dossiers croisés par clé lorsque cela est faisable; la description de chaque verbe sur la page de ressources l'appelle explicitement. Les bibliothèques et les webhooks sont à l'échelle des locataires et n'acceptent pas --folder-*.
  • Clés. La plupart des ressources sont identifiées par un GUID renvoyé dans la sortie list (sous key, identifier ou — pour les éléments de file d'attente — uniqueKey pour une tentative unique et key pour la chaîne de réessai). Les champs numériques id sont internes et ne doivent pas être transmis aux commandes.
  • Filtrage. Lorsque cette option est prise en charge, -n, --name <name> est une correspondance de « contient» au niveau du nom de la ressource; certaines ressources ajoutent --enabled, --disabled, --status, etc.

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(opens in new window)

Vous souhaitez apprendre ? UiPath Academy(opens in new window)

Vous avez des questions ? UiPath Forum(opens in new window)

Rester à jour