UIP 或计算机

“uip 或计算机”的语法和选项，用于管理计算机模板，定义机器人的执行位置以及分配的许可证插槽数量。

uip or machines管理计算机模板 — 描述机器人执行位置以及为每种类型分配的许可证插槽数量的机器人主机定义。计算机在租户范围内，但可以将其分配给特定文件夹。

大纲

uip or machines <verb> [options]

动词

动词	用途
list	列出租户中的计算机或分配到特定文件夹的计算机。
get	通过密钥获取一台计算机。
create	创建新的计算机模板（可以使用无服务器模板）。
update （别名 edit）	更新计算机的名称、描述或槽分配。
delete	删除一台或多台计算机。
assign	将计算机分配到文件夹。
unassign	从文件夹中删除计算机。

UIP 或计算机列表

列出计算机。缺少--folder-key或--folder-path ，将返回租户中的每台计算机。使用任一标志时，仅返回分配给该文件夹的计算机。

选项

短	长	值	默认	描述
—	--folder-key	GUID	—	按键作用域到文件夹。
—	--folder-path	路径	—	按路径将范围限制为文件夹。
-n	--name	text	—	计算机名称的包含匹配项。
—	--scope	枚举	—	Default、 Shared 、 PersonalWorkspace 、 Cloud 、 Serverless 、 AutomationCloudRobot 、 ElasticRobot 。
-l	--limit	数字	50	页面大小。
—	--offset	数字	0	跳过计数。
—	--sort-by	字段	Id desc	OData 排序。
—	--all-fields	标记	关闭	返回完整的 API 有效负载。

示例

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

数据形状（--输出 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 }
}

uip 或 machines get

通过 GUID 密钥获取计算机。不需要文件夹上下文 — 计算机是租户作用域。

参数

名称	必填	用途
<machine-key>	是	计算机密钥 (GUID)。使用machines list查找。

选项

短	长	值	默认	描述
—	--all-fields	标记	关闭	返回完整的 API 有效负载。

示例

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'

数据形状（--输出 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 或计算机创建

新建计算机模板。必须填写--name ；使用--serverless ，计算机将创建为云托管（便携式）模板。

选项

短	长	值	默认	描述
-n	--name	text	必填	计算机名称（在租户中必须唯一）。
-d	--description	text	—	计算机描述。
—	--serverless	标记	关闭	创建无服务器（云托管）计算机。
—	--unattended-slots	数字	—	Unattended Robot 插槽。
—	--headless-slots	数字	—	无头机器人插槽.
—	--non-production-slots	数字	—	非生产机器人插槽。
—	--testing-slots	数字	—	测试自动化机器人插槽。

示例

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'

数据形状（--输出 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": ""
  }
}

uip 或计算机更新

更新计算机的名称、描述或槽分配。仅更新提供的选项；省略的字段保持不变。

edit 是此动词的已注册别名，uip or machines edit 的作用与 uip or machines update 相同。

参数

名称	必填	用途
<machine-key>	是	计算机密钥 (GUID)。

选项

短	长	值	默认	描述
-n	--name	text	—	新计算机名称。
-d	--description	text	—	新的计算机描述。
—	--unattended-slots	数字	—	Unattended Robot 插槽。
—	--headless-slots	数字	—	无头机器人插槽.
—	--non-production-slots	数字	—	非生产机器人插槽。
—	--testing-slots	数字	—	测试自动化机器人插槽。

示例

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'

数据形状（--输出 json）

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

uip 或计算机删除

删除一台或多台计算机。单键使用DeleteById ；多个密钥使用批量 API。在删除之前，必须从所有文件夹中取消分配计算机。

参数

名称	必填	用途
<machine-keys...>	是	一个或多个计算机密钥 (GUID)。

选项

短	长	值	默认	描述
-y	--yes	标记	—	必需。确认此不可撤销的操作 — CLI 从不提示。

示例

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'

数据形状（--输出 json）

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

uip 或计算机分配

将一台或多台计算机分配到文件夹。需要--folder-path或--folder-key 。

参数

名称	必填	用途
<machine-keys...>	是	一个或多个计算机密钥 (GUID)。

选项

短	长	值	默认	描述
—	--folder-path	路径	—	路径中的目标文件夹。
—	--folder-key	GUID	—	密钥目标文件夹。

示例

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'

数据形状（--输出 json）

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

uip 或计算机取消分配

从文件夹中删除计算机。计算机不会删除，仅会删除其分配的文件夹。需要--folder-path或--folder-key 。

参数

名称	必填	用途
<machine-keys...>	是	一个或多个计算机密钥 (GUID)。

选项

短	长	值	默认	描述
—	--folder-path	路径	—	要从中取消分配的文件夹。
—	--folder-key	GUID	—	要从中取消分配的文件夹。

示例

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'

数据形状（--输出 json）

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

退出代码

请参阅退出代码。没有动词特定的覆盖。

相关命令

• uip or folders — 尤其是folders runtimes ，用于从文件夹端检查计算机分配。
• uip or licenses — licenses toggle在特定计算机上启用/禁用许可。
• uip or jobs — jobs start --machine-keys面向特定计算机。

另请参阅

• 全局选项。