UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

UIP RPA 远程

“uip rpa Remote”的语法和选项,用于配置和驱动远程 Orchestrator Unattended Robot — 目标配置、用户界面自动化会话、流程执行和文件传输。

uip rpa remote 在远程 Orchestrator Unattended Robot 上运行:配置要针对的计算机/机器人/runtime,在其上启动或停止远程用户界面自动化设计会话,对其运行 shell 命令,以及向/从其传输文件。配置后, uip rpa run --remote和debug start --remote会将执行路由到该计算机,而不是在本地运行。

每个动词都需要 Orchestrator 登录 (uip login)。

大纲​

uip rpa remote configure --machine <name> [--folder-path <path>] [--robot <name>] [--runtime <name>] [--live-authoring | --remote-run-only]
uip rpa remote status
uip rpa remote start
uip rpa remote stop
uip rpa remote echo --message <text>
uip rpa remote exec --command <cmd> [--package-id <id> --package-version <v>] [--working-directory <dir>] [--timeout <seconds>]
uip rpa remote upload-file --local-path <path> --remote-path <path>
uip rpa remote download-file --remote-path <path> --local-path <path>
uip rpa remote configure --machine <name> [--folder-path <path>] [--robot <name>] [--runtime <name>] [--live-authoring | --remote-run-only]
uip rpa remote status
uip rpa remote start
uip rpa remote stop
uip rpa remote echo --message <text>
uip rpa remote exec --command <cmd> [--package-id <id> --package-version <v>] [--working-directory <dir>] [--timeout <seconds>]
uip rpa remote upload-file --local-path <path> --remote-path <path>
uip rpa remote download-file --remote-path <path> --local-path <path>

uip rpa 远程配置​

解析并存储远程调试目标(文件夹 → 机器人 → 计算机 → runtime),并在其上启动远程用户界面自动化设计会话。remote stop 将关闭会话。

选项​

长值必填描述
--machine <name>字符串是用于运行 Unattended Robot 的 Orchestrator 计算机名称。
--folder-path <path>字符串否机器人/计算机所属的完全限定 Orchestrator 文件夹(例如Shared/Finance)— 在其中解析机器人、计算机和 runtime。默认为后端的当前文件夹。
--robot <name>字符串否要运行的机器人/用户帐户。默认为计算机的默认身份。
--runtime <name>字符串否已连接的 Runtime(主机/会话)名称。对于无服务器计算机,可忽略;将其设置为针对传统计算机上特定的已连接会话。
--live-authoring标记否使用目标进行实时创作:一个长期远程会话作业为每个远程命令、运行和调试会话提供服务;此时远程用户界面自动化设计会话将变为可用,并且远程屏幕会流式传输。与 --remote-run-only 互斥。需要先让 remote echo 正常工作。
--remote-run-only标记否目标仅用于远程运行:运行或调试会话是其自己的 Orchestrator 作业,没有远程用户界面自动化会话。这是从未存储模式的目标的默认设置。与 --live-authoring 互斥。

在客户端同时通过 --live-authoring 和 --remote-run-only 失败 — 它们是一个连接的两种模式;最多传递一个。这两项若不通过,系统将保持存储模式不变。

示例​

uip rpa remote configure --machine BotMachine --folder-path "Shared/Finance"
uip rpa remote configure --machine BotMachine --folder-path "Shared/Finance"

数据形状(--输出 json)​

后端 { success, ...resolved-config } 有效负载的原始传递 — 包括匹配后已解析的文件夹/机器人/计算机/运行时。

UIP RPA 远程状态​

显示当前为登录的租户配置的远程连接,并根据 Orchestrator 解析。只读— 不会更改或启动任何内容。无选项。

示例​

uip rpa remote status
uip rpa remote status

uip rpa 远程启动​

启动远程用户界面自动化:在已配置的远程代理上设置 UIA 设计体验会话,以便带有uip rpa uia --remote驱动该计算机。如果未配置任何目标(首先是 remote configure),则会失败。启动已在运行的会话无需执行任何操作;重新配置为其他目标会重新启动目标。无选项。

示例​

uip rpa remote start
uip rpa remote start

uip rpa 远程停止​

终止当前的远程 UIA 会话并释放智能体。幂等 — 即使没有正在运行的会话或不再配置目标,也会成功。稍后的 uia --remote 调用将自动启动新会话。无选项。

示例​

uip rpa remote stop
uip rpa remote stop

UIP RPA 远程回显​

消息在已配置的远程代理上运行的 RemoteSessionAgent 之间来回传递并打印回复——即连接检查。仅实时创作( remote configure --live-authoring );仅 Remote Runtime 没有要应答的智能体。首次使用时启动智能体;每个回显都在自己的私人频道上传播,因此并发调用者只能看到自己的回复。

选项​

长值必填描述
--message <text>字符串是RemoteSessionAgent 回显的文本 — 用于区分并发调用者的回复。

示例​

uip rpa remote echo --message "ping"
uip rpa remote echo --message "ping"

uip rpa 远程执行​

在已配置的远程代理上执行 shell 命令(在 Windows 上为 cmd.exe /c,否则为 /bin/sh -c),并实时输出流式传输。没有本地模式 — 始终在远程计算机上运行。

选项​

长值必填描述
--command <cmd>字符串是要远程运行的 Shell 命令行(例如dir、ls -la)。还原包时(见下文),可以是相对于包文件夹的路径。
--package-id <id>字符串有条件地要在运行命令之前在远程计算机上还原的 NuGet 包。需要一起使用 --package-version。
--package-version <v>字符串有条件地要还原的 --package-id 的版本。设置为 --package-id 为必需 — 如果仅传递一个而忽略另一个,客户端将会失败。
--working-directory <dir>字符串否命令的工作目录。还原包时默认为还原的包文件夹,否则为远程计算机的当前目录。
--timeout <seconds>数字否在规定秒数后终止命令。省略则无超时。

示例​

uip rpa remote exec --command "dir" --timeout 30
uip rpa remote exec --command "dir" --timeout 30

uip rpa 远程上传文件​

将本地文件上传到已配置的远程代理,并通过临时 Orchestrator 存储桶(自动创建和删除)进行传输。

选项​

长值必填描述
--local-path <path>字符串是要上传的本地文件的路径。
--remote-path <path>字符串是远程计算机上的目标路径。已创建父目录。

示例​

uip rpa remote upload-file --local-path ./data.csv --remote-path "C:\Bots\data.csv"
uip rpa remote upload-file --local-path ./data.csv --remote-path "C:\Bots\data.csv"

uip rpa 远程下载文件​

将通过临时 Orchestrator 存储桶传输的文件从已配置的远程代理下载到本地路径。

选项​

长值必填描述
--remote-path <path>字符串是远程计算机上要下载的文件的路径。
--local-path <path>字符串是本地目标路径。已创建父目录。

示例​

uip rpa remote download-file --remote-path "C:\Bots\output.log" --local-path ./output.log
uip rpa remote download-file --remote-path "C:\Bots\output.log" --local-path ./output.log

另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新