Implantação da solução UIP

Sintaxe e opções para "uip solution implant", que instala, atualiza, ativa e desinstala implantações de solução no Orchestrator.

uip solution deploy pega um pacote de solução publicado (consulte uip solution publish) e o instala no Orchestrator: cria uma pasta, provisiona recursos (filas, ativos, processos, buckets, conexões) e ativa a implantação.

Esta página abrange cada subcomando em deploy.

Observação:

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.

Subcomando	Finalidade
run	Install a deployment from a published package.
upgrade	Move an existing deployment to another published version of its package, in place.
status	Check the state of a deployment, by name or key, or the progress of a pipeline deployment run.
list	Listar implantações existentes.
activate	Ative uma implantação que foi instalada sem ativação automática.
uninstall	Remova uma implantação e seus recursos provisionados.
delete	Delete a deployment record that uninstall cannot remove.
config get	Busque a configuração de implantação padrão para um pacote.
config set	Defina uma propriedade do recurso em um arquivo de configuração de implantação.
config link	Vincule um recurso da solução a um recurso do Orchestrator existente.
config unlink	Remova um link de recurso de um arquivo de configuração de implantação.

Cada subcomando é autenticado. Execute uip login primeiro.

Fluxo de trabalho 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 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.

---

Execução de implantação da solução 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.

Resumo

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

Opções

Long	Valor	Padrão	Description
-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	—	Obrigatório. Nome do pacote da solução. Use packages list para encontrar nomes disponíveis.
--package-version <version>	text	—	Obrigatório. Versão do pacote da solução.
--folder-name <name>	text	—	Obrigatório. Nome da nova pasta do Orchestrator criada para esta implantação.
--parent-folder-path <path>	Path	—	Caminho Shared da pasta pai (por exemplo,). A pasta de implantação é criada abaixo dela. mutuamente exclusivo com --parent-folder-key e --personal-workspace.
--parent-folder-key <key>	GUID	—	Chave da pasta pai. Alternativa --parent-folder-path para.
--personal-workspace	Bandeira	desativada	Deploy 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>	text	Feed do tenant	Deploy 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>	Path	—	Arquivo de configuração JSON ou YAML. Gere com deploy config get, edite com config set / config link e, em seguida, passe aqui.
--skip-activate	Bandeira	desativada	Ignorar ativação automática; deixe a implantação no estado Inactive (Ready to activate). Ative mais tarde com deploy activate.
-y, --yes	Bandeira	desativada	Deploy 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>	segundos	360	Tempo limite de pesquisa aplicado por fase — implantar e (quando não ignorado) ativar.
--poll-interval <ms>	ms	5000	Milissegundos entre pesquisas de status durante as fases de implantação e ativação.
--login-validity <minutes>	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplos

Comum

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --parent-folder-path "Shared"

Pular ativação 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

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

Uma segunda cópia independente de um pacote já implantado

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

De um feed de pasta

uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --feed Finance

Com uma configuração 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

Scripting — capture o ID de implantação para chamadas de acompanhamento

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"

Formato dos dados (--output json)

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

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

With --skip-activate, ActivationStatus is Skipped.

RequestedFolderName e FolderNote aparecem apenas quando o --folder-name solicitado já foi executado: o Orchestrator renomeia a pasta em vez de reutilizá-la, então o FolderName/FolderPath real difere do que foi solicitado e FolderNote explica a renomeação com um ponteiro para usar a pasta renomeada ou executar novamente com um nome livre.

Status de implantação de terminais: DeploymentSucceeded, DeploymentFailed, ValidationFailed, ConflictFixingError, DeploymentScheduleError. Os estados terminais sem sucesso saem com 1 e agregam os erros de validação/conflito/agendamento/fluxo de trabalho no campo Instructions .

Comportamento do tempo limite

Se a implantação não atingir um estado terminal antes transcorrer --timeout , o comando sairá diferente de zero com um ponteiro para deploy status <pipeline-deployment-id> para que você possa continuar o monitoramento.

Modos de falha

• 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 um --package-name diferente. Falha imediatamente — um nome de implantação não pode alternar pacotes por meio de deploy run.
• Uma implantação de --name já está em progresso. Falha — a operação anterior deve ser concluída primeiro.

---

atualização de implantação da solução 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>.

Resumo

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.

Opções

Long	Valor	Padrão	Description
-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>	text	newest published	Target package version. Any published version of the same package is accepted, including an older one. An empty value is refused.
--personal-workspace	Bandeira	desativada	With --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-draft	Bandeira	desativada	When 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-wait	Bandeira	desativada	Retorne assim que a atualização for aceita, em vez de esperar que ela seja finalizada.
--timeout <seconds>	segundos	300	Segundos para esperar até que a atualização seja concluída.
--poll-interval <ms>	ms	5000	Milissegundos entre pesquisas de status.
--login-validity <minutes>	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

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.

Exemplos

# 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

Formato dos dados (--output json)

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

Com --no-wait:

{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "Accepted",
    "DeploymentName": "my-deployment",
    "ToVersion": "2.0.0",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000002"
  }
}

Campo	Description
Status	Terminal pipeline status (DeploymentSucceeded), or Accepted when --no-wait returned before the upgrade finished.
Operation	What the server did: VersionChange for a version move, or ConfigurationChange when the requested version was already deployed. Absent with --no-wait.
DeploymentStatus	SuccessfulActivate 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.
Actions	Operations available on the deployment next (for example SetupActivation, Uninstall, Upgrade).
ActivationStatus, PendingResources, NextSteps	Present when the new version does not run yet, for example ActivationStatus: NeedsSetupToActivate with the resources that need configuration. Same shape as deploy run.
FromVersion	Version deployed before the upgrade. Key form only.
ToVersion	Version the upgrade targeted.
PipelineDeploymentId	ID of the pipeline run that performs the upgrade. Pass it to deploy status.
DeploymentKey	Key of the upgraded deployment record. Absent with --no-wait.
InstallDeploymentKey	Key of the original install. It stays the same across upgrades, so it is the key to store. Key form only.
DiscardedDraftKey	Key of the pending draft that --discard-draft deleted. Present only when one was discarded.

Modos de falha

• 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>.

---

status de implantação da solução 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.

Opções

Long	Valor	Padrão	Description
--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-workspace	Bandeira	desativada	For a deployment name: look it up in your Personal Workspace feed instead of the tenant.
--login-validity <minutes>	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

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

Exemplos

# 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

Formato dos dados (--output json)

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

Campo	Description
DeploymentKey	The key that was requested.
Superseded	true 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.
CurrentDeploymentKey	Key of the deployment's current record.
InstallDeploymentKey	Key of the original install, stable across upgrades.
DeploymentStatus	SuccessfulActivate when the version runs, SuccessfulInstall when it waits for activation or its setup.
ActivationStatus	Activation state, for example Active, ReadyToActivate, or NeedsSetupToActivate. null when it could not be read.
Actions	Operations available on the deployment. null when they could not be read.
PendingResources	Resources that need configuration before activation. Present only when the deployment waits for setup.
NextSteps	What 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
    }
  }
}

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 implantação da solução uip

Listar implantações de solução. Mostra o nome da implantação, versão do pacote atual/de destino, operação pendente, status de ativação e caminho da pasta.

Opções

Long	Valor	Padrão	Description
--folder-path <path>	Path	—	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úmero	50	Máx. de implantações a ser buscada.
--offset <number>	Número	0	Number of deployments to skip.
--sort-by <column>	text	startTime	Coluna usada para classificar.
--sort-order <direction>	Ascending | Descending	Descending	Classificar direção.
--operation-status <statuses>	separados por vírgula	—	Server-side filter by operation status. One or more of Draft, Successful, Failed, InProgress, FailedRollback.
--activation-status <statuses>	separados por vírgula	—	Server-side filter by activation status. One or more of None, Active, Inactive, ActivationFailed, DeactivationFailed, ReadyToActivate, NeedsSetupToActivate.
--personal-workspace	Bandeira	desativada	Lista apenas implantações do feed do Espaço de Trabalho Pessoal do usuário atual. mutuamente exclusivo com --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>	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

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

Exemplos

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

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

Formato dos dados (--output json)

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

---

implantação da solução uip ativar

Ative uma implantação que foi instalada sem ativação automática. A ativação provisiona todos os componentes da solução. activate imprime as etapas de pré-ativação relatadas pelo Orchestrator (para stderr, via --log-level info), em seguida, chama a ativação e pesquisa até um estado terminal (SuccessfulActivate ou FailedActivate).

Argumentos

• <deployment-name> (necessário) — Nome da implantação a ser ativada. Use deploy list para encontrar nomes de implantações.

Opções

• --timeout <seconds> — Tempo limite da pesquisa de ativação. O padrão é 360.
• — --poll-interval <ms> entre pesquisas de status. O padrão é 5000.
• --login-validity <minutes> — O padrão é 10.

Exemplo

uip solution deploy activate my-deployment

Formato dos dados (--output json)

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

Se o Orchestrator não relatar instanceId ( nada para pesquisar), InstanceId será omitido e o comando retornará com sucesso.

---

desinstalação da implantação da solução uip

Desinstala uma solução implantada. Remove todos os recursos provisionados e a pasta da solução. Esta é uma operação permanente — não há desfazer.

Argumentos

• <deployment-name> (necessário) — Nome da implantação a ser desinstalada.

Opções

• -y, --yes — Obrigatório. Confirma esta operação irreversível — a CLI nunca solicita.
• --timeout <seconds> — Desinstalar tempo limite de pesquisa. O padrão é 360.
• — --poll-interval <ms> entre pesquisas de status. O padrão é 5000.
• --login-validity <minutes> — O padrão é 10.

Exemplo

uip solution deploy uninstall my-deployment --yes

Formato dos dados (--output json)

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

Três formas de sucesso são possíveis, distintas pela qual os campos aparecem:

• Imediato — o Orchestrator relata complete: true na primeira chamada; nenhuma pesquisa acontece. Apenas Status/DeploymentName é exibido.
• Agendado — o Orchestrator agenda o trabalho sem retornar um ID de instância; um campo Scheduled é adicionado.
• Pesquisado — um InstanceId é retornado e o comando o pesquisa até a conclusão, conforme mostrado acima.

Modos de falha

• Não há -y, --yes. O comando recusa sem 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.

Opções

• -y, --yes — Required. Confirms this irreversible operation; the CLI never prompts.
• --login-validity <minutes> — O padrão é 10.

Exemplo

uip solution deploy delete my-deployment --yes

Formato dos dados (--output json)

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

Modos de falha

• Não há -y, --yes. O comando recusa sem 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.

---

Obtenção de configuração de implantação da solução uip

Busque a configuração de implantação padrão para um pacote de solução publicado. A configuração lista cada recurso que a solução criará (filas, ativos, processos, buckets, conexões...) com suas configurações padrão. Salve-o em um arquivo (-d), personalize com config set / config link e passe para deploy run --config-file.

Argumentos

• <package-name> (necessário) — Nome do pacote da solução. Use packages list.

Opções

Long	Valor	Padrão	Description
--package-version <version>	text	Mais recente	Versão do pacote.
-d, --destination <path>	Path	Saída std	Grave a configuração nesse arquivo em vez do stdout.
--format <format>	json | yaml	json	Formato da configuração.
--login-validity <minutes>	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplo

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

Formato dos dados (--output json)

Quando -d é fornecido:

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

Quando -d é omitido, a configuração é incorporada na resposta:

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "State": "Ready",
    "Format": "json",
    "Configuration": { "resources": [ "..." ] }
  }
}

---

conjunto de configurações de implantação da solução uip

Edite uma propriedade de recurso em um arquivo de configuração de implantação. O arquivo permanece local até que você o passe para deploy run --config-file.

Argumentos

• <file> (necessário) — Caminho para o arquivo JSON de configuração de implantação (produzido por config get).
• <args...> (necessário) — Depende de --all:
  • Sem --all: <resource> <property> <value> — por exemplo MyQueue maxNumberOfRetries 5.
  • Com --all: <property> <value> — aplica-se a todos os recursos no arquivo. Válido apenas para a propriedade conflictFixingAction de nível superior.

Opções

• --all Aplique a propriedade a todos os recursos no arquivo. Permitido apenas com conflictFixingAction (por exemplo UseExisting).

Exemplos

Alterar novas tentativas em uma única fila

uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

Definir uma política de correção de conflitos para cada recurso

uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting

Formato dos dados (--output json)

Atualização de recurso único:

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

Atualização em massa (--all):

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

---

link de configuração de implantação da solução uip

Vincule um recurso da solução a um recurso do Orchestrator existente para que a implantação o reutilize em vez de criar um novo. As alterações são locais — aplique-as passando o arquivo para deploy run --config-file.

Argumentos

• <file> (necessário) — Caminho para o arquivo JSON de configuração de implantação.
• <resource> (necessário) — Nome do recurso ou resourceKey do arquivo de configuração.

Opções

• -n, --name <name> (necessário) — Nome do recurso do Orchestrator existente ao qual vincular.
• --folder-path <path> — Caminho da pasta do Orchestrator onde o recurso existente reside.

Exemplo

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

Formato dos dados (--output json)

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

---

desvinculação da configuração da implantação da solução uip

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

Argumentos

• <file> (necessário) — Caminho para o arquivo JSON de configuração de implantação.
• <resource> (necessário) — Nome do recurso ou resourceKey para desvincular.

Exemplo

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

Formato dos dados (--output json)

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

Modos de falha

• Recurso não vinculado no momento. O comando recusa a desvinculação e aponta para config link.

---

Comandos relacionados

• uip solution publish — etapa obrigatória antes de deploy run.
• uip solution packages list — descubra nomes e versões de pacotes.
• uip or — inspecione ou crie os recursos do Orchestrator a que deploy config link faz referência.

Veja também

• Seu primeiro guia passo a passo do pipeline — empacotar → publicar → implantar execução.
• Autenticação e Configuração — configuração de sessão e padrões por tenant.
• uip solution visão geral.