UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
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.

implementación de la solución uip

Sintaxis y opciones para `implementación de soluciones de uip`, que instala, actualiza, activa y desinstala implementaciones de soluciones en Orchestrator.

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.

Nota:

run, status, and list accept --feed <name-or-key> to work with a folder feed. Refer to uip solution feeds to list the feeds you can reach. For more information about folder feeds, refer to Solution feed in the Solutions Management documentation.

SubcomandoPropósito
runInstall a deployment from a published package.
upgradeMove an existing deployment to another published version of its package, in place.
statusCheck the state of a deployment, by name or key, or the progress of a pipeline deployment run.
listEnumera las implementaciones existentes.
activateActiva una implementación que se instaló sin activación automática.
uninstallElimina una implementación y sus recursos aprovisionados.
deleteDelete a deployment record that uninstall cannot remove.
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.

Cada subcomando se autentica. Ejecuta uip login primero.

Flujo de trabajo típico​

deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       ├─→ deploy upgrade    (new package version, same deployment)
                                                       └─→ deploy uninstall  (tear down)  →  deploy delete
deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       ├─→ deploy upgrade    (new package version, same deployment)
                                                       └─→ deploy uninstall  (tear down)  →  deploy delete

deploy run is keyed on --name. A name that does not exist yet gets a new deployment in a new folder. If the package is already deployed, deploy run stops and points to deploy upgrade, which moves the existing deployment to another version in place. To install a second, separate copy, pass -y, --yes with a different --name.


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

Install a solution deployment in Orchestrator from a published package. Creates a new folder (under --parent-folder-path or --parent-folder-key, or the current user's Personal Workspace), provisions every resource described in the package (or in --config-file), and, unless --skip-activate is set, activates it.

The deployment is keyed on --name. Before installing, the command checks whether the package already has a deployment; if so, it stops and points to deploy upgrade. The check is best-effort: a lookup failure only warns, and under an External Application (client-credentials) login an existing deployment is reported as a warning instead of stopping the deploy.

The package is validated against the target before anything is installed. A validation failure ends the run at ValidationFailed with the errors in Instructions, and nothing is installed. The rejected attempt is kept as a pending draft: fix the configuration and re-run the same command, and the server validates the draft again with the new file. Settings and resource links that the file does not name keep the values the draft was rejected with.

Sinopsis​

uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--parent-folder-path <path> | --parent-folder-key <guid> | --personal-workspace] \
  [--feed <name-or-key>] \
  [--config-file <path>] \
  [--skip-activate] \
  [-y, --yes] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]
uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--parent-folder-path <path> | --parent-folder-key <guid> | --personal-workspace] \
  [--feed <name-or-key>] \
  [--config-file <path>] \
  [--skip-activate] \
  [-y, --yes] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

Opciones​

LargoValorPredeterminadoDescripción
-n, --name <deployment-name>text—Required. Name for the deployment. Used by deploy status, deploy upgrade, deploy activate, deploy uninstall, and deploy delete to identify this install.
--package-name <name>text—Obligatorio. Nombre del paquete de soluciones. Utiliza packages list para encontrar los nombres disponibles.
--package-version <version>text—Obligatorio. Versión del paquete de soluciones.
--folder-name <name>text—Obligatorio. Nombre de la nueva carpeta de Orchestrator creada para esta implementación.
--parent-folder-path <path>Ruta—Ruta de la carpeta principal (por ejemplo, Shared). La carpeta de implementación se crea debajo de ella. Mutuamente exclusivo con --parent-folder-key y --personal-workspace.
--parent-folder-key <key>GUID—Clave de la carpeta principal. Alternativa a --parent-folder-path.
--personal-workspaceMarcaDesactivadoDeploy into the current user's Personal Workspace. The workspace name is resolved from Orchestrator automatically. Requires a user login; an External Application has no Personal Workspace. Mutually exclusive with --parent-folder-path, --parent-folder-key, and --feed.
--feed <name-or-key>textTransmisión de inquilinosDeploy a package published to this feed (name or folder key, from solution feeds list) instead of the tenant feed. This scopes which feed the package comes from — the --parent-folder-path/--parent-folder-key/--personal-workspace flags still control where the Orchestrator folder is created. Requires a user login; an External Application login is refused instead of deploying to the tenant feed. Mutually exclusive with --personal-workspace.
--config-file <path>Ruta—Archivo de configuración JSON o YAML. Generar con deploy config get, editar con config set / config link y luego pasarlo aquí.
--skip-activateMarcaDesactivadoOmitir la activación automática; deja la implementación en estado Inactive (Ready to activate). Activar más tarde con deploy activate.
-y, --yesMarcaDesactivadoDeploy even when this package already has a deployment. Without it, the command looks the package up and stops if it is already deployed. The check is best-effort: a lookup failure only warns, and under an External Application (client-credentials) login an existing deployment is reported as a warning instead of stopping the deploy. --yes only skips the check. Re-using an existing deployment's --name updates that deployment in place; pass a different --name for a separate copy.
--timeout <seconds>segundos360Tiempo de espera de sondeo aplicado por fase: implementación y (si no se omite) activación.
--poll-interval <ms>ms5000Milisegundos entre sondeos de estado durante las fases de implementación y activación.
--login-validity <minutes>minutos10Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

Ejemplos​

Común​
uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --parent-folder-path "Shared"
uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --parent-folder-path "Shared"
Omitir la activación automática​
uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --parent-folder-path "Shared" \
  --skip-activate
uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --parent-folder-path "Shared" \
  --skip-activate
Into the Personal Workspace​
uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --personal-workspace
uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --personal-workspace
Una segunda copia independiente de un paquete ya implementado​
uip solution deploy run \
  --name my-deployment-2 \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolutionCopy --parent-folder-path "Shared" --yes
uip solution deploy run \
  --name my-deployment-2 \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolutionCopy --parent-folder-path "Shared" --yes
Desde una fuente de carpeta​
uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --feed Finance
uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --feed Finance
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 --parent-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 --parent-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 --parent-folder-path "Shared" \
  --output-filter "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 --parent-folder-path "Shared" \
  --output-filter "PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

Forma de datos (--json de salida)​

The command waits for the deployment to finish, bounded by --timeout:

{
  "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",
    "ActivationStatus": "SuccessfulActivate"
  }
}
{
  "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",
    "ActivationStatus": "SuccessfulActivate"
  }
}

A deployment that installed but needs Setup activation in Orchestrator before it can be activated returns Result: Success with ActivationStatus: NeedsSetupToActivate. Do not deploy it again; configure the listed resources and activate it:

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000003",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000003",
    "InstanceId": null,
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution",
    "ActivationStatus": "NeedsSetupToActivate",
    "PendingResources": [
      {
        "Kind": "connection",
        "Name": "Outlook",
        "Type": "uipath-microsoft-outlook365",
        "Reason": "[CNS1072] You will need to authenticate this connection before proceeding further"
      }
    ],
    "NextSteps": [
      "Deployment 'my-deployment' is installed at version 1.0.0 but not live: it needs 'Setup activation' before it can be activated.",
      "Resources that need configuration: connection 'Outlook' (uipath-microsoft-outlook365): [CNS1072] You will need to authenticate this connection before proceeding further."
    ]
  }
}
{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000003",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000003",
    "InstanceId": null,
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution",
    "ActivationStatus": "NeedsSetupToActivate",
    "PendingResources": [
      {
        "Kind": "connection",
        "Name": "Outlook",
        "Type": "uipath-microsoft-outlook365",
        "Reason": "[CNS1072] You will need to authenticate this connection before proceeding further"
      }
    ],
    "NextSteps": [
      "Deployment 'my-deployment' is installed at version 1.0.0 but not live: it needs 'Setup activation' before it can be activated.",
      "Resources that need configuration: connection 'Outlook' (uipath-microsoft-outlook365): [CNS1072] You will need to authenticate this connection before proceeding further."
    ]
  }
}

With --skip-activate, ActivationStatus is Skipped.

RequestedFolderName y FolderNote solo aparecen cuando el --folder-name solicitado ya estaba en uso: Orchestrator cambia el nombre de la carpeta por colisión en lugar de reutilizarla, por lo que los FolderName/FolderPath reales difieren de lo que se solicitó, y FolderNote explica el cambio de nombre con un puntero para utilizar la carpeta renombrada o volver a ejecutar con un nombre libre.

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.

Modos de fallo​

  • The package already has a deployment. Refused unless -y, --yes is passed. Use deploy upgrade to move the existing deployment to a new version, or pass --yes with a different --name to install a second, separate copy.
  • Validation failed. The run ends at ValidationFailed and nothing is installed. The rejected attempt is kept as a pending draft; fix the configuration and re-run the command. When the run was an update of an existing deployment, Instructions also names the deploy upgrade <deployment-key> --discard-draft --version <version> command that discards the draft and upgrades the live version instead.
  • --name has a pending draft for another version. Refused. Re-run with the draft's --package-version to retry the draft, or discard it with deploy upgrade --discard-draft.
  • --name existe, vinculado a un --package-name diferente. Falla por completo: un nombre de implementación no puede cambiar paquetes a través de deploy run.
  • Ya hay una implementación para --name en curso. Fallo: la operación anterior debe finalizar primero.

actualización de implementación de la solución uip​

Upgrade an existing deployment to another published version of its package, in place. This is the CLI equivalent of the Upgrade button in Orchestrator. Use it when deploy run stops because the package is already deployed. The deployment's existing configuration is preserved, so values already set on it (for example a credential asset's secret) are not reset to the package defaults.

The package is validated against the target before anything is installed. A validation failure reports the errors and leaves the deployment on its current version. The command waits for the upgrade to finish unless --no-wait is passed; track a running upgrade with deploy status <pipeline-deployment-id>.

Sinopsis​

uip solution deploy upgrade <deployment-key> [options]
uip solution deploy upgrade --name <deployment-name> --package-name <name> [options]
uip solution deploy upgrade <deployment-key> [options]
uip solution deploy upgrade --name <deployment-name> --package-name <name> [options]

Address the deployment either by key or by --name with --package-name, not both.

Argumentos​

  • [deployment-key] — Key of the deployment to upgrade, as deploy list reports it (Key), or a stored InstallDeploymentKey. The deployment's name, package, current version, and feed are read from the server, so --package-name and --personal-workspace are not needed. Use either this or --name with --package-name.

Opciones​

LargoValorPredeterminadoDescripción
-n, --name <deployment-name>text—Name of the deployment to upgrade, as reported by deploy list. Goes with --package-name. The command checks that the name exists before installing, so a mistyped name is refused instead of creating a new deployment.
--package-name <name>text—The deployment's package. Required with --name.
--version <version>textnewest publishedTarget package version. Any published version of the same package is accepted, including an older one. An empty value is refused.
--personal-workspaceMarcaDesactivadoWith --name: upgrade a deployment in your Personal Workspace feed instead of the tenant. With a key, the feed is read from the deployment and this flag is not needed.
--discard-draftMarcaDesactivadoWhen the deployment has a pending draft (an earlier attempt that never completed, usually one rejected by validation), discard the draft first and upgrade the live version. Without it, such a deployment is refused, because the server would re-run the draft with the configuration it was rejected for. With --name, the draft is found only under a user login; under an External Application, pass the deployment key.
--no-waitMarcaDesactivadoVuelve tan pronto como se acepte la actualización, en lugar de esperar a que finalice.
--timeout <seconds>segundos300Segundos de espera para que finalice la actualización.
--poll-interval <ms>ms5000Milisegundos entre encuestas de estado.
--login-validity <minutes>minutos10Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

Both forms work under an External Application (client-credentials) login, so they can run from a CI/CD pipeline. A deployment in a Personal Workspace or folder feed requires a user login. The --name form has no --feed option; to upgrade a deployment in a folder feed, pass its key.

Ejemplos​

# By key, to the newest published version
uip solution deploy upgrade c3d4e5f6-0000-0000-0000-000000000003

# By name, to the newest published version
uip solution deploy upgrade --name my-deployment --package-name my-package

# To a specific published version (for example from a CI/CD pipeline)
uip solution deploy upgrade --name my-deployment --package-name my-package --version 1.5.0

# Start the upgrade without waiting
uip solution deploy upgrade --name my-deployment --package-name my-package --no-wait

# Discard the pending draft a rejected attempt left behind, then upgrade the live version
uip solution deploy upgrade c3d4e5f6-0000-0000-0000-000000000003 --version 2.0.0 --discard-draft
# By key, to the newest published version
uip solution deploy upgrade c3d4e5f6-0000-0000-0000-000000000003

# By name, to the newest published version
uip solution deploy upgrade --name my-deployment --package-name my-package

# To a specific published version (for example from a CI/CD pipeline)
uip solution deploy upgrade --name my-deployment --package-name my-package --version 1.5.0

# Start the upgrade without waiting
uip solution deploy upgrade --name my-deployment --package-name my-package --no-wait

# Discard the pending draft a rejected attempt left behind, then upgrade the live version
uip solution deploy upgrade c3d4e5f6-0000-0000-0000-000000000003 --version 2.0.0 --discard-draft

Forma de datos (--json de salida)​

Upgrade by key:

{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "DeploymentSucceeded",
    "Operation": "VersionChange",
    "DeploymentStatus": "SuccessfulActivate",
    "Actions": ["Uninstall", "Upgrade"],
    "DeploymentName": "my-deployment",
    "FromVersion": "1.5.0",
    "ToVersion": "2.0.0",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000002",
    "DeploymentKey": "d4e5f6a7-0000-0000-0000-000000000004",
    "InstallDeploymentKey": "c3d4e5f6-0000-0000-0000-000000000003"
  }
}
{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "DeploymentSucceeded",
    "Operation": "VersionChange",
    "DeploymentStatus": "SuccessfulActivate",
    "Actions": ["Uninstall", "Upgrade"],
    "DeploymentName": "my-deployment",
    "FromVersion": "1.5.0",
    "ToVersion": "2.0.0",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000002",
    "DeploymentKey": "d4e5f6a7-0000-0000-0000-000000000004",
    "InstallDeploymentKey": "c3d4e5f6-0000-0000-0000-000000000003"
  }
}

Con --no-wait:

{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "Accepted",
    "DeploymentName": "my-deployment",
    "ToVersion": "2.0.0",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000002"
  }
}
{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "Accepted",
    "DeploymentName": "my-deployment",
    "ToVersion": "2.0.0",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000002"
  }
}
CampoDescripción
StatusTerminal pipeline status (DeploymentSucceeded), or Accepted when --no-wait returned before the upgrade finished.
OperationWhat the server did: VersionChange for a version move, or ConfigurationChange when the requested version was already deployed. Absent with --no-wait.
DeploymentStatusSuccessfulActivate when the new version runs, or SuccessfulInstall when it is installed but waits for activation setup (the previous version keeps running). Absent with --no-wait.
ActionsOperations available on the deployment next (for example SetupActivation, Uninstall, Upgrade).
ActivationStatus, PendingResources, NextStepsPresent when the new version does not run yet, for example ActivationStatus: NeedsSetupToActivate with the resources that need configuration. Same shape as deploy run.
FromVersionVersion deployed before the upgrade. Key form only.
ToVersionVersion the upgrade targeted.
PipelineDeploymentIdID of the pipeline run that performs the upgrade. Pass it to deploy status.
DeploymentKeyKey of the upgraded deployment record. Absent with --no-wait.
InstallDeploymentKeyKey of the original install. It stays the same across upgrades, so it is the key to store. Key form only.
DiscardedDraftKeyKey of the pending draft that --discard-draft deleted. Present only when one was discarded.

Modos de fallo​

  • Both a key and --name passed, or --name without --package-name. Refused.
  • No deployment found for the key, or for the name in that feed. Refused.
  • The deployment is uninstalled. Refused, because an install would create a new deployment. Use deploy run to deploy the package again.
  • The deployment has a pending draft. Refused unless --discard-draft is passed.
  • The deployment is in a Personal Workspace or folder feed and the login is an External Application. Refused; use a user login.
  • The target version is not published in the feed. Refused.
  • Validation, conflict fixing, scheduling, or the install failed. The command exits with 1 and reports the errors. The deployment stays on the version it was already running. When the failure left a pending draft, Instructions names the --discard-draft command to retry with.
  • Timeout. The upgrade did not finish within --timeout. It may still be running; check it with deploy status <pipeline-deployment-id>.

estado de implementación de la solución uip​

Check the state of a deployment by name, or by a deployment key from deploy list or deploy upgrade: operation, activation status, and what is left to do before it runs. The command also takes the pipeline deployment ID from deploy run and returns that run's progress and errors.

Argumentos​

  • <deployment> (required) — Deployment name (preferred), a deployment key, or a pipeline deployment ID. A key is resolved across every feed, and a superseded key is answered with the deployment's current record.

Opciones​

LargoValorPredeterminadoDescripción
--feed <name-or-key>text—For a deployment name: the feed to look it up in (name or folder key, from solution feeds list). Without --feed or --personal-workspace, a name is looked up across the feeds. Mutually exclusive with --personal-workspace.
--personal-workspaceMarcaDesactivadoFor a deployment name: look it up in your Personal Workspace feed instead of the tenant.
--login-validity <minutes>minutos10Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

--personal-workspace, and --feed with a deployment name, require a user login; an External Application login is refused.

Ejemplos​

# By deployment name
uip solution deploy status my-deployment

# By deployment key
uip solution deploy status a1b2c3d4-0000-0000-0000-000000000001

# By name, in your Personal Workspace feed
uip solution deploy status my-deployment --personal-workspace

# The pipeline deployment run that deploy run started
uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001
# By deployment name
uip solution deploy status my-deployment

# By deployment key
uip solution deploy status a1b2c3d4-0000-0000-0000-000000000001

# By name, in your Personal Workspace feed
uip solution deploy status my-deployment --personal-workspace

# The pipeline deployment run that deploy run started
uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001

Forma de datos (--json de salida)​

A deployment addressed by name or key returns Code: SolutionDeployment. This example is a deployment that is upgraded but not live yet:

{
  "Code": "SolutionDeployment",
  "Data": {
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000002",
    "Superseded": false,
    "CurrentDeploymentKey": "a1b2c3d4-0000-0000-0000-000000000002",
    "InstallDeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "my-deployment",
    "PackageName": "my-package",
    "PackageVersion": "2.0.0",
    "NewPackageVersionAvailable": null,
    "Operation": "VersionChange",
    "OperationStatus": "Successful",
    "DeploymentStatus": "SuccessfulInstall",
    "ActivationStatus": "NeedsSetupToActivate",
    "Actions": ["SetupActivation", "Uninstall", "Upgrade"],
    "PendingResources": [
      {
        "Kind": "connection",
        "Name": "Outlook",
        "Type": "uipath-microsoft-outlook365",
        "Reason": "[CNS1072] You will need to authenticate this connection before proceeding further"
      }
    ],
    "NextSteps": [
      "Deployment 'my-deployment' is installed at version 2.0.0 but not live: it needs 'Setup activation' before it can be activated.",
      "Resources that need configuration: connection 'Outlook' (uipath-microsoft-outlook365): [CNS1072] You will need to authenticate this connection before proceeding further."
    ]
  }
}
{
  "Code": "SolutionDeployment",
  "Data": {
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000002",
    "Superseded": false,
    "CurrentDeploymentKey": "a1b2c3d4-0000-0000-0000-000000000002",
    "InstallDeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "my-deployment",
    "PackageName": "my-package",
    "PackageVersion": "2.0.0",
    "NewPackageVersionAvailable": null,
    "Operation": "VersionChange",
    "OperationStatus": "Successful",
    "DeploymentStatus": "SuccessfulInstall",
    "ActivationStatus": "NeedsSetupToActivate",
    "Actions": ["SetupActivation", "Uninstall", "Upgrade"],
    "PendingResources": [
      {
        "Kind": "connection",
        "Name": "Outlook",
        "Type": "uipath-microsoft-outlook365",
        "Reason": "[CNS1072] You will need to authenticate this connection before proceeding further"
      }
    ],
    "NextSteps": [
      "Deployment 'my-deployment' is installed at version 2.0.0 but not live: it needs 'Setup activation' before it can be activated.",
      "Resources that need configuration: connection 'Outlook' (uipath-microsoft-outlook365): [CNS1072] You will need to authenticate this connection before proceeding further."
    ]
  }
}
CampoDescripción
DeploymentKeyThe key that was requested.
Supersededtrue when a later operation replaced the requested record. The state fields then describe the current record, and NextSteps names the key to use. null when the chain of records could not be read.
CurrentDeploymentKeyKey of the deployment's current record.
InstallDeploymentKeyKey of the original install, stable across upgrades.
DeploymentStatusSuccessfulActivate when the version runs, SuccessfulInstall when it waits for activation or its setup.
ActivationStatusActivation state, for example Active, ReadyToActivate, or NeedsSetupToActivate. null when it could not be read.
ActionsOperations available on the deployment. null when they could not be read.
PendingResourcesResources that need configuration before activation. Present only when the deployment waits for setup.
NextStepsWhat is left before the deployment runs. Absent when it runs.

A pipeline deployment ID returns Code: SolutionDeployStatus with the run's progress:

{
  "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
    }
  }
}

The pipeline service tracks a run only while it is active. After the run ends, check the deployment by name or key instead.


lista de implementación de soluciones de uip​

Enumera las implementaciones de soluciones. Muestra el nombre de la implementación, la versión del paquete actual/de destino, la operación pendiente, el estado de activación y la ruta de la carpeta.

Opciones​

LargoValorPredeterminadoDescripción
--folder-path <path>Ruta—Filter by the full path of the folder the deployment was installed into (for example Shared or Shared/Finance). Exact match, not case-sensitive; subfolders are not included. Applied server-side.
--folder-key <key>GUID—Filter by the key of the folder the deployment was installed into. Alternative to --folder-path. Applied server-side.
-l, --limit <number>Número50Máximo de implementaciones para recuperar.
--offset <number>Número0Number of deployments to skip.
--sort-by <column>textstartTimeColumna por la que ordenar.
--sort-order <direction>Ascending | DescendingDescendingOrdenar dirección.
--operation-status <statuses>separados por comas—Server-side filter by operation status. One or more of Draft, Successful, Failed, InProgress, FailedRollback.
--activation-status <statuses>separados por comas—Server-side filter by activation status. One or more of None, Active, Inactive, ActivationFailed, DeactivationFailed, ReadyToActivate, NeedsSetupToActivate.
--personal-workspaceMarcaDesactivadoEnumera solo las implementaciones de la fuente del espacio de trabajo personal del usuario actual. Mutuamente exclusivo con --feed.
--feed <name-or-key>text—Only list deployments from this feed (name or folder key, from solution feeds list). Mutually exclusive with --personal-workspace.
--login-validity <minutes>minutos10Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

Both --operation-status and --activation-status reject values outside these lists, and the error message lists the valid values.

Ejemplos​

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

# Spot a pending in-place upgrade
uip solution deploy list --operation-status InProgress
uip solution deploy list --limit 20 --folder-path "Shared/Production"

# Spot a pending in-place upgrade
uip solution deploy list --operation-status InProgress

Forma de datos (--json de salida)​

{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000002",
      "InstallDeploymentKey": "b2c3d4e5-0000-0000-0000-000000000002",
      "Name": "billing-solution",
      "PackageName": "billing-solution",
      "PackageVersion": "1.0.0",
      "CurrentPackageVersion": "1.0.0",
      "TargetPackageVersion": "2.0.0",
      "NewPackageVersionAvailable": "2.0.0",
      "Operation": "VersionChange",
      "OperationStatus": "InProgress",
      "ActivationStatus": "Active",
      "FolderPath": "Shared/Billing",
      "FolderKey": "c3d4e5f6-0000-0000-0000-000000000002",
      "CreatedAt": "2026-04-15T10:30:00Z",
      "Actions": ["Upgrade"]
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0, "Total": 1 }
}
{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000002",
      "InstallDeploymentKey": "b2c3d4e5-0000-0000-0000-000000000002",
      "Name": "billing-solution",
      "PackageName": "billing-solution",
      "PackageVersion": "1.0.0",
      "CurrentPackageVersion": "1.0.0",
      "TargetPackageVersion": "2.0.0",
      "NewPackageVersionAvailable": "2.0.0",
      "Operation": "VersionChange",
      "OperationStatus": "InProgress",
      "ActivationStatus": "Active",
      "FolderPath": "Shared/Billing",
      "FolderKey": "c3d4e5f6-0000-0000-0000-000000000002",
      "CreatedAt": "2026-04-15T10:30:00Z",
      "Actions": ["Upgrade"]
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0, "Total": 1 }
}

Key is the value deploy upgrade and deploy status accept as a deployment key. NewPackageVersionAvailable is non-null when a newer published version exists than the one currently deployed. Actions lists operations currently available on the deployment (for example ["Upgrade"]).


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​

  • --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 informa que no instanceId (nada que sondear), se omite InstanceId 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. Esta es una operación permanente: no se puede deshacer.

Argumentos​

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

Opciones​

  • -y, --yes — Obligatorio. Confirma esta operación irreversible: la CLI nunca solicita.
  • --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 --yes
uip solution deploy uninstall my-deployment --yes

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 tres formas de resultado correcto, que se distinguen por los campos que aparecen:

  • Inmediato : Orchestrator informa complete: true en la primera llamada; no se realiza ningún sondeo. Solo aparecen Status/DeploymentName.
  • Programado : Orchestrator programa el trabajo sin devolver un ID de instancia; se añade un campo Scheduled .
  • Sondeado : se devuelve un InstanceId y el comando lo sondea hasta completarlo, como se muestra arriba.

Modos de fallo​

  • Faltan -y, --yes. El comando se rechaza sin confirmar.
  • The deployment cannot be uninstalled in its state (inactive after an uninstall, superseded, or left by a failed install). When the record offers Delete, Instructions points to deploy delete.

uip solution deploy delete​

Delete a deployment record from the tenant. Use this for a deployment that deploy uninstall cannot remove: one left inactive after an uninstall, one superseded by a newer version, or one left behind by a failed install. Orchestrator refuses to uninstall those with error 4007.

The command finds the deployment by name across the feeds, then reads its available actions. When the record lists actions but not Delete, the command refuses and names the state and the actions that are available. When the record lists no actions, the request goes to the server, which decides.

Argumentos​

  • <deployment-name> (required) — Name of the deployment to delete. Use deploy list to find deployment names.

Opciones​

  • -y, --yes — Required. Confirms this irreversible operation; the CLI never prompts.
  • --login-validity <minutes> — El valor predeterminado es 10.

Ejemplo​

uip solution deploy delete my-deployment --yes
uip solution deploy delete my-deployment --yes

Forma de datos (--json de salida)​

{
  "Code": "SolutionDeployDelete",
  "Data": {
    "Status": "Deleted",
    "DeploymentName": "my-deployment",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}
{
  "Code": "SolutionDeployDelete",
  "Data": {
    "Status": "Deleted",
    "DeploymentName": "my-deployment",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

Modos de fallo​

  • Faltan -y, --yes. El comando se rechaza sin confirmar.
  • No deployment with that name. Refused.
  • The deployment offers Uninstall but not Delete. Refused. Run deploy uninstall <deployment-name> --yes first, then retry the delete.
  • An operation is in progress on the deployment. Refused. Wait for the operation to finish, then retry.

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​

LargoValorPredeterminadoDescripción
--package-version <version>textMás recienteVersión del paquete.
-d, --destination <path>RutaSalida estándarEscribe la configuración en este archivo en lugar de la salida estándar.
--format <format>json | yamljsonFormato de configuración.
--login-validity <minutes>minutos10Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

Ejemplo​

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

# YAML format
uip solution deploy config get my-package -d ./deploy-config.yaml --format yaml
uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json

# YAML format
uip solution deploy config get my-package -d ./deploy-config.yaml --format yaml

Forma de datos (--json de salida)​

Cuando se proporciona -d :

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

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

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "State": "Ready",
    "Format": "json",
    "Configuration": { "resources": [ "..." ] }
  }
}
{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "State": "Ready",
    "Format": "json",
    "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"
    }
  }
}

Remove a link set with config link. On the next deploy run --config-file, the resource is created instead of reused.

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.

Ver también​

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte(opens in new window)

¿Quiere aprender? UiPath Academy(opens in new window)

¿Tiene alguna pregunta? Foro de UiPath(opens in new window)

Manténgase actualizado