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

UiPath-CLI-Benutzerhandbuch

UIP oder Maschinen

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

VerbZweck
listListen Sie Maschinen im Mandanten oder Maschinen auf, die einem bestimmten Ordner zugewiesen sind.
getEine Maschine nach Schlüssel abrufen.
createErstellen Sie eine neue Maschinenvorlage (optional serverlos).
editBearbeiten Sie den Namen, die Beschreibung oder die Slot-Zuweisung einer Maschine.
deleteLöschen Sie eine oder mehrere Maschinen.
assignWeisen Sie einem Ordner Maschinen zu.
unassignMaschinen 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

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
--folder-keyGUIDScope auf einen Ordner nach Schlüssel.
--folder-pathPfadScope auf einen Ordner nach Pfad.
-n--nametextEnthält Übereinstimmung für Maschinennamen.
--scopeENUMDefault, Shared, PersonalWorkspace, Cloud, Serverless, AutomationCloudRobot, ElasticRobot.
-l--limitNummer50Seitengröße.
--offsetNummer0Anzahl der Überspringungen.
--order-byFeldId descOData-Sortierung.
--all-fieldsMarkierenausGibt 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

NameErforderlichZweck
<machine-key>jaMaschinenschlüssel (GUID). Finden Sie es mit machines list.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
--all-fieldsMarkierenausGibt 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

ShortLongWertStandardBeschreibung
-n--nametexterforderlichMaschinenname (muss innerhalb des Mandanten eindeutig sein).
-d--descriptiontextMaschinenbeschreibung.
--serverlessMarkierenausErstellen Sie eine serverlose (in der Cloud gehostete) Maschine.
--unattended-slotsNummerUnattended Robot-Slots.
--headless-slotsNummerHeadless-Roboter-Slots.
--non-production-slotsNummerNon-Production-Roboter-Slots.
--testing-slotsNummerRoboter-Slots für Testautomatisierung.
-t--tenantnameSitzungsstandardÜ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

NameErforderlichZweck
<machine-key>jaMaschinenschlüssel (GUID).

Optionen

ShortLongWertStandardBeschreibung
-n--nametextNeuer Maschinenname.
-d--descriptiontextNeue Maschinenbeschreibung.
--unattended-slotsNummerUnattended Robot-Slots.
--headless-slotsNummerHeadless-Roboter-Slots.
--non-production-slotsNummerNon-Production-Roboter-Slots.
--testing-slotsNummerRoboter-Slots für Testautomatisierung.
-t--tenantnameSitzungsstandardÜ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

NameErforderlichZweck
<machine-keys...>jaEin oder mehrere Maschinenschlüssel (GUIDs).

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜ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

NameErforderlichZweck
<machine-keys...>jaEin oder mehrere Maschinenschlüssel (GUIDs).

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
--folder-pathPfadZielordner nach Pfad.
--folder-keyGUIDZielordner 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

NameErforderlichZweck
<machine-keys...>jaEin oder mehrere Maschinenschlüssel (GUIDs).

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
--folder-pathPfadOrdner, dessen Zuweisung aufgehoben werden soll.
--folder-keyGUIDOrdner, 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.

  • uip or folders – insbesondere folders runtimes , um die Maschinenzuweisung auf Ordnerseite zu überprüfen.
  • uip or licenseslicenses toggle aktiviert/deaktiviert die Lizenzierung auf einer bestimmten Maschine.
  • uip or jobsjobs start --machine-keys zielt auf bestimmte Maschinen ab.

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