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

uip or a ferramenta do Orchestrator: ele gerencia trabalhos, pastas, processos, pacotes, máquinas, usuários, funções, licenças, feeds e anexos em um tenant do UiPath Orchestrator. Instale-o com uip tools install or ou invoque uip or … 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 or — execute uip or --help para confirmar a superfície completa em sua instalação.

RecursoFinalidade
TrabalhosIniciar, parar, reiniciar, retomar e inspecionar execuções de processos; buscar logs, traces, dados de correção e o histórico do estado.
PastasCriar, listar, mover, editar e excluir pastas; inspecionar a alocação de runtime.
Processosassocie pacotes a pastas como processos executáveis; atualizar, reverter e editar.
PacotesCarregar, baixar, listar e inspecionar .nupkg pacotes de automação e seus pontos de entrada.
MáquinasGerenciar modelos de máquina e alocações de slots; atribuir máquinas a pastas.
usuáriosCriar, editar, excluir e atribuir usuários do Orchestrator; gerenciar atribuições de função no nível do tenant.
FunçõesGerencie funções, permissões e associação de usuário de função no escopo do tenant e da pasta.
LicençasListar atribuições de licenças de runtime e Named-User; alternar o licenciamento da máquina; visualizar o resumo da licença do tenant.
FeedsLista os feeds de pacote disponíveis para o usuário atual.
AnexosListar e baixar anexos de trabalho.

Resumo

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

Sempre uip or, nunca uip orchestrator. or é 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 or <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, três exemplos (mais simples, caso comum, amigável ao script com --output-filter) 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 compartilhado, com quaisquer substituições específicas do verbo chamadas em linha.
  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

Um pequeno conjunto de sinalizadores é recorrente na maioria dos recursos. Elas se comportam da mesma maneira onde quer que apareçam:

BandeiraUsado porFinalidade
-t, --tenant <tenant-name>cada verboSubstitui o tenant selecionado no momento da autenticação. Opcional; omita para usar o padrão da sessão. Consulte Autenticação.
--folder-path <path>a maioria dos verbos que abrangem uma pastaPasta de destino por caminho totalmente qualificado (por exemplo, Shared, Production/EU).
--folder-key <key>a maioria dos verbos que abrangem uma pastaPasta de destino por GUID. Mutualmente usado com --folder-path; resolve a mesma pasta.
-l, --limit <number>cada verbo de listaTamanho da página O padrão é o da CLI DEFAULT_PAGE_SIZE (50 no momento da escrita).
--offset <number>cada verbo de listaNúmero de itens a ignorar antes de retornar. O padrão é 0.
--order-by <field>mais verbos da listaExpressão de classificação OData (por exemplo, Name asc, Id desc). Cada verbo documenta seu padrão.
--all-fieldsmuitos list / get verbosRetorna a resposta da API bruta em vez do resumo selecionado. Útil quando você precisa de campos que a forma padrão omite.

Os sinalizadores no nível do verbo (filtros, caminhos de entrada/saída, estratégias, prioridades) são documentados em cada página de recurso.

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

Todos os verbos uip or respeitam as quatro opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato compartilhado; qualquer substituição específica do verbo é chamada na página do recurso relevante.

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