ejecución de agente de uip

uip agent run y supervisa trabajos de agente en Orchestrator. Internamente, cada subcomando llama a los puntos finales estándar de Trabajos/Lanzamientos de OData de Orchestrator, los mismos puntos finales que uip or jobs expone, con ámbito para las versiones producidas por uip agent deploy.

Cada subcomando requiere una sesión CLI activa (uip login). Si no se pasa --folder-id , el comando utiliza la carpeta vinculada a la sesión actual.

Sinopsis

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

Todos los subcomandos uip agent run respetan las opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato estándar.

inicio de la ejecución del agente de uip

Inicia un trabajo para una versión de agente implementada.

Argumentos

• <releaseKeyOrName> obligatorio) : una clave de versión (GUID) o un nombre de versión. Si el valor no es un GUID, el comando realiza una búsqueda de nombres en el punto final de Versiones de OData ($filter=Name eq '<name>').

Opciones

Marca	Predeterminado	Propósito
-i, --inputs <json>	{}	Argumentos de entrada como una cadena JSON. Debe ser un JSON válido.
--folder-id <id>	carpeta de inicio de sesión	ID de la unidad organizativa de la carpeta de Orchestrator. Enviado como X-UIPATH-OrganizationUnitId.
-t, --tenant <tenant>	tenant de inicio de sesión	Tenant de destino.
--login-validity <minutes>	10	Minutos mínimos de validez del token requeridos.

Ejemplos

# 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

Forma de datos (--json de salida)

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

JobId es el ID numérico que pasas a uip agent run status. JobKey es el GUID equivalente, útil para referencias cruzadas contra la IU de Orchestrator o los comandos uip or jobs . Los trabajos se inician con Strategy: ModernJobsCount y JobsCount: 1.

estado de ejecución del agente de uip

Obtener el estado actual de un solo trabajo.

Argumentos

• (obligatorio) <jobId> ID de trabajo numérico de Orchestrator (de run start o uip or jobs list).

Opciones

Igual que run start (--folder-id, -t/--tenant, --login-validity).

Ejemplos

# Quick status check
uip agent run status 12345

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

Forma de datos (--json de salida)

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

• Los valores State reflejan los estados de trabajo de Orchestrator (Pending, Running, Successful, Faulted, Stopped, Suspended, …).
• Info solo está presente cuando el trabajo lleva un mensaje de estado (normalmente en caso de fallo).
• Output se OutputArguments analiza como JSON. Si el análisis falla, se devuelve la cadena sin formato en su lugar.

lista de ejecución de agente de uip

Enumera las versiones de agente disponibles en una carpeta.

Argumentos

Nada.

Opciones

Marca	Predeterminado	Propósito
--folder-id <id>	carpeta de inicio de sesión	ID de la unidad organizativa de la carpeta de Orchestrator.
--filter <odata>	—	Expresión adicional de OData $filter anexada a la consulta predeterminada (que ya se ordena por Name).
-t, --tenant <tenant>	tenant de inicio de sesión	Tenant de destino.
--login-validity <minutes>	10	Minutos mínimos de validez del token requeridos.

Ejemplos

# 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')"

Forma de datos (--json de salida)

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

Una carpeta vacía devuelve una entrada de registro Message (No releases found in this folder. Publish an agent first.) y ninguna carga útil correcta.

Relacionado

• uip agent deploy — publica los lanzamientos que run list enumera.
• uip agent eval run start : la evaluación equivalente a run start, dirigida al servicio Agent Runtime en lugar de un trabajo de Orchestrator.
• Orchestrator: trabajos : la API de trabajos completos (detener, reiniciar, registros, archivos adjuntos).

Ver también

• Autenticación : sesiones, tenants y --login-validity.
• Opciones globales, códigos de salida.