- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- UiPath para agentes de codificação
- 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 agent deploy e ativa uma versão do pacote de agente publicada anteriormente em uma pasta do Orchestrator. Ele direciona o pipeline de implantação de soluções completo — configurar → implantar → instalar → provisionar → ativar — e faz pesquisas até que cada fase atinja um estado terminal.
Por padrão, o comando também provisiona a pasta de destino para execução imediata: atribui um modelo de máquina serverless no nível do tenant e vincula um usuário do robô com a função Automation User à pasta. As falhas de provisionamento são exibidas como avisos em vez de erros (você pode atribuir a máquina e o usuário manualmente após o fato).
Requer uma sessão de CLI ativa (uip login).
Resumo
uip agent deploy <packageVersionKey>
[-n <name>]
[--folder-key <guid>]
[--force-activate] [--skip-activate]
[-t <tenant>]
[--timeout <seconds>]
[--login-validity <minutes>]
uip agent deploy <packageVersionKey>
[-n <name>]
[--folder-key <guid>]
[--force-activate] [--skip-activate]
[-t <tenant>]
[--timeout <seconds>]
[--login-validity <minutes>]
Todas as invocações uip agent deploy honram as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão, com as substituições específicas de implantação anotadas abaixo.
Argumentos
<packageVersionKey>(necessário) — Chave da versão do pacote retornada poruip agent publish(caminho padrão de carregamento). GUID.
Opções
| Bandeira | Padrão | Finalidade |
|---|---|---|
-n, --name <name> | agent-<timestamp> | Nome da implantação. Torna-se o nome de exibição no Orchestrator e — para pastas criadas automaticamente — o nome da pasta. |
--folder-key <guid> | — (criação automática) | Chave da pasta de instalação (GUID). Se omitido, uma nova pasta será criada automaticamente durante a instalação. |
--force-activate | desativada | Força a ativação mesmo que exista uma implantação anterior nesta chave de configuração. |
--skip-activate | desativada | Pare após a fase de instalação; não ative. Útil quando você deseja revisar a instalação antes de lançar o agente. |
-t, --tenant <tenant> | Tenant de logon | Tenant de destino. Obrigatório se a sessão de logon não tiver um tenant padrão. |
--timeout <seconds> | 120 | Máximo de segundos para esperar que cada fase de pesquisa (instalar, ativar) atinja um estado terminal. No tempo limite, o comando sai com o código 2. |
--login-validity <minutes> | 10 | Mínimo de minutos de validade do token necessários. |
Exemplos
# Deploy to an auto-created folder named "invoice-agent"
uip agent deploy a1b2c3d4-0000-0000-0000-000000000050 --name invoice-agent
# Deploy into an existing folder
uip agent deploy <PackageVersionKey> --folder-key <FolderGuid>
# Install only; do not activate (review in Orchestrator first)
uip agent deploy <PackageVersionKey> --skip-activate
# Force re-activation of a replacement deployment
uip agent deploy <PackageVersionKey> --force-activate
# Longer timeout for slow environments
uip agent deploy <PackageVersionKey> --timeout 600
# Deploy to an auto-created folder named "invoice-agent"
uip agent deploy a1b2c3d4-0000-0000-0000-000000000050 --name invoice-agent
# Deploy into an existing folder
uip agent deploy <PackageVersionKey> --folder-key <FolderGuid>
# Install only; do not activate (review in Orchestrator first)
uip agent deploy <PackageVersionKey> --skip-activate
# Force re-activation of a replacement deployment
uip agent deploy <PackageVersionKey> --force-activate
# Longer timeout for slow environments
uip agent deploy <PackageVersionKey> --timeout 600
Formato dos dados (--output json)
Instalação + ativação concluída (Code: "AgentDeploy"):
{
"Code": "AgentDeploy",
"Data": {
"DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000060",
"DeploymentName": "invoice-agent",
"Status": "SuccessfulActivate",
"FolderKey": "a1b2c3d4-0000-0000-0000-000000000070",
"FolderId": 42,
"FolderName": "invoice-agent",
"ConfigurationKey": "a1b2c3d4-0000-0000-0000-000000000080",
"PackageVersionKey": "a1b2c3d4-0000-0000-0000-000000000050"
}
}
{
"Code": "AgentDeploy",
"Data": {
"DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000060",
"DeploymentName": "invoice-agent",
"Status": "SuccessfulActivate",
"FolderKey": "a1b2c3d4-0000-0000-0000-000000000070",
"FolderId": 42,
"FolderName": "invoice-agent",
"ConfigurationKey": "a1b2c3d4-0000-0000-0000-000000000080",
"PackageVersionKey": "a1b2c3d4-0000-0000-0000-000000000050"
}
}
Apenas instalar (--skip-activate ou não pronto para ativar): mesma forma, com Status refletindo a fase de instalação (SuccessfulInstall, FailedInstall) e FolderName omitido quando a pasta não pôde ser resolvida.
FolderId— ID numérico da unidade de organização da pasta, preenchido apenas quando o provisionamento automático foi bem-sucedido. Passe-o diretamente parauip agent run list --folder-id.FolderKey— GUID da pasta de instalação.ConfigurationKeychave das soluçõesConfigurationcriada por esta implantação.PackageVersionKeyretornado pela entrada por conveniência.
Códigos de saída
Além dos códigos de CLI padrão:
0— instalação (e, opcionalmente, ativação) concluída com sucesso.1— falha na implantação (FailedInstall,FailedActivate), pesquisa com erro ou qualquer outra falha.2— uma fase de pesquisa expirou (consulte--timeout). A implantação ainda pode ser concluída no Orchestrator. executar novamente com um tempo limite mais longo ou inspecionar o status na interface gráfica do Orchestrator.
Consulte Códigos de saída para o contrato compartilhado.
Detalhes do provisionamento
Quando uma pasta é criada automaticamente (sem --folder-key), a implantação tenta:
- Atribua um modelo de máquina sem servidor de nível de tenant à pasta. Se não existir nenhum modelo serverless no tenant, o provisionamento falhará e a implantação exibirá um aviso — você deve atribuir um manualmente.
- Escolha um usuário atribuível e conceda a ele a função
Automation Userna pasta. Se essa função não existir no tenant, o provisionamento falhará com um aviso.
Os conflitos (HTTP 409) durante a atribuição da máquina ou do usuário são tratados como sucessos idempotentes.
Relacionado
uip agent publish— produz oPackageVersionKeyque este comando consome.uip agent run start— inicia um trabalho em uma versão na pasta implantada.uip agent run list— lista as versões que a implantação criou.
Veja também
- Orchestrator: trabalhos — o modelo de trabalho subjacente.
- Autenticação — sessões, tenants e
--login-validity. - Opções globais, Códigos de saída.