uip o sesiones

uip or sessions y gestiona sesiones de Orchestrator: conexiones de host en vivo entre robots (attended y unattended) y Orchestrator. Úsalo para ver qué hosts están conectados, inspeccionar el uso de ranuras de runtime, alternar el modo de depuración en una sesión, colocar una sesión en mantenimiento o limpiar sesiones inactivas.

Sinopsis

uip or sessions <verb> [options]

Verbos

Verbo	Propósito
list-attended-sessions	Enumerar las sesiones atendidas (Studio/Assistant) en todo el tenant o en el ámbito de una carpeta.
list-machines-sessions	Enumerar sesiones para una máquina específica por clave de máquina.
list-usernames	Enumera los nombres de usuario de los usuarios con sesiones activas.
list-unattended-sessions	Enumerar los tiempos de ejecución de sesión unattended (uso de ranuras en todas las máquinas).
list-user-executors	Enumera los ejecutores de automatización (nombres de robot) agrupados por nombre de usuario.
toggle-debug-mode	Habilita o deshabilita el modo de depuración en una sesión de máquina.
delete-inactive	Eliminar sesiones desconectadas o que no responden (todas o por ID).
set-maintenance-mode	Coloca una sesión de máquina en modo de mantenimiento.

Todos los verbos respetan las opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato estándar.

uip o sesiones list-attended-sessions

Enumerar sesiones a las que asistió: conexiones de Studio y Assistant. Sin un marcador de carpeta, devuelve sesiones en todas las carpetas (vista global). Con --folder-key o --folder-path, devuelve las sesiones en el ámbito de la carpeta.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
—	--folder-key	GUID	—	Clave de carpeta para el listado de ámbito de carpeta.
—	--folder-path	Ruta	—	Ruta de la carpeta (por ejemplo, Shared).
—	--state	ENUM	—	Available, Busy, Disconnected, Unknown. Sin --state, se excluyen Disconnected sesiones.
—	--machine-name	text	—	Contiene coincidencia en el nombre de la máquina.
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--order-by	Campo	Id desc	Expresión de ordenación de OData (por ejemplo, MachineName asc).

Ejemplos

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

Forma de datos (--json de salida)

{
  "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 o sesiones lista-máquinas-sesiones

Enumerar sesiones para una máquina por clave de máquina. La clave de la máquina es el GUID devuelto por uip or machines list. Opcionalmente, ámbito a una carpeta.

Argumentos

Nombre	Obligatorio	Propósito
<machine-key>	Sí	Clave de la máquina (GUID). Encuéntralo con uip or machines list.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
—	--folder-key	GUID	—	Clave de carpeta para el listado de ámbito de carpeta.
—	--folder-path	Ruta	—	Ruta de la carpeta para el listado de ámbito de carpeta.
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--order-by	Campo	Id desc	Expresión de ordenación de OData.

Ejemplos

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"

Forma de datos (--json de salida)

{
  "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 o sesiones lista-nombres de usuario

Devuelve los nombres de usuario de los usuarios actualmente conectados a Orchestrator. Útil para responder rápidamente a "¿quién está activo en este momento?".

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--order-by	Campo	—	Expresión de ordenación (vacía de forma predeterminada).

Ejemplos

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

Forma de datos (--json de salida)

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

uip o sesiones lista-unattended-sessions

Enumerar runtimes de sesión unattended: la vista de uso de ranuras para máquinas unattended. Sin un marcador de carpeta, devuelve sesiones en todo el tenant. Con --folder-key o --folder-path, devuelve las sesiones en el ámbito de la carpeta.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
—	--folder-key	GUID	—	Clave de carpeta para el listado de ámbito de carpeta.
—	--folder-path	Ruta	—	Ruta de la carpeta (por ejemplo, Shared).
—	--runtime-type	ENUM	—	Filtrar por tipo de runtime (por ejemplo, Unattended, Attended, Headless, Serverless).
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--order-by	Campo	SessionId desc	Expresión de ordenación de OData.

Ejemplos

# 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

Forma de datos (--json de salida)

{
  "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 o sesiones list-user-executors

Enumera los ejecutores de automatización asignados a cada usuario. Devuelve los nombres de los robots (ejecutores) agrupados por nombre de usuario: útil para descubrir qué usuarios tienen qué robots desatendidos.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--order-by	Campo	—	Expresión de ordenación (vacía de forma predeterminada).

Ejemplos

uip or sessions list-user-executors

Forma de datos (--json de salida)

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

uip o sesiones alternar-depurar-modo

Alternar el modo de depuración en una sesión de máquina. Habilitar el modo de depuración permite conectar una instancia de Studio a la sesión en ejecución. Utiliza list-unattended-sessions o list-machines-sessions para buscar los ID de sesión.

Argumentos

Nombre	Obligatorio	Propósito
<session-id>	Sí	ID de sesión (entero).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
—	--enabled	true/false	— (obligatorio)	Habilita o deshabilita el modo de depuración.
—	--minutes	Número	—	Duración, en minutos, para que el modo de depuración permanezca activo.

Ejemplos

# 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

Forma de datos (--json de salida)

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

uip o sesiones eliminar-inactivo

Eliminar sesiones desconectadas o que no responden (inactivas). Proporciona uno o más ID de sesión para apuntar a sesiones específicas u omite todos los ID para eliminar cada sesión inactiva en el tenant.

Argumentos

Nombre	Obligatorio	Propósito
[session-ids...]	No	ID de sesión (entero). Omitir para eliminar todas las sesiones inactivas.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.

Ejemplos

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

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

Forma de datos (--json de salida)

Con ID explícitos:

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

Sin ID:

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

uip o sesiones set-maintenance-mode

Coloca una sesión de máquina en modo de mantenimiento (o sácala). El mantenimiento evita que se asignen nuevos trabajos a la sesión. Al habilitar el mantenimiento, --stop-jobs-strategy controla si los trabajos en ejecución se detienen de forma suave o se cancelan de forma forzada.

Argumentos

Nombre	Obligatorio	Propósito
<session-id>	Sí	ID de sesión (entero).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
—	--maintenance-mode	ENUM	— (obligatorio)	Default o Enabled.
—	--stop-jobs-strategy	ENUM	—	SoftStop (elegante) o Kill (inmediato). Solo se aplica al habilitar el mantenimiento.

Ejemplos

# 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

Forma de datos (--json de salida)

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

Comandos relacionados

• uip or machines — resuelve los nombres de las máquinas en claves para list-machines-sessions.
• uip or users : directorio de usuario; los nombres de usuario de sesión se asignan a los registros de usuario aquí.
• uip or jobs : investiga los trabajos que se ejecutan en una sesión.

Ver también

• Opciones globales : --output, --output-filter, --log-level, --log-file.
• Códigos de salida : contrato de código de salida estándar.
• Sesiones y credenciales : cómo se resuelve el contexto del tenant.