UiPathRobot.msi 命令行参数

您可以通过从命令行运行 UiPathRobot.msi 安装程序来安装 Robot。

请参阅以下各部分，了解有关可用参数的描述和一些用法示例。

备注：

• 需要管理员权限才能执行这些命令。
• 不支持使用 msiexec.exe 的 /passive 选项运行无人值守安装。

命令行参数描述

以下列表显示所有可用的命令行参数。

• /q - 在不显示用户界面的情况下，静默安装指定的 UiPath 功能。
• /l*vx <LogFile> - 在指定路径中生成安装程序日志文件。 如果在安装过程中由于任何原因而遇到困难，您可以将文件进一步发送给我们的支持团队。
• ADDLOCAL - 允许选择要安装的功能。 如不设置此参数，系统将默认安装以下功能：服务模式机器人、默认活动包和 JavaScript 插件。 它支持以下选项：
  • Studio（仅适用于 UiPathStudio.msi）— 安装 Studio。
  • ExcelAddin（仅适用于 UiPathStudio.msi）— 安装 StudioX Excel 加载项。 必须与Studio参数一起使用。
  • Robot— 安装机器人（用户模式或服务模式）以及 Assistant。
  • RegisterService — 对服务模式安装而言是必需的。 不要在用户模式安装中添加它。
  • StartupLauncher — 在 Windows 启动时运行机器人。
  • JavaBridge — 安装 UiPath Java Bridge，以便更好地与 Java 应用程序集成和自动化。 添加此项可能会增加安装时间。 必须与Robot参数一起使用。
  • ChromeExtension — 安装 Google Chrome 扩展程序。 必须与Robot参数一起使用。
  • FirefoxExtension — 安装 Firefox 扩展程序。 必须与Robot参数一起使用。
  • EdgeExtension — 安装基于 Chromium 的 Microsoft Edge 扩展程序。 必须与Robot参数一起使用。
  • CitrixClient — 安装 UiPath Citrix 客户端扩展程序。 必须与 Robot 参数一起使用。不适用于按用户安装。
  • JavaScriptAddOn — 安装浏览器嵌入插件。 必须与 Robot 参数一起使用。不能在提权情况下使用。
  • SapPlugin（仅适用于 UiPathStudio.msi）— 安装 SAP 解决方案管理器插件。 需要在您的计算机上安装 SAP Connector for Microsoft。在全新安装上，您还必须使用 SAP_SOL_MAN_HOST 参数提供实例的地址。必须与 Studio 参数一起使用。不适用于按用户安装。
  • VMwareExtension — 安装 UiPath VMware Horizon 扩展程序。 必须与 Robot 参数一起使用。不适用于按用户安装。
  • WindowsRdpExtension — 安装 UiPath Windows 远程桌面扩展程序。 必须与Robot参数一起使用。
• MSIINSTALLPERUSER - 使您能够仅为当前用户安装。
  • 要按用户安装，请添加 MSIINSTALLPERUSER=1。以下选项在按用户安装中不可用：RegisterService、CitrixExtension、VMwareExtension、PACKAGES_FOLDER、CODE。
  • 如要按计算机安装，请勿包含此参数。
• SAP_SOL_MAN_HOST （仅适用于 UiPathStudio.msi） - SAP Solution Manager 实例的主机名或 IP 地址。 对于在ADDLOCAL选项中添加了SapPlugin参数的清洁安装，这是必需的。
• APPLICATIONFOLDER - 使您能够将机器人安装到自定义位置。
• NUGET_OPTIONS - 适用于离线环境。 如果设置为DisableOnlineFeeds，则此参数将禁用机器人的在线 UiPath 官方和社区订阅源，并仅使用 Orchestrator 和本地订阅源。
  备注：

  URL 订阅源仍保留在配置文件中，但会被忽略。

• PACKAGES_FOLDER
  • 可使您更改工作流及其依赖项的下载位置。 选定的文件夹可以是用户专属的文件夹，也可以由计算机上的所有用户访问。
  • 如不设置此参数，默认下载位置为%userProfile%\.nuget\packages。
  • 不适用于按用户安装。
    备注：

    确保需要执行流程的所有用户均具有新文件夹的读取权限。

  • 对于启用并发执行的 Windows Server 计算机上的安装，您必须提供每个用户的专属路径。 阅读有关 的更多信息
  • 了解如何在安装后更改包的下载文件夹。
• CUSTOM_NUGET_FEEDS - 使您能够为 Studio 和/或机器人添加自定义 NuGet 活动订阅源。 此命令只会添加或更新现有订阅源列表。 必须填充类型为字符串的键值对：
  • 有效的位置包括在线订阅源、文件夹路径和共享网络驱动器。
  • 确保提供的订阅源可供给定计算机上的所有用户访问。
  • 用分号 (;) 分隔订阅源。 例如:

    CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\"
    

• ENFORCE_SIGNED_EXECUTION - 可选。 使您能够强制机器人仅执行已签名的包。如不设置此参数，则不会启用包签名。 它具有以下选项：
  • 1 - 机器人仅处理由 UiPath 验证的作者或存储库签署的包。 如要将您自己的证书添加为已信任来源，请修改nuget.config文件。
  • 0 - 不在您的机器人部署中实施任何包签名规则。如需更多详细信息，请参阅在包上签名。
• CODE - 为您的机器人实例授予许可证。 不适用于按用户安装。
• CLIENT_ID 和 CLIENT_SECRET- 在安装机器人的同时，使用客户端凭据自动将机器人连接到 Orchestrator。例如：

  UiPathRobot.msi ORCHESTRATOR_URL=https://demo.uipath.com/company/tenant/orchestrator_ CLIENT_ID=1234-abcd-1ab2-cd32-1111 CLIENT_SECRET=2143ndafj32k
  

• CHROME_INSTALL_TYPE - 可让您选择 Chrome 扩展程序的安装方法。 需要管理员权限。 如不设置此参数，系统将自动选择最合适的方法。 它具有以下选项：
  • POLICYOFFLINE - Chrome 扩展程序是通过离线组策略方法自动安装到每个系统的，这相当于使用 SetupExtensions 工具调用 /Chrome-Policy-Offline 命令。
  • POLICYONLINE - Edge 扩展程序是通过在线组策略方法自动安装到每个系统的，这相当于使用 SetupExtensions 工具调用 /Edge-Chromium-PolicyGlobal 命令。
  • MANUALPERMACHINE - 为所有用户安装 Chrome 扩展程序，相当于使用 SetupExtensions 工具调用 /ChromeGlobal 命令。
  • NATIVEHOSTONLY - 仅安装原生消息传递主机组件 (ChromeNativeMessaging.exe)，相当于使用 SetupExtensions 工具调用 /ChromeNativeHostGlobal 命令。
  备注：

  保留旧的安装方法名称 (STORE、GLOBAL) 以实现向后兼容性。

• EDGE_INSTALL_TYPE - 允许您选择 Edge 扩展程序的安装方法。 需要管理员权限。 如不设置此参数，系统将自动选择最合适的方法。 它具有以下选项：
  • POLICYOFFLINE - Edge 扩展程序是通过离线组策略方法自动安装到每个系统的，这相当于使用 SetupExtensions 工具调用 /Edge-Policy-Offline 命令。
  • POLICYONLINE - Edge 扩展程序是通过在线组策略方法自动安装到每个系统的，这相当于使用 SetupExtensions 工具调用 /Edge-Chromium-PolicyGlobal 命令。
  • MANUALPERMACHINE - 为所有用户安装 Edge 扩展程序，相当于使用 SetupExtensions 工具调用 /Edge-Chromium-Global 命令。
  • NATIVEHOSTONLY - 仅安装原生消息传递主机组件 (ChromeNativeMessaging.exe)，相当于使用 SetupExtensions 工具调用 /Edge-Chromium-NativeHostGlobal 命令。
  备注：

  保留旧的安装方法名称 (STORE、GLOBAL) 以实现向后兼容性。

• DISABLE_SECURE_XAML - 允许您为作为 Windows 服务安装的机器人禁用XAML文件的安全性。 未加密的 XAML 文件允许用户读取和修改流程文件和逻辑。 它具有以下选项：
  • 0 - 默认选项。 启用 Windows 服务机器人XAML的文件保护功能。
  • 1 - 为 Windows 服务机器人禁用 XAML 文件的安全性。
• SERVICE_URL - 可让您确定使用交互式登录连接到的 Orchestrator 实例的 URL。此值保存在uipath.config文件中。 用户模式安装需要。服务模式安装时会忽略此参数。
• ORCHESTRATOR_URL - 在清洁安装中，您可以指定用于检索自动更新信息的主要 Orchestrator URL。 例如：https://orchestrator.local/organizationName/tenantName
• TELEMETRY_ENABLED - 允许您禁用使用情况数据收集。 它具有以下选项：
  • 0 - 禁用 Studio 和机器人的遥测功能。
  • 1 - 默认选项。 启用 Studio 和 Robot 的遥测功能。了解如何选择退出遥测功能。
• ENABLE_PIP - 可让您启用计算机的“机器人会话”（画中画）功能。 它具有以下选项：
  • 0 - 默认选项。 机器人会话功能已禁用。
  • 1 - 启用机器人会话功能。
• INSTALLER_LANGUAGE - 使您能够选择安装程序的显示语言。 如不设置此参数，安装程序将使用 Windows 中的语言设置。 它具有以下选项：
  • 2052 - 中文（简体）
  • 12 - 法语
  • 7 - 德语
  • 17 - 日语
  • 1 - 韩语
  • 22 - 葡萄牙语（葡萄牙）
  • 1046 - 葡萄牙语（巴西）
  • 25 - 俄语
  • 10 - 西班牙语（西班牙）
  • 2058 - 西班牙语（墨西哥）
  • 31 - 土耳其语
• ASSISTANT_OPTIONS - 启用或禁用 Assistant 的 Marketplace 小组件。它具有以下选项：
  • 无或 EnableMarketplace- 默认选项。 启用微件。
  • DisableMarketplace - 禁用小组件。
• ORCHESTRATOR_AUTO_SIGNIN - 启用自动登录您的帐户。 适用于用户模式安装和已配置为通过 Azure Active Directory 实现单点登录 (SSO) 的环境一起使用。 必须与 ORCHESTRATOR_URL 参数一起使用。它具有以下选项：
  • 0 - 禁用自动登录功能。
  • 1 - 启用自动登录功能。

在命令行中使用路径

输入路径时，请考虑以下事项：

• 可以使用 %USERNAME% 或 %USERPROFILE% 等环境变量。% 特殊字符需要通过以下方式转义：
  • 从命令行提示符调用安装时 - 使用 ^ - UiPathRobot.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^%。
  • 在批处理脚本中 - 使用 ^ - UiPathRobot.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^%。
  • 在 PowerShell 控制台或脚本中 - 不需要转义。
  • 在使用 Active Directory 域帐户时，建议您也在文件夹结构中使用域，例如 C:\packages\^%UserDomain^%.^%Username^%。
• 如果需要使用带空格的路径，则必须按如下方式将该路径换行：
  • 在命令提示符中，使用双引号 (" ") 将其括起。例如，UiPathRobot.msi APPLICATIONFOLDER="C:\folder name"。
  • 在 PowerShell 中，请使用单引号和双引号 ('" "') 将其括起。例如，./UiPathRobot.msi APPLICATIONFOLDER='"C:\folder name"'。

执行同步安装

如果要在安装完成后进行其他配置，可以同步运行安装程序。这使您能够添加要在安装程序完成后执行的其他命令，例如，您可以安装并设置机器人连接或配置订阅源。

以下脚本将执行安装，并允许您添加安装成功后要执行的其他命令。

:: Runnning the MSI synchronously
start /wait /b UiPathRobot.msi /Q
:: Assert the exit code and continue accordingly
set "_isSuccess="
if %ERRORLEVEL% EQU 0 Set "_isSuccess=1"
if %ERRORLEVEL% EQU 1641 Set "_isSuccess=1"
if %ERRORLEVEL% EQU 3010 Set "_isSuccess=1"
:: test for success and run follow-up commands
if (%_isSuccess% EQU 1) (
    echo "success"
) ELSE (
    echo "fail"
)

示例

编写这些示例时，我们假设您已处于 UiPathRobot.msi 安装程序所在的目录中。您可以使用以下命令来完成此操作，例如：cd D:\UiPathInstaller。

• 在用户模式下仅为当前用户安装 Robot

  UiPathRobot.msi MSIINSTALLPERUSER=1 ADDLOCAL=Robot
  

• 静默安装 Robot

  UiPathRobot.msi ADDLOCAL=Robot,RegisterService,StartupLauncher,JavaBridge /Q
  

• 通过策略静默安装 Robot 和 Chrome 扩展程序

  UiPathRobot.msi ADDLOCAL=Robot,RegisterService,ChromeExtension CHROME_INSTALL_TYPE=POLICYONLINE /Q
  

• 将 Robot 静默安装为 Windows 服务，并将其连接到 Orchestrator

  UiPathRobot.msi ADDLOCAL=Robot,RegisterService CONNECTIONSTRING=https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1 /Q
  

• 将 Robot 静默安装为 Windows 服务，并添加两个自定义活动订阅源

  UiPathRobot.msi ADDLOCAL=Robot,RegisterService CUSTOM_NUGET_FEEDS="Feed Name1,https://my.custom.nuget.feed; FeedName2,D:\RPA\Activities\Packages\" /Q
  

• 静默安装并许可注册为 Windows 服务的 Robot 和本地活动订阅源

  UiPathRobot.msi ADDLOCAL=Robot,RegisterService,CODE=1234567890 /Q
  

• 将机器人安装为 Windows 服务，并禁用官方在线订阅源

  UiPathRobot.msi ADDLOCAL=Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds
  

• 卸载 Chrome 扩展程序

  UiPathRobot.msi REMOVE=ChromeExtension /Q
  

• 在 Attended Robot 安装期间设置自动更新连接

  UiPathRobot.msi ADDLOCAL=Robot,RegisterService SERVICE_URL="https://demo.uipath.com/myorg/mytenant"
  

• 在 Unattended Robot 安装期间设置自动更新连接

  UiPathRobot.msi ADDLOCAL=Robot,RegisterService ORCHESTRATOR_URL="https://demo.uipath.com/myorg/mytenant/orchestrator_"