UIP oder Sitzungen

uip or sessions zeigt und verwaltet Orchestrator-Sitzungen – Live-Hostverbindungen zwischen Robotern (Attended und Unattended) und Orchestrator. Verwenden Sie diese Option, um anzuzeigen, welche Hosts verbunden sind, die Nutzung von Runtime-Slots zu überprüfen, den Debugmodus für eine Sitzung umzuschalten, eine Sitzung in die Wartungsphase zu versetzen oder inaktive Sitzungen zu bereinigen.

Zusammenfassung

uip or sessions <verb> [options]

Verben

Verb	Zweck
list-attended-sessions	Listen Sie Attended-Sitzungen (Studio/Assistant) im gesamten Mandanten auf oder in einem Ordner.
list-machines-sessions	Listen Sie Sitzungen für eine bestimmte Maschine nach Maschinenschlüssel auf.
list-usernames	Listen Sie die Benutzernamen der Benutzer mit aktiven Sitzungen auf.
list-unattended-sessions	Listen Sie Runtimes für unbeaufsichtigte Sitzungen auf (Slot-Nutzung zwischen Maschinen).
list-user-executors	Listen Sie Automatisierungs-Executors (Roboternamen) auf, die nach Benutzernamen gruppiert sind.
toggle-debug-mode	Aktivieren oder deaktivieren Sie den Debug-Modus für eine Maschinensitzung.
delete-inactive	Löschen Sie getrennte oder nicht reagierende Sitzungen (alle oder nach ID).
set-maintenance-mode	Versetzen Sie eine Maschinensitzung in den Wartungsmodus.

Alle Verben berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem Standardvertrag.

UIP oder Sitzungslist-attended-Sitzungen

Listen von Attended-Sitzungen – Studio- und Assistant-Verbindungen. Ohne ein Ordner-Flag werden Sitzungen über alle Ordner hinweg zurückgegeben (Globale Ansicht). Mit --folder-key oder --folder-path werden Sitzungen im Scope des Ordners zurückgegeben.

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--folder-key	GUID	–	Ordnerschlüssel für die Auflistung im Ordnerbereich.
–	--folder-path	Pfad	–	Ordnerpfad (z. B. Shared).
–	--state	ENUM	–	Available, Busy, Disconnected, Unknown. Ohne --state werden Disconnected Sitzungen ausgeschlossen.
–	--machine-name	text	–	Enthält Übereinstimmung für Maschinennamen.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--order-by	Feld	Id desc	OData-Sortierungsausdruck (z. B. MachineName asc).

Beispiele

# Attended sessions across the tenant, excluding Disconnected
uip or sessions list-attended-sessions

# Only Busy sessions in a specific folder
uip or sessions list-attended-sessions --folder-path "Shared" --state Busy

# Just machine names and states, script-friendly
uip or sessions list-attended-sessions \
    --output-filter 'Data[].{m:MachineName, s:State}'

Datenform (--output json)

{
  "Code": "SessionList",
  "Data": [
    {
      "Id": 501,
      "HostMachineName": "host-01",
      "MachineId": 101,
      "MachineName": "attended-01",
      "State": "Available",
      "Job": null,
      "ReportingTime": "2025-04-15T10:30:00Z",
      "Info": "",
      "IsUnresponsive": false,
      "LicenseErrorCode": "",
      "OrganizationUnitId": 42,
      "FolderName": "Shared",
      "RobotSessionType": "Attended",
      "Version": "23.10.0",
      "Source": "Studio",
      "DebugModeExpirationDate": "",
      "UpdateInfo": null,
      "InstallationId": "",
      "Platform": "Windows",
      "EndpointDetection": ""
    }
  ]
}

UIP oder Sitzungsliste-Maschinen-Sitzungen

Listen Sie Sitzungen für eine Maschine nach Maschinenschlüssel auf. Der Maschinenschlüssel ist die von uip or machines list zurückgegebene GUID. Optional: Scope auf einen Ordner.

Argumente

Name	Erforderlich	Zweck
<machine-key>	ja	Maschinenschlüssel (GUID). Finden Sie es mit uip or machines list.

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--folder-key	GUID	–	Ordnerschlüssel für die Auflistung im Ordnerbereich.
–	--folder-path	Pfad	–	Ordnerpfad für die ordnerbezogenen Auflistungen.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--order-by	Feld	Id desc	OData-Sortierungsausdruck.

Beispiele

uip or sessions list-machines-sessions a1b2c3d4-0000-0000-0000-000000000001
uip or sessions list-machines-sessions a1b2c3d4-0000-0000-0000-000000000001 \
    --folder-path "Production"

Datenform (--output json)

{
  "Code": "SessionGetMachine",
  "Data": [
    {
      "Id": 601,
      "ServiceUserName": "svc-runner",
      "HostMachineName": "prod-worker-01",
      "MachineId": 101,
      "MachineName": "prod-worker-01",
      "State": "Available",
      "Job": null,
      "ReportingTime": "2025-04-15T10:30:00Z",
      "Info": "",
      "IsUnresponsive": false,
      "LicenseErrorCode": "",
      "OrganizationUnitId": 42,
      "FolderName": "Shared",
      "RobotSessionType": "Unattended",
      "Version": "23.10.0",
      "Source": "",
      "DebugModeExpirationDate": "",
      "UpdateInfo": null,
      "InstallationId": "",
      "Platform": "Windows",
      "EndpointDetection": ""
    }
  ]
}

UIP oder Sessions List-Usernames

Gibt die Benutzernamen der Benutzer zurück, die derzeit mit dem Orchestrator verbunden sind. Nützlich für die schnelle Beantwortung von „Wer ist gerade aktiv?“.

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--order-by	Feld	–	Sortierausdruck (standardmäßig leer).

Beispiele

uip or sessions list-usernames
uip or sessions list-usernames --limit 200

Datenform (--output json)

{
  "Code": "SessionListUsernames",
  "Data": ["[e-mail]", "[e-mail]"]
}

UIP oder Sitzungsliste-unbeaufsichtigt-Sitzungen

Runtimes für unbeaufsichtigte Sitzungen auflisten – die Ansicht der Slot-Nutzung für unbeaufsichtigte Maschinen. Ohne ein Ordner-Flag werden Sitzungen im gesamten Mandanten zurückgegeben. Mit --folder-key oder --folder-path werden Sitzungen im Scope des Ordners zurückgegeben.

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--folder-key	GUID	–	Ordnerschlüssel für die Auflistung im Ordnerbereich.
–	--folder-path	Pfad	–	Ordnerpfad (z. B. Shared).
–	--runtime-type	ENUM	–	Filtern Sie nach Laufzeittyp (z. B. Unattended, Attended, Headless, Serverless).
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--order-by	Feld	SessionId desc	OData-Sortierungsausdruck.

Beispiele

# All unattended runtimes in the tenant
uip or sessions list-unattended-sessions

# Serverless-only in a specific folder
uip or sessions list-unattended-sessions --folder-path "Shared" \
    --runtime-type Serverless

Datenform (--output json)

{
  "Code": "SessionListMachineSessions",
  "Data": [
    {
      "SessionId": 701,
      "MachineId": 101,
      "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
      "MachineName": "prod-worker-01",
      "MaintenanceMode": "Default",
      "HostMachineName": "prod-worker-01",
      "RuntimeType": "Unattended",
      "MachineType": "Standard",
      "MachineScope": "Default",
      "Status": "Available",
      "IsUnresponsive": false,
      "Runtimes": 3,
      "UsedRuntimes": 1,
      "ServiceUserName": "svc-runner",
      "ReportingTime": "2025-04-15T10:30:00Z",
      "Version": "23.10.0",
      "DebugModeExpirationDate": "",
      "Platform": "Windows",
      "EndpointDetection": "",
      "TriggersCount": 0
    }
  ]
}

UIP oder Sitzungslist-user-executors

Listen Sie die jedem Benutzer zugewiesenen Automatisierungs-Executors auf. Gibt Roboternamen (Executor) zurück, die nach Benutzernamen gruppiert sind – nützlich, um herauszufinden, welche Benutzer welche Unattended-Roboter haben.

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--order-by	Feld	–	Sortierausdruck (standardmäßig leer).

Beispiele

uip or sessions list-user-executors

Datenform (--output json)

{
  "Code": "SessionListUserExecutors",
  "Data": [
    { "UserName": "[e-mail]", "RobotNames": ["prod-worker-01", "prod-worker-02"] },
    { "UserName": "[e-mail]", "RobotNames": ["dev-serverless"] }
  ]
}

UIP oder Sitzungen-Debugging-Modus umschalten

Schalten Sie den Debug-Modus für eine Maschinensitzung um. Durch Aktivieren des Debugmodus kann eine Studio-Instanz mit der ausgeführten Sitzung verbunden werden. Verwenden Sie list-unattended-sessions oder list-machines-sessions , um Sitzungs-IDs zu finden.

Argumente

Name	Erforderlich	Zweck
<session-id>	ja	Sitzungs-ID (Integer).

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--enabled	true/false	– (erforderlich)	Debugmodus aktivieren oder deaktivieren.
–	--minutes	Nummer	–	Dauer in Minuten, für die der Debugmodus aktiv bleibt.

Beispiele

# Enable debug mode for 60 minutes
uip or sessions toggle-debug-mode 701 --enabled true --minutes 60

# Disable debug mode
uip or sessions toggle-debug-mode 701 --enabled false

Datenform (--output json)

{
  "Code": "SessionToggleDebugMode",
  "Data": {
    "SessionId": 701,
    "Enabled": true,
    "Status": "Debug mode updated successfully"
  }
}

UIP oder Sitzungen löschen-inaktiv

Löschen Sie getrennte oder nicht reagierende (inaktive) Sitzungen. Geben Sie eine oder mehrere Sitzungs-IDs an, um bestimmte Sitzungen anzuvisieren, oder lassen Sie alle IDs weg, um jede inaktive Sitzung im Mandanten zu löschen.

Argumente

Name	Erforderlich	Zweck
[session-ids...]	nein	Sitzungs-IDs (Zahlen). Auslassen, um alle inaktiven Sitzungen zu löschen.

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

Beispiele

# Delete specific inactive sessions
uip or sessions delete-inactive 701 702

# Delete every inactive session in the tenant
uip or sessions delete-inactive

Datenform (--output json)

Mit expliziten IDs:

{
  "Code": "SessionDeleteInactive",
  "Data": {
    "SessionIds": [701, 702],
    "Count": 2,
    "Status": "Inactive sessions deleted successfully"
  }
}

Ohne IDs:

{
  "Code": "SessionDeleteInactive",
  "Data": { "Status": "All inactive sessions deleted successfully" }
}

uip oder Sessions set-wartung-modus

Versetzen Sie eine Maschinensitzung in den Wartungsmodus (oder beenden Sie sie). Die Wartung verhindert, dass der Sitzung neue Aufträge zugewiesen werden. Wenn die Wartung aktiviert ist, steuert --stop-jobs-strategy , ob ausgeführte Aufträge Soft-Angehalten oder das Beenden erzwungen werden.

Argumente

Name	Erforderlich	Zweck
<session-id>	ja	Sitzungs-ID (Integer).

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--maintenance-mode	ENUM	– (erforderlich)	Default oder Enabled.
–	--stop-jobs-strategy	ENUM	–	SoftStop (anständige) oder Kill (sofort). Gilt nur bei Aktivierung der Wartung.

Beispiele

# Enable maintenance, soft-stop running jobs
uip or sessions set-maintenance-mode 701 \
    --maintenance-mode Enabled --stop-jobs-strategy SoftStop

# Take the session back out of maintenance
uip or sessions set-maintenance-mode 701 --maintenance-mode Default

Datenform (--output json)

{
  "Code": "SessionSetMaintenanceMode",
  "Data": {
    "SessionId": 701,
    "MaintenanceMode": "Enabled",
    "Status": "Maintenance mode updated successfully"
  }
}

Zugehörige Befehle

• uip or machines – Lösen Sie Maschinennamen in Schlüssel für list-machines-sessions auf.
• uip or users – Benutzerverzeichnis; Sitzungsbenutzernamen werden hier den Benutzerdatensätzen zugeordnet.
• uip or jobs – Untersuchen Sie Aufträge, die in einer Sitzung ausgeführt werden.

Siehe auch

• Globale Optionen – --output, --output-filter, --log-level, --log-file.
• Austrittscodes – Standard-Austrittscode-Vertrag.
• Sitzungen und Anmeldeinformationen – wie der Mandantenkontext aufgelöst wird.