UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

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.

Sous-commandeObjectif
runInstallez un nouveau déploiement à partir d'un package publié.
upgradeMettre à niveau un déploiement existant vers une version de package plus récente, en place.
statusVérifier le statut d'un déploiement de pipeline.
listDressez la liste des déploiements existants.
activateActivez un déploiement installé sans activation automatique.
uninstallSupprimer un déploiement et ses ressources enregistrées.
config getRécupérez la configuration de déploiement par défaut d'un package.
config setDéfinissez une propriété de ressource dans un fichier de configuration de déploiement.
config linkLiez une ressource de solution à une ressource Orchestrator existante.
config unlinkSupprime un lien de ressource d'un fichier de configuration de déploiement.

Également documenté sur cette page:

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 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 crée toujours un nouveau déploiement dans un nouveau dossier - il ne met jamais à jour un déploiement existant. Si un package est déjà déployé sous un --name donné, utilisez deploy upgrade pour déplacer ce déploiement vers une nouvelle version en place, ou transmettez -y, --yes sur deploy run pour installer une deuxième copie indépendante à la place.


Exécution du déploiement de la solution UIP​

Installez un nouveau déploiement de solution dans Orchestrator à partir d'un package publié. Crée un nouveau dossier (sous --parent-folder-path ou --parent-folder-key, ou l'espace de travail personnel de l'utilisateur actuel), enregistre chaque ressource décrite dans le package (ou dans --config-file) et, à moins que --skip-activate ne soit défini, l'active.

Étant donné que cela crée toujours un nouveau déploiement, la commande vérifie d'abord si le package en a déjà un sous le même --name; dans ce cas, il s’arrête et pointe à deploy upgrade au lieu de réinstaller en mode silencieux. Cette vérification se fait dans la mesure du possible, mais non une garantie: elle lit la recherche de solutions, qui nécessite une session utilisateur, de sorte qu'une connexion à l'application l'ignore, et un échec de recherche avertit uniquement.

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

Options​

LongValeur (Value)DefaultDescription
-n, --name <deployment-name>text—Requis. Nom du déploiement. Utilisé par deploy status, deploy upgrade, deploy activate et deploy uninstall pour identifier cette installation.
--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-workspaceDrapeaudésactivéDéployer dans l’espace de travail personnel de l’utilisateur actuel. Le nom de l'espace de travail est automatiquement résolu dans Orchestrator. Exclusif mutuellement avec --parent-folder-path, --parent-folder-key et --feed.
--feed <name-or-key>textFlux de locataireDéployez un package publié dans ce flux (nom ou clé de dossier, à partir de solution feeds list) au lieu du flux de locataire. Cette étendue d'où provient le flux de paquets — les indicateurs --parent-folder-path/--parent-folder-key/--personal-workspace contrôlent toujours l'endroit où le dossier Orchestrator est créé. Capture mutuellement exclusive avec --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-activateDrapeaudésactivéIgnorer l’activation automatique; laissez le déploiement à l’état Inactive (Ready to activate). Activez plus tard avec deploy activate
--waitDrapeaudésactivéPour un déploiement --personal-workspace ou --feed, attendez qu’il se termine au lieu de revenir dès son début (limité par --timeout). Le chemin d’accès au flux de locataires attend toujours, donc cet indicateur n’y change rien.
-y, --yesDrapeaudésactivéDéployer même lorsque ce package a déjà un déploiement sous --name, en installant une deuxième copie indépendante avec son propre dossier.
--timeout <seconds>secondes360Délai d'attente d'interrogation appliqué par phase - déployer et activer (lorsqu'il n'est pas ignoré).
--poll-interval <ms>ms5000Millisecondes entre les interrogations de statut pendant les phases de déploiement et d’activation.
--login-validity <minutes>minutes10Nombre 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"
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
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
Dans l’espace de travail personnel, en attente d’achèvement​
uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --personal-workspace --wait
uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --personal-workspace --wait
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
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
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
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 "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"
PIPELINE_ID=$(uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --parent-folder-path "Shared" \
  --output-filter "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

Format des données (--sortie json)​

Déploiement du flux de locataires (attend toujours):

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution",
    "ActivationStatus": "SuccessfulActivate"
  }
}
{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution",
    "ActivationStatus": "SuccessfulActivate"
  }
}

Déploiement d'espace de travail personnel/de flux de dossier sans --wait:

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

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​

  • Le déploiement existe déjà sous --name. Refusé si -y, --yes n’est pas réussi (installe une deuxième copie indépendante): utilisez deploy upgrade à la place si l’intention est de déplacer le déploiement existant vers une nouvelle version.
  • --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​

Mettez à niveau un déploiement existant vers une version de package plus récente en place — l'équivalent CLI du bouton « Mettre à niveau» de l'interface utilisateur d'Orchestrator. Utilisez cette option lorsque deploy run est bloqué, car un déploiement existe déjà sous le nom de la cible. La configuration existante du déploiement est conservée, de sorte que les valeurs déjà définies sur ce déploiement (par exemple, le secret d’une ressource d’informations d’identification) ne sont pas réinitialisées selon les valeurs par défaut du package. Attend la fin de la mise à niveau, sauf si --no-wait est transmis.

Arguments​

  • <deployment-key> (requis) : la clé du déploiement à mettre à niveau. Utilisez deploy list pour le trouver (le champ Key ).

Options​

LongValeur (Value)DefaultDescription
--version <version>textla plus récente disponibleVersion du package cible. Seule la dernière version publiée est prise en charge aujourd'hui.
--personal-workspaceDrapeaudésactivéMettez à niveau un déploiement dans votre flux d'espace de travail personnel au lieu du locataire.
--no-waitDrapeaudésactivéRetournez dès que la mise à niveau est acceptée, au lieu d’attendre qu’elle se termine.
--timeout <seconds>secondes300Secondes d'attente de la fin de la mise à niveau.
--poll-interval <ms>ms5000Millisecondes entre les interrogations de statut.
--login-validity <minutes>minutes10Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Exemples​

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

Format des données (--sortie json)​

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

Avec --no-wait, Status est "Draft" et la mise à niveau a uniquement été acceptée, non terminée — interrogez deploy list (les champs Actions/TargetPackageVersion ) pour le suivre.


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​

  • --login-validity <minutes> — La valeur par défaut est 10.

Exemple​

uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001
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
    }
  }
}
{
  "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, la version actuelle/cible du package, l'opération en attente, l'état d'activation et le chemin d'accès au dossier.

Options​

LongValeur (Value)DefaultDescription
--folder-path <path>Chemin d'accès—Filtrer par chemin de dossier parent. Le filtrage est appliqué après la récupération; augmentez --limit si les résultats semblent incomplets lorsque vous utilisez ce filtre.
--folder-key <key>GUID—Filtrer par clé de dossier parent. Alternative à --folder-path.
-l, --limit <number>Numérique50Nombre maximal de déploiements à récupérer.
--offset <number>Numérique0Nombre de déploiements à ignorer (appliqué avant le filtrage --folder-path/--folder-key).
--sort-by <column>textstartTimeColonne par laquelle trier.
--sort-order <direction>Ascending | DescendingDescendingChoisir l'ordre de tri.
--operation-status <statuses>Séparé par des virgules—Filtre côté serveur par statut d'opération (par exemple Successful, InProgress, Failed).
--activation-status <statuses>Séparé par des virgules—Filtre côté serveur par statut d’activation (par exemple Active, Inactive).
--personal-workspaceDrapeaudé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—Répertoriez uniquement les déploiements de ce flux. Capture mutuellement exclusive avec --personal-workspace.
--login-validity <minutes>minutes10Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

--operation-status et --activation-status rejettent les valeurs qui ne figurent pas sur les listes des statuts connus du SDK - le message d'erreur énumère les valeurs valides.

Exemples​

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

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

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

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 }
}
{
  "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 est la valeur que deploy upgrade attend comme <deployment-key>. NewPackageVersionAvailable est non-null lorsqu’il existe une version publiée plus récente que celle actuellement déployée. Actions répertorie les opérations actuellement disponibles sur le déploiement (par exemple ["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
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"
  }
}
{
  "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
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"
  }
}
{
  "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.

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​

LongValeur (Value)DefaultDescription
--package-version <version>textPlus récente (Latest)Version du package.
-d, --destination <path>Chemin d'accèsstdoutÉcrivez la configuration dans ce fichier au lieu de stdout.
--format <format>json | yamljsonFormat de configuration.
--login-validity <minutes>minutes10Nombre 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
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"
  }
}
{
  "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": [ "..." ] }
  }
}
{
  "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
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
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
  }
}
{
  "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
  }
}
{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "all",
    "Property": "conflictFixingAction",
    "NewValue": "UseExisting",
    "ResourceCount": 12
  }
}

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"
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"
    }
  }
}
{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}

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
uip solution deploy config unlink ./deploy-config.json MyQueue

Format des données (--sortie json)​

{
  "Code": "DeployConfigUnlink",
  "Data": {
    "Resource": "MyQueue",
    "UnlinkedFrom": "ProductionQueue"
  }
}
{
  "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.

Voir également​

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour