UiPath Documentation
uipath-cli
latest
false
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Guía del usuario de UiPath CLI

implementación de la solución uip

uip solution deploy un paquete de soluciones publicado (consulta uip solution publish) y lo instala en Orchestrator: crea una carpeta, aprovisiona recursos (colas, activos, procesos, depósitos, conexiones) y activa la implementación.

Esta página cubre todos los subcomandos de deploy, además del uip solution delete nivel superior que gestiona las soluciones de Studio Web (no las implementaciones).

SubcomandoPropósito
runImplementar un paquete publicado en Orchestrator.
statusComprobar el estado de la implementación de un proceso.
listEnumera las implementaciones existentes.
activateActiva una implementación que se instaló sin activación automática.
uninstallElimina una implementación y sus recursos aprovisionados.
config getObtener la configuración de implementación predeterminada para un paquete.
config setEstablece una propiedad de recurso en un archivo de configuración de implementación.
config linkVincula un recurso de solución a un recurso de Orchestrator existente.
config unlinkEliminar un enlace de recursos de un archivo de configuración de implementación.

También se documenta en esta página:

  • uip solution delete : un verbo de nivel superior que elimina una solución de Studio Web por ID. No es un subcomando de implementación; se documenta junto con estos comandos por razones de agrupación.

Cada subcomando se autentica. Ejecuta uip login primero o pasa --tenant para apuntar a un tenant específico.

Flujo de trabajo típico

deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       └─→ deploy uninstall  (tear down)
deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       └─→ deploy uninstall  (tear down)

ejecución de implementación de la solución uip

Implementa un paquete de soluciones publicado en Orchestrator. Crea una nueva carpeta (en --folder-path o --folder-key), aprovisiona cada recurso descrito en el paquete (o en --config-file) y sondea hasta que la implementación alcanza un estado terminal.

Sinopsis

uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--folder-path <path> | --folder-key <guid>] \
  [--config-file <path>] \
  [--tenant <tenant-name>] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]
uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--folder-path <path> | --folder-key <guid>] \
  [--config-file <path>] \
  [--tenant <tenant-name>] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

Opciones

  • -n, --name <deployment-name> requerido) — Nombre para la implementación. Utilizado por deploy status, activate y uninstall para identificar esta instalación.
  • --package-name <name> (obligatorio) : nombre del paquete de soluciones. Utiliza packages list para buscar los nombres disponibles.
  • --package-version <version> (obligatorio) : versión del paquete de soluciones. Utiliza packages list para encontrar las versiones disponibles.
  • (obligatorio) : nombre de la nueva carpeta --folder-name <name> Orchestrator creada para esta implementación (en --folder-path).
  • --folder-path <path> — Ruta de la carpeta principal (por ejemplo Shared). La carpeta de implementación se crea debajo de ella.
  • --folder-key <key> — Clave de la carpeta principal (GUID). Alternativa a --folder-path.
  • --config-file <path> — Archivo de configuración JSON. Genere con deploy config get, edítelo con config set / config link y luego páselo aquí.
  • -t, --tenant <tenant-name> — Tenant en el que implementar.
  • --timeout <seconds> — Tiempo de espera de sondeo de implementación. El valor predeterminado es 360.
  • --poll-interval <ms> : milisegundos entre encuestas de estado. El valor predeterminado es 5000.
  • --login-validity <minutes> — Minutos mínimos antes de la caducidad del token para desencadenar una actualización. El valor predeterminado es 10.

Ejemplos

Común
uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared"
uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared"
Con una configuración personalizada
uip solution deploy config get my-package -d ./deploy-config.json
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared" \
  --config-file ./deploy-config.json
uip solution deploy config get my-package -d ./deploy-config.json
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared" \
  --config-file ./deploy-config.json
Creación de scripts: captura el ID de implementación para las llamadas de seguimiento
PIPELINE_ID=$(uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --folder-path "Shared" \
  --output-filter "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"
PIPELINE_ID=$(uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --folder-path "Shared" \
  --output-filter "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

Forma de datos (--json de salida)

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution"
  }
}
{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution"
  }
}

Estados de implementación del terminal: DeploymentSucceeded, DeploymentFailed, ValidationFailed, ConflictFixingError, DeploymentScheduleError. Los estados terminales no correctos salen con 1 y agregan los errores de validación/conflicto/programación/flujo de trabajo en el campo Instructions .

Comportamiento del tiempo de espera

Si la implementación no alcanza un estado terminal antes de que transcurra --timeout , el comando sale distinto de cero con un puntero a deploy status <pipeline-deployment-id> para que puedas continuar con la supervisión.


estado de implementación de la solución uip

Comprueba el estado actual de la implementación de un proceso. Devuelve el estado de implementación y, si está disponible, el nombre/paquete/versión de la implementación y un resumen de errores concatenado.

Argumentos

  • <pipeline-deployment-id> (obligatorio) : el PipelineDeploymentId devuelto por deploy run.

Opciones

  • -t, --tenant <tenant-name> — Tenant a consultar.
  • --login-validity <minutes> — El valor predeterminado es 10.

Ejemplo

uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001
uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001

Forma de datos (--json de salida)

{
  "Code": "SolutionDeployStatus",
  "Data": {
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "ConfigurationKey": "...",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "DeploymentResult": {
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "Status": "Successful",
      "StartDate": "2026-04-15T10:30:00Z",
      "EndDate": "2026-04-15T10:31:12Z",
      "Errors": null
    }
  }
}
{
  "Code": "SolutionDeployStatus",
  "Data": {
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "ConfigurationKey": "...",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "DeploymentResult": {
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "Status": "Successful",
      "StartDate": "2026-04-15T10:30:00Z",
      "EndDate": "2026-04-15T10:31:12Z",
      "Errors": null
    }
  }
}

lista de implementación de soluciones de uip

Enumera las implementaciones de soluciones. Muestra el nombre de la implementación, el estado, la versión del paquete y la ruta de la carpeta.

Opciones

  • -t, --tenant <tenant-name> — Tenant a consultar.
  • --folder-path <path> — Filtrar por ruta de la carpeta principal. El filtrado se aplica después de la obtención; aumente --take si los resultados parecen incompletos al utilizar este filtro.
  • --folder-key <key> — Filtrar por clave de carpeta principal (GUID). Alternativa a --folder-path.
  • --take <number> — Máximo de implementaciones para recuperar. El valor predeterminado es 10.
  • --order-by <column> — Columna por la que ordenar. El valor predeterminado es startTime.
  • --order-direction <direction>Ascending o Descending. El valor predeterminado es Descending.
  • --login-validity <minutes> — El valor predeterminado es 10.

Ejemplo

uip solution deploy list --take 20 --folder-path "Shared/Production"
uip solution deploy list --take 20 --folder-path "Shared/Production"

Forma de datos (--json de salida)

{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "InstallDeploymentKey": "…",
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "OperationStatus": "Successful",
      "ActivationStatus": "Activated",
      "FolderPath": "Shared/Production",
      "FolderKey": "…",
      "CreatedAt": "2026-04-15T10:30:00Z"
    }
  ]
}
{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "InstallDeploymentKey": "…",
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "OperationStatus": "Successful",
      "ActivationStatus": "Activated",
      "FolderPath": "Shared/Production",
      "FolderKey": "…",
      "CreatedAt": "2026-04-15T10:30:00Z"
    }
  ]
}

implementación de la solución uip activar

Activa una implementación que se instaló sin activación automática. La activación aprovisiona todos los componentes de la solución. activate primero imprime los pasos de preactivación informados por Orchestrator (a stderr, a través de --log-level info), luego llama a activar y sondea hasta un estado terminal (SuccessfulActivate o FailedActivate).

Argumentos

  • <deployment-name> obligatorio) : nombre de la implementación que se va a activar. Utiliza deploy list para buscar nombres de implementación.

Opciones

  • -t, --tenant <tenant-name> — Tenant a destino.
  • --timeout <seconds> — Tiempo de espera de sondeo de activación. El valor predeterminado es 360.
  • --poll-interval <ms> : milisegundos entre encuestas de estado. El valor predeterminado es 5000.
  • --login-validity <minutes> — El valor predeterminado es 10.

Ejemplo

uip solution deploy activate my-deployment
uip solution deploy activate my-deployment

Forma de datos (--json de salida)

{
  "Code": "SolutionDeployActivate",
  "Data": {
    "Status": "SuccessfulActivate",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}
{
  "Code": "SolutionDeployActivate",
  "Data": {
    "Status": "SuccessfulActivate",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

Si Orchestrator no informa instanceId (nada que sondear), Status es Activation completed (no instance to poll) y el comando se devuelve correctamente.


implementación de la solución uip desinstalación

Desinstala una solución implementada. Elimina todos los recursos aprovisionados y la carpeta de la solución.

Argumentos

  • <deployment-name> obligatorio) : nombre de la implementación que se va a desinstalar.

Opciones

  • -t, --tenant <tenant-name> — Tenant a destino.
  • --timeout <seconds> — Tiempo de espera de sondeo de desinstalación. El valor predeterminado es 360.
  • --poll-interval <ms> : milisegundos entre encuestas de estado. El valor predeterminado es 5000.
  • --login-validity <minutes> — El valor predeterminado es 10.

Ejemplo

uip solution deploy uninstall my-deployment
uip solution deploy uninstall my-deployment

Forma de datos (--json de salida)

{
  "Code": "SolutionDeployUninstall",
  "Data": {
    "Status": "SuccessfulUninstall",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}
{
  "Code": "SolutionDeployUninstall",
  "Data": {
    "Status": "SuccessfulUninstall",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

Son posibles dos respuestas de corto circuito:

  • Uninstall completed immediately — cuando Orchestrator informa complete: true en la primera llamada; no se realiza ningún sondeo.
  • Uninstall scheduled Orchestrator programa el trabajo sin devolver un ID de instancia; los datos incluyen el campo Scheduled de la API.

obtener configuración de implementación de la solución uip

Obtener la configuración de implementación predeterminada para un paquete de soluciones publicado. La configuración enumera todos los recursos que creará la solución (colas, activos, procesos, depósitos, conexiones, ...) con su configuración predeterminada. Guárdalo en un archivo (-d), personalízalo con config set / config link y luego pásalo a deploy run --config-file.

Argumentos

  • <package-name> (obligatorio) : nombre del paquete de soluciones. Usa packages list.

Opciones

  • --package-version <version> — Versión del paquete. Si se omite, se utiliza la opción Más reciente.
  • -d, --destination <path> — Escribe la configuración en este archivo en lugar de stdout.
  • -t, --tenant <tenant-name> — Tenant a consultar.
  • --login-validity <minutes> — El valor predeterminado es 10.

Ejemplo

uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json
uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json

Forma de datos (--json de salida)

Cuando se proporciona -d :

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "Status": "Configuration written",
    "OutputPath": "/workspace/deploy-config.json",
    "PackageName": "my-package"
  }
}
{
  "Code": "SolutionDeployConfig",
  "Data": {
    "Status": "Configuration written",
    "OutputPath": "/workspace/deploy-config.json",
    "PackageName": "my-package"
  }
}

Cuando se omite -d , la configuración se incrusta en la respuesta:

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "Configuration": { "resources": [ ... ] }
  }
}
{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "Configuration": { "resources": [ ... ] }
  }
}

conjunto de configuraciones de implementación de la solución uip

Edita una propiedad de recurso en un archivo de configuración de implementación. El archivo permanece local hasta que lo pases a deploy run --config-file.

Argumentos

  • <file> (obligatorio) : ruta al archivo JSON de configuración de implementación (producido por config get).
  • <args...> (requerido) — Depende de --all:
    • Sin --all: <resource> <property> <value> — p. ej. MyQueue maxNumberOfRetries 5.
    • Con --all: <property> <value> : se aplica a todos los recursos del archivo. Solo es válido para la propiedad conflictFixingAction de nivel superior.

Opciones

  • --all — Aplicar la propiedad a todos los recursos del archivo. Solo se permite con conflictFixingAction (p. ej. UseExisting).

Ejemplos

Cambiar reintentos en una sola cola
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5
Establezca una política de solución de conflictos en cada recurso
uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting
uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting

Forma de datos (--json de salida)

Actualización de un solo recurso:

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "MyQueue",
    "Property": "maxNumberOfRetries",
    "OldValue": 1,
    "NewValue": 5
  }
}
{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "MyQueue",
    "Property": "maxNumberOfRetries",
    "OldValue": 1,
    "NewValue": 5
  }
}

Actualización masiva (--all):

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "all",
    "Property": "conflictFixingAction",
    "NewValue": "UseExisting",
    "ResourceCount": 12
  }
}
{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "all",
    "Property": "conflictFixingAction",
    "NewValue": "UseExisting",
    "ResourceCount": 12
  }
}

Vincula un recurso de solución a un recurso de Orchestrator existente , para que la implementación lo reutilice en lugar de crear uno nuevo. Los cambios son locales: aplícalos pasando el archivo a deploy run --config-file.

Argumentos

  • <file> obligatorio) : ruta al archivo JSON de configuración de implementación.
  • <resource> (obligatorio) : nombre del recurso o resourceKey desde el archivo de configuración.

Opciones

  • -n, --name <name> obligatorio) : nombre del recurso de Orchestrator existente al que vincular.
  • --folder-path <path> — Ruta de la carpeta de Orchestrator donde reside el recurso existente.

Ejemplo

uip solution deploy config link ./deploy-config.json MyQueue \
  --name ProductionQueue \
  --folder-path "Shared/Production"
uip solution deploy config link ./deploy-config.json MyQueue \
  --name ProductionQueue \
  --folder-path "Shared/Production"

Forma de datos (--json de salida)

{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}
{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}

Eliminar un enlace establecido previamente con config link. En el siguiente deploy run --config-file, el recurso se creará de nuevo en lugar de reutilizarse.

Argumentos

  • <file> obligatorio) : ruta al archivo JSON de configuración de implementación.
  • <resource> (obligatorio) : nombre del recurso o resourceKey para desvincular.

Ejemplo

uip solution deploy config unlink ./deploy-config.json MyQueue
uip solution deploy config unlink ./deploy-config.json MyQueue

Forma de datos (--json de salida)

{
  "Code": "DeployConfigUnlink",
  "Data": {
    "Resource": "MyQueue",
    "UnlinkedFrom": "ProductionQueue"
  }
}
{
  "Code": "DeployConfigUnlink",
  "Data": {
    "Resource": "MyQueue",
    "UnlinkedFrom": "ProductionQueue"
  }
}

Modos de fallo

  • El recurso no está vinculado actualmente. El comando rechaza la desvinculación y apunta a config link.

eliminación de solución uip

uip solution delete es un verbo de nivel superior (no un subcomando deploy ) que elimina una solución de Studio Web por su ID de solución. El ID es emitido por uip solution upload y por flow debug en su salida.

Esto no desinstala una solución implementada de Orchestrator: utiliza deploy uninstall para ello.

Sinopsis

uip solution delete <solution-id>
uip solution delete <solution-id>

Argumentos

  • <solution-id> obligatorio) : el ID de la solución de Studio Web (UUID).

Ejemplo

uip solution delete a1b2c3d4-0000-0000-0000-000000000001
uip solution delete a1b2c3d4-0000-0000-0000-000000000001

Forma de datos (--json de salida)

{
  "Code": "SolutionDelete",
  "Data": {
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}
{
  "Code": "SolutionDelete",
  "Data": {
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

Ver también

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado