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

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.

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.
AnmeldeinformationsspeicherList 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).

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 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>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, --yesevery destructive (delete) verbConfirm the operation. Required — the CLI never prompts interactively for a destructive action.

Flags auf Verbebene (Filter, Eingabe-/Ausgabepfade, Strategien, Prioritäten) werden auf jeder Ressourcenseite dokumentiert.

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-*.
  • 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

  • Ressourcen
  • Zusammenfassung
  • So lesen Sie diesen Abschnitt
  • Allgemeine Flags
  • Runtime-resource conventions
  • Globale Optionen und Exitcodes
  • 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