UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

UIP o

Manage Orchestrator jobs, folders, processes, packages, machines, users, roles, licenses, and runtime resources using the `uip or` tool.

uip or is the Orchestrator tool: it manages jobs, folders, processes, packages, machines, users, roles, licenses, feeds, attachments, and the runtime resources automations depend on (assets, buckets, queues, triggers, libraries, webhooks) on a UiPath Orchestrator tenant. Install it with uip tools install or, or invoke uip or … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation.

Recursos

Cada recurso tiene su propia página de referencia. El verbo establecido en cada página coincide con los comandos registrados por uip or — ejecuta uip or --help para confirmar la superficie completa en tu instalación.

RecursoPropósito
TrabajosIniciar, detener, reiniciar, reanudar e inspeccionar ejecuciones de procesos; obtener registros, seguimientos, datos de reparación e historial de estados.
CarpetasCrear, enumerar, mover, editar y eliminar carpetas; inspeccionar la asignación de runtime.
ProcesosVincular paquetes a carpetas como procesos ejecutables; actualizar, revertir y editar.
PaquetesCargar, descargar, enumerar e inspeccionar paquetes de automatización .nupkg y sus puntos de entrada.
MáquinasGestionar las plantillas de máquinas y las asignaciones de ranuras; asignar máquinas a carpetas.
UsuariosCrear, editar, eliminar y asignar usuarios de Orchestrator; gestionar las asignaciones de roles a nivel de tenant.
RolesGestiona roles, permisos y membresía de rol-usuario en el ámbito del tenant y la carpeta.
LicenciasEnumerar las asignaciones de licencias de runtime y de usuario nombrado; alternar licencias de máquina; ver resumen de licencia de tenant.
TransmisionesEnumerar las fuentes de paquetes disponibles para el usuario actual.
Archivos adjuntosEnumerar y descargar archivos adjuntos de trabajo.
ActivosValores de configuración con nombre (Texto, Bool, Entero, Credencial, Secreto) utilizados por las automatizaciones en runtime. Ámbito de carpeta.
DepósitosContenedores de almacenamiento para archivos utilizados por las automatizaciones. Ámbito de carpeta.
archivos-depósitoArchivos individuales dentro de un depósito. Enumerar, cargar, descargar, eliminar y obtener URL prefirmadas.
LibreríasPaquetes .nupkg reutilizables (actividades y lógica compartidas). Ámbito de tenant.
ColasContenedores para elementos de trabajo transaccionales. Ámbito de carpeta.
artículos en colaTransacciones individuales dentro de colas, con controles completos de máquina de estados. Ámbito de carpeta.
DesencadenadoresDesencadenadores de tiempo, cola y API que inician trabajos. Los desencadenadores de tiempo/cola tienen ámbito de carpeta; Los desencadenadores de API tienen ámbito de tenant.
WebhooksDevoluciones de llamada HTTP activadas en eventos de plataforma (finalización de trabajo, fallo de artículo en cola, …). Ámbito de tenant.
almacenes-de-credencialesList and inspect external credential store configurations used by Credential/Secret assets and Azure/Amazon buckets.

Runtime evaluation of deployed packages — submitting runs, scoring outputs, and managing evaluators/eval sets/schedules against an Orchestrator process — is a separate, standalone tool: uip eval (package @uipath/eval-tool, not a uip or sub-command, even though every verb operates against an Orchestrator process/folder).

Sinopsis

uip or <resource> <verb> [options]
uip or <resource> <verb> [options]

Siempre uip or, nunca uip orchestrator. or es el prefijo de comando de la herramienta (consulta la columna commandPrefix en uip tools list).

Cómo leer esta sección

Cada página de recursos está estructurada de la misma manera:

  1. Sinopsis : la forma del comando uip or <resource> <verb> .
  2. Verbos : una tabla de una línea de cada verbo que expone el recurso.
  3. Un H2 por verbo : descripción, argumentos posicionales (si los hay), tabla de marcas, tres ejemplos (el más simple, el caso común, el scripting con --output-filter) y la forma Data devuelta en --output json.
  4. Códigos de salida : un puntero al contrato de códigos de salida compartido, con cualquier anulación específica del verbo llamada en línea.
  5. Comandos relacionados y enlaces cruzados a recursos relacionados y páginas de conceptos relevantes.

El formato de salida predeterminado es --output json. Las formas de datos en cada página reflejan la carga útil de JSON: las representaciones de tabla, yaml y simples se derivan del mismo objeto Data .

Marcadores comunes

Un pequeño conjunto de marcadores se repite en la mayoría de los recursos. Se comportan de la misma manera dondequiera que aparezcan:

MarcaUtilizado porPropósito
--folder-path <path>la mayoría de los verbos que se limitan a una carpetaCarpeta de destino por ruta completa (por ejemplo, Shared, Production/EU).
--folder-key <key>la mayoría de los verbos que se limitan a una carpetaCarpeta de destino por GUID. Utilizable mutuamente con --folder-path; resuelve la misma carpeta.
--all-folderslist on some folder-scoped resources (for example, assets, buckets)List across every folder accessible to the caller instead of scoping to one. Where supported, one of --folder-path, --folder-key, or --all-folders is required.
-l, --limit <number>cada verbo de listaTamaño de la página. El valor predeterminado es el DEFAULT_PAGE_SIZE de CLI (50 en el momento de escribir este artículo).
--offset <number>cada verbo de listaNúmero de elementos que se omitirán antes de volver. El valor predeterminado es 0.
--sort-by <field>la mayoría de los verbos de listaExpresión de ordenación de OData (por ejemplo, Name asc, Id desc). Cada verbo documenta su valor predeterminado.
--all-fieldsmuchos verbos list / getDevuelve la respuesta de la API sin procesar en lugar del resumen seleccionado. Útil cuando necesitas campos que omite la forma predeterminada.
-y, --yesevery destructive (delete) verbConfirm the operation. Required — the CLI never prompts interactively for a destructive action.

Los marcadores a nivel de verbo (filtros, rutas de entrada/salida, estrategias, prioridades) se documentan en cada página de recursos.

Runtime-resource conventions

The runtime-resource pages (assets, buckets, bucket-files, libraries, queues, queue-items, triggers, webhooks) share a few additional conventions on top of the ones above:

  • Folder scoping. Assets, buckets, queues, queue items, and triggers (time / queue) are folder-scoped. Provide either --folder-path <path> (e.g. "Shared") or --folder-key <guid> on list, create, and related calls — or --all-folders where that flag is supported. get, update, and delete resolve cross-folder by key when feasible; each verb's description on the resource page calls it out explicitly. Libraries, API triggers, and webhooks are tenant-scoped and do not accept --folder-*.
  • Claves. La mayoría de los recursos se identifican por un GUID devuelto en la salida list (en key, identifier o, para artículos en cola, uniqueKey para un solo intento y key para la cadena de reintentos). Los campos numéricos id son internos y no deben pasarse a los comandos.
  • Filtrado. Cuando se admite, -n, --name <name> es una coincidencia de contenido en el nombre del recurso; algunos recursos añaden --enabled, --disabled, --status, etc.

Opciones globales y códigos de salida

Todos los verbos uip or respetan las cuatro opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato compartido; cualquier anulación específica del verbo se indica en la página de recursos relevante.

Ver también

  • Recursos
  • Sinopsis
  • Cómo leer esta sección
  • Marcadores comunes
  • Runtime-resource conventions
  • Opciones globales y códigos de salida
  • Ver también

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado