uip ou máquinas

Sintaxe e opções para "uip ou máquinas", que gerencia modelos de máquina definindo onde os robôs são executados e quantos slots de licença são alocados.

uip or machines gerencia modelos de máquinas — definições de host de robôs que descrevem onde os robôs são executados e quantos slots de licença de cada tipo são alocados. As máquinas têm o escopo de tenant, mas podem ser atribuídas a pastas específicas.

Resumo

uip or machines <verb> [options]

Verbo

Texto	Finalidade
list	Liste máquinas no tenant ou máquinas atribuídas a uma pasta específica.
get	Busca uma máquina por chave.
create	Crie um novo modelo de máquina (opcionalmente sem servidor).
update (alias edit)	Atualizar o nome, descrição ou alocação de slots de uma máquina.
delete	Exclua uma ou mais máquinas.
assign	Atribua máquinas a uma pasta.
unassign	Remove máquinas de uma pasta.

lista de uip ou máquinas

Listar máquinas. Sem --folder-key ou --folder-path, retorna todas as máquinas no tenant. Com qualquer sinalizador, retorna apenas máquinas atribuídas a essa pasta.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-key	GUID	—	Escopo para uma pasta por chave.
—	--folder-path	Path	—	Escopo para uma pasta por caminho.
-n	--name	text	—	Contains-match no nome da máquina.
—	--scope	ENUM	—	Default, Shared, PersonalWorkspace, Cloud, Serverless, AutomationCloudRobot, ElasticRobot.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--sort-by	Campo	Id desc	Classificação OData.
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa.

Exemplos

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}'

Formato dos dados (--output json)

{
  "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 }
}

uiip ou máquinas obtêm

Buscar uma máquina por chave GUID. Nenhum contexto de pasta necessário — as máquinas têm o escopo de tenant.

Argumentos

Name	Required	Finalidade
<machine-key>	sim	Chave da máquina (GUID). Encontre-o com machines list.

Opções

Short	Long	Valor	Padrão	Description
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa.

Exemplos

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'

Formato dos dados (--output json)

{
  "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"
  }
}

uip ou máquinas criam

Crie um novo modelo de máquina. --name é necessário; com --serverless, a máquina é criada como um modelo hospedado na nuvem (portátil).

Opções

Short	Long	Valor	Padrão	Description
-n	--name	text	necessário	Nome da máquina (deve ser exclusivo dentro do tenant).
-d	--description	text	—	Descrição da máquina.
—	--serverless	Bandeira	desativada	Crie uma máquina sem servidor (hospedada na nuvem).
—	--unattended-slots	Número	—	Slots de robôs não assistidos.
—	--headless-slots	Número	—	Slots de robôs sem cabeça.
—	--non-production-slots	Número	—	Slots de robôs non-production.
—	--testing-slots	Número	—	Slots de robôs de automação de teste.

Exemplos

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'

Formato dos dados (--output json)

{
  "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": ""
  }
}

Atualização da uip ou máquinas

Atualizar o nome, descrição ou alocação de slots de uma máquina. Apenas as opções fornecidas serão atualizadas; os campos omitidos permanecem inalterados.

edit é um alias registrado para esse verbo — uip or machines edit funciona de forma idêntica a uip or machines update.

Argumentos

Name	Required	Finalidade
<machine-key>	sim	Chave da máquina (GUID).

Opções

Short	Long	Valor	Padrão	Description
-n	--name	text	—	Nome da nova máquina.
-d	--description	text	—	Nova descrição da máquina.
—	--unattended-slots	Número	—	Slots de robôs não assistidos.
—	--headless-slots	Número	—	Slots de robôs sem cabeça.
—	--non-production-slots	Número	—	Slots de robôs non-production.
—	--testing-slots	Número	—	Slots de robôs de automação de teste.

Exemplos

uip or machines update a1b2c3d4-0000-0000-0000-000000000010 --unattended-slots 5
uip or machines update a1b2c3d4-0000-0000-0000-000000000010 \
    --name "staging-worker-eu" --description "EU staging host"
uip or machines update a1b2c3d4-0000-0000-0000-000000000010 \
    --unattended-slots 5 --output-filter 'Data.Status'

Formato dos dados (--output json)

{
  "Code": "MachineUpdate",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Name": "staging-worker",
    "Status": "Updated successfully"
  }
}

exclusão da uip ou máquinas

Exclua uma ou mais máquinas. Uma única chave usa DeleteById várias chaves usam a API em massa. As máquinas devem ter a atribuição cancelada de todas as pastas antes da exclusão.

Argumentos

Name	Required	Finalidade
<machine-keys...>	sim	Uma ou mais chaves de máquina (GUIDs).

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Obrigatório. Confirma esta operação irreversível — a CLI nunca solicita.

Exemplos

uip or machines delete a1b2c3d4-0000-0000-0000-000000000010 --yes
uip or machines delete key-1 key-2 key-3 --yes
uip or machines delete key-1 key-2 --yes --output-filter 'Data.Count'

Formato dos dados (--output json)

{
  "Code": "MachineDelete",
  "Data": {
    "Deleted": [
      { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Name": "staging-worker" }
    ],
    "Count": 1,
    "Status": "Deleted successfully"
  }
}

uip ou máquinas atribuem

Atribua uma ou mais máquinas a uma pasta. Requer --folder-path ou --folder-key.

Argumentos

Name	Required	Finalidade
<machine-keys...>	sim	Uma ou mais chaves de máquina (GUIDs).

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	—	Pasta de destino por caminho.
—	--folder-key	GUID	—	Pasta de destino por chave.

Exemplos

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'

Formato dos dados (--output json)

{
  "Code": "MachineAssign",
  "Data": {
    "MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
    "FolderPath": "Shared",
    "Count": 1,
    "Status": "Assigned successfully"
  }
}

cancelamento de atribuição de uip ou máquinas

Remove máquinas de uma pasta. As máquinas não são excluídas — apenas sua atribuição de pasta é removida. Requer --folder-path ou --folder-key.

Argumentos

Name	Required	Finalidade
<machine-keys...>	sim	Uma ou mais chaves de máquina (GUIDs).

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	—	Pasta da qual cancelar a atribuição.
—	--folder-key	GUID	—	Pasta da qual cancelar a atribuição.

Exemplos

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'

Formato dos dados (--output json)

{
  "Code": "MachineUnassign",
  "Data": {
    "MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
    "FolderPath": "Shared",
    "Count": 1,
    "Status": "Unassigned successfully"
  }
}

Códigos de saída

Consulte Códigos de saída. Nenhuma substituição específica do verbo.

Comandos relacionados

• uip or folders — especialmente folders runtimes para inspecionar a alocação de máquina do lado da pasta.
• uip or licenses — licenses toggle habilita/desabilita o licenciamento em uma máquina específica.
• uip or jobs — jobs start --machine-keys tem como alvo máquinas específicas.

Veja também

• Opções globais.