- Überblick
- Erste Schritte
- Konzepte
- Verwenden der UiPath CLI
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Coded
- UIP-Kontextgrundlage
- UIP-Dokumentation
- UIP-Funktion
- UIP-Leitplanken
- uip llm-configuration
- uip llm-gateway
- UIP Maestro-Erstellung
- UIP Maestro-Registrierung
- UIP-Modellhub
- Aktivitäten finden
- get-standard-xaml
- Analysieren
- Analyseregeln-Liste
- Erstellen
- Bereinigung
- data-fabric-entities installieren
- data-fabric-entities-Liste
- Dateien differenzieren
- Get-Library-Object-Repository
- Get-Object-Repository
- Init
- Instanzenliste
- Packen
- Pakete überprüfen
- Pakete installieren
- Paketversionen
- Veröffentlichen
- Remote
- restore
- Ausführen, Debuggen & Ausführung enthält
- Einstellungen
- Studio-Start
- Vorlagensuche
- Testdaten-Add-Entität
- Testdaten-Warteschlange hinzufügen
- Testdaten-Hinzufügevariante
- TM
- UIA
- Überprüfen
- Workflow-Beispiele abrufen
- Workflow-Beispiele
- UIP-Aufgaben
- Anhang
- benutzerdefiniertes Feld
- Defects
- Ausführungen
- Exportaufträge
- Migration
- Objektbeschriftung
- Packen
- perf-szenario
- Perf-Szenario-Lastgruppen
- Ausführungsdaten für perf-szenario
- Perf-Szenario-Bericht
- Projekt
- Projektberechtigungen
- Aufforderungen
- Melden
- Anforderungen
- Ergebnis
- Ausführen
- Zeitpläne
- Testfallprotokoll
- Testfälle
- Testsätze
- Testschrittprotokoll
- Benutzer
- Warten
- UIP-Ablaufverfolgungen
- Feedback zu UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
uip oder
Verwalten Sie Orchestrator-Aufträge, Ordner, Prozesse, Pakete, Maschinen, Benutzer, Rollen, Lizenzen und Runtime-Ressourcen mit dem Tool „uip or“.
uip or ist das Orchestrator-Tool: Es verwaltet Aufträge, Ordner, Prozesse, Pakete, Maschinen, Benutzer, Rollen, Lizenzen, Feeds, Anhänge, die Business-ROI-Konfiguration von Prozessen und Warteschlangen und die Runtime-Ressourcen, von denen Automatisierungen abhängen (Assets, Buckets). Warteschlangen, Trigger, Bibliotheken, Webhooks) auf einem UiPath Orchestrator-Mandanten. Installieren Sie es mit uip tools install or oder rufen Sie uip or … auf und lassen Sie die automatische Installation ausführen. Weitere Informationen finden Sie unter Tools (Plugins) für das Installationsmodell und unter UIP-Tools für den Befehl, der die Toolinstallation verwaltet.
Ressourcen
Jede Ressource hat eine eigene Referenzseite. Das auf jeder Seite festgelegte Verb stimmt mit den von uip or registrierten Befehlen überein – führen Sie uip or --help aus, um die vollständige Oberfläche Ihrer Installation zu bestätigen.
| Ressource | Zweck |
|---|---|
| Jobs | Starten, Stoppen, Neustarten, Fortsetzen und Überprüfen von Prozessausführungen; Protokolle, Heilungsdaten und Statusverlauf abrufen. |
| Ordner | Erstellen, Auflisten, Verschieben, Bearbeiten und Löschen von Ordnern; Überprüfen Sie die Runtime-Zuweisung. |
| Prozesse | Pakete als ausführbare Prozesse an Ordner binden; Aktualisieren, Rollback und Bearbeiten. |
| Prozess-ROI | Abrufen, Erstellen, Aktualisieren und Löschen der Business-ROI-Konfiguration eines Prozesses. |
| Pakete | Das Hochladen, Herunterladen, Auflisten und Überprüfen von .nupkg -Automatisierungspaketen und deren Einstiegspunkte. |
| Maschinen | Verwalten von Maschinenvorlagen und Slot-Zuweisungen; Maschinen zu Ordnern zuweisen. |
| Benutzer | Erstellen, Bearbeiten, Löschen und Zuweisen von Orchestrator-Benutzern; Verwalten Sie Rollenzuweisungen auf Mandantenebene. |
| Rollen | Verwalten Sie Rollen, Berechtigungen und Rollenbenutzermitgliedschaften im Mandanten- und Ordnerbereich. |
| Lizenzen | Runtime- und Named-User-Lizenzzuweisungen auflisten; Maschinenlizenzierung umschalten; Zusammenfassung der Mandantenlizenzen anzeigen. |
| Feeds | Listen Sie Paketfeeds auf, die für den aktuellen Benutzer verfügbar sind. |
| Anhänge (Attachments) | Auftragsanhänge auflisten und herunterladen. |
| Sitzungen | Anzeigen und Verwalten von Live-Roboterverbindungen zu Orchestrator. |
| Kalender | Kalender der ausgeschlossenen Datumsangaben, die von Zeittriggern verwendet werden. |
| Prüfungsprotokolle | Listen Sie das Mandantenprüfungsprotokoll auf. |
| Einstellungen | Lesen und schreiben Sie Orchestrator-Einstellungen auf Mandantenebene mithilfe der gepunkteten Taste. |
| Assets | Benannte Konfigurationswerte (Text, Bool, Integer, Anmeldeinformationen, Geheimnis), die von Automatisierungen zur Runtime verwendet werden. Ordnerbezogenen. |
| Buckets | Speichercontainer für Dateien, die von Automatisierungen verwendet werden. Ordnerbezogenen. |
| Bucket-Dateien | Einzelne Dateien in einem Bucket. Auflisten, Hochladen, Herunterladen, Löschen und Abrufen von vorsignierten URLs. |
| Bibliotheken | Wiederverwendbare .nupkg -Pakete (gemeinsame Aktivitäten und Logik). Mandantenbezogenen. |
| Warteschlangen | Container für transaktionale Arbeitselemente. Ordnerbezogenen. |
| Warteschlangen-ROI | Abrufen, Erstellen, Aktualisieren und Löschen der Business-ROI-Konfiguration einer Warteschlange. |
| Warteschlangenelemente | Einzelne Transaktionen innerhalb von Warteschlangen mit vollständigen State-Machine-Steuerelementen. Ordnerbezogenen. |
| Auslöser | Zeit, Warteschlange und API-Trigger, die Aufträge starten. Ordnerbezogenen. |
| Webhooks | HTTP-Rückrufe, die bei Plattformereignissen ausgelöst werden (Auftragsabschluss, Fehler bei Warteschlangenelementen, …). Mandantenbezogenen. |
| Anmeldeinformationsspeicher | Listen und überprüfen Sie externe Anmeldeinformationsspeicherkonfigurationen, die von Anmeldeinformations-/Geheimnis-Assets und Azure/Amazon-Buckets verwendet werden. |
Die Runtime-Auswertung bereitgestellter Pakete – Einreichen von Ausführungen, Bewerten von Ausgaben und Verwalten von Auswertern/Auswertungssätzen/Zeitplänen für einen Orchestrator-Prozess – ist ein separates, eigenständiges Tool: uip eval (Paket @uipath/eval-tool, kein uip or -Unterbefehl, obwohl jedes Verb für einen Orchestrator-Prozess/Ordner arbeitet).
Zusammenfassung
uip or <resource> <verb> [options]
uip or <resource> <verb> [options]
Immer uip or, nie uip orchestrator. or ist das Befehlspräfix des Tools (siehe Spalte commandPrefix in uip tools list).
So lesen Sie diesen Abschnitt
Jede Ressourcenseite ist gleich strukturiert:
- Synopse – die Befehlsform
uip or <resource> <verb>. - Verben – eine einzeilige Tabelle mit jedem Verb, das die Ressource verfügbar macht.
- Ein H2 pro Verb – Beschreibung, Positionargumente (falls vorhanden), Flag-Tabelle, drei Beispiele (einfaches, gängigstes Fall, Skripting-freundlich mit
--output-filter) und dieData-Form, die unter--output jsonzurückgegeben wird. - Austrittscodes – ein Verweis auf den gemeinsam genutzten Austrittscode -Vertrag mit allen verbspezifischen Überschreibungen, die inline aufgerufen werden.
- Zugehörige Befehle und Siehe auch – Querlinks zu gleichgeordneten Ressourcen und relevanten Konzeptseiten.
Das Standardausgabeformat ist --output json. Datenstrukturen auf jeder Seite spiegeln die JSON-Payload wider – Tabelle, yaml und einfache Renderings werden vom gleichen Data -Objekt abgeleitet.
Allgemeine Flags
Eine kleine Reihe von Flags wird in den meisten Ressourcen wiederholt. Sie verhalten sich überall gleich:
| Markieren | Wird von verwendet | Zweck |
|---|---|---|
--folder-path <path> | die meisten Verben, die sich auf einen Ordner beziehen | Zielordner nach vollqualifiziertem Pfad (z. B. Shared, Production/EU). |
--folder-key <key> | die meisten Verben, die sich auf einen Ordner beziehen | Zielordner nach GUID. Gemeinsam mit --folder-path verwendbar; Entweder löst derselbe Ordner auf. |
--all-folders | list auf einigen Ressourcen mit Ordner-Scope (z. B. assets, buckets) | Listen Sie über jeden Ordner hinweg auf, auf den der Aufrufer zugreifen kann, anstatt sich auf einen zu beschränken. Sofern unterstützt, ist eine von --folder-path, --folder-key oder --all-folders erforderlich. |
-l, --limit <number> | jedes Listenverb | Seitengröße. Die Standardeinstellung ist DEFAULT_PAGE_SIZE der CLI (50 zum Zeitpunkt des Schreibens). |
--offset <number> | jedes Listenverb | Anzahl der Elemente, die vor der Rückgabe übersprungen werden sollen. Die Standardeinstellung ist 0. |
--sort-by <field> | die meisten Listenverben | OData-Sortierungsausdruck (z. B. Name asc, Id desc). Jedes Verb dokumentiert seinen Standardwert. |
--all-fields | viele list / get Verben | Geben Sie die Roh-API-Antwort anstelle der kuratierten Zusammenfassung zurück. Nützlich, wenn Sie Felder benötigen, die die Standardform auslässt. |
-y, --yes | jedes destruktive (delete) Verb | Bestätigen Sie den Vorgang. Erforderlich – die CLI fordert Sie nie interaktiv für eine destruktive Aktion auf. |
Flags auf Verbebene (Filter, Eingabe-/Ausgabepfade, Strategien, Prioritäten) werden auf jeder Ressourcenseite dokumentiert.
Konventionen für Runtime-Ressourcen
Die Runtime-Ressourcenseiten (Assets, Buckets, Bucket-Dateien, Bibliotheken, Warteschlangen, Warteschlangenelemente, Trigger, Webhooks) haben einige zusätzliche Konventionen zusätzlich zu den oben genannten:
- Ordner-Scoping. Assets, Buckets, Warteschlangen, Warteschlangenelemente und Trigger (Zeit, Warteschlange und API) haben einen Ordner-Scope. Geben Sie entweder
--folder-path <path>(z. B"Shared") oder--folder-key <guid>fürlist,createund verwandte Aufrufe – oder--all-folders, bei denen dieses Flag unterstützt wird.get,updateunddeletelösen ordnerübergreifend nach Schlüssel auf, wenn möglich; Die Beschreibung jedes Verbs auf der Ressourcenseite ruft es explizit auf. Bibliotheken und Webhooks haben einen Mandanten-Scope und akzeptieren--folder-*nicht. - Schlüssel. Die meisten Ressourcen werden durch eine GUID identifiziert, die in der
list-Ausgabe zurückgegeben wird (unterkey,identifieroder – für Warteschlangenelemente –uniqueKeyfür einen einzelnen Versuch undkeyfür die Wiederholungskette). Numerischeid-Felder sind intern und sollten nicht an Befehle übergeben werden. - Filtern. Sofern unterstützt, ist
-n, --name <name>eine Enthält-Übereinstimmung für den Ressourcennamen; Einige Ressourcen fügen--enabled,--disabled,--statususw. hinzu.
Globale Optionen und Exitcodes
Alle uip or -Verben berücksichtigen die vier globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem gemeinsamen Vertrag; Jede Verb-spezifische Überschreibung wird auf der entsprechenden Ressourcenseite aufgerufen.
Siehe auch
- Konzepte: Wie die UiPath CLI organisiert ist – wo Tools in das Host- und Toolmodell passen.
- Sitzungen – wie Mandanten- und Ordnerkontext aufgelöst werden.
- Konfiguration – Umgebungsvariablen und Konfigurationsdateien, die sich auf jedes Tool auswirken.
- Schnellstart und Ihre erste Pipeline – End-to-End-Anleitungen, die
uip ortrainieren.