UiPath Documentation
uipath-cli
latest
false
UiPath-CLI-Benutzerhandbuch
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

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 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. Das Installationsmodell finden Sie unter Tools (Plugins) und unter UIP-Tools finden Sie 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.

RessourceZweck
JobsStarten, Stoppen, Neustarten, Fortsetzen und Überprüfen von Prozessausführungen; Abrufen von Protokollen, Ablaufverfolgungen, Reparaturdaten und Statusverlauf.
OrdnerErstellen, Auflisten, Verschieben, Bearbeiten und Löschen von Ordnern; Überprüfen Sie die Runtime-Zuweisung.
ProzessePakete als ausführbare Prozesse an Ordner binden; Aktualisieren, Rollback und Bearbeiten.
PaketeDas Hochladen, Herunterladen, Auflisten und Überprüfen von .nupkg -Automatisierungspaketen und deren Einstiegspunkte.
MaschinenVerwalten von Maschinenvorlagen und Slot-Zuweisungen; Maschinen zu Ordnern zuweisen.
BenutzerErstellen, Bearbeiten, Löschen und Zuweisen von Orchestrator-Benutzern; Verwalten Sie Rollenzuweisungen auf Mandantenebene.
RollenVerwalten Sie Rollen, Berechtigungen und Rollenbenutzermitgliedschaften im Mandanten- und Ordnerbereich.
LizenzenRuntime- und Named-User-Lizenzzuweisungen auflisten; Maschinenlizenzierung umschalten; Zusammenfassung der Mandantenlizenzen anzeigen.
FeedsListen Sie Paketfeeds auf, die für den aktuellen Benutzer verfügbar sind.
Anhänge (Attachments)Auftragsanhänge auflisten und herunterladen.
AssetsBenannte Konfigurationswerte (Text, Bool, Integer, Anmeldeinformationen, Geheimnis), die von Automatisierungen zur Runtime verwendet werden. Ordnerbezogenen.
BucketsSpeichercontainer für Dateien, die von Automatisierungen verwendet werden. Ordnerbezogenen.
Bucket-DateienEinzelne Dateien in einem Bucket. Auflisten, Hochladen, Herunterladen, Löschen und Abrufen von vorsignierten URLs.
BibliothekenWiederverwendbare .nupkg -Pakete (gemeinsame Aktivitäten und Logik). Mandantenbezogenen.
WarteschlangenContainer für transaktionale Arbeitselemente. Ordnerbezogenen.
WarteschlangenelementeEinzelne Transaktionen innerhalb von Warteschlangen mit vollständigen State-Machine-Steuerelementen. Ordnerbezogenen.
AuslöserZeit, Warteschlange und API-Trigger, die Aufträge starten. Zeit-/Warteschlangentrigger haben einen Ordner-Scope; API-Trigger haben einen Mandanten-Scope.
WebhooksHTTP-Rückrufe, die bei Plattformereignissen ausgelöst werden (Auftragsabschluss, Fehler bei Warteschlangenelementen, …). Mandantenbezogenen.
AnmeldeinformationsspeicherListen 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:

  1. Synopse – die Befehlsform uip or <resource> <verb> .
  2. Verben – eine einzeilige Tabelle mit jedem Verb, das die Ressource verfügbar macht.
  3. Ein H2 pro Verb – Beschreibung, Positionargumente (falls vorhanden), Flag-Tabelle, drei Beispiele (einfaches, gängigstes Fall, Skripting-freundlich mit --output-filter) und die Data -Form, die unter --output json zurückgegeben wird.
  4. Austrittscodes – ein Verweis auf den gemeinsam genutzten Austrittscode -Vertrag mit allen verbspezifischen Überschreibungen, die inline aufgerufen werden.
  5. 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:

MarkierenWird von verwendetZweck
--folder-path <path>die meisten Verben, die sich auf einen Ordner beziehenZielordner nach vollqualifiziertem Pfad (z. B. Shared, Production/EU).
--folder-key <key>die meisten Verben, die sich auf einen Ordner beziehenZielordner nach GUID. Gemeinsam mit --folder-path verwendbar; Entweder löst derselbe Ordner auf.
--all-folderslist 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 ListenverbSeitengröße. Die Standardeinstellung ist DEFAULT_PAGE_SIZE der CLI (50 zum Zeitpunkt des Schreibens).
--offset <number>jedes ListenverbAnzahl der Elemente, die vor der Rückgabe übersprungen werden sollen. Die Standardeinstellung ist 0.
--sort-by <field>die meisten ListenverbenOData-Sortierungsausdruck (z. B. Name asc, Id desc). Jedes Verb dokumentiert seinen Standardwert.
--all-fieldsviele list / get VerbenGeben Sie die Roh-API-Antwort anstelle der kuratierten Zusammenfassung zurück. Nützlich, wenn Sie Felder benötigen, die die Standardform auslässt.
-y, --yesjedes destruktive (delete) VerbBestä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) sind ordnerbezogenen. Geben Sie entweder --folder-path <path> (z. B "Shared") oder --folder-key <guid> für list, create und verwandte Aufrufe – oder --all-folders , bei denen dieses Flag unterstützt wird. get, update und delete lösen ordnerübergreifend nach Schlüssel auf, wenn möglich; Die Beschreibung jedes Verbs auf der Ressourcenseite ruft es explizit auf. Bibliotheken, API-Trigger 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 (unter key, identifier oder – für Warteschlangenelemente – uniqueKey für einen einzelnen Versuch und key für die Wiederholungskette). Numerische id -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, --status usw. 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​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben