uipath-cli
latest
false
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
UiPath CLI 用户指南
uip agent deploy将先前发布的智能体包版本安装并激活到 Orchestrator 文件夹中。它驱动完整的解决方案部署管道(配置→部署→安装→配置→激活)并轮询,直到每个阶段都达到最终状态。
默认情况下,该命令还会配置目标文件夹以立即执行:它会分配租户级别的无服务器计算机模板,并将具有Automation User角色的机器人用户绑定到该文件夹。配置失败显示为警告,而不是错误(您可以在配置失败后手动分配计算机和用户)。
需要活动的 CLI 会话 ( uip login )。
大纲
uip agent deploy <packageVersionKey>
[-n <name>]
[--folder-key <guid>]
[--force-activate] [--skip-activate]
[-t <tenant>]
[--timeout <seconds>]
[--login-validity <minutes>]
uip agent deploy <packageVersionKey>
[-n <name>]
[--folder-key <guid>]
[--force-activate] [--skip-activate]
[-t <tenant>]
[--timeout <seconds>]
[--login-validity <minutes>]
所有uip agent deploy调用都遵循全局选项( --output 、 --output-filter 、 --log-level 、 --log-file )。退出代码遵循标准合同,并在下面列出了特定于部署的覆盖项。
参数
<packageVersionKey>(必填) —uip agent publish(默认上传路径)返回的包版本密钥。GUID。
选项
| 标记 | 默认 | 用途 |
|---|---|---|
-n, --name <name> | agent-<timestamp> | 部署名称。成为 Orchestrator 中的显示名称(对于自动创建的文件夹),以及文件夹的名称。 |
--folder-key <guid> | — (自动创建) | 安装文件夹密钥 (GUID)。如果省略,则安装过程中会自动创建一个新文件夹。 |
--force-activate | 关闭 | 强制激活,即使此配置键中存在以前的部署也是如此。 |
--skip-activate | 关闭 | 在安装阶段后停止;不激活。当您要在发布智能体之前查看安装时非常有用。 |
-t, --tenant <tenant> | 登录租户 | 目标租户。如果登录会话没有默认租户,则为必填。 |
--timeout <seconds> | 120 | 每个轮询阶段(安装、激活)达到最终状态的最大等待秒数。超时时,命令将退出并显示代码2 。 |
--login-validity <minutes> | 10 | 令牌有效期的最短分钟数要求。 |
示例
# Deploy to an auto-created folder named "invoice-agent"
uip agent deploy a1b2c3d4-0000-0000-0000-000000000050 --name invoice-agent
# Deploy into an existing folder
uip agent deploy <PackageVersionKey> --folder-key <FolderGuid>
# Install only; do not activate (review in Orchestrator first)
uip agent deploy <PackageVersionKey> --skip-activate
# Force re-activation of a replacement deployment
uip agent deploy <PackageVersionKey> --force-activate
# Longer timeout for slow environments
uip agent deploy <PackageVersionKey> --timeout 600
# Deploy to an auto-created folder named "invoice-agent"
uip agent deploy a1b2c3d4-0000-0000-0000-000000000050 --name invoice-agent
# Deploy into an existing folder
uip agent deploy <PackageVersionKey> --folder-key <FolderGuid>
# Install only; do not activate (review in Orchestrator first)
uip agent deploy <PackageVersionKey> --skip-activate
# Force re-activation of a replacement deployment
uip agent deploy <PackageVersionKey> --force-activate
# Longer timeout for slow environments
uip agent deploy <PackageVersionKey> --timeout 600
数据形状(--输出 json)
已完成安装和激活( Code: "AgentDeploy" ):
{
"Code": "AgentDeploy",
"Data": {
"DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000060",
"DeploymentName": "invoice-agent",
"Status": "SuccessfulActivate",
"FolderKey": "a1b2c3d4-0000-0000-0000-000000000070",
"FolderId": 42,
"FolderName": "invoice-agent",
"ConfigurationKey": "a1b2c3d4-0000-0000-0000-000000000080",
"PackageVersionKey": "a1b2c3d4-0000-0000-0000-000000000050"
}
}
{
"Code": "AgentDeploy",
"Data": {
"DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000060",
"DeploymentName": "invoice-agent",
"Status": "SuccessfulActivate",
"FolderKey": "a1b2c3d4-0000-0000-0000-000000000070",
"FolderId": 42,
"FolderName": "invoice-agent",
"ConfigurationKey": "a1b2c3d4-0000-0000-0000-000000000080",
"PackageVersionKey": "a1b2c3d4-0000-0000-0000-000000000050"
}
}
仅安装( --skip-activate或未准备激活):形状相同, Status反映安装阶段( SuccessfulInstall 、 FailedInstall ), FolderName在无法解析文件夹时省略。
FolderId— 文件夹的数字组织单位 ID,仅在自动配置成功时填充。将其直接传递给uip agent run list --folder-id。FolderKey— 安装文件夹的 GUID。ConfigurationKey— 此部署创建的解决方案Configuration的密钥。PackageVersionKey— 为方便起见,从输入中回显。
退出代码
除了标准 CLI 代码外:
0— 安装(和激活)已成功完成。1— 部署失败(FailedInstall、FailedActivate)、轮询错误或任何其他失败。2— 轮询阶段已超时(请参阅--timeout)。仍可能在 Orchestrator 中完成部署;请使用更长的超时时间重新运行,或在 Orchestrator 用户界面中检查状态。
请参阅共享合同的退出代码。
配置详细信息
自动创建文件夹时(没有--folder-key ),部署会尝试:
- 将租户级别的无服务器计算机模板分配到文件夹。如果租户中不存在无服务器模板,则配置将失败,并且部署会显示警告 — 您必须手动分配一个警告。
- 选择一个可分配用户,并授予其文件夹中的
Automation User角色。如果租户中不存在此类角色,配置将失败,并显示警告。
计算机或用户分配期间的冲突 (HTTP 409) 将被视为幂等成功。
相关内容
uip agent publish— 生成此命令使用的PackageVersionKey。uip agent run start— 在已部署的文件夹中针对版本启动作业。uip agent run list— 列出部署创建的版本。
另请参阅
- Orchestrator:作业— 基础作业模型。
- 身份验证— 会话、租户和
--login-validity。 - 全局选项,退出代码。