UiPath Documentation
uipath-cli
latest
false
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.

Guia do usuário da UiPath CLI

Plataforma UIP

uip platform a ferramenta de plataforma: ele gerencia recursos de licença no nível da organização e do tenant — alocações de runtime de tenant/consumíveis, pacotes de licenças por usuário, regras de alocação de grupos e o relatório de consumíveis em toda a organização. Instale-o com uip tools install platform ou invoque uip platform … e deixe a instalação automática ser executada. Consulte Ferramentas ( plugins ) para ver o modelo de instalação e ferramentas uip para o comando que gerencia a instalação da ferramenta.

Recursos

Cada recurso tem sua própria página de referência. O verbo definido em cada página corresponde aos comandos registrados por uip platform — execute uip platform --help para confirmar a superfície completa em sua instalação.

RecursoFinalidade
TenantsObter o resumo de licença de um tenant; definir licenças de runtime e consumíveis, roteadas para a licença de serviço que já possui o código de cada produto.
usuáriosAloque licenças de pacote de usuário a um usuário de diretório, liste as concessões atuais de um usuário (diretas ou herdadas do grupo) e visualize a disponibilidade do pacote de usuário no nível da conta.
GruposListe, inspecione e configure regras de alocação de licença de grupo com cotas opcionais por pacote.
LicençasRelatórios de consumíveis no nível da organização: resumo de alocação por tenant, detalhamento diário por serviço e detalhamento por pasta.

Resumo

uip platform <resource> <verb> [options]
uip platform <resource> <verb> [options]

Sempre uip platform, nunca uip plt. platform é o prefixo de comando da ferramenta (consulte a coluna commandPrefix em uip tools list).

Como ler esta seção

Cada página de recurso é estruturada da mesma maneira:

  1. Resumo — a forma de comando uip platform <resource> <verb> .
  2. Verbos — uma tabela de uma linha de cada verbo que o recurso expõe.
  3. Um H2 por verbo — descrição, argumentos posicionais (se houver), tabela de sinalizador, um exemplo e a forma Data retornada sob --output json.
  4. Códigos de saída — um ponteiro para o contrato de códigos de saída compartilhados.
  5. Comandos relacionados e Consulte também — links cruzados para recursos irmãos e páginas de conceito relevantes.

O formato de saída padrão é --output json. As formas de dados em cada página refletem a carga JSON — as renderizações de tabela, yaml e simples são derivadas do mesmo objeto Data .

Sinalizadores comuns

verbos uip platform compartilham um sinalizador opcional de escopo de organização. Os sinalizadores identificadores (<tenant-key>, <user>, <group>) são posicionais e documentados por verbo.

BandeiraUsado porFinalidade
--organization <account-id>cada verboGUID da conta da organização. O padrão é a organização do login atual. Substituição quando um aplicativo externo ou sessão tiver como escopo uma conta diferente.

Os sinalizadores no nível do verbo (--input, --mode, --tenant, --unit, --start-date, --end-date, --limit, --offset, --sort-by, --sort-order) são documentados em cada recurso página.

Opções globais e códigos de saída

Todos os verbos uip platform respeitam as quatro opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato compartilhado.

Veja também

  • Conceitos: como o UiPath CLI é organizado — onde as ferramentas se encaixam no modelo de host + ferramenta.
  • Sessões — como o contexto da organização é resolvido.
  • Configuração — variáveis de ambiente e arquivos de configuração que afetam cada ferramenta.
  • uip ou licenças — Atribuição de licenças de robô no nível do Orchestrator (máquina e name-user), complementar à alocação no nível da plataforma.

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