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

Guía del usuario de UiPath CLI

uip o máquinas

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

VerboPropósito
listEnumera las máquinas en el tenant o las máquinas asignadas a una carpeta específica.
getObtener una máquina por clave.
createCrea una nueva plantilla de máquina (opcionalmente sin servidor).
editEditar el nombre, la descripción o la asignación de ranuras de una máquina.
deleteElimina una o más máquinas.
assignAsigna máquinas a una carpeta.
unassignEliminar 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

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.
--folder-keyGUIDÁmbito a una carpeta por clave.
--folder-pathRutaÁmbito a una carpeta por ruta.
-n--nametextContiene coincidencia en el nombre de la máquina.
--scopeENUMDefault, Shared, PersonalWorkspace, Cloud, Serverless, AutomationCloudRobot, ElasticRobot.
-l--limitNúmero50Tamaño de la página.
--offsetNúmero0Omitir recuento.
--order-byCampoId descOrdenación de OData.
--all-fieldsMarcaDesactivadoDevuelve 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

NombreObligatorioPropósito
<machine-key>Clave de la máquina (GUID). Encuéntralo con machines list.

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.
--all-fieldsMarcaDesactivadoDevuelve 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

CortoLargoValorPredeterminadoDescripción
-n--nametextobligatorioNombre de la máquina (debe ser único dentro del tenant).
-d--descriptiontextDescripción de la máquina.
--serverlessMarcaDesactivadoCrea una máquina sin servidor (alojada en la nube).
--unattended-slotsNúmeroRanuras de robots desatendidos.
--headless-slotsNúmeroTragamonedas de robot sin cabeza.
--non-production-slotsNúmeroRanuras de robot de no producción.
--testing-slotsNúmeroRanuras de robot de automatización de pruebas.
-t--tenantnamesesión predeterminadaAnula 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

NombreObligatorioPropósito
<machine-key>Clave de la máquina (GUID).

Opciones

CortoLargoValorPredeterminadoDescripción
-n--nametextNuevo nombre de la máquina.
-d--descriptiontextNueva descripción de la máquina.
--unattended-slotsNúmeroRanuras de robots desatendidos.
--headless-slotsNúmeroTragamonedas de robot sin cabeza.
--non-production-slotsNúmeroRanuras de robot de no producción.
--testing-slotsNúmeroRanuras de robot de automatización de pruebas.
-t--tenantnamesesión predeterminadaAnula 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

NombreObligatorioPropósito
<machine-keys...>Una o más claves de máquina (GUID).

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula 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

NombreObligatorioPropósito
<machine-keys...>Una o más claves de máquina (GUID).

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.
--folder-pathRutaCarpeta de destino por ruta.
--folder-keyGUIDCarpeta 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

NombreObligatorioPropósito
<machine-keys...>Una o más claves de máquina (GUID).

Opciones

CortoLargoValorPredeterminadoDescripción
-t--tenantnamesesión predeterminadaAnula el tenant.
--folder-pathRutaCarpeta de la que desasignar.
--folder-keyGUIDCarpeta 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.

  • uip or folders , especialmente folders runtimes para inspeccionar la asignación de máquinas desde el lado de la carpeta.
  • uip or licenseslicenses toggle habilita/deshabilita las licencias en una máquina específica.
  • uip or jobs : jobs start --machine-keys se dirige a máquinas específicas.

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