uip ou sessions

uip or sessions affiche et gère les sessions Orchestrator — les connexions hôtes en direct entre les robots (attended et unattended) et Orchestrator. Utilisez-le pour voir quels hôtes sont connectés, inspecter l'utilisation des emplacements de runtime, activer/désactiver le mode débogage d'une session, placer une session en maintenance ou nettoyer les sessions inactives.

Synthèse

uip or sessions <verb> [options]

Verbes

Verbe	Objectif
list-attended-sessions	Répertoriez les sessions (Studio/Assistant) sur l’ensemble du locataire ou limitées à un dossier.
list-machines-sessions	Répertorier les sessions d'une machine spécifique par clé de machine.
list-usernames	Répertoriez les noms d'utilisateur des utilisateurs avec des sessions actives.
list-unattended-sessions	Répertoriez les runtimes de session non assistés (utilisation des emplacements sur les machines).
list-user-executors	Répertorie les exécuteurs d'automatisation (noms de robots) regroupés par nom d'utilisateur.
toggle-debug-mode	Activez ou désactivez le mode débogage sur une session de machine.
delete-inactive	Supprimez les sessions déconnectées ou qui ne répondent pas (toutes ou par ID).
set-maintenance-mode	Placez une session de machine en mode maintenance.

Tous les verbes respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

uip ou sessions list-attended-sessions

Lister les sessions Attended — Connexions à Studio et Assistant. Sans indicateur de dossier, renvoie les sessions dans tous les dossiers (vue globale). Avec --folder-key ou --folder-path, renvoie les sessions limitées au dossier.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--folder-key	GUID	—	Clé de dossier pour la liste à l'échelle des dossiers.
—	--folder-path	Chemin d'accès	—	Chemin d'accès au dossier (par exemple, Shared).
—	--state	ENUM	—	Available, Busy, Disconnected, Unknown. Sans --state, Disconnected sessions sont exclues.
—	--machine-name	text	—	Contient une correspondance sur le nom de la machine.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--order-by	Champ	Id desc	Expression de tri OData (par exemple, MachineName asc).

Exemples

# 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}'

Format des données (--sortie 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 ou sessions list-machines-sessions

Répertoriez les sessions d'une machine par clé de machine. La clé de la machine est le GUID renvoyé par uip or machines list. Étendue facultative à un dossier.

Arguments

Nom	Requis	Objectif
<machine-key>	oui	Clé de machine. Recherchez-le avec uip or machines list.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--folder-key	GUID	—	Clé de dossier pour la liste à l'échelle des dossiers.
—	--folder-path	Chemin d'accès	—	Chemin d'accès au dossier pour la liste à l'échelle du dossier.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--order-by	Champ	Id desc	Expression de tri OData.

Exemples

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"

Format des données (--sortie 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 ou sessions list-usernames

Renvoyez les noms d'utilisateur des utilisateurs actuellement connectés à Orchestrator. Utile pour répondre rapidement à « qui est actif en ce moment?».

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--order-by	Champ	—	Expression de tri (vide par défaut).

Exemples

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

Format des données (--sortie json)

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

uip ou sessions list-unattended-sessions

Répertorier les runtimes de session non assistés - la vue de l'utilisation des emplacements pour les machines non assistées. Sans indicateur de dossier, renvoie les sessions sur l’ensemble du locataire. Avec --folder-key ou --folder-path, renvoie les sessions limitées au dossier.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--folder-key	GUID	—	Clé de dossier pour la liste à l'échelle des dossiers.
—	--folder-path	Chemin d'accès	—	Chemin d'accès au dossier (par exemple, Shared).
—	--runtime-type	ENUM	—	Filtrez par type de runtime (par exemple, Unattended, Attended, Headless, Serverless).
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--order-by	Champ	SessionId desc	Expression de tri OData.

Exemples

# 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

Format des données (--sortie 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 ou sessions list-user-executor

Répertoriez les exécuteurs d'automatisation affectés à chaque utilisateur. Renvoie les noms des robots (exécuteurs) regroupés par nom d'utilisateur — utile pour découvrir quels utilisateurs ont quels robots non assistés.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--order-by	Champ	—	Expression de tri (vide par défaut).

Exemples

uip or sessions list-user-executors

Format des données (--sortie json)

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

uip ou sessions activer/désactiver le mode débogage

Basculer en mode débogage sur une session de machine. L'activation du mode de débogage permet de connecter une instance de Studio à la session en cours d'exécution. Utilisez list-unattended-sessions ou list-machines-sessions pour trouver des ID de session.

Arguments

Nom	Requis	Objectif
<session-id>	oui	ID de session (entier).

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--enabled	true/false	— (obligatoire)	Activez ou désactivez le mode de débogage.
—	--minutes	Numérique	—	Durée, en minutes, pendant laquelle le mode débogage doit rester actif.

Exemples

# 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

Format des données (--sortie json)

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

uip ou sessions - inactive

Supprimez les sessions déconnectées ou qui ne répondent pas (inactives). Fournissez un ou plusieurs ID de session pour cibler des sessions spécifiques, ou omettez tous les ID pour supprimer chaque session inactive du locataire.

Arguments

Nom	Requis	Objectif
[session-ids...]	non	ID de session (entiers). Omettez pour supprimer toutes les sessions inactives.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

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

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

Format des données (--sortie json)

Avec des ID explicites:

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

Sans ID:

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

uip ou sessions set-maintenance-mode

Placez une session de machine en mode de maintenance (ou supprimez-la). La maintenance empêche l'attribution de nouvelles tâches à la session. Lors de l'activation de la maintenance, --stop-jobs-strategy contrôle si les tâches en cours d'exécution sont arrêtées petit à petit ou arrêtées de force.

Arguments

Nom	Requis	Objectif
<session-id>	oui	ID de session (entier).

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--maintenance-mode	ENUM	— (obligatoire)	Default ou Enabled.
—	--stop-jobs-strategy	ENUM	—	SoftStop (gratuit) ou Kill (immédiat). S’applique uniquement lors de l’activation de la maintenance.

Exemples

# 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

Format des données (--sortie json)

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

Commandes associées

• uip or machines — résolvez les noms de machine en clés pour list-machines-sessions.
• uip or users — répertoire des utilisateurs; les noms d'utilisateur de session sont mappés vers les enregistrements d'utilisateurs ici.
• uip or jobs — examiner les tâches s'exécutant sur une session.

Voir également

• Options globales — --output, --output-filter, --log-level, --log-file.
• Codes de sortie — contrat de code de sortie standard.
• Sessions et informations d’identification — comment le contexte du locataire est résolu.