Exécution d’agent UIP

uip agent run démarre et surveille les tâches d’agent sur Orchestrator. En interne, chaque sous-commande appelle les points de terminaison OData des tâches/versions standard d'Orchestrator, les mêmes points de terminaison que uip or jobs exposés, étendus aux versions produites par uip agent deploy.

Chaque sous-commande nécessite une session CLI active (uip login). Si aucun --folder-id n'est transmis, la commande utilisera le dossier lié à la session en cours.

Synthèse

uip agent run start <releaseKeyOrName> [-i <json>] [--folder-id <id>] [-t <tenant>] [--login-validity <minutes>]
uip agent run status <jobId>                         [--folder-id <id>] [-t <tenant>] [--login-validity <minutes>]
uip agent run list                                   [--folder-id <id>] [--filter <odata>] [-t <tenant>] [--login-validity <minutes>]

Toutes les sous-commandes uip agent run respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

début de l’exécution de l’agent uip

Démarrer une tâche pour une version d'agent déployée.

Arguments

• <releaseKeyOrName> (requis) : soit une clé de version, soit un nom de version. Si la valeur n'est pas un GUID, la commande effectue une recherche de nom par rapport au point de terminaison OData des versions ($filter=Name eq '<name>').

Options

Drapeau	Default	Objectif
-i, --inputs <json>	{}	Les arguments d'entrée sous la forme d'une chaîne JSON. Doit être un JSON valide.
--folder-id <id>	dossier de connexion	ID d'unité organisationnelle du dossier Orchestrator. Envoyé en tant que X-UIPATH-OrganizationUnitId.
-t, --tenant <tenant>	se connecter au locataire	Locataire cible.
--login-validity <minutes>	10	Nombre minimum de minutes de validité du jeton requis.

Exemples

# Start by release key (the exact key from 'agent run list')
uip agent run start a1b2c3d4-0000-0000-0000-000000000401 -i '{"input":"hello"}'

# Start by release name (resolved via OData lookup)
uip agent run start InvoiceAgent -i '{"invoiceUrl":"…"}' --folder-id 42

# Start with no inputs
uip agent run start InvoiceAgent

Format des données (--sortie json)

{
  "Code": "AgentJobStarted",
  "Data": {
    "JobId": 12345,
    "JobKey": "a1b2c3d4-0000-0000-0000-000000000410",
    "State": "Pending"
  }
}

JobId est l'ID numérique que vous transmettez à uip agent run status. JobKey est l'équivalent GUID, utile pour les références croisées par rapport à l'interface utilisateur d'Orchestrator ou aux commandes uip or jobs . Les tâches sont démarrées par Strategy: ModernJobsCount et JobsCount: 1.

statut d’exécution de l’agent uip

Récupérez l'état actuel d'une tâche unique.

Arguments

• <jobId> (requis) : ID de tâche Orchestrator numérique (de run start ou uip or jobs list).

Options

Identique à run start (--folder-id, -t/--tenant, --login-validity).

Exemples

# Quick status check
uip agent run status 12345

# Explicit folder
uip agent run status 12345 --folder-id 42

Format des données (--sortie json)

{
  "Code": "AgentJobStatus",
  "Data": {
    "JobId": 12345,
    "State": "Successful",
    "ReleaseName": "InvoiceAgent",
    "StartTime": "2025-04-15T10:30:00Z",
    "EndTime": "2025-04-15T10:31:12Z",
    "Info": "…",
    "Output": { "...": "..." }
  }
}

• Les valeurs State reflètent les états des tâches d'Orchestrator (Pending, Running, Successful, Faulted, Stopped, Suspended, …).
• Info n'est présent que lorsque la tâche comporte un message d'état (généralement en cas d'échec).
• Output est OutputArguments analysé en tant que JSON. Si l’analyse échoue, la chaîne brute est renvoyée à la place.

Liste des exécutions d’agents UIP

Répertoriez les versions d'agent disponibles dans un dossier.

Arguments

Aucun

Options

Drapeau	Default	Objectif
--folder-id <id>	dossier de connexion	ID d'unité organisationnelle du dossier Orchestrator.
--filter <odata>	—	Expression OData $filter supplémentaire ajoutée à la requête par défaut (qui est déjà triée par Name).
-t, --tenant <tenant>	se connecter au locataire	Locataire cible.
--login-validity <minutes>	10	Nombre minimum de minutes de validité du jeton requis.

Exemples

# List all releases in the login folder
uip agent run list

# List in a specific folder
uip agent run list --folder-id 42

# Filter by name prefix
uip agent run list --filter "startswith(Name,'Invoice')"

Format des données (--sortie json)

{
  "Code": "AgentReleaseList",
  "Data": [
    {
      "Name": "InvoiceAgent",
      "ReleaseKey": "a1b2c3d4-0000-0000-0000-000000000401",
      "ProcessKey": "InvoiceAgent",
      "Version": "1.0.0",
      "FolderId": 42
    }
  ]
}

Un dossier vide renvoie une entrée de journal Message (No releases found in this folder. Publish an agent first.) et aucune charge utile de réussite.

Associé

• uip agent deploy — publie les versions que run list énumère.
• uip agent eval run start — l'équivalent d'évaluation de run start, ciblant le service Agent Runtime plutôt qu'une tâche Orchestrator.
• Orchestrator: tâches — l'API complète des tâches (arrêt, redémarrage, journaux, pièces jointes).

Voir également

• Authentification — sessions, locataires et --login-validity.
• Options globales, codes de sortie.