uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
UIP 或许可证
"uip or licenses" 的语法和选项,用于检查和管理 Runtime 和 Named User 的 Orchestrator 许可证分配。
uip or licenses检查和管理 Orchestrator 许可证分配。列出 runtime 和 Named-User 许可证分配情况,开启或关闭计算机许可证,以及查看整体租户许可证摘要(每种机器人类型的允许与使用情况)。
大纲
uip or licenses <verb> [options]
uip or licenses <verb> [options]
动词
| 动词 | 用途 |
|---|---|
list | 列出给定机器人类型(runtime 或 Named User)的许可证分配情况。 |
toggle | 为特定 Runtime Robot 类型启用或禁用计算机许可。 |
info | 显示租户许可证摘要(订阅计划、允许/已使用、功能)。 |
机器人类型参考
--type标志接受这些机器人类型。命令行为分为两个存储桶:
- runtime 类型— 计算机级分配:
Unattended、NonProduction、Headless、TestAutomation。 - 已命名用户类型— 用户级分配:
Attended、Development、Studio、StudioX、RpaDeveloper、CitizenDeveloper。
licenses list接受两个存储桶; licenses toggle仅接受运行时类型。
uip 或许可证列表
列出给定机器人类型的许可证分配情况。
- 对于runtime 类型,每一行都是一台已连接机器人的计算机;将返回
MachineName、MachineType、Runtimes、IsOnline、IsLicensed和Enabled。 - 对于命名用户类型,每一行是一个用户;将返回
UserName、LastLoginDate、MachinesCount、IsLicensed和MachineNames。
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
| — | --type | 枚举 | 必填 | 机器人类型(请参阅上面的列表)。 |
| — | --licensed | 标记 | 关闭 | 仅限获得许可的条目。与--unlicensed互斥。 |
| — | --unlicensed | 标记 | 关闭 | 仅限未授权的条目。与--licensed互斥。 |
-l | --limit | 数字 | 50 | 页面大小。 |
| — | --offset | 数字 | 0 | 跳过计数。 |
| — | --sort-by | 字段 | — | OData 排序(例如, MachineName desc )。 |
示例
uip or licenses list --type Unattended --limit 50
uip or licenses list --type Attended --unlicensed
uip or licenses list --type Unattended \
--output-filter 'Data[?IsOnline].MachineName'
uip or licenses list --type Unattended --limit 50
uip or licenses list --type Attended --unlicensed
uip or licenses list --type Unattended \
--output-filter 'Data[?IsOnline].MachineName'
数据形状(--输出 json)
Runtime 类型:
{
"Code": "LicenseList",
"Data": [
{
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"MachineName": "prod-worker-01",
"MachineType": "Standard",
"Runtimes": 3,
"IsOnline": true,
"IsLicensed": true,
"Enabled": true
}
]
}
{
"Code": "LicenseList",
"Data": [
{
"Key": "a1b2c3d4-0000-0000-0000-000000000001",
"MachineName": "prod-worker-01",
"MachineType": "Standard",
"Runtimes": 3,
"IsOnline": true,
"IsLicensed": true,
"Enabled": true
}
]
}
已命名用户类型:
{
"Code": "LicenseList",
"Data": [
{
"Key": "d4e5f6a7-0000-0000-0000-000000000001",
"UserName": "dev@example.com",
"LastLoginDate": "2025-04-15T10:30:00Z",
"MachinesCount": 2,
"IsLicensed": true,
"MachineNames": ["studio-01", "studio-02"]
}
]
}
{
"Code": "LicenseList",
"Data": [
{
"Key": "d4e5f6a7-0000-0000-0000-000000000001",
"UserName": "dev@example.com",
"LastLoginDate": "2025-04-15T10:30:00Z",
"MachinesCount": 2,
"IsLicensed": true,
"MachineNames": ["studio-01", "studio-02"]
}
]
}
uip 或许可证切换
为特定 Runtime Robot 类型启用或禁用计算机许可。已命名用户类型将被拒绝。接受计算机密钥 (GUID) — 在调用 API 之前,在内部解析为计算机名称。
必须正好提供--enable或--disable 。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<machine-key> | 是 | 计算机密钥 (GUID)。使用machines list查找。 |
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
| — | --type | 枚举 | 必填 | 仅 Runtime Robot 类型: Unattended 、 NonProduction 、 Headless 、 TestAutomation 。 |
| — | --enable | 标记 | — | 启用许可。 |
| — | --disable | 标记 | — | 禁用许可。 |
示例
uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
--type Unattended --enable
uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
--type NonProduction --disable
uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
--type Unattended --enable --output-filter 'Data.Status'
uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
--type Unattended --enable
uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
--type NonProduction --disable
uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
--type Unattended --enable --output-filter 'Data.Status'
数据形状(--输出 json)
{
"Code": "LicenseToggle",
"Data": {
"MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
"MachineName": "prod-worker-01",
"RobotType": "Unattended",
"Enabled": true,
"Status": "Licensing enabled"
}
}
{
"Code": "LicenseToggle",
"Data": {
"MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
"MachineName": "prod-worker-01",
"RobotType": "Unattended",
"Enabled": true,
"Status": "Licensing enabled"
}
}
UIP 或许可证信息
显示租户许可证摘要:订阅计划、每种机器人类型的允许数量与已使用数量、到期状态和获得许可的功能。使用此选项在分配之前检查总容量。
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|
示例
uip or licenses info
uip or licenses info --output-filter 'Data.Used'
uip or licenses info --output table
uip or licenses info
uip or licenses info --output-filter 'Data.Used'
uip or licenses info --output table
数据形状(--输出 json)
{
"Code": "LicenseInfo",
"Data": {
"IsExpired": false,
"SubscriptionPlan": "Enterprise",
"Allowed": { "Unattended": 10, "Attended": 20 },
"Used": { "Unattended": 4, "Attended": 7 },
"LicensedFeatures": ["AISuite", "TestManager"]
}
}
{
"Code": "LicenseInfo",
"Data": {
"IsExpired": false,
"SubscriptionPlan": "Enterprise",
"Allowed": { "Unattended": 10, "Attended": 20 },
"Used": { "Unattended": 4, "Attended": 7 },
"LicensedFeatures": ["AISuite", "TestManager"]
}
}
退出代码
请参阅退出代码。没有动词特定的覆盖。
相关命令
uip or machines— 管理计算机和插槽分配。uip or users—--license-type,users update。
另请参阅
- 全局选项。