Déploiement de la solution UIP

Syntaxe et options pour `uip solution Deploy`, qui installe, met à niveau, active et désinstalle les déploiements de solutions dans Orchestrator.

uip solution deploy prend un package de solution publié (voir uip solution publish) et l'installe dans Orchestrator: crée un dossier, enregistre les ressources (files d'attente, ressources, processus, compartiments, connexions) et active le déploiement.

Cette page couvre chaque sous-commande sous deploy.

Remarque :

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.

Sous-commande	Objectif
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	Dressez la liste des déploiements existants.
activate	Activez un déploiement installé sans activation automatique.
uninstall	Supprimer un déploiement et ses ressources enregistrées.
delete	Delete a deployment record that uninstall cannot remove.
config get	Récupérez la configuration de déploiement par défaut d'un package.
config set	Définissez une propriété de ressource dans un fichier de configuration de déploiement.
config link	Liez une ressource de solution à une ressource Orchestrator existante.
config unlink	Supprime un lien de ressource d'un fichier de configuration de déploiement.

Chaque sous-commande est authentifiée. Exécutez d'abord uip login .

Workflow standard

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.

---

Exécution du déploiement de la solution 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.

Synthèse

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

Options

Long	Valeur (Value)	Default	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	—	Requis. Nom du package de solutions. Utilisez packages list pour trouver des noms disponibles.
--package-version <version>	text	—	Requis. Version du package de solution.
--folder-name <name>	text	—	Requis. Nom du nouveau dossier Orchestrator créé pour ce déploiement.
--parent-folder-path <path>	Chemin d'accès	—	Chemin d’accès au dossier parent (par exemple Shared). Le dossier de déploiement est créé en dessous. mutuellement exclusif avec --parent-folder-key et --personal-workspace.
--parent-folder-key <key>	GUID	—	Clé de dossier parent. Alternative à --parent-folder-path.
--personal-workspace	Drapeau	désactivé	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	Flux de locataire	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>	Chemin d'accès	—	Fichier de configuration JSON ou YAML. Générer avec deploy config get, modifier avec config set / config link, puis transmettre ici.
--skip-activate	Drapeau	désactivé	Ignorer l’activation automatique; laissez le déploiement à l’état Inactive (Ready to activate). Activez plus tard avec deploy activate
-y, --yes	Drapeau	désactivé	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>	secondes	360	Délai d'attente d'interrogation appliqué par phase - déployer et activer (lorsqu'il n'est pas ignoré).
--poll-interval <ms>	ms	5000	Millisecondes entre les interrogations de statut pendant les phases de déploiement et d’activation.
--login-validity <minutes>	minutes	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Exemples

Commun

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

Ignorer l’activation automatique

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

Une deuxième copie indépendante d’un package déjà déployé

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

À partir d’un flux de dossier

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

Avec une configuration personnalisée

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

Scripts — capturez l'ID du déploiement pour les appels de suivi

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"

Format des données (--sortie 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 et FolderNote apparaissent uniquement lorsque le --folder-name demandé a déjà été pris: Orchestrator renomme le dossier plutôt que de le réutiliser, de sorte que le FolderName/FolderPath réel diffère de ce qui a été demandé, et FolderNote explique le changement de nom avec un pointeur pour utiliser le dossier renommé ou le réexécuter avec un nom libre.

Statuts du déploiement du terminal: DeploymentSucceeded, DeploymentFailed, ValidationFailed, ConflictFixingError, DeploymentScheduleError Les états terminaux non réussis se terminent par 1 et agrège les erreurs de validation/conflit/planification/workflow dans le champ Instructions .

Comportement du délai d’expiration

Si le déploiement n'atteint pas un état terminal avant l'expiration de --timeout , la commande se termine non-zéro avec un pointeur vers deploy status <pipeline-deployment-id> afin que vous puissiez continuer la surveillance.

Modes d’échec

• 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, lié à un autre --package-name. Échec: un nom de déploiement ne peut pas changer de package via deploy run.
• Un déploiement pour --name est déjà en cours. Échec: l’opération précédente doit se terminer en premier.

---

mise à niveau du déploiement de la solution 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>.

Synthèse

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.

Arguments

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

Options

Long	Valeur (Value)	Default	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	Drapeau	désactivé	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	Drapeau	désactivé	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	Drapeau	désactivé	Retournez dès que la mise à niveau est acceptée, au lieu d’attendre qu’elle se termine.
--timeout <seconds>	secondes	300	Secondes d'attente de la fin de la mise à niveau.
--poll-interval <ms>	ms	5000	Millisecondes entre les interrogations de statut.
--login-validity <minutes>	minutes	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

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.

Exemples

# 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

Format des données (--sortie 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"
  }
}

Avec --no-wait:

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

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

Modes d’échec

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

---

statut de déploiement de la solution 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.

Arguments

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

Options

Long	Valeur (Value)	Default	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	Drapeau	désactivé	For a deployment name: look it up in your Personal Workspace feed instead of the tenant.
--login-validity <minutes>	minutes	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

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

Exemples

# 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

Format des données (--sortie 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."
    ]
  }
}

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

---

liste de déploiement de solutions UiP

Lister les déploiements de solutions. Affiche le nom du déploiement, la version actuelle/cible du package, l'opération en attente, l'état d'activation et le chemin d'accès au dossier.

Options

Long	Valeur (Value)	Default	Description
--folder-path <path>	Chemin d'accès	—	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>	Numérique	50	Nombre maximal de déploiements à récupérer.
--offset <number>	Numérique	0	Number of deployments to skip.
--sort-by <column>	text	startTime	Colonne par laquelle trier.
--sort-order <direction>	Ascending | Descending	Descending	Choisir l'ordre de tri.
--operation-status <statuses>	Séparé par des virgules	—	Server-side filter by operation status. One or more of Draft, Successful, Failed, InProgress, FailedRollback.
--activation-status <statuses>	Séparé par des virgules	—	Server-side filter by activation status. One or more of None, Active, Inactive, ActivationFailed, DeactivationFailed, ReadyToActivate, NeedsSetupToActivate.
--personal-workspace	Drapeau	désactivé	Répertoriez uniquement les déploiements du flux d’espace de travail personnel de l’utilisateur actuel. Capture mutuellement exclusive avec --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>	minutes	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

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

Exemples

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

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

Format des données (--sortie 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"]).

---

Activation du déploiement de la solution UIP

Activez un déploiement installé sans activation automatique. L'activation enregistre tous les composants de la solution. activate imprime d'abord les étapes de pré-activation signalées par Orchestrator (vers stderr, via --log-level info), puis appelle l'activation et les interrogations jusqu'à l'état terminal (SuccessfulActivate ou FailedActivate).

Arguments

• <deployment-name> (requis) : le nom du déploiement à activer. Utilisez deploy list pour trouver des noms de déploiement.

Options

• --timeout <seconds> — Délai d'attente de l'interrogation d'activation. La valeur par défaut est 360.
• --poll-interval <ms> — Millisecondes entre les interrogations de statut. La valeur par défaut est 5000.
• --login-validity <minutes> — La valeur par défaut est 10.

Exemple

uip solution deploy activate my-deployment

Format des données (--sortie json)

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

Si Orchestrator ne signale aucun instanceId (Rien à interroger), InstanceId est omis et la commande se renvoie avec succès.

---

désinstallation du déploiement de la solution uip

Désinstalle une solution déployée. Supprime toutes les ressources enregistrées et le dossier de la solution. Il s'agit d'une opération permanente — il n'y a pas d'annulation.

Arguments

• <deployment-name> (requis) : le nom du déploiement à désinstaller.

Options

• -y, --yes — Requis. Confirme cette opération irréversible — la CLI ne s'affiche jamais.
• --timeout <seconds> — Délai d'attente d'interrogation de désinstallation. La valeur par défaut est 360.
• --poll-interval <ms> — Millisecondes entre les interrogations de statut. La valeur par défaut est 5000.
• --login-validity <minutes> — La valeur par défaut est 10.

Exemple

uip solution deploy uninstall my-deployment --yes

Format des données (--sortie json)

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

Trois formes de réussite sont possibles, selon les champs qui apparaissent:

• Immédiat : Orchestrator signale complete: true lors du premier appel; aucune interrogation ne se produit. Seuls Status/DeploymentName apparaissent.
• Planifié — Orchestrator planifie le travail sans renvoyer d'ID d'instance; un champ Scheduled est ajouté.
• Interrogé - un InstanceId est renvoyé et la commande l’interroge pour qu’elle soit terminée, comme indiqué ci-dessus.

Modes d’échec

• -y, --yes manquant. La commande refuse sans confirmation.
• 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.

Arguments

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

Options

• -y, --yes — Required. Confirms this irreversible operation; the CLI never prompts.
• --login-validity <minutes> — La valeur par défaut est 10.

Exemple

uip solution deploy delete my-deployment --yes

Format des données (--sortie json)

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

Modes d’échec

• -y, --yes manquant. La commande refuse sans confirmation.
• 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.

---

Configuration du déploiement de la solution UIP

Récupérez la configuration de déploiement par défaut d'un package de solution publié. La configuration répertorie chaque ressource créée par la solution (files d'attente, ressources, processus, compartiments, connexions, etc.) avec leurs paramètres par défaut. Enregistrez-le dans un fichier (-d), personnalisez avec config set / config link, puis transmettez-le à deploy run --config-file.

Arguments

• <package-name> (obligatoire) : nom du package de solution. Utilisez packages list.

Options

Long	Valeur (Value)	Default	Description
--package-version <version>	text	Plus récente (Latest)	Version du package.
-d, --destination <path>	Chemin d'accès	stdout	Écrivez la configuration dans ce fichier au lieu de stdout.
--format <format>	json | yaml	json	Format de configuration.
--login-validity <minutes>	minutes	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Exemple

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

Format des données (--sortie json)

Lorsque -d est fourni:

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

Lorsque -d est omis, la configuration est intégrée à la réponse:

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

---

Ensemble de configurations de déploiement de solution UIP

Modifiez une propriété de ressource dans un fichier de configuration de déploiement. Le fichier reste local jusqu'à ce que vous le transmettiez à deploy run --config-file.

Arguments

• <file> (requis) : chemin d'accès au fichier JSON de configuration de déploiement (produit par config get).
• <args...> (obligatoire) — Dépend de --all:
  • Sans --all: <resource> <property> <value> — ex. MyQueue maxNumberOfRetries 5.
  • Avec --all: <property> <value> — s'applique à chaque ressource dans le fichier. Uniquement valide pour la propriété conflictFixingAction de niveau supérieur.

Options

• --all — Applique la propriété à toutes les ressources dans le fichier. Autorisés uniquement avec conflictFixingAction (par ex. UseExisting).

Exemples

Modifier les nouvelles tentatives sur une file d'attente unique

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

Définir une politique de résolution de conflit pour chaque ressource

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

Format des données (--sortie json)

Mise à jour à ressource unique:

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

Mise à jour groupée (--all):

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

---

lien de configuration du déploiement de la solution uip

Liez une ressource de solution à une ressource Orchestrator existante , afin que le déploiement la réutilise au lieu d'en créer une nouvelle. Les modifications sont locales - appliquez-les en transmettant le fichier à deploy run --config-file.

Arguments

• <file> (requis) : chemin d'accès au fichier JSON de configuration de déploiement.
• <resource> (requis) : le nom de la ressource ou resourceKey dans le fichier de configuration.

Options

• -n, --name <name> (requis) : Nom de la ressource Orchestrator existante à laquelle lier.
• --folder-path <path> : le chemin du dossier Orchestrator où se trouve la ressource existante.

Exemple

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

Format des données (--sortie json)

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

---

Dissociation de la configuration du déploiement de la solution UIP

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

Arguments

• <file> (requis) : chemin d'accès au fichier JSON de configuration de déploiement.
• <resource> (obligatoire) : le nom de la ressource ou resourceKey pour dissocier.

Exemple

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

Format des données (--sortie json)

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

Modes d’échec

• Ressource non actuellement liée. La commande refuse la dissociation et pointe vers config link.

---

Commandes associées

• uip solution publish — étape requise avant deploy run.
• uip solution packages list — découvrez les noms et les versions des packages.
• uip or — inspectez ou créez les ressources Orchestrator qui deploy config link référencent.

Voir également

• Votre premier pipeline — empaqueter → publier → déployer l'exécution.
• Authentification et configuration — configuration de la session et valeurs par défaut par locataire.
• Vue d’ensemble du typeuip solution .