UIP ou

Manage Orchestrator jobs, folders, processes, packages, machines, users, roles, licenses, and runtime resources using the `uip or` tool.

uip or is the Orchestrator tool: it manages jobs, folders, processes, packages, machines, users, roles, licenses, feeds, attachments, and the runtime resources automations depend on (assets, buckets, queues, triggers, libraries, webhooks) on a UiPath Orchestrator tenant. Install it with uip tools install or, or invoke uip or … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation.

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.

Ressource	Objectif
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.
Dossiers	Créer, répertorier, déplacer, modifier et supprimer des dossiers; inspecter l'affectation du runtime.
Processus	Lier des packages à des dossiers en tant que processus exécutables; mettre à jour, restaurer et modifier.
Paquets	Charger, télécharger, répertorier et inspecter .nupkg les packages d'automatisation et leurs points d'entrée.
Machines	Gérer les modèles de machine et les affectations d'emplacements; affecter des machines à des dossiers.
Utilisateurs	Créer, modifier, supprimer et affecter des utilisateurs d'Orchestrator; gérez les attributions de rôles au niveau des locataires.
Rôles	Gérer les rôles, les autorisations et l’appartenance à un rôle d’utilisateur au niveau du locataire et du dossier.
Licences	Lister 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.
Flux	Ré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.
Actifs	Valeurs de configuration nommées (Texte, Booléen, Integer, Credential, Secret) utilisées par les automatisations au moment du runtime. Étendue du dossier.
Compartiments	Conteneurs de stockage pour les fichiers utilisés par les automatisations. Étendue du dossier.
Compartiment-fichiers	Fichiers individuels dans un compartiment. Répertorier, charger, télécharger, supprimer, récupérer des URL pré-signées.
Bibliothèques	Packages .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.
éléments de la file d'attente	Transactions 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. Les déclencheurs de temps/file d'attente sont à l'échelle du dossier; Les déclencheurs d'API sont à l'échelle du locataire.
Webhooks	Rappels 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’identification	List and inspect external credential store configurations used by Credential/Secret assets and Azure/Amazon buckets.

Runtime evaluation of deployed packages — submitting runs, scoring outputs, and managing evaluators/eval sets/schedules against an Orchestrator process — is a separate, standalone tool: uip eval (package @uipath/eval-tool, not a uip or sub-command, even though every verb operates against an Orchestrator process/folder).

Synthèse

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:

Drapeau	Utilisé par	Objectif
--folder-path <path>	la plupart des verbes qui se situent dans un dossier	Dossier cible par le chemin complet (par exemple, Shared, Production/EU).
--folder-key <key>	la plupart des verbes qui se situent dans un dossier	Dossier cible par GUID. Utilisable avec --folder-path; soit résout le même dossier.
--all-folders	list on some folder-scoped resources (for example, assets, buckets)	List across every folder accessible to the caller instead of scoping to one. Where supported, one of --folder-path, --folder-key, or --all-folders is required.
-l, --limit <number>	chaque verbe de liste	Taille 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 liste	Nombre d'éléments à ignorer avant de revenir. La valeur par défaut est 0.
--sort-by <field>	la plupart des verbes de liste	Expression de tri OData (par exemple, Name asc, Id desc). Chaque verbe documente sa valeur par défaut.
--all-fields	plusieurs list / get verbes	Renvoyez 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, --yes	every destructive (delete) verb	Confirm the operation. Required — the CLI never prompts interactively for a destructive action.

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.

Runtime-resource conventions

The runtime-resource pages (assets, buckets, bucket-files, libraries, queues, queue-items, triggers, webhooks) share a few additional conventions on top of the ones above:

• Folder scoping. Assets, buckets, queues, queue items, and triggers (time / queue) are folder-scoped. Provide either --folder-path <path> (e.g. "Shared") or --folder-key <guid> on list, create, and related calls — or --all-folders where that flag is supported. get, update, and delete resolve cross-folder by key when feasible; each verb's description on the resource page calls it out explicitly. Libraries, API triggers, and webhooks are tenant-scoped and do not accept --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

• Concepts: comment UiPath CLI est organisé — où les outils s’intègrent dans le modèle hôte + outil.
• Sessions — la façon dont le contexte du locataire et du dossier est résolu.
• Configuration — variables d'environnement et fichiers de configuration qui affectent chaque outil.
• Démarrage rapide et Votre premier pipeline - présentations de bout en bout qui entraînent uip or.