- Ü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 machines verwaltet Maschinenvorlagen – Roboterhostdefinitionen, die beschreiben, wo Roboter ausgeführt werden und wie viele Lizenzslots jedes Typs zugewiesen sind. Maschinen sind Mandanten-Scope, können aber bestimmten Ordnern zugewiesen werden.
Zusammenfassung
uip or machines <verb> [options]
uip or machines <verb> [options]
Verben
| Verb | Zweck |
|---|---|
list | Listen Sie Maschinen im Mandanten oder Maschinen auf, die einem bestimmten Ordner zugewiesen sind. |
get | Eine Maschine nach Schlüssel abrufen. |
create | Erstellen Sie eine neue Maschinenvorlage (optional serverlos). |
edit | Bearbeiten Sie den Namen, die Beschreibung oder die Slot-Zuweisung einer Maschine. |
delete | Löschen Sie eine oder mehrere Maschinen. |
assign | Weisen Sie einem Ordner Maschinen zu. |
unassign | Maschinen aus einem Ordner entfernen. |
UIP oder Maschinenliste
Maschinen auflisten. Ohne --folder-key oder --folder-path wird jede Maschine im Mandanten zurückgegeben. Mit einem der beiden Flags werden nur Maschinen zurückgegeben, die diesem Ordner zugewiesen sind.
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
| – | --folder-key | GUID | – | Scope auf einen Ordner nach Schlüssel. |
| – | --folder-path | Pfad | – | Scope auf einen Ordner nach Pfad. |
-n | --name | text | – | Enthält Übereinstimmung für Maschinennamen. |
| – | --scope | ENUM | – | Default, Shared, PersonalWorkspace, Cloud, Serverless, AutomationCloudRobot, ElasticRobot. |
-l | --limit | Nummer | 50 | Seitengröße. |
| – | --offset | Nummer | 0 | Anzahl der Überspringungen. |
| – | --order-by | Feld | Id desc | OData-Sortierung. |
| – | --all-fields | Markieren | aus | Gibt die vollständige API-Nutzlast zurück. |
Beispiele
uip or machines list --limit 10
uip or machines list --folder-path "Shared"
uip or machines list --scope Serverless \
--output-filter 'Data[].{name:Name, slots:UnattendedSlots}'
uip or machines list --limit 10
uip or machines list --folder-path "Shared"
uip or machines list --scope Serverless \
--output-filter 'Data[].{name:Name, slots:UnattendedSlots}'
Datenform (--output json)
{
"Code": "MachineList",
"Data": [
{
"Name": "prod-worker-01",
"ID": 101,
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Type": "Standard",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 3,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
}
],
"Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}
{
"Code": "MachineList",
"Data": [
{
"Name": "prod-worker-01",
"ID": 101,
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Type": "Standard",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 3,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
}
],
"Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}
UIP oder Maschinen abrufen
Rufen Sie eine Maschine nach GUID-Schlüssel ab. Kein Ordnerkontext erforderlich – Maschinen sind mandantenbezogenen Maschinen.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<machine-key> | ja | Maschinenschlüssel (GUID). Finden Sie es mit machines list. |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
| – | --all-fields | Markieren | aus | Gibt die vollständige API-Nutzlast zurück. |
Beispiele
uip or machines get a1b2c3d4-0000-0000-0000-000000000001
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 --all-fields
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 \
--output-filter 'Data.UnattendedSlots'
uip or machines get a1b2c3d4-0000-0000-0000-000000000001
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 --all-fields
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 \
--output-filter 'Data.UnattendedSlots'
Datenform (--output json)
{
"Code": "MachineGet",
"Data": {
"Name": "prod-worker-01",
"ID": 101,
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Type": "Standard",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 3,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
}
}
{
"Code": "MachineGet",
"Data": {
"Name": "prod-worker-01",
"ID": 101,
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Type": "Standard",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 3,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
}
}
UIP oder Maschinen erstellen
Erstellen Sie eine neue Maschinenvorlage. --name ist erforderlich; Mit --serverless wird die Maschine als in der Cloud gehostete (portierbare) Vorlage erstellt.
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-n | --name | text | erforderlich | Maschinenname (muss innerhalb des Mandanten eindeutig sein). |
-d | --description | text | – | Maschinenbeschreibung. |
| – | --serverless | Markieren | aus | Erstellen Sie eine serverlose (in der Cloud gehostete) Maschine. |
| – | --unattended-slots | Nummer | – | Unattended Robot-Slots. |
| – | --headless-slots | Nummer | – | Headless-Roboter-Slots. |
| – | --non-production-slots | Nummer | – | Non-Production-Roboter-Slots. |
| – | --testing-slots | Nummer | – | Roboter-Slots für Testautomatisierung. |
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
Beispiele
uip or machines create --name "staging-worker" --unattended-slots 2
uip or machines create --name "serverless-pool" --serverless \
--unattended-slots 10
uip or machines create --name "qa-host" --unattended-slots 1 --testing-slots 2 \
--output-filter 'Data.Key'
uip or machines create --name "staging-worker" --unattended-slots 2
uip or machines create --name "serverless-pool" --serverless \
--unattended-slots 10
uip or machines create --name "qa-host" --unattended-slots 1 --testing-slots 2 \
--output-filter 'Data.Key'
Datenform (--output json)
{
"Code": "MachineCreated",
"Data": {
"Name": "staging-worker",
"ID": 103,
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Type": "Template",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 2,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": ""
}
}
{
"Code": "MachineCreated",
"Data": {
"Name": "staging-worker",
"ID": 103,
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Type": "Template",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 2,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": ""
}
}
UIP oder Maschinen bearbeiten
Bearbeiten Sie den Namen, die Beschreibung oder die Slot-Zuweisung einer Maschine. Nur bereitgestellte Optionen werden aktualisiert; ausgelassene Felder bleiben unverändert.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<machine-key> | ja | Maschinenschlüssel (GUID). |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-n | --name | text | – | Neuer Maschinenname. |
-d | --description | text | – | Neue Maschinenbeschreibung. |
| – | --unattended-slots | Nummer | – | Unattended Robot-Slots. |
| – | --headless-slots | Nummer | – | Headless-Roboter-Slots. |
| – | --non-production-slots | Nummer | – | Non-Production-Roboter-Slots. |
| – | --testing-slots | Nummer | – | Roboter-Slots für Testautomatisierung. |
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
Beispiele
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 --unattended-slots 5
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
--name "staging-worker-eu" --description "EU staging host"
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
--unattended-slots 5 --output-filter 'Data.Status'
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 --unattended-slots 5
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
--name "staging-worker-eu" --description "EU staging host"
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
--unattended-slots 5 --output-filter 'Data.Status'
Datenform (--output json)
{
"Code": "MachineUpdate",
"Data": {
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Name": "staging-worker",
"Status": "Updated successfully"
}
}
{
"Code": "MachineUpdate",
"Data": {
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Name": "staging-worker",
"Status": "Updated successfully"
}
}
UIP oder Maschinen löschen
Löschen Sie eine oder mehrere Maschinen. Ein einzelner Schlüssel verwendet DeleteById; Mehrere Schlüssel verwenden die Massen-API. Vor dem Löschen müssen Maschinen alle Ordnern zugewiesen sein.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<machine-keys...> | ja | Ein oder mehrere Maschinenschlüssel (GUIDs). |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
Beispiele
uip or machines delete a1b2c3d4-0000-0000-0000-000000000010
uip or machines delete key-1 key-2 key-3
uip or machines delete key-1 key-2 --output-filter 'Data.Count'
uip or machines delete a1b2c3d4-0000-0000-0000-000000000010
uip or machines delete key-1 key-2 key-3
uip or machines delete key-1 key-2 --output-filter 'Data.Count'
Datenform (--output json)
{
"Code": "MachineDelete",
"Data": {
"Deleted": [
{ "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Name": "staging-worker" }
],
"Count": 1,
"Status": "Deleted successfully"
}
}
{
"Code": "MachineDelete",
"Data": {
"Deleted": [
{ "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Name": "staging-worker" }
],
"Count": 1,
"Status": "Deleted successfully"
}
}
uip oder Maschinen zuweisen
Weisen Sie einem Ordner eine oder mehrere Maschinen zu. Erfordert --folder-path oder --folder-key.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<machine-keys...> | ja | Ein oder mehrere Maschinenschlüssel (GUIDs). |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
| – | --folder-path | Pfad | – | Zielordner nach Pfad. |
| – | --folder-key | GUID | – | Zielordner nach Schlüssel. |
Beispiele
uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared"
uip or machines assign key-1 key-2 --folder-key b1c2d3e4-0000-0000-0000-000000000001
uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared" --output-filter 'Data.Status'
uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared"
uip or machines assign key-1 key-2 --folder-key b1c2d3e4-0000-0000-0000-000000000001
uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared" --output-filter 'Data.Status'
Datenform (--output json)
{
"Code": "MachineAssign",
"Data": {
"MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
"FolderPath": "Shared",
"Count": 1,
"Status": "Assigned successfully"
}
}
{
"Code": "MachineAssign",
"Data": {
"MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
"FolderPath": "Shared",
"Count": 1,
"Status": "Assigned successfully"
}
}
UIP oder Zuweisung von Maschinen aufheben
Maschinen aus einem Ordner entfernen. Die Maschinen werden nicht gelöscht – nur ihre Ordnerzuweisung wird entfernt. Erfordert --folder-path oder --folder-key.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<machine-keys...> | ja | Ein oder mehrere Maschinenschlüssel (GUIDs). |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-t | --tenant | name | Sitzungsstandard | Überschreiben Sie den Mandanten. |
| – | --folder-path | Pfad | – | Ordner, dessen Zuweisung aufgehoben werden soll. |
| – | --folder-key | GUID | – | Ordner, dessen Zuweisung aufgehoben werden soll. |
Beispiele
uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared"
uip or machines unassign key-1 key-2 --folder-path "Production"
uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared" --output-filter 'Data.Count'
uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared"
uip or machines unassign key-1 key-2 --folder-path "Production"
uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared" --output-filter 'Data.Count'
Datenform (--output json)
{
"Code": "MachineUnassign",
"Data": {
"MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
"FolderPath": "Shared",
"Count": 1,
"Status": "Unassigned successfully"
}
}
{
"Code": "MachineUnassign",
"Data": {
"MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
"FolderPath": "Shared",
"Count": 1,
"Status": "Unassigned successfully"
}
}
Exitcodes
Siehe Exitcodes. Keine Verb-spezifischen Überschreibungen.
Zugehörige Befehle
uip or folders– insbesonderefolders runtimes, um die Maschinenzuweisung auf Ordnerseite zu überprüfen.uip or licenses–licenses toggleaktiviert/deaktiviert die Lizenzierung auf einer bestimmten Maschine.uip or jobs–jobs start --machine-keyszielt auf bestimmte Maschinen ab.
Siehe auch
- Zusammenfassung
- Verben
- UIP oder Maschinenliste
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Maschinen abrufen
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Maschinen erstellen
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Maschinen bearbeiten
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Maschinen löschen
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- uip oder Maschinen zuweisen
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Zuweisung von Maschinen aufheben
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- Exitcodes
- Zugehörige Befehle
- Siehe auch