Déploiement de la solution UIP

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, plus le niveau supérieur uip solution delete qui gère les solutions Studio Web (et non les déploiements).

Sous-commande	Objectif
run	Déployez un package publié dans Orchestrator.
status	Vérifier le statut d'un déploiement de pipeline.
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.
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.

Également documenté sur cette page:

• uip solution delete — un verbe de haut niveau qui supprime une solution de Studio Web par ID. Il ne s'agit pas d'une sous-commande de déploiement; il est documenté avec ces commandes pour des raisons de regroupement.

Chaque sous-commande est authentifiée. Exécutez d’abord uip login ou transmettez --tenant pour cibler un locataire spécifique.

Workflow standard

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

---

Exécution du déploiement de la solution UIP

Déployez un package de solution publié dans Orchestrator. Crée un nouveau dossier (sous --folder-path ou --folder-key), enregistre chaque ressource décrite dans le package (ou dans --config-file) et interroge jusqu'à ce que le déploiement atteigne un état terminal.

Synthèse

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

Options

• -n, --name <deployment-name> (requis) : le nom du déploiement. Utilisé par deploy status, activate et uninstall pour identifier cette installation.
• --package-name <name> (obligatoire) : nom du package de solution. Utilisez packages list pour trouver des noms disponibles.
• --package-version <version> (requis) : la version du package de solution. Utilisez packages list pour trouver les versions disponibles.
• --folder-name <name> (requis) : nom du nouveau dossier Orchestrator créé pour ce déploiement (sous --folder-path).
• --folder-path <path> : chemin d'accès au dossier parent (par exemple Shared). Le dossier de déploiement est créé en dessous.
• --folder-key <key> — Clé de dossier parent. Alternative à --folder-path.
• --config-file <path> — Fichier de configuration JSON. Générez-le avec deploy config get, modifiez-le avec config set / config link, puis transmettez-le ici.
• -t, --tenant <tenant-name> — Locataire vers lequel déployer.
• --timeout <seconds> — Délai d'attente de l'interrogation de déploiement. 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> — Nombre minimum de minutes avant l'expiration du jeton pour déclencher une actualisation. La valeur par défaut est 10.

Exemples

Commun

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

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 \
  --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 --folder-path "Shared" \
  --output-filter "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

Format des données (--sortie json)

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

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.

---

statut de déploiement de la solution uip

Vérifier le statut actuel d'un déploiement de pipeline. Renvoie l'état du déploiement et, si disponible, le nom/package/version du déploiement et un résumé concaténé des erreurs.

Arguments

• <pipeline-deployment-id> (requis) : le PipelineDeploymentId renvoyé par deploy run.

Options

• -t, --tenant <tenant-name> — Locataire à interroger.
• --login-validity <minutes> — La valeur par défaut est 10.

Exemple

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

Format des données (--sortie json)

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

---

liste de déploiement de solutions UiP

Lister les déploiements de solutions. Affiche le nom du déploiement, le statut, la version du package et le chemin du dossier.

Options

• -t, --tenant <tenant-name> — Locataire à interroger.
• --folder-path <path> — Filtrer par chemin de dossier parent. Le filtrage est appliqué après la récupération; augmentez --take si les résultats semblent incomplets lorsque vous utilisez ce filtre.
• --folder-key <key> — Filtrer par clé de dossier parent. Alternative à --folder-path.
• --take <number> — Nombre maximal de déploiements à récupérer. La valeur par défaut est 10.
• --order-by <column> — Colonne à trier par. La valeur par défaut est startTime.
• --order-direction <direction> — Ascending ou Descending. La valeur par défaut est Descending.
• --login-validity <minutes> — La valeur par défaut est 10.

Exemple

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

Format des données (--sortie json)

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

---

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

• -t, --tenant <tenant-name> — Locataire à cibler.
• --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 rapporte aucun instanceId (Rien à interroger), Status est Activation completed (no instance to poll) 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.

Arguments

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

Options

• -t, --tenant <tenant-name> — Locataire à cibler.
• --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

Format des données (--sortie json)

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

Deux réponses de raccourci sont possibles:

• Uninstall completed immediately — lorsqu'Orchestrator signale complete: true lors du premier appel; aucune interrogation ne se produit.
• Uninstall scheduled — lorsqu'Orchestrator planifie le travail sans renvoyer d'ID d'instance; les données incluent le champ Scheduled de l’API.

---

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

• --package-version <version> — Version du package. Le champ « Plus récent » est utilisé si ce champ est omis.
• -d, --destination <path> — Écrivez la configuration dans ce fichier au lieu de stdout.
• -t, --tenant <tenant-name> — Locataire à interroger.
• --login-validity <minutes> — La valeur par défaut est 10.

Exemple

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

Format des données (--sortie json)

Lorsque -d est fourni:

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

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

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "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

Supprimez un lien précédemment défini avec config link. Le deploy run --config-file suivant, la ressource sera créée à nouveau au lieu d’être réutilisée.

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.

---

suppression de la solution uip

uip solution delete est un verbe de haut niveau (pas une sous-commande deploy ) qui supprime une solution de Studio Web par son ID de solution. L'ID est émis par uip solution upload et par flow debug dans leur sortie.

Cela ne désinstalle pas une solution déployée d’Orchestrator — utilisez deploy uninstall pour cela.

Synthèse

uip solution delete <solution-id>

Arguments

• <solution-id> (requis) : l'ID de la solution Studio Web.

Exemple

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

Format des données (--sortie json)

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

---

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 resource — 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 .