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.

Subcomando	Propósito
run	Instala una nueva implementación desde un paquete publicado.
upgrade	Actualiza una implementación existente a una versión de paquete más reciente, en su lugar.
status	Comprobar el estado de la implementación de un proceso.
list	Enumera las implementaciones existentes.
activate	Activa una implementación que se instaló sin activación automática.
uninstall	Elimina una implementación y sus recursos aprovisionados.
config get	Obtener la configuración de implementación predeterminada para un paquete.
config set	Establece una propiedad de recurso en un archivo de configuración de implementación.
config link	Vincula un recurso de solución a un recurso de Orchestrator existente.
config unlink	Eliminar un enlace de recursos de un archivo de configuración de implementación.

También se documenta en esta página:

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 run siempre crea una nueva implementación en una nueva carpeta; nunca actualiza una existente. Si un paquete ya está implementado en un --name determinado, utiliza deploy upgrade para mover esa implementación a una nueva versión en su lugar, o pasa -y, --yes en deploy run para instalar una segunda copia independiente en su lugar.

---

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

Instala una nueva implementación de solución en Orchestrator desde un paquete publicado. Crea una nueva carpeta (en --parent-folder-path o --parent-folder-key, o en el espacio de trabajo personal del usuario actual), aprovisiona cada recurso descrito en el paquete (o en --config-file) y, a menos que se establezca --skip-activate, lo activa.

Como esto siempre crea una nueva implementación, el comando primero comprueba si el paquete ya tiene uno bajo el mismo --name; si es así, se detiene y apunta a deploy upgrade en lugar de reinstalar silenciosamente. Esa comprobación es el mejor esfuerzo, no una garantía: lee la búsqueda de soluciones, que necesita una sesión de usuario, por lo que un inicio de sesión de la aplicación (credenciales de cliente) la omite, y un fallo de búsqueda solo advierte.

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] \
  [--wait] \
  [-y, --yes] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

Opciones

Largo	Valor	Predeterminado	Descripción
-n, --name <deployment-name>	text	—	Obligatorio. Nombre de la implementación. Utilizado por deploy status, deploy upgrade, deploy activate y deploy uninstall para identificar esta instalación.
--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-workspace	Marca	Desactivado	Implementar en el espacio de trabajo personal del usuario actual. El nombre del espacio de trabajo se resuelve desde Orchestrator automáticamente. Mutuamente exclusivo con --parent-folder-path, --parent-folder-key y --feed.
--feed <name-or-key>	text	Transmisión de inquilinos	Implementa un paquete publicado en esta fuente (nombre o clave de carpeta, de solution feeds list) en lugar de la fuente del tenant. Estos ámbitos de los que proviene el paquete : los marcadores --parent-folder-path/--parent-folder-key/--personal-workspace siguen controlando dónde se crea la carpeta de Orchestrator. Mutuamente excluyente con --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-activate	Marca	Desactivado	Omitir la activación automática; deja la implementación en estado Inactive (Ready to activate). Activar más tarde con deploy activate.
--wait	Marca	Desactivado	Para una implementación --personal-workspace o --feed, espera a que finalice en lugar de volver tan pronto como comience (limitado por --timeout). La ruta de alimentación del tenant siempre espera, por lo que este marcador no cambia nada allí.
-y, --yes	Marca	Desactivado	Implementar incluso cuando este paquete ya tenga una implementación en --name, instalando una segunda copia independiente con su propia carpeta.
--timeout <seconds>	segundos	360	Tiempo de espera de sondeo aplicado por fase: implementación y (si no se omite) activación.
--poll-interval <ms>	ms	5000	Milisegundos entre sondeos de estado durante las fases de implementación y activación.
--login-validity <minutes>	minutos	10	Minutos 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"

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

En el espacio de trabajo personal, esperando a que finalice

uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --personal-workspace --wait

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

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

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

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 "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

Forma de datos (--json de salida)

Implementación de fuente de tenant (siempre espera):

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

Implementación de espacio de trabajo personal/alimentación de carpetas sin --wait:

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentStarted",
    "DeploymentName": "my-deployment",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "FolderName": "MySolution",
    "FolderPath": "[e-mail]/MySolution",
    "ActivationStatus": "Auto",
    "NextSteps": "Deployment created in your Personal Workspace and will auto-activate. Check status with: uip solution deploy list."
  }
}

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

• La implementación ya existe en --name. Rechazado a menos que se pase -y, --yes (instala una segunda copia independiente): utiliza deploy upgrade en su lugar si la intención es mover la implementación existente a una nueva versión.
• --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

Actualiza una implementación existente a una versión de paquete más reciente en el lugar: el equivalente CLI del botón "Actualizar" de la IU de Orchestrator. Usa esto cuando deploy run esté bloqueado porque ya existe una implementación con el nombre de destino. La configuración existente de la implementación se conserva, por lo que los valores ya establecidos (por ejemplo, el secreto de un activo de credenciales) no se restablecen a los valores predeterminados del paquete. Espera a que finalice la actualización a menos que se pase --no-wait.

Argumentos

• <deployment-key> obligatorio) : clave de la implementación que se actualizará. Utiliza deploy list para encontrarlo (el campo Key ).

Opciones

Largo	Valor	Predeterminado	Descripción
--version <version>	text	más reciente disponible	Versión del paquete de destino. Solo la última versión publicada es compatible hoy en día.
--personal-workspace	Marca	Desactivado	Actualiza una implementación en tu fuente de Espacio de trabajo personal en lugar de en el tenant.
--no-wait	Marca	Desactivado	Vuelve tan pronto como se acepte la actualización, en lugar de esperar a que finalice.
--timeout <seconds>	segundos	300	Segundos de espera para que finalice la actualización.
--poll-interval <ms>	ms	5000	Milisegundos entre encuestas de estado.
--login-validity <minutes>	minutos	10	Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

Ejemplos

# Upgrade to the newest published version, waiting for completion
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001

# Start the upgrade without waiting
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001 --no-wait

Forma de datos (--json de salida)

{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "Successful",
    "DeploymentName": "billing-solution",
    "FromVersion": "1.0.0",
    "ToVersion": "2.0.0",
    "VersionChangeKey": "b2c3d4e5-0000-0000-0000-000000000002"
  }
}

Con --no-wait, Status es "Draft" y la actualización solo se ha aceptado, no se ha completado: sondee deploy list (los campos Actions/TargetPackageVersion ) para realizar un seguimiento.

---

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

• --login-validity <minutes> — El valor predeterminado es 10.

Ejemplo

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

---

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

Largo	Valor	Predeterminado	Descripción
--folder-path <path>	Ruta	—	Filtrar por ruta de la carpeta principal. El filtrado se aplica después de la obtención; aumente --limit si los resultados parecen incompletos al utilizar este filtro.
--folder-key <key>	GUID	—	Filtrar por clave de carpeta principal. Alternativa a --folder-path.
-l, --limit <number>	Número	50	Máximo de implementaciones para recuperar.
--offset <number>	Número	0	Número de implementaciones que se omitirán (aplicado antes del filtrado --folder-path/--folder-key).
--sort-by <column>	text	startTime	Columna por la que ordenar.
--sort-order <direction>	Ascending | Descending	Descending	Ordenar dirección.
--operation-status <statuses>	separados por comas	—	Filtro del lado del servidor por estado de la operación (por ejemplo, Successful, InProgress, Failed).
--activation-status <statuses>	separados por comas	—	Filtro del lado del servidor por estado de activación (por ejemplo, Active, Inactive).
--personal-workspace	Marca	Desactivado	Enumera solo las implementaciones de la fuente del espacio de trabajo personal del usuario actual. Mutuamente exclusivo con --feed.
--feed <name-or-key>	text	—	Enumerar solo las implementaciones de esta fuente. Mutuamente exclusivo con --personal-workspace.
--login-validity <minutes>	minutos	10	Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

Tanto --operation-status como --activation-status rechazan valores fuera de las listas de estados conocidos del SDK: el mensaje de error enumera los valores válidos.

Ejemplos

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

Key es el valor que deploy upgrade espera como <deployment-key>. NewPackageVersionAvailable no es nulo cuando existe una versión publicada más reciente que la implementada actualmente. Actions enumera las operaciones disponibles actualmente en la implementación (por ejemplo, ["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

Forma de datos (--json de salida)

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

Forma de datos (--json de salida)

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

---

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

Largo	Valor	Predeterminado	Descripción
--package-version <version>	text	Más reciente	Versión del paquete.
-d, --destination <path>	Ruta	Salida estándar	Escribe la configuración en este archivo en lugar de la salida estándar.
--format <format>	json | yaml	json	Formato de configuración.
--login-validity <minutes>	minutos	10	Minutos 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

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

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": [ "..." ] }
  }
}

---

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

Establezca una política de solución de conflictos en cada recurso

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

Actualización masiva (--all):

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

---

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

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"

Forma de datos (--json de salida)

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

---

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

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

Forma de datos (--json de salida)

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

---

Comandos relacionados

• uip solution publish — paso obligatorio antes de deploy run.
• uip solution packages list : descubre nombres y versiones de paquetes.
• uip or : inspecciona o crea los recursos de Orchestrator a los que deploy config link hace referencia.

Ver también

• Tu primer proceso : empaquetar → publicar → implementar tutorial de ejecución.
• Autenticación y configuración : configuración de sesión y valores predeterminados por tenant.
• Información generaluip solution .