- Überblick
- Erste Schritte
- Konzepte
- Verwenden der UiPath CLI
- UiPath für Codierungs-Agents
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Dokumentation
- Add-Test-Data-Entität
- Add-Test-Data-Queue
- Add-Test-Data-Variation
- Analysieren
- Erstellen
- Ein Projekt erstellen
- Diff
- Suchaktivitäten
- Get-Analyse-Regeln
- get-standard-aktivität-xaml
- Fehler abrufen
- Manuelle-Testfälle erhalten
- Manuelle-Testschritte erhalten
- Get-Versionen
- Beispiel für einen Workflow abrufen
- Anwendung anzeigen
- Anzeigeelement
- Inspektionspaket
- install-data-fabric-entities
- Pakete installieren oder aktualisieren
- list-data-fabric-entities
- Beispiele für Listenworkflows
- Packen
- restore
- Ausführungsdatei installieren
- Suchvorlagen
- Studio starten
- Ausführung anhalten
- UIA
- UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
UiPath-CLI-Benutzerhandbuch
uip or folders verwaltet Orchestrator-Ordner – die hierarchischen Container, die Prozesse, Aufträge, Assets, Warteschlangen und Benutzerberechtigungen umfassen. Verben decken das Auflisten, Erstellen, Verschieben, Bearbeiten und Löschen von Ordnern sowie einen runtimes -Befehl ab, der die Maschinen-Laufzeit-Zuweisung innerhalb eines Ordners meldet.
Zusammenfassung
uip or folders <verb> [options]
uip or folders <verb> [options]
Verben
| Verb | Zweck |
|---|---|
list | Listen Sie Ordner auf. Standard: Ordner, auf die der aktuelle Benutzer zugreifen kann; mit --all, jedem Ordner im Mandanten. |
create | Erstellen Sie einen Ordner, der optional unter einem übergeordneten Ordner verschachtelt ist. |
get | Rufen Sie einen Ordner nach Schlüssel oder Pfad ab. |
delete | Löschen Sie einen Ordner nach Schlüssel oder Pfad. |
move | Übergeordnete Elemente eines Ordners oder Verschieben in das Stammverzeichnis. |
edit | Aktualisieren Sie den Anzeigenamen und/oder die Beschreibung. |
runtimes | Zeigen Sie die Runtime-Zuweisung (insgesamt/verbunden/verfügbar) pro Runtime-Typ für einen Ordner an. |
UIP oder Ordnerliste
Listen Sie Ordner auf. Die Standardansicht verwendet GetAllForCurrentUser – Ordner, auf die der Aufrufer Zugriff hat. Mit --all wechselt das Verb zum vollständigen Folders -Endpunkt (Standard- und Lösungsordner im Mandanten); Mit --type personal wird zum Endpunkt PersonalWorkspaces gewechselt. Das Filtern und Sortieren von Flags (--name, --path, --type, --top-level, --order-by) erfordert --all.
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
-a | --all | Markieren | aus | Alle Ordner im Mandanten auflisten; erforderlich, um den Filter und die Sortier-Flags unten zu aktivieren. |
-n | --name | text | – | Enthält Übereinstimmung für Anzeigenamen. Erfordert --all. |
| – | --path | Pfadpräfix | – | Filtern Sie nach dem Präfix des Ordnerpfads (z. B. Shared entspricht Shared und allem, was darunter liegt). Erfordert --all. |
| – | --type | ENUM | – | standard, solution oder personal. Erfordert --all. personal wechselt zum Endpunkt der persönlichen Arbeitsbereiche. |
| – | --top-level | Markieren | aus | Nur Stammordner (kein übergeordnetes Ordner). Erfordert --all. Nicht mit --type personal unterstützt. |
-l | --limit | Nummer | 50 | Seitengröße. |
| – | --offset | Nummer | 0 | Anzahl der Überspringungen. |
| – | --order-by | Feld | – | OData-Sortierung (z. B. Name asc). Erfordert --all. |
| – | --login-validity | Minuten | 10 | Mindestens Minuten vor dem Tokenablauf, der eine Aktualisierung vor der Anforderung auslöst. |
Beispiele
# Folders the authenticated user can access
uip or folders list
# All tenant folders, filtered and sorted
uip or folders list --all --type standard --name "Prod" --order-by "Name asc"
# Personal workspaces only
uip or folders list --all --type personal
# Folders the authenticated user can access
uip or folders list
# All tenant folders, filtered and sorted
uip or folders list --all --type standard --name "Prod" --order-by "Name asc"
# Personal workspaces only
uip or folders list --all --type personal
Datenform (--output json)
{
"Code": "FolderList",
"Data": [
{
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Name": "Shared",
"Path": "Shared",
"Description": "",
"Type": "Standard",
"ParentKey": ""
}
]
}
{
"Code": "FolderList",
"Data": [
{
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Name": "Shared",
"Path": "Shared",
"Description": "",
"Type": "Standard",
"ParentKey": ""
}
]
}
Mit --all enthalten die Elemente auch FeedType und PermissionModel. Mit --type personal ist die Nutzlast { Key, Name, OwnerName, OwnerKey, LastLogin }.
UIP oder Ordner erstellen
Erstellen Sie einen Ordner, der optional unter einem übergeordneten Ordner verschachtelt ist. --parent akzeptiert entweder eine Ordner-GUID oder einen Pfad (Shared, Production/EU).
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<name> | ja | Anzeigename des Ordners. |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
-d | --description | text | – | Ordnerbeschreibung. |
-p | --parent | Schlüssel oder Pfad | – | Übergeordneter Ordner nach GUID oder Pfad. Für einen Stammordner weglassen. |
| – | --feed-type | ENUM | Processes | Processes, Libraries, FolderHierarchy. |
| – | --permission-model | ENUM | FineGrained | FineGrained oder InheritFromTenant. |
| – | --provision-type | ENUM | Automatic | Automatic oder Manual. |
Beispiele
uip or folders create "Staging"
uip or folders create "EU" --parent "Production" \
--description "European workloads"
uip or folders create "Libraries" --feed-type Libraries \
--permission-model InheritFromTenant
uip or folders create "Staging"
uip or folders create "EU" --parent "Production" \
--description "European workloads"
uip or folders create "Libraries" --feed-type Libraries \
--permission-model InheritFromTenant
Datenform (--output json)
{
"Code": "FolderCreated",
"Data": {
"Name": "Staging",
"ID": 103,
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Path": "Shared/Staging",
"Status": "Created successfully"
}
}
{
"Code": "FolderCreated",
"Data": {
"Name": "Staging",
"ID": 103,
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Path": "Shared/Staging",
"Status": "Created successfully"
}
}
UIP oder Ordner abrufen
Rufen Sie einen Ordner nach Schlüssel oder Pfad ab. Das Positionsargument erkennt automatisch: Eine UUID-Eingabe wird als Schlüssel behandelt, alles andere als Pfad.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<folder-key-or-path> | ja | Ordner-GUID oder Pfad. |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
Beispiele
uip or folders get "Shared"
uip or folders get a1b2c3d4-0000-0000-0000-000000000001
uip or folders get "Shared/Staging" --output-filter 'Data.Key'
uip or folders get "Shared"
uip or folders get a1b2c3d4-0000-0000-0000-000000000001
uip or folders get "Shared/Staging" --output-filter 'Data.Key'
Datenform (--output json)
{
"Code": "FolderGet",
"Data": {
"Name": "Shared",
"ID": 101,
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Description": "No description",
"Path": "Shared",
"ParentID": "Root",
"FolderType": "Standard",
"IsPersonal": "No",
"ProvisionType": "Automatic",
"PermissionModel": "FineGrained",
"FeedType": "Processes"
}
}
{
"Code": "FolderGet",
"Data": {
"Name": "Shared",
"ID": 101,
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Description": "No description",
"Path": "Shared",
"ParentID": "Root",
"FolderType": "Standard",
"IsPersonal": "No",
"ProvisionType": "Automatic",
"PermissionModel": "FineGrained",
"FeedType": "Processes"
}
}
UIP oder Ordner löschen
Löschen Sie einen Ordner nach Schlüssel oder Pfad. Schlägt fehl, wenn der Ordner Entitäten oder Benutzerzuordnungen enthält – zuerst Inhalte entfernen oder verschieben.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<folder-key-or-path> | ja | Ordner-GUID oder Pfad. |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
Beispiele
uip or folders delete "Shared/Staging"
uip or folders delete a1b2c3d4-0000-0000-0000-000000000010
uip or folders delete "Shared/Staging" --output-filter 'Data.Status'
uip or folders delete "Shared/Staging"
uip or folders delete a1b2c3d4-0000-0000-0000-000000000010
uip or folders delete "Shared/Staging" --output-filter 'Data.Status'
Datenform (--output json)
{
"Code": "FolderDelete",
"Data": {
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Path": "Shared/Staging",
"Status": "Deleted successfully"
}
}
{
"Code": "FolderDelete",
"Data": {
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Path": "Shared/Staging",
"Status": "Deleted successfully"
}
}
UIP oder Ordner verschieben
Verschieben Sie einen Ordner in einen neuen übergeordneten Ordner oder hoch zum Stammordner. Sie müssen genau eines von --parent und --root angeben.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<folder-key-or-path> | ja | Ordner-GUID oder zu verschiebender Pfad. |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
-p | --parent | Schlüssel oder Pfad | – | Neuer übergeordneter Ordner. Erforderlich, es sei denn, --root ist festgelegt. |
| – | --root | Markieren | aus | Zur obersten Ebene wechseln (kein übergeordnetes Element). |
Beispiele
uip or folders move "Shared/Staging" --parent "Production"
uip or folders move a1b2c3d4-0000-0000-0000-000000000010 --root
uip or folders move "Shared/Staging" --parent "Production" \
--output-filter 'Data.TargetParentPath'
uip or folders move "Shared/Staging" --parent "Production"
uip or folders move a1b2c3d4-0000-0000-0000-000000000010 --root
uip or folders move "Shared/Staging" --parent "Production" \
--output-filter 'Data.TargetParentPath'
Datenform (--output json)
{
"Code": "FolderMove",
"Data": {
"FolderKey": "a1b2c3d4-0000-0000-0000-000000000010",
"FolderPath": "Shared/Staging",
"TargetParentPath": "Production",
"Status": "Moved successfully"
}
}
{
"Code": "FolderMove",
"Data": {
"FolderKey": "a1b2c3d4-0000-0000-0000-000000000010",
"FolderPath": "Shared/Staging",
"TargetParentPath": "Production",
"Status": "Moved successfully"
}
}
--root legt TargetParentPath auf (root) fest.
UIP oder Ordner bearbeiten
Aktualisieren Sie den Anzeigenamen und/oder die Beschreibung. Von den Optionen --name und --description muss mindestens eine bereitgestellt werden.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<folder-key-or-path> | ja | Ordner-GUID oder Pfad. |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
-n | --name | text | – | Neuer Anzeigename. |
-d | --description | text | – | Neue Beschreibung. |
Beispiele
uip or folders edit a1b2c3d4-0000-0000-0000-000000000010 --name "Staging (EU)"
uip or folders edit "Shared/Staging" --description "Pre-prod runs"
uip or folders edit "Shared/Staging" --name "Staging (EU)" --output-filter 'Data.Status'
uip or folders edit a1b2c3d4-0000-0000-0000-000000000010 --name "Staging (EU)"
uip or folders edit "Shared/Staging" --description "Pre-prod runs"
uip or folders edit "Shared/Staging" --name "Staging (EU)" --output-filter 'Data.Status'
Datenform (--output json)
{
"Code": "FolderUpdate",
"Data": { "Status": "Updated successfully" }
}
{
"Code": "FolderUpdate",
"Data": { "Status": "Updated successfully" }
}
UIP- oder Ordner-Runtimes
Listen Sie die Runtime-Zuweisung für einen Ordner auf – für jeden Runtime-Typ, wie viele Slots insgesamt, verbunden und verfügbar sind. Nützlich zur Überprüfung der Kapazität vor dem Starten von Aufträgen.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<folder-key-or-path> | ja | Ordner-GUID oder Pfad. |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
Beispiele
uip or folders runtimes "Shared"
uip or folders runtimes a1b2c3d4-0000-0000-0000-000000000001
uip or folders runtimes "Shared" \
--output-filter "Data[?Type=='Unattended'].Available | [0]"
uip or folders runtimes "Shared"
uip or folders runtimes a1b2c3d4-0000-0000-0000-000000000001
uip or folders runtimes "Shared" \
--output-filter "Data[?Type=='Unattended'].Available | [0]"
Datenform (--output json)
{
"Code": "FolderRuntimes",
"Data": [
{ "Type": "Unattended", "Total": 4, "Connected": 3, "Available": 1 },
{ "Type": "NonProduction", "Total": 2, "Connected": 1, "Available": 1 }
]
}
{
"Code": "FolderRuntimes",
"Data": [
{ "Type": "Unattended", "Total": 4, "Connected": 3, "Available": 1 },
{ "Type": "NonProduction", "Total": 2, "Connected": 1, "Available": 1 }
]
}
Exitcodes
Siehe Exitcodes. Keine Verb-spezifischen Überschreibungen.
Zugehörige Befehle
uip or processes– Prozessbindungen mit Ordner-Scope.uip or machines– insbesonderemachines assign/unassignfür die Ordnermitgliedschaft.uip or users–users list-in-folder,users assign,users unassign.uip or roles– Rollenzuweisungen auf Ordnerebene.
Siehe auch
- Globale Optionen.
- Sitzungen – Auflösung des Kontexts für Mandant und Ordner.
- Zusammenfassung
- Verben
- UIP oder Ordnerliste
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Ordner erstellen
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Ordner abrufen
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Ordner löschen
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Ordner verschieben
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Ordner bearbeiten
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP- oder Ordner-Runtimes
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- Exitcodes
- Zugehörige Befehle
- Siehe auch