UiPath Documentation
uipath-cli
latest
false
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.

Guide de l'utilisateur de UiPath CLI

Déploiement d’agent UIP

uip agent deploy installe et active une version de package d'agent précédemment publiée dans un dossier Orchestrator. Il entraîne le pipeline de déploiement complet des solutions — configurer → déployer → installer → enregistrer → activer — et interroge jusqu'à ce que chaque phase atteigne un état terminal.

Par défaut, la commande enregistre également le dossier cible pour une exécution immédiate: elle affecte un modèle de machine sans serveur au niveau du locataire et lie un utilisateur robot avec le rôle Automation User au dossier. Les échecs d'enregistrement sont apparus sous forme d'avertissements plutôt que d'erreurs (vous pouvez affecter manuellement la machine et l'utilisateur après cela).

Nécessite une session CLI active (uip login).

Synthèse

uip agent deploy <packageVersionKey>
                 [-n <name>]
                 [--folder-key <guid>]
                 [--force-activate] [--skip-activate]
                 [-t <tenant>]
                 [--timeout <seconds>]
                 [--login-validity <minutes>]
uip agent deploy <packageVersionKey>
                 [-n <name>]
                 [--folder-key <guid>]
                 [--force-activate] [--skip-activate]
                 [-t <tenant>]
                 [--timeout <seconds>]
                 [--login-validity <minutes>]

Toutes les uip agent deploy invocations respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard, avec les remplacements spécifiques au déploiement indiqués ci-dessous.

Arguments

  • <packageVersionKey> (obligatoire) : la clé de version du package renvoyée par uip agent publish (chemin de téléchargement par défaut). GUID.

Options

DrapeauDefaultObjectif
-n, --name <name>agent-<timestamp>Nom du déploiement. Devient le nom d'affichage dans Orchestrator et — pour les dossiers créés automatiquement — le nom du dossier.
--folder-key <guid>(création automatique)Clé de dossier d'installation. S'il est omis, un nouveau dossier est créé automatiquement lors de l'installation.
--force-activatedésactivéForcez l'activation même s'il existe un déploiement précédent au niveau de cette clé de configuration.
--skip-activatedésactivéArrêter après la phase d'installation; ne l'activez pas. Utile lorsque vous souhaitez examiner l'installation avant de publier l'agent.
-t, --tenant <tenant>se connecter au locataireLocataire cible. Requis si la session de connexion n’a pas de locataire par défaut.
--timeout <seconds>120Nombre maximal de secondes à attendre pendant chaque phase d’interrogation (installation, activation) pour atteindre un état terminal. Au moment de l’expiration, la commande se termine avec le code 2.
--login-validity <minutes>10Nombre minimum de minutes de validité du jeton requis.

Exemples

# Deploy to an auto-created folder named "invoice-agent"
uip agent deploy a1b2c3d4-0000-0000-0000-000000000050 --name invoice-agent

# Deploy into an existing folder
uip agent deploy <PackageVersionKey> --folder-key <FolderGuid>

# Install only; do not activate (review in Orchestrator first)
uip agent deploy <PackageVersionKey> --skip-activate

# Force re-activation of a replacement deployment
uip agent deploy <PackageVersionKey> --force-activate

# Longer timeout for slow environments
uip agent deploy <PackageVersionKey> --timeout 600
# Deploy to an auto-created folder named "invoice-agent"
uip agent deploy a1b2c3d4-0000-0000-0000-000000000050 --name invoice-agent

# Deploy into an existing folder
uip agent deploy <PackageVersionKey> --folder-key <FolderGuid>

# Install only; do not activate (review in Orchestrator first)
uip agent deploy <PackageVersionKey> --skip-activate

# Force re-activation of a replacement deployment
uip agent deploy <PackageVersionKey> --force-activate

# Longer timeout for slow environments
uip agent deploy <PackageVersionKey> --timeout 600

Format des données (--sortie json)

Installation + activation terminée (Code: "AgentDeploy"):

{
  "Code": "AgentDeploy",
  "Data": {
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000060",
    "DeploymentName": "invoice-agent",
    "Status": "SuccessfulActivate",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000070",
    "FolderId": 42,
    "FolderName": "invoice-agent",
    "ConfigurationKey": "a1b2c3d4-0000-0000-0000-000000000080",
    "PackageVersionKey": "a1b2c3d4-0000-0000-0000-000000000050"
  }
}
{
  "Code": "AgentDeploy",
  "Data": {
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000060",
    "DeploymentName": "invoice-agent",
    "Status": "SuccessfulActivate",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000070",
    "FolderId": 42,
    "FolderName": "invoice-agent",
    "ConfigurationKey": "a1b2c3d4-0000-0000-0000-000000000080",
    "PackageVersionKey": "a1b2c3d4-0000-0000-0000-000000000050"
  }
}

Installer uniquement (--skip-activate ou Non prêt à être activé): même forme, avec Status reflétant la phase d'installation (SuccessfulInstall, FailedInstall) et FolderName omis lorsque le dossier n'a pas pu être résolu.

  • FolderId — ID d'unité organisationnelle numérique du dossier, renseigné uniquement lorsque l'enregistrement automatique a réussi. Transmettez-le directement à uip agent run list --folder-id.
  • FolderKey — GUID du dossier d'installation.
  • ConfigurationKey — clé des solutions Configuration créées par ce déploiement.
  • PackageVersionKey — renvoyé à partir de l'entrée à des fins de commodité.

Codes de sortie

En plus des codes CLI standard:

  • 0 — installation (et éventuellement activation) terminée avec succès.
  • 1 — échec du déploiement (FailedInstall, FailedActivate), Error d'interrogation ou tout autre échec.
  • 2 — une phase d'interrogation a expiré (voir --timeout). Le déploiement peut toujours se terminer dans Orchestrator; réexécutez avec un délai d’expiration plus long, ou inspectez le statut dans l’interface utilisateur d’Orchestrator.

Voir Codes de sortie pour le contrat partagé.

Détails de l'enregistrement

Lorsqu’un dossier est créé automatiquement (aucune --folder-key), le déploiement tente de:

  1. Affectez un modèle de machine sans serveur au niveau du locataire au dossier. Si aucun modèle sans serveur n'existe dans le locataire, l'enregistrement échoue et le déploiement fait apparaître un avertissement — vous devez en attribuer un manuellement.
  2. Choisissez un utilisateur attribuable et accordez-lui le rôle Automation User dans le dossier. Si ce rôle n'existe pas dans le locataire, l'enregistrement échoue avec un avertissement.

Les conflits lors de l’affectation de la machine ou de l’utilisateur sont traités comme des réussites idempotentes.

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