UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

UIP ou licenças

Sintaxe e opções para "uip ou licenses", que inspeciona e gerencia a alocação de licenças do Orchestrator para runtimes e Named Users.

uip or licenses inspeciona e gerencia a alocação de licenças do Orchestrator. Liste atribuições de licença de runtime e Named User, ative ou desative o licenciamento da máquina e visualize o resumo geral da licença do tenant (permitido versus usado por tipo de robô).

Resumo​

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

Verbo​

TextoFinalidade
listListe atribuições de licença para um determinado tipo de robô (runtime ou Named-User).
toggleHabilite ou desabilite o licenciamento de máquinas para um tipo de robô de runtime específico.
infoMostrar o resumo da licença do tenant (plano de assinatura, permitido/usado, recursos).

Referência do tipo de robô​

O sinalizador --type aceita esses tipos de robô. O comportamento do comando divide-se em dois buckets:

  • Tipos de runtime — alocação no nível da máquina: Unattended, NonProduction, Headless, TestAutomation.
  • Tipos de Named User — alocação no nível do usuário: Attended, Development, Studio, StudioX, RpaDeveloper, CitizenDeveloper.

aceita licenses list os buckets; licenses toggle aceita apenas tipos de runtime.

uip ou lista de licenças​

Lista atribuições de licença para um determinado tipo de robô.

  • Para tipos de runtime, cada linha é uma máquina com um robô conectado; MachineName, MachineType, Runtimes, IsOnline, IsLicensed e Enabled são retornados.
  • Para tipos de Named-user, cada linha é um usuário; UserName, LastLoginDate, MachinesCount, IsLicensed e MachineNames são retornados.

Opções​

ShortLongValorPadrãoDescription
—--typeENUMnecessárioTipo de robô (consulte a lista acima).
—--licensedBandeiradesativadaApenas entradas licenciadas. mutuamente exclusivo com --unlicensed.
—--unlicensedBandeiradesativadaApenas entradas não licenciadas. mutuamente exclusivo com --licensed.
-l--limitNúmero50Tamanho da página
—--offsetNúmero0Ignorar contagem.
—--sort-byCampo—Classificação OData (por exemplo, MachineName desc).

Exemplos​

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'

Formato dos dados (--output json)​

Tipo de runtime:

{
  "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
    }
  ]
}

Tipo de Named-user:

{
  "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"]
    }
  ]
}

alternância de uip ou licenças​

Habilite ou desabilite o licenciamento de máquinas para um tipo de robô de runtime específico. Os tipos de Named User são rejeitados. Aceita uma chave da máquina (GUID) — resolvida internamente para um nome da máquina antes de chamar a API.

Exatamente um dos --enable ou --disable deve ser fornecido.

Argumentos​

NameRequiredFinalidade
<machine-key>simChave da máquina (GUID). Encontre-o com machines list.

Opções​

ShortLongValorPadrãoDescription
—--typeENUMnecessárioApenas o tipo de robô de runtime: Unattended, NonProduction, Headless, TestAutomation.
—--enableBandeira—Habilitar licenciamento.
—--disableBandeira—Desabilite o licenciamento.

Exemplos​

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'

Formato dos dados (--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"
  }
}

informações de UI ou Licenças​

Exiba o resumo da licença do tenant: plano de assinatura, contagens permitidas versus usadas por tipo de robô, status de expiração e funcionalidades licenciadas. Use isso para verificar a capacidade geral antes de alocar.

Opções​

ShortLongValorPadrãoDescription

Exemplos​

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

Formato dos dados (--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"]
  }
}

Códigos de saída​

Consulte Códigos de saída. Nenhuma substituição específica do verbo.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades