- 概述
- UiPath CLI
- Azure DevOps 扩展程序
- Jenkins 插件
使用 CLI 将资产部署到 Orchestrator 的先决条件和步骤。
先决条件
-
创建一个 CSV 文件,其中包含要部署到 Orchestrator 的资产。
CSV 文件必须包含以下列三列:
name、type、value和description。 -
运行 CLI
exe(对于 Windows 旧版)或dll(对于 Windows/Linux/macOS)文件。 -
添加所需的 Orchestrator API 访问应用程序作用域。
有关 CSV 文件的更多信息,请查看下表中的示例。
| name | 类型 | 值 | 描述 |
|---|---|---|---|
| asset_1_name | text | “我有意见” | asset_1_description |
| asset_2_name | 整数 | 1 | asset_2_description |
| asset_3_name | Bool | false | asset_3_description |
| asset_4_name | 凭据 | username:password | asset_4_description |
要将资产部署到 Orchestrator,请执行以下步骤:
- 使用
uipcli asset运行asset任务。您可以注意可用子任务的列表。 - 指定所需的参数并运行
deploy子任务。下表介绍了必需参数:
| 参数 | 描述 |
|---|---|
Assets File (pos. 0) (必填) | 包含要部署的资产的 CSV 文件的名称。 |
Orchestrator URL (pos. 1) (必填) | Orchestrator 实例的 URL。 |
Orchestrator Tenant (pos. 2) | 要部署资产的 Orchestrator 实例的租户。以Automation Cloud为目标时为必需。对于Automation Suite和独立 Orchestrator (内部部署 MSI)为可选,其中租户是 URL 的一部分。 |
-u 或--username (如果通过用户名和密码使用基本身份验证,则为必需) | 用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。 |
-p 或--password (如果通过用户名和密码使用基本身份验证,则为必需) | 用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。 |
-t 或--token (如果使用 基于令牌的身份验证 , 则为必填项 ) | 用于对 Orchestrator 进行身份验证的OAuth2 刷新令牌。您必须将其与帐户名称和客户端 ID配对。 |
-a 或--accountName (如果使用 基于令牌的身份验证 , 则为必填项 ) | Orchestrator CloudRPA 帐户名称。您必须将其与OAuth2 刷新令牌和客户端 ID配对。 |
-A , or --accountForApp | Orchestrator CloudRPA 帐户名称(组织名称)。您必须将其与外部应用程序的应用程序 ID、应用程序密码和应用程序作用域配对。 |
-I 或--applicationId (如果使用 外部应用程序身份验证 , 则为必填项 ) | 外部应用程序 ID。您必须将其与“应用程序帐户”、“应用程序密码”和“应用程序作用域”配对。 |
-S 或--applicationSecret (如果使用 外部应用程序身份验证 , 则为必填项 ) | 外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。 |
--applicationScope (对于 外部应用程序身份验证, 为 可选项 ) | 应用程序作用域列表,以单个空格分隔。在使用外部应用程序身份验证时为可选,因为系统会自动应用默认作用域。您必须将其与外部应用程序的“应用程序帐户”、 “应用程序 ID”和“应用程序密码”配对。 |
-o , or --organizationUnit | Orchestrator 文件夹(组织单元)的名称。 AccountingTeam\TeamJohn。 |
-l , or --language | Orchestrator 用户界面中使用的语言。 |
|
| 显示事件的跟踪。 |
--identityUrl | 身份服务器的 URL。当 Orchestrator 在UiPath Automation Suite或独立 Orchestrator (内部部署 MSI)上运行时为必需。Automation Cloud不需要 — CLI 从云 URL 解析身份服务器。 |
|
| 显示此命令的参数和示例。 |
|
| 显示版本信息。 |
--ca-cert | 验证 Orchestrator 和 Identity Server TLS 证书时使用的一个或多个受信任的根 CA 证书文件(PEM、DER 或 PKCS#7)。重复标记或用逗号分隔多个路径。有关详细信息,请参阅信任自定义证书。 |
--pinnedpubkey | 固定服务器叶证书的公钥。格式: sha256//<base64> 。除标准证书验证以外进行检查。有关详细信息,请参阅信任自定义证书。 |
对于私有证书颁发机构签名的 Orchestrator 实例(例如 UiPath Automation Suite),此命令也接受--ca-cert和--pinnedpubkey参数。有关场景和示例,请参阅信任自定义证书。
在不指定--applicationScope参数的情况下使用外部应用程序身份验证时,CLI 会自动应用这些默认的 Orchestrator 作用域:
OR.Assets OR.BackgroundTasks OR.Execution OR.Folders OR.Robots.Read OR.Machines.Read OR.Jobs OR.TestSets OR.TestSetExecutions OR.Monitoring OR.Settings.Read
用法
uipcli asset deploy <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]
uipcli asset deploy <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]
最少命令示例
uipcli asset deploy "C:\userprofile\assets.csv" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"uipcli asset deploy "C:\userprofile\assets.csv" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel "Information"uipcli asset deploy "C:\userprofile\assets.csv" "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Informationuipcli asset deploy "C:\userprofile\assets.csv" "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"