- Información general
- Comience ya
- Conceptos
- Uso de UiPath CLI
- UiPath para agentes de codificación
- Guías prácticas
- Recetas de CI/CD
- Referencia de los comandos
- Información general
- Códigos de salida
- Opciones globales
- agente de código UIP
- UIP Docsai
- añadir-entidad-de-datos-de-prueba
- añadir-cola-de-datos-de-prueba
- añadir-variación-de-datos-de-prueba
- Analizar
- Crear
- Crear proyecto
- Diferencia
- Buscar actividades
- obtener-reglas-del-analizador
- obtener-predeterminado-actividad-xaml
- obtener-errores
- obtener-casos-de-prueba-manual
- obtener-pasos-de-prueba-manual
- obtener versiones
- get-workflow-example
- indicar-aplicación
- indicar-elemento
- inspeccionar-paquete
- install-data-fabric-entities
- instalar-o-actualizar-paquetes
- enumerar-data-fabric-entities
- ejemplos-de-flujo-de-trabajo-de-lista
- Paquete
- restore
- archivo de ejecución
- plantillas-de-búsqueda
- iniciar-studio
- detener la ejecución
- UIA
- Seguimientos de UIP
- Migración
- Referencia y soporte
Guía del usuario de UiPath CLI
uip or machines las plantillas de máquina: definiciones de host de robot que describen dónde se ejecutan los robots y cuántos espacios de licencia de cada tipo se asignan. Las máquinas tienen ámbito de tenant, pero pueden asignarse a carpetas específicas.
Sinopsis
uip or machines <verb> [options]
uip or machines <verb> [options]
Verbos
| Verbo | Propósito |
|---|---|
list | Enumera las máquinas en el tenant o las máquinas asignadas a una carpeta específica. |
get | Obtener una máquina por clave. |
create | Crea una nueva plantilla de máquina (opcionalmente sin servidor). |
edit | Editar el nombre, la descripción o la asignación de ranuras de una máquina. |
delete | Elimina una o más máquinas. |
assign | Asigna máquinas a una carpeta. |
unassign | Eliminar máquinas de una carpeta. |
uip o lista de máquinas
Enumerar máquinas. Sin --folder-key o --folder-path, devuelve todas las máquinas del tenant. Con cualquiera de los marcadores, devuelve solo las máquinas asignadas a esa carpeta.
Opciones
| Corto | Largo | Valor | Predeterminado | Descripción |
|---|---|---|---|---|
-t | --tenant | name | sesión predeterminada | Anula el tenant. |
| — | --folder-key | GUID | — | Ámbito a una carpeta por clave. |
| — | --folder-path | Ruta | — | Ámbito a una carpeta por ruta. |
-n | --name | text | — | Contiene coincidencia en el nombre de la máquina. |
| — | --scope | ENUM | — | Default, Shared, PersonalWorkspace, Cloud, Serverless, AutomationCloudRobot, ElasticRobot. |
-l | --limit | Número | 50 | Tamaño de la página. |
| — | --offset | Número | 0 | Omitir recuento. |
| — | --order-by | Campo | Id desc | Ordenación de OData. |
| — | --all-fields | Marca | Desactivado | Devuelve la carga útil de la API completa. |
Ejemplos
uip or machines list --limit 10
uip or machines list --folder-path "Shared"
uip or machines list --scope Serverless \
--output-filter 'Data[].{name:Name, slots:UnattendedSlots}'
uip or machines list --limit 10
uip or machines list --folder-path "Shared"
uip or machines list --scope Serverless \
--output-filter 'Data[].{name:Name, slots:UnattendedSlots}'
Forma de datos (--json de salida)
{
"Code": "MachineList",
"Data": [
{
"Name": "prod-worker-01",
"ID": 101,
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Type": "Standard",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 3,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
}
],
"Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}
{
"Code": "MachineList",
"Data": [
{
"Name": "prod-worker-01",
"ID": 101,
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Type": "Standard",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 3,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
}
],
"Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}
uip o máquinas obtener
Obtener una máquina mediante clave GUID. No se requiere contexto de carpeta: las máquinas tienen ámbito de tenant.
Argumentos
| Nombre | Obligatorio | Propósito |
|---|---|---|
<machine-key> | Sí | Clave de la máquina (GUID). Encuéntralo con machines list. |
Opciones
| Corto | Largo | Valor | Predeterminado | Descripción |
|---|---|---|---|---|
-t | --tenant | name | sesión predeterminada | Anula el tenant. |
| — | --all-fields | Marca | Desactivado | Devuelve la carga útil de la API completa. |
Ejemplos
uip or machines get a1b2c3d4-0000-0000-0000-000000000001
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 --all-fields
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 \
--output-filter 'Data.UnattendedSlots'
uip or machines get a1b2c3d4-0000-0000-0000-000000000001
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 --all-fields
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 \
--output-filter 'Data.UnattendedSlots'
Forma de datos (--json de salida)
{
"Code": "MachineGet",
"Data": {
"Name": "prod-worker-01",
"ID": 101,
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Type": "Standard",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 3,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
}
}
{
"Code": "MachineGet",
"Data": {
"Name": "prod-worker-01",
"ID": 101,
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"Type": "Standard",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 3,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
}
}
creación de uip o máquinas
Crea una nueva plantilla de máquina. --name es obligatorio; con --serverless, la máquina se crea como una plantilla alojada en la nube (Portátil).
Opciones
| Corto | Largo | Valor | Predeterminado | Descripción |
|---|---|---|---|---|
-n | --name | text | obligatorio | Nombre de la máquina (debe ser único dentro del tenant). |
-d | --description | text | — | Descripción de la máquina. |
| — | --serverless | Marca | Desactivado | Crea una máquina sin servidor (alojada en la nube). |
| — | --unattended-slots | Número | — | Ranuras de robots desatendidos. |
| — | --headless-slots | Número | — | Tragamonedas de robot sin cabeza. |
| — | --non-production-slots | Número | — | Ranuras de robot de no producción. |
| — | --testing-slots | Número | — | Ranuras de robot de automatización de pruebas. |
-t | --tenant | name | sesión predeterminada | Anula el tenant. |
Ejemplos
uip or machines create --name "staging-worker" --unattended-slots 2
uip or machines create --name "serverless-pool" --serverless \
--unattended-slots 10
uip or machines create --name "qa-host" --unattended-slots 1 --testing-slots 2 \
--output-filter 'Data.Key'
uip or machines create --name "staging-worker" --unattended-slots 2
uip or machines create --name "serverless-pool" --serverless \
--unattended-slots 10
uip or machines create --name "qa-host" --unattended-slots 1 --testing-slots 2 \
--output-filter 'Data.Key'
Forma de datos (--json de salida)
{
"Code": "MachineCreated",
"Data": {
"Name": "staging-worker",
"ID": 103,
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Type": "Template",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 2,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": ""
}
}
{
"Code": "MachineCreated",
"Data": {
"Name": "staging-worker",
"ID": 103,
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Type": "Template",
"Scope": "Default",
"Description": "",
"UnattendedSlots": 2,
"HeadlessSlots": 0,
"NonProductionSlots": 0,
"TestAutomationSlots": 0,
"LicenseKey": ""
}
}
edición de uip o máquinas
Editar el nombre, la descripción o la asignación de ranuras de una máquina. Solo se actualizan las opciones proporcionadas; los campos omitidos permanecen sin cambios.
Argumentos
| Nombre | Obligatorio | Propósito |
|---|---|---|
<machine-key> | Sí | Clave de la máquina (GUID). |
Opciones
| Corto | Largo | Valor | Predeterminado | Descripción |
|---|---|---|---|---|
-n | --name | text | — | Nuevo nombre de la máquina. |
-d | --description | text | — | Nueva descripción de la máquina. |
| — | --unattended-slots | Número | — | Ranuras de robots desatendidos. |
| — | --headless-slots | Número | — | Tragamonedas de robot sin cabeza. |
| — | --non-production-slots | Número | — | Ranuras de robot de no producción. |
| — | --testing-slots | Número | — | Ranuras de robot de automatización de pruebas. |
-t | --tenant | name | sesión predeterminada | Anula el tenant. |
Ejemplos
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 --unattended-slots 5
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
--name "staging-worker-eu" --description "EU staging host"
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
--unattended-slots 5 --output-filter 'Data.Status'
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 --unattended-slots 5
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
--name "staging-worker-eu" --description "EU staging host"
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
--unattended-slots 5 --output-filter 'Data.Status'
Forma de datos (--json de salida)
{
"Code": "MachineUpdate",
"Data": {
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Name": "staging-worker",
"Status": "Updated successfully"
}
}
{
"Code": "MachineUpdate",
"Data": {
"Key": "a1b2c3d4-0000-0000-0000-000000000010",
"Name": "staging-worker",
"Status": "Updated successfully"
}
}
eliminar uip o máquinas
Elimina una o más máquinas. Una sola clave utiliza DeleteById; varias claves utilizan la API masiva. Las máquinas deben estar desasignadas de todas las carpetas antes de su eliminación.
Argumentos
| Nombre | Obligatorio | Propósito |
|---|---|---|
<machine-keys...> | Sí | Una o más claves de máquina (GUID). |
Opciones
| Corto | Largo | Valor | Predeterminado | Descripción |
|---|---|---|---|---|
-t | --tenant | name | sesión predeterminada | Anula el tenant. |
Ejemplos
uip or machines delete a1b2c3d4-0000-0000-0000-000000000010
uip or machines delete key-1 key-2 key-3
uip or machines delete key-1 key-2 --output-filter 'Data.Count'
uip or machines delete a1b2c3d4-0000-0000-0000-000000000010
uip or machines delete key-1 key-2 key-3
uip or machines delete key-1 key-2 --output-filter 'Data.Count'
Forma de datos (--json de salida)
{
"Code": "MachineDelete",
"Data": {
"Deleted": [
{ "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Name": "staging-worker" }
],
"Count": 1,
"Status": "Deleted successfully"
}
}
{
"Code": "MachineDelete",
"Data": {
"Deleted": [
{ "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Name": "staging-worker" }
],
"Count": 1,
"Status": "Deleted successfully"
}
}
UIP o asignación de máquinas
Asigna una o más máquinas a una carpeta. Requiere --folder-path o --folder-key.
Argumentos
| Nombre | Obligatorio | Propósito |
|---|---|---|
<machine-keys...> | Sí | Una o más claves de máquina (GUID). |
Opciones
| Corto | Largo | Valor | Predeterminado | Descripción |
|---|---|---|---|---|
-t | --tenant | name | sesión predeterminada | Anula el tenant. |
| — | --folder-path | Ruta | — | Carpeta de destino por ruta. |
| — | --folder-key | GUID | — | Carpeta de destino por clave. |
Ejemplos
uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared"
uip or machines assign key-1 key-2 --folder-key b1c2d3e4-0000-0000-0000-000000000001
uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared" --output-filter 'Data.Status'
uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared"
uip or machines assign key-1 key-2 --folder-key b1c2d3e4-0000-0000-0000-000000000001
uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared" --output-filter 'Data.Status'
Forma de datos (--json de salida)
{
"Code": "MachineAssign",
"Data": {
"MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
"FolderPath": "Shared",
"Count": 1,
"Status": "Assigned successfully"
}
}
{
"Code": "MachineAssign",
"Data": {
"MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
"FolderPath": "Shared",
"Count": 1,
"Status": "Assigned successfully"
}
}
desasignar uip o máquinas
Eliminar máquinas de una carpeta. Las máquinas no se eliminan, solo se elimina su asignación de carpetas. Requiere --folder-path o --folder-key.
Argumentos
| Nombre | Obligatorio | Propósito |
|---|---|---|
<machine-keys...> | Sí | Una o más claves de máquina (GUID). |
Opciones
| Corto | Largo | Valor | Predeterminado | Descripción |
|---|---|---|---|---|
-t | --tenant | name | sesión predeterminada | Anula el tenant. |
| — | --folder-path | Ruta | — | Carpeta de la que desasignar. |
| — | --folder-key | GUID | — | Carpeta de la que desasignar. |
Ejemplos
uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared"
uip or machines unassign key-1 key-2 --folder-path "Production"
uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared" --output-filter 'Data.Count'
uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared"
uip or machines unassign key-1 key-2 --folder-path "Production"
uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
--folder-path "Shared" --output-filter 'Data.Count'
Forma de datos (--json de salida)
{
"Code": "MachineUnassign",
"Data": {
"MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
"FolderPath": "Shared",
"Count": 1,
"Status": "Unassigned successfully"
}
}
{
"Code": "MachineUnassign",
"Data": {
"MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
"FolderPath": "Shared",
"Count": 1,
"Status": "Unassigned successfully"
}
}
Códigos de salida
Consulta Códigos de salida. Sin anulaciones específicas de verbos.
Comandos relacionados
uip or folders, especialmentefolders runtimespara inspeccionar la asignación de máquinas desde el lado de la carpeta.uip or licenses—licenses togglehabilita/deshabilita las licencias en una máquina específica.uip or jobs:jobs start --machine-keysse dirige a máquinas específicas.
Ver también
- Sinopsis
- Verbos
- uip o lista de máquinas
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- uip o máquinas obtener
- Argumentos
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- creación de uip o máquinas
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- edición de uip o máquinas
- Argumentos
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- eliminar uip o máquinas
- Argumentos
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- UIP o asignación de máquinas
- Argumentos
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- desasignar uip o máquinas
- Argumentos
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- Códigos de salida
- Comandos relacionados
- Ver también