uip ou sessões

uip or sessions visualiza e gerencia sessões do Orchestrator — conexões de host ao vivo entre robôs (attended e unattended) e o Orchestrator. Use-o para ver quais hosts estão conectados, inspecionar o uso de slots de runtime, alternar o modo de depuração em uma sessão, colocar uma sessão em manutenção ou limpar sessões inativas.

Resumo

uip or sessions <verb> [options]

Verbo

Texto	Finalidade
list-attended-sessions	Listar sessões assistidas (Studio/Assistant) em todo o tenant ou com escopo em uma pasta.
list-machines-sessions	Liste as sessões de uma máquina específica por chave da máquina.
list-usernames	Listar os nomes de usuários de usuários com sessões ativas.
list-unattended-sessions	Liste runtimes de sessão não assistida (uso de slot em todas as máquinas).
list-user-executors	Lista os Executores de automação (nomes de Robôs) agrupados por nome de usuário.
toggle-debug-mode	Habilite ou desabilite o modo de depuração em uma sessão de máquina.
delete-inactive	Exclua sessões desconectadas ou não responsivas (todas ou por ID).
set-maintenance-mode	Coloque uma sessão de máquina no modo de manutenção.

Todos os verbos honram as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

uip ou sessões list-attended-sessions

Listar sessões assistidas — Conexões do Studio e do Assistant. Sem um sinalizador de pasta, retorna sessões em todas as pastas (exibição global). Com --folder-key ou --folder-path, retorna sessões com escopo para a pasta.

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--folder-key	GUID	—	Chave de pasta para listagem com escopo de pasta.
—	--folder-path	Path	—	Caminho da pasta (por exemplo, Shared).
—	--state	ENUM	—	Available, Busy, Disconnected, Unknown. Sem --state, Disconnected sessões são excluídas.
—	--machine-name	text	—	Contains-match no nome da máquina.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--order-by	Campo	Id desc	Expressão de classificação OData (por exemplo, MachineName asc).

Exemplos

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

Formato dos dados (--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 ou sessões listar-máquinas-sessões

Liste as sessões de uma máquina por chave da máquina. A chave da máquina é o GUID retornado por uip or machines list. Opcionalmente, o escopo para uma pasta.

Argumentos

Name	Required	Finalidade
<machine-key>	sim	Chave da máquina (GUID). Encontre-o com uip or machines list.

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--folder-key	GUID	—	Chave de pasta para listagem com escopo de pasta.
—	--folder-path	Path	—	Caminho da pasta para a listagem com escopo de pasta.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--order-by	Campo	Id desc	Expressão de classificação do OData.

Exemplos

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"

Formato dos dados (--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 ou sessões listar-nomes de usuário

Retorne os nomes de usuário dos usuários atualmente conectados ao Orchestrator. Útil para responder rapidamente "quem está ativo agora?".

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--order-by	Campo	—	Expressão de classificação (vazia por padrão).

Exemplos

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

Formato dos dados (--output json)

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

uip ou sessões list-unattended-sessions

Listar runtimes de sessão não assistida — a visualização do uso de slots para máquinas não assistidas. Sem um sinalizador de pasta, retorna sessões em todo o tenant. Com --folder-key ou --folder-path, retorna sessões com escopo para a pasta.

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--folder-key	GUID	—	Chave de pasta para listagem com escopo de pasta.
—	--folder-path	Path	—	Caminho da pasta (por exemplo, Shared).
—	--runtime-type	ENUM	—	Filtra por tipo de runtime (por exemplo, Unattended, Attended, Headless, Serverless).
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--order-by	Campo	SessionId desc	Expressão de classificação do OData.

Exemplos

# 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

Formato dos dados (--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 ou Sessions list-user-executors

Lista os Executores de automação atribuídos a cada usuário. Retorna nomes de robôs (executores) agrupados por nome de usuário — útil para descobrir quais usuários têm quais robôs não assistidos.

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--order-by	Campo	—	Expressão de classificação (vazia por padrão).

Exemplos

uip or sessions list-user-executors

Formato dos dados (--output json)

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

uip ou sessões toggle-debug-mode

Alterne o modo de depuração em uma sessão de máquina. Habilitar o modo de depuração permite conectar uma instância do Studio à sessão em execução. Use list-unattended-sessions ou list-machines-sessions para encontrar IDs de sessão.

Argumentos

Name	Required	Finalidade
<session-id>	sim	ID da sessão (inteiro).

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--enabled	true/false	— (obrigatório)	Habilite ou desabilite o modo de depuração.
—	--minutes	Número	—	Duração, em minutos, para que o modo de depuração permaneça ativo.

Exemplos

# 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

Formato dos dados (--output json)

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

uip ou sessões exclua-inativo

Exclua sessões desconectadas ou não responsivas (inativas). Forneça um ou mais IDs de sessão para segmentar sessões específicas ou omita todos os IDs para excluir cada sessão inativa no tenant.

Argumentos

Name	Required	Finalidade
[session-ids...]	não	IDs de sessão (inteiros). Omita para excluir todas as sessões inativas.

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.

Exemplos

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

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

Formato dos dados (--output json)

Com IDs explícitos:

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

Sem IDs:

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

uip ou sessões set-maintenance-mode

Coloque uma sessão de máquina no modo de manutenção (ou remova-a). A manutenção impede que novos trabalhos sejam atribuídos à sessão. Ao habilitar a manutenção, --stop-jobs-strategy controla se os trabalhos em execução são interrompidos temporariamente ou encerrados à força.

Argumentos

Name	Required	Finalidade
<session-id>	sim	ID da sessão (inteiro).

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--maintenance-mode	ENUM	— (obrigatório)	Default ou Enabled.
—	--stop-jobs-strategy	ENUM	—	SoftStop ( gracioso) ou Kill (imediato). Aplica-se apenas ao habilitar a manutenção.

Exemplos

# 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

Formato dos dados (--output json)

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

Comandos relacionados

• uip or machines — resolver nomes de máquinas para chaves de list-machines-sessions.
• uip or users — diretório de usuários; os nomes de usuário das sessões mapeiam de volta para os registros de usuários aqui.
• uip or jobs — investigar trabalhos em execução em uma sessão.

Veja também

• Opções globais — --output, --output-filter, --log-level, --log-file.
• Códigos de saída — contrato de código de saída padrão.
• Sessões e credenciais — como o contexto do tenant é resolvido.