- Información general
- Comience ya
- Conceptos
- Uso de UiPath CLI
- UiPath para agentes de codificación
- Guías prácticas
- Recetas de CI/CD
- Referencia de los comandos
- Información general
- Códigos de salida
- Opciones globales
- agente de código UIP
- UIP Docsai
- añadir-entidad-de-datos-de-prueba
- añadir-cola-de-datos-de-prueba
- añadir-variación-de-datos-de-prueba
- Analizar
- Crear
- Crear proyecto
- Diferencia
- Buscar actividades
- obtener-reglas-del-analizador
- obtener-predeterminado-actividad-xaml
- obtener-errores
- obtener-casos-de-prueba-manual
- obtener-pasos-de-prueba-manual
- obtener versiones
- get-workflow-example
- indicar-aplicación
- indicar-elemento
- inspeccionar-paquete
- install-data-fabric-entities
- instalar-o-actualizar-paquetes
- enumerar-data-fabric-entities
- ejemplos-de-flujo-de-trabajo-de-lista
- Paquete
- restore
- archivo de ejecución
- plantillas-de-búsqueda
- iniciar-studio
- detener la ejecución
- UIA
- Seguimientos de UIP
- Migración
- Referencia y soporte
Guía del usuario de UiPath CLI
instala y activa una versión de paquete de agente publicada anteriormente en una carpeta uip agent deploy Orchestrator. Impulsa el proceso completo de implementación de soluciones (configurar → implementar → instalar → aprovisionar → activar) y sondea hasta que cada fase alcanza un estado terminal.
De forma predeterminada, el comando también aprovisiona la carpeta de destino para la ejecución inmediata: asigna una plantilla de máquina sin servidor en el nivel de tenant y vincula un usuario de robot con el rol Automation User a la carpeta. Los fallos de aprovisionamiento se muestran como advertencias en lugar de errores (puedes asignar la máquina y el usuario manualmente después del hecho).
Requiere una sesión CLI activa (uip login).
Sinopsis
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 las invocaciones uip agent deploy respetan las opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato estándar, con las anulaciones específicas de la implementación que se indican a continuación.
Argumentos
<packageVersionKey>(obligatorio) : clave de versión del paquete devuelta poruip agent publish(ruta de carga predeterminada). GUID.
Opciones
| Marca | Predeterminado | Propósito |
|---|---|---|
-n, --name <name> | agent-<timestamp> | Nombre de la implementación. Se convierte en el nombre para mostrar en Orchestrator y, para las carpetas creadas automáticamente, en el nombre de la carpeta. |
--folder-key <guid> | — (creación automática) | Clave de carpeta de instalación (GUID). Si se omite, se crea una nueva carpeta automáticamente durante la instalación. |
--force-activate | Desactivado | Forzar la activación incluso si existe una implementación anterior en esta clave de configuración. |
--skip-activate | Desactivado | Detener después de la fase de instalación; no activar. Útil cuando quieres revisar la instalación antes de lanzar el agente. |
-t, --tenant <tenant> | tenant de inicio de sesión | Tenant de destino. Obligatorio si la sesión de inicio de sesión no tiene tenant predeterminado. |
--timeout <seconds> | 120 | Máximo de segundos de espera para que cada fase de sondeo (instalar, activar) alcance un estado terminal. Cuando se agota el tiempo, el comando sale con el código 2. |
--login-validity <minutes> | 10 | Minutos mínimos de validez del token requeridos. |
Ejemplos
# 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
Forma de datos (--json de salida)
Instalación + activación completada (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"
}
}
Solo instalar (--skip-activate o no está listo para activar): la misma forma, con Status reflejando la fase de instalación (SuccessfulInstall, FailedInstall) y FolderName omitido cuando la carpeta no se pudo resolver.
FolderId: ID de la unidad organizativa numérica de la carpeta, que se rellena solo cuando el autoaprovisionamiento se ha realizado correctamente. Pásalo directamente auip agent run list --folder-id.FolderKey— GUID de la carpeta de instalación.ConfigurationKey: clave de las solucionesConfigurationcreadas por esta implementación.PackageVersionKey: se repite desde la entrada para mayor comodidad.
Códigos de salida
Además de los códigos CLI estándar:
0: la instalación (y opcionalmente la activación) se ha completado correctamente.1— implementación fallida (FailedInstall,FailedActivate), error de sondeo o cualquier otro fallo.2: se agotó el tiempo de espera de una fase de encuesta (ver--timeout). La implementación aún puede completarse en Orchestrator; volver a ejecutar con un tiempo de espera más largo o inspeccionar el estado en la IU de Orchestrator.
Consulta Códigos de salida para el contrato compartido.
Detalle de aprovisionamiento
Cuando una carpeta se crea automáticamente (no --folder-key), la implementación intenta:
- Asigna una plantilla de máquina sin servidor a nivel de tenant a la carpeta. Si no existe ninguna plantilla sin servidor en el tenant, el aprovisionamiento falla y la implementación muestra una advertencia; debes asignar una manualmente.
- Elige un usuario asignable y concédele el rol
Automation Useren la carpeta. Si no existe tal rol en el tenant, el aprovisionamiento falla con una advertencia.
Los conflictos (HTTP 409) durante la asignación de máquina o usuario se tratan como éxitos idempotentes.
Relacionado
uip agent publish— produce elPackageVersionKeyque consume este comando.uip agent run start: inicia un trabajo para una versión en la carpeta implementada.uip agent run list: enumera las versiones creadas por la implementación.
Ver también
- Orchestrator: trabajos : el modelo de trabajo subyacente.
- Autenticación : sesiones, tenants y
--login-validity. - Opciones globales, códigos de salida.