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 Lizenzen

uip or licenses überprüft und verwaltet die Orchestrator-Lizenzzuweisung. Listen Sie Runtime- und Named-User-Lizenzzuweisungen auf, schalten Sie die Maschinenlizenzierung ein oder aus und zeigen Sie die Gesamtzusammenfassung der Mandantenlizenzen an (zulässig vs. verwendet pro Robotertyp).

Zusammenfassung

uip or licenses <verb> [options]
uip or licenses <verb> [options]

Verben

VerbZweck
listListen Sie Lizenzzuweisungen für einen bestimmten Robotertyp auf (Runtime oder Named User).
toggleAktivieren oder Deaktivieren der Maschinenlizenzierung für einen bestimmten Runtime Robotertyp.
infoZeigen Sie die Zusammenfassung der Mandantenlizenz an (Abonnementplan, zulässig/verwendet, Funktionen).

Referenz des Robotertyps

Das Flag --type akzeptiert diese Robotertypen. Das Befehlsverhalten teilt sich in zwei Bereiche auf:

  • Runtime-Typen – Zuweisung auf Maschinenebene: Unattended, NonProduction, Headless, TestAutomation.
  • Named-User-Typen – Zuweisung auf Benutzerebene: Attended, Development, Studio, StudioX, RpaDeveloper, CitizenDeveloper.

licenses list akzeptiert beide Buckets; licenses toggle akzeptiert nur Runtime-Typen.

UIP oder Lizenzenliste

Listen Sie Lizenzzuweisungen für einen bestimmten Robotertyp auf.

  • Bei den Runtime-Typen ist jede Zeile eine Maschine mit einem verbundenen Roboter; MachineName, MachineType, Runtimes, IsOnline, IsLicensed und Enabled werden zurückgegeben.
  • Bei Named-User-Typen ist jede Zeile ein Benutzer; UserName, LastLoginDate, MachinesCount, IsLicensed und MachineNames werden zurückgegeben.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
--typeENUMerforderlichRobotertyp (siehe Liste oben).
--licensedMarkierenausNur lizenzierte Einträge. Sich gegenseitig mit --unlicensed ausschließen.
--unlicensedMarkierenausNur nicht lizenzierte Einträge. Sich gegenseitig mit --licensed ausschließen.
-l--limitNummer50Seitengröße.
--offsetNummer0Anzahl der Überspringungen.
--order-byFeldOData-Sortierung (z. B. MachineName desc).

Beispiele

uip or licenses list --type Unattended --limit 50
uip or licenses list --type Attended --unlicensed
uip or licenses list --type Unattended \
    --output-filter 'Data[?IsOnline].MachineName'
uip or licenses list --type Unattended --limit 50
uip or licenses list --type Attended --unlicensed
uip or licenses list --type Unattended \
    --output-filter 'Data[?IsOnline].MachineName'

Datenform (--output json)

Runtime-Typ:

{
  "Code": "LicenseList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "MachineName": "prod-worker-01",
      "MachineType": "Standard",
      "Runtimes": 3,
      "IsOnline": true,
      "IsLicensed": true,
      "Enabled": true
    }
  ]
}
{
  "Code": "LicenseList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "MachineName": "prod-worker-01",
      "MachineType": "Standard",
      "Runtimes": 3,
      "IsOnline": true,
      "IsLicensed": true,
      "Enabled": true
    }
  ]
}

Named-User-Typ:

{
  "Code": "LicenseList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "dev@example.com",
      "LastLoginDate": "2025-04-15T10:30:00Z",
      "MachinesCount": 2,
      "IsLicensed": true,
      "MachineNames": ["studio-01", "studio-02"]
    }
  ]
}
{
  "Code": "LicenseList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "dev@example.com",
      "LastLoginDate": "2025-04-15T10:30:00Z",
      "MachinesCount": 2,
      "IsLicensed": true,
      "MachineNames": ["studio-01", "studio-02"]
    }
  ]
}

UIP oder Lizenzen umschalten

Aktivieren oder Deaktivieren der Maschinenlizenzierung für einen bestimmten Runtime Robotertyp. Named User-Typen werden abgelehnt. Akzeptiert einen Maschinenschlüssel (GUID), der intern in einen Maschinennamen aufgelöst wird, bevor die API aufgerufen wird.

Es muss genau eine von --enable oder --disable angegeben werden.

Argumente

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

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
--typeENUMerforderlichNur Runtime-Robotertyp: Unattended, NonProduction, Headless, TestAutomation.
--enableMarkierenLizenzierung aktivieren.
--disableMarkierenLizenzierung deaktivieren.

Beispiele

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type Unattended --enable

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type NonProduction --disable

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type Unattended --enable --output-filter 'Data.Status'
uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type Unattended --enable

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type NonProduction --disable

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type Unattended --enable --output-filter 'Data.Status'

Datenform (--output json)

{
  "Code": "LicenseToggle",
  "Data": {
    "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "MachineName": "prod-worker-01",
    "RobotType": "Unattended",
    "Enabled": true,
    "Status": "Licensing enabled"
  }
}
{
  "Code": "LicenseToggle",
  "Data": {
    "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "MachineName": "prod-worker-01",
    "RobotType": "Unattended",
    "Enabled": true,
    "Status": "Licensing enabled"
  }
}

UIP oder Lizenzinformationen

Zeigen Sie die Zusammenfassung der Mandantenlizenz an: Abonnementplan, zulässige und verwendete Anzahlen pro Robotertyp, Ablaufstatus und lizenzierte Funktionen. Damit können Sie die Gesamtkapazität vor der Zuweisung überprüfen.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.

Beispiele

uip or licenses info
uip or licenses info --output-filter 'Data.Used'
uip or licenses info --output table
uip or licenses info
uip or licenses info --output-filter 'Data.Used'
uip or licenses info --output table

Datenform (--output json)

{
  "Code": "LicenseInfo",
  "Data": {
    "IsExpired": false,
    "SubscriptionPlan": "Enterprise",
    "Allowed": { "Unattended": 10, "Attended": 20 },
    "Used": { "Unattended": 4, "Attended": 7 },
    "LicensedFeatures": ["AISuite", "TestManager"]
  }
}
{
  "Code": "LicenseInfo",
  "Data": {
    "IsExpired": false,
    "SubscriptionPlan": "Enterprise",
    "Allowed": { "Unattended": 10, "Attended": 20 },
    "Used": { "Unattended": 4, "Attended": 7 },
    "LicensedFeatures": ["AISuite", "TestManager"]
  }
}

Exitcodes

Siehe Exitcodes. Keine Verb-spezifischen Überschreibungen.

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