UIP ou

Gerencie trabalhos, pastas, processos, pacotes, máquinas, usuários, funções, licenças e recursos de runtime do Orchestrator usando a ferramenta "uip ou".

uip or é a ferramenta do Orchestrator: ele gerencia trabalhos, pastas, processos, pacotes, máquinas, usuários, funções, licenças, feeds, anexos e os recursos de runtime dos quais as automações dependem (ativos, buckets, filas, gatilhos, bibliotecas, webhooks) 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.

Recurso	Finalidade
Trabalhos	Iniciar, parar, reiniciar, retomar e inspecionar execuções de processos; buscar logs, traces, dados de correção e o histórico do estado.
Pastas	Criar, listar, mover, editar e excluir pastas; inspecionar a alocação de runtime.
Processos	associe pacotes a pastas como processos executáveis; atualizar, reverter e editar.
Pacotes	Carregar, baixar, listar e inspecionar .nupkg pacotes de automação e seus pontos de entrada.
Máquinas	Gerenciar modelos de máquina e alocações de slots; atribuir máquinas a pastas.
usuários	Criar, editar, excluir e atribuir usuários do Orchestrator; gerenciar atribuições de função no nível do tenant.
Funções	Gerencie funções, permissões e associação de usuário de função no escopo do tenant e da pasta.
Licenças	Listar atribuições de licenças de runtime e Named-User; alternar o licenciamento da máquina; visualizar o resumo da licença do tenant.
Feeds	Lista os feeds de pacote disponíveis para o usuário atual.
Anexos	Listar e baixar anexos de trabalho.
Ativos	Valores de configuração nomeados (Texto, Bool, Integer, Credential e Segredo) usados por automações no runtime. Com escopo de pasta.
Buckets	Contêineres de armazenamento para arquivos usados por automações. Com escopo de pasta.
arquivos do bucket	Arquivos individuais dentro de um bucket. Listar, carregar, baixar, excluir e buscar URLs pré-assinadas.
Bibliotecas	Pacotes .nupkg reutilizáveis (atividades compartilhadas e lógica). Com escopo de tenant.
Filas	Contêineres para itens de trabalho transacionais. Com escopo de pasta.
Itens da Fila	Transações individuais dentro de filas, com controles completos de máquina de estado. Com escopo de pasta.
Gatilhos	Gatilhos de tempo, fila e API que iniciam trabalhos. Os gatilhos de tempo/fila têm escopo de pasta; Os gatilhos de API têm o escopo de tenant.
Webhooks	Retornos de chamada HTTP disparados em eventos de plataforma (conclusão do trabalho, falha do item da fila,…). Com escopo de tenant.
armazenamentos de credenciais	Liste e inspecione as configurações de armazenamento de credenciais externas usadas por ativos Credential/Secret e buckets Azure/Amazon.

A avaliação de runtime de pacotes implantados — envio de execuções, saídas de pontuação e gerenciamento de avaliadores/conjuntos de avaliação/programações em relação a um processo do Orchestrator — é uma ferramenta separada e independente: uip eval (pacote @uipath/eval-tool, não um subcomando uip or , mesmo que cada verbo opere em um processo/pasta do Orchestrator).

Resumo

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:

Bandeira	Usado por	Finalidade
--folder-path <path>	a maioria dos verbos que abrangem uma pasta	Pasta de destino por caminho totalmente qualificado (por exemplo, Shared, Production/EU).
--folder-key <key>	a maioria dos verbos que abrangem uma pasta	Pasta de destino por GUID. Mutualmente usado com --folder-path; resolve a mesma pasta.
--all-folders	list em alguns recursos com escopo de pasta (por exemplo, assets, buckets)	Listar todas as pastas acessíveis ao chamador em vez de delimitar uma. Onde compatível, um entre --folder-path, --folder-key ou --all-folders é necessário.
-l, --limit <number>	cada verbo de lista	Tamanho da página O padrão é o da CLI DEFAULT_PAGE_SIZE (50 no momento da escrita).
--offset <number>	cada verbo de lista	Número de itens a ignorar antes de retornar. O padrão é 0.
--sort-by <field>	mais verbos da lista	Expressão de classificação OData (por exemplo, Name asc, Id desc). Cada verbo documenta seu padrão.
--all-fields	muitos list / get verbos	Retorna a resposta da API bruta em vez do resumo selecionado. Útil quando você precisa de campos que a forma padrão omite.
-y, --yes	cada verbo destrutivo (delete)	Confirme a operação. Necessário — a CLI nunca solicita interativamente uma ação destrutiva.

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.

Convenções de recursos de runtime

As páginas de recursos de runtime (ativos, buckets, arquivos de bucket, bibliotecas, filas, itens de fila, gatilhos, webhooks) compartilham algumas convenções adicionais sobre as acima:

• Escopo de pastas. Ativos, buckets, filas, itens de fila e gatilhos (tempo / fila) têm escopo de pasta. Forneça --folder-path <path> ( exemplo "Shared") ou --folder-key <guid> em list, create e chamadas relacionadas — ou --all-folders onde esse sinalizador for compatível. get, update e delete resolvem pasta cruzada por chave quando viável; a descrição de cada verbo na página do recurso o chama explicitamente. Bibliotecas, gatilhos de API e webhooks têm o escopo de tenant e não aceitam --folder-*.
• Chaves. A maioria dos recursos é identificada por um GUID retornado na saída list (em key, identifier ou — para itens de fila — uniqueKey para uma única tentativa e key para a cadeia de repetições). Os campos numéricos id são internos e não devem ser passados para comandos.
• Filtrando. Quando compatível, -n, --name <name> é uma correspondência contém no nome do recurso; alguns recursos adicionam --enabled, --disabled, --status, etc.

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

• Conceitos: como o UiPath CLI é organizado — onde as ferramentas se encaixam no modelo de host + ferramenta.
• Sessões — como o contexto do tenant e da pasta são resolvidos.
• Configuração — variáveis de ambiente e arquivos de configuração que afetam cada ferramenta.
• Início rápido e seu primeiro pipeline — tutoriais completos que usaram uip or.