robot
2023.10
false
UiPath logo, featuring letters U and I in white
机器人用户指南
Last updated 2024年10月25日

UiPathRobot.msi 命令行参数

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

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

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

命令行参数描述

下表列出了所有可用的命令行参数。

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

  • 可以使用 %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"'。

命令

描述

/q

帮助您静默安装指定的 UiPath™ 功能，而不显示用户界面。

/l*vx <LogFile>

在指定路径生成安装程序日志文件。自 v2018.4.2 起，如果您在安装之时许可 Studio 或机器人，则此文件中也可能会包含许可信息。

如果您在安装过程中遇到困难，不管何种原因，均可将此文件发送给我们的支持团队。

ADDLOCAL
使您能够选择要安装的功能。如果使用 ADDLOCAL，则仅安装其中指定的功能。如果未使用 ADDLOCAL，则会安装以下功能：处于服务模式的 Robot、活动包和 JavaScript 加载项。

它支持以下选项：

DesktopFeature - 指示要安装 Robot 和 Studio 功能。
Robot - 在用户模式或服务模式下安装 Robot 以及 Assistant。没有 DesktopFeature 便无法使用它。
  • 要安装处于服务模式的机器人，请添加 RegisterService 选项。我们为无人值守机器人选择推荐此选项。
  • 要在用户模式下安装 Robot，请不要添加 RegisterService 选项。我们为有人值守和开发机器人推荐该选项。
注意：将 Robot 从服务模式转换为用户模式时，Robot 可能无法访问原始 NuGet 包文件夹中的 .xaml 文件。有关如何解决此问题的详细信息，请参阅《迁移后无法访问 NuGet 包》故障排除文章。
StartupLauncher - 在 Windows 启动时运行机器人。如果未使用 Robot 参数，则不能使用此选项。
JavaBridge - 安装 UiPath™ Java Bridge，以实现更出色的 Java 应用程序集成和自动化。请注意，安装 Java Bridge 可能会延长安装时间。如果未使用 Robot 参数，则不能使用此选项。
ChromeExtension - 安装 Uipath™ Google Chrome 扩展程序。如果未使用 Robot 参数，则不能使用此选项。
FirefoxExtension - 例如：UiPathRobot.msi ADDLOCAL=Robot,ChromeExtension,FirefoxExtension /Q
EdgeExtension - 安装基于 Microsoft Edge Chromium 的 UiPath 扩展程序。如果没有 Robot 参数，则不能使用。
CitrixClient - 安装 UiPath™ Citrix 客户端扩展程序。如果未使用 Robot 参数，则不能使用此选项。
JavaScriptAddOn - 为机器人安装浏览器嵌入插件。
VMwareExtension - 安装 UiPath™ VMware Horizon 扩展程序。如果未使用 Robot 参数，则不能使用此选项。
WindowsRdpExtension - 安装 UiPath™ Microsoft 远程桌面扩展程序。如果未使用 Robot 参数，则不能使用此选项。

MSIINSTALLPERUSER
使您能够仅为当前用户安装。要按用户安装，请添加 MSIINSTALLPERUSER=1。要按计算机安装，请不要包含此参数。

以下选项在按用户安装中不可用：RegisterService、CitrixExtension、VMwareExtension、PACKAGES_FOLDER、CODE。

APPLICATIONFOLDER

用于在自定义位置安装 Robot。

NUGET_OPTIONS
如果您在离线环境中工作，建议使用此参数。如果设置为 DisableOnlineFeeds，则此参数可帮助您为机器人禁用在线 UiPath™ 官方和社区订阅源（仅考虑 Orchestrator 和本地订阅源）。

请注意，不会从配置文件中删除 URL 订阅源，仅忽略它们。

它可用于安装和升级。

PACKAGES_FOLDER
用于更改 Studio 和/或机器人工作流及其依赖项的下载位置。此文件夹可以由特定用户访问，也可由计算机上的所有用户访问。此参数可用于服务模式机器人或用户模式机器人。如果不提供此参数，则默认文件夹是 %userProfile%\.nuget\packages。
注意：更改包文件夹时，请确保需要执行流程的所有用户都具有该文件夹的读取访问权限。
注意： 使用 PACKAGES_FOLDER 参数时，存在一些限制。有关更多信息，请参阅自定义包文件夹和网络路径文档。
  • 对于 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

向您的 Robot 实例授予许可。

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 - Chrome 扩展程序是通过在线组策略方法自动安装到每个系统的，这相当于使用 SetupExtensions 工具调用 /ChromePolicyGlobal 命令。
  • 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。

所提供的 URL 保存在 uipath.config 文件中，并且仅保存为用户模式机器人。对于服务模式安装，该参数将被忽略。
运行安装程序以从较早版本进行更新或更改现有安装时，如果要将 Robot 从服务模式切换到用户模式（不包括 RegisterService 选项），则支持使用此参数。

ORCHESTRATOR_URL
在全新安装中，您可以指定用于检索自动更新信息的主要 Orchestrator URL（例如，https://orchestrator.local/organizationName/tenantName）。

TELEMETRY_ENABLED

允许您禁用使用情况数据收集，并且可以在机器人的安装时完成。

默认情况下，为 Studio 和机器人启用遥测。要禁用该功能，请在执行全新安装或更新时为参数使用以下值：

  • TELEMETRY_ENABLED=0

如果要启用遥测，请不要包含该参数，或将其包含在以下值中：

  • TELEMETRY_ENABLED=1

有关使用情况数据收集以及如何更改遥测设置的更多信息，请参阅选择退出遥测文档。

ENABLE_PIP

允许您在 UiPathTM 命令行安装过程中启用计算机的画中画功能。

要启用它，请使用以下参数：

  • ENABLE_PIP=1

示例：

UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService ENABLE_PIP=1

INSTALLER_LANGUAGE
使您能够选择安装程序的显示语言。如果未指定，则将根据 Windows 中的语言设置确定安装程序的语言。要指定语言，请输入参数 INSTALLER_LANGUAGE=<language_code>。可选择以下选项：
  • 中文（简体）：INSTALLER_LANGUAGE=2052
  • 法语：INSTALLER_LANGUAGE=12
  • 德语：INSTALLER_LANGUAGE=7
  • 日语：INSTALLER_LANGUAGE=17
  • 韩语：INSTALLER_LANGUAGE=1
  • 葡萄牙语（葡萄牙）：INSTALLER_LANGUAGE=22
  • 葡萄牙语（巴西）：INSTALLER_LANGUAGE=1046
  • 俄语：INSTALLER_LANGUAGE=25
  • 西班牙语（西班牙）：INSTALLER_LANGUAGE=10
  • 西班牙语（墨西哥）：INSTALLER_LANGUAGE=2058
  • 土耳其语：INSTALLER_LANGUAGE=31
ASSISTANT_OPTIONS可用于指定是否为 UiPath Assistant 启用或禁用 Marketplace 微件。
  • 要启用微件，请使用 ASSISTANT_OPTIONS=EnableMarketplace 或不添加此参数。
  • 要禁用微件，请使用 ASSISTANT_OPTIONS=DisableMarketplace。
ORCHESTRATOR_AUTO_SIGNIN如果您在用户模式下安装 Attended Robot，并且您的环境配置为将 SSO 与 Azure Active Directory 一起使用，则可以自动登录到您的帐户。此参数必须与 ORCHESTRATOR_URL 一起使用。
要启用此选项，请使用 ORCHESTRATOR_AUTO_SIGNIN=1

执行同步安装

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

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

:: 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"
):: 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=DesktopFeature,Robot
  • 静默安装 Robot - UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,StartupLauncher,JavaBridge /Q
  • 通过策略静默安装 Robot 和 Chrome 扩展程序 - UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,ChromeExtension CHROME_INSTALL_TYPE=POLICYONLINE /Q

  • 将机器人静默安装为 Windows 服务，并将其连接到 Orchestrator -

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

  • 以静默方式将 Robot 安装为 Windows 服务，并添加两个自定义活动订阅源 - UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CUSTOM_NUGET_FEEDS="Feed Name1,https://my.custom.nuget.feed; FeedName2,D:\RPA\Activities\Packages\" /Q
  • 静默安装并许可注册为 Windows 服务的 Robot 和本地活动订阅源 - UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,CODE=1234567890 /Q
  • 将机器人安装为 Windows 服务，并禁用官方在线订阅源 - UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds
  • 卸载 Chrome 扩展程序 - UiPathRobot.msi REMOVE=ChromeExtension /Q

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

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

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

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

  • 命令行参数描述
  • 执行同步安装
  • 示例

此页面有帮助吗？

支持与服务
获取您需要的帮助
UiPath Academy
了解 RPA - 自动化课程
UiPath 论坛
UiPath Community 论坛
Uipath Logo White
信任与安全
使用条款
隐私策略
Cookie 政策
© 2005-2024 UiPath。保留所有权利。