- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- UiPath for Coding Agents
- Guias de instruções
- Receitas de CI/CD
- Referência de comando
- Visão geral
- Códigos de saída
- Opções globais
- Agente de código uip
- Documento da UIP
- adicionar-tipo-dados-de-teste
- adicionar-dados-de-teste-fila
- adicionar-teste-variação de dados
- Analisar
- Criar
- criar projeto
- Comparação
- encontrar atividades
- obter-analisador-regras
- obter-padrão-atividade-xaml
- obter-erros
- obter-casos-de-teste-manuais
- obter-etapas-de-teste-manual
- Obter versões
- obter-fluxo-de-trabalho-exemplo
- indicar aplicativo
- indicar elemento
- inspecionar pacote
- instalar-data-fabric-entities
- instalar-ou-atualizar pacotes
- listar-data-fabric-entities
- listar-exemplos-de-fluxo-de-trabalho
- Empacotar
- restore
- arquivo de execução
- modelos-pesquisar
- Iniciar Studio
- interromper a execução
- UIA
- Traces da UIP
- Migração
- Referência e suporte
Guia do usuário da UiPath CLI
uip platform tenants reads and updates per-tenant license allocations. licenses get returns the active product allocation for a tenant (allocated, available, consumed, validity window); licenses set overlays a JSON delta of {code, quantity} entries, routing each product code to the service license that already owns it within the tenant.
Resumo
uip platform tenants licenses <verb> [options] <tenant-key>
uip platform tenants licenses <verb> [options] <tenant-key>
Verbo
| Texto | Finalidade |
|---|---|
get | Get the active license summary for a tenant (one row per product, dates as ISO). |
set | Apply a delta of {code, quantity} entries to a tenant's runtime licenses and consumables, auto-routed across service-types. |
uip platform tenants licenses get
Get the license summary for a tenant: allocated, available, consumed quantities per product code, with friendly names. Returns one row per active product (consumables and runtime licenses alike).
Argumentos
| Name | Required | Finalidade |
|---|---|---|
<tenant-key> | sim | Tenant key (GUID). |
Opções
| Long | Valor | Padrão | Description |
|---|---|---|---|
--organization | account-id | padrão da sessão | Organization account GUID. Override the org resolved from the current login. |
Exemplo
uip platform tenants licenses get 296b7134-6691-43db-b48a-2d95ed3ab031
uip platform tenants licenses get 296b7134-6691-43db-b48a-2d95ed3ab031
Formato dos dados (--output json)
{
"Code": "TenantLicenses",
"Data": [
{
"code": "PLTU",
"name": "Platform Units",
"allocated": 300,
"availableForAllocation": 4700,
"allocatedAcrossOtherTenants": 0,
"totalUnitsInAccount": 5000,
"consumed": 50,
"startDate": "2023-11-14T22:13:20.000Z",
"endDate": "2027-09-15T18:40:00.000Z"
}
]
}
{
"Code": "TenantLicenses",
"Data": [
{
"code": "PLTU",
"name": "Platform Units",
"allocated": 300,
"availableForAllocation": 4700,
"allocatedAcrossOtherTenants": 0,
"totalUnitsInAccount": 5000,
"consumed": 50,
"startDate": "2023-11-14T22:13:20.000Z",
"endDate": "2027-09-15T18:40:00.000Z"
}
]
}
uip platform tenants licenses set
Set runtime licenses and consumables for a tenant. The CLI fetches the tenant's existing service licenses, indexes their products by code, and routes each input entry to the service license that already owns that code. Quantities in --input overlay the current allocation by code; products you do not list keep their existing quantities.
The command fails before writing if any input code:
- is not present in any of the tenant's existing service licenses (unrouted), or
- appears under more than one of the tenant's service licenses (ambiguous routing).
On partial failure (one service-type fails to update after another already succeeded), the error message lists the service types that were already applied so you can re-run with the same input idempotently.
Argumentos
| Name | Required | Finalidade |
|---|---|---|
<tenant-key> | sim | Tenant key (GUID). |
Opções
| Long | Valor | Padrão | Description |
|---|---|---|---|
--input | Path | necessário | Path to a JSON file with the product delta, for example [{"code":"UNATT","quantity":5}]. Quantities overlay the current allocation by product code. |
--organization | account-id | padrão da sessão | Organization account GUID. Override the org resolved from the current login. |
Exemplo
uip platform tenants licenses set 296b7134-6691-43db-b48a-2d95ed3ab031 \
--input ./delta.json
uip platform tenants licenses set 296b7134-6691-43db-b48a-2d95ed3ab031 \
--input ./delta.json
delta.json:
[
{ "code": "PLTU", "quantity": 500 },
{ "code": "RU", "quantity": 100 }
]
[
{ "code": "PLTU", "quantity": 500 },
{ "code": "RU", "quantity": 100 }
]
Formato dos dados (--output json)
{
"Code": "TenantLicensesSet",
"Data": [
{
"serviceType": "orchestrator",
"code": "PLTU",
"name": "Platform Units",
"quantity": 500
},
{
"serviceType": "orchestrator",
"code": "RU",
"name": "Robot Units",
"quantity": 100
}
]
}
{
"Code": "TenantLicensesSet",
"Data": [
{
"serviceType": "orchestrator",
"code": "PLTU",
"name": "Platform Units",
"quantity": 500
},
{
"serviceType": "orchestrator",
"code": "RU",
"name": "Robot Units",
"quantity": 100
}
]
}
Códigos de saída
Consulte Códigos de saída. Nenhuma substituição específica do verbo.
Comandos relacionados
uip platform licenses consumables— organization-level consumables report (per-tenant pool usage, daily and folder breakdowns).uip platform users— per-user license bundles.uip or licenses— Orchestrator-level machine and named-user license assignment.
Veja também
- Opções globais.
- Output formats — switch the table view with
--output table.