uip admin 集成 vpn

“uip admin Integration vpn”的语法和选项，用于管理 VPN 网关和站点到站点连接，使云机器人和无服务器机器人能够私下访问本地部署网络。

uip admin integrations vpn 管理 VPN 网关及其站点到站点连接。VPN 网关允许云机器人和 Serverless Robot 通过站点到站点 IPsec 隧道私下访问内部部署网络，该隧道托管在您在创建时提供地址空间的网络中。一个网关可以有多个连接，使每个网关与一个本地部署网络对等连接。

此命令树由单独发布的@uipath/admin-vpngateway-commands包实现，这是组成uip admin多个包之一（请参阅uip admin概述）— 它不拥有自己的顶级 CLI 谓词； integrations是其他管理员集成工具稍后可能会注册的共享父命名空间。

概念

• 异步操作。每个变异动词（ create 、 edit 、 redeploy 、 delete 、 refresh ）都会在任务加入队列后返回，而不是在应用后返回。轮询 gateways get <key>/connections get <key>，直到 state 达到终端值（对于网关，轮询为 Deployed，对于连接，轮询达到 Connecting/Updating 以外的任何值），然后再发布下一个变更。同一网关上的并发变更返回 HTTP 409 — 等待几秒钟，然后重试。
• 破坏性动词需要--confirm 。没有它，gateways delete 和 connections delete 将无法运行，因此非交互式调用者不会意外触发删除。connections edit 还在每次调用时都需要 --confirm，因为大多数编辑都会导致短暂的隧道重新协商和连接断开。
• edit的列表替换语义。对于gateways edit和connections edit ，列表形状标志（ --dns-server 、 --apipa-address 、 --trusted-cert 、 --target-address-space ）在传递时批量替换现有列表 — 重新传递要保留的每个条目。每个都有一个匹配的 --clear-* 标志，用于显式清空列表，与填充的表单互斥。
• connections edit始终需要--shared-key 。即使您不进行更改，也必须在每次编辑调用时重新提供当前的预共享密钥 — 后端没有部分更新路径。
• IPsec 策略是“要么全有，要么全无”。如果设置了 8 个 IPsec/IKE 标志（--ipsec-sa-lifetime、--ipsec-sa-data-size、--ipsec-encryption、--ipsec-integrity、--ike-encryption、--ike-integrity、--dh-group、--pfs-group）中的任何一个，则必须设置所有 8 个 IPsec/IKE 标志。GCMAES --ipsec-encryption 变体需要相同的 GCMAES --ipsec-integrity。connections edit 默认保留现有策略；传递所有 8 个标志以将其替换，或传递 --clear-ipsec 将其删除（与 8 个标志互斥）。
• BGP 配对约定。--bgp-peer-address（内部部署设备的 BGP 端点）必须是网关的 /30 池中地址的 --apipa-address 合作伙伴，两者均来自 169.254.21.0/24 或 169.254.22.0/24。约定：网关采用 /30 中较大的可用地址（例如.10），本地部署对等采用较低者（例如.9）。在以前未启用 BGP 的连接上启用 BGP 需要同时传递 --asn 和 --bgp-peer-address — 否则，CLI 将预先拒绝编辑。
• --vnet-address-space在gateways create之后不可变，并且必须是前缀介于/8和/27之间的 CIDR； 169.254.0.0/16 APIPA 范围已被拒绝，因为它与内部使用的 BGP APIPA 块冲突。

大纲

uip admin integrations vpn gateways list [--tenant <name>]
uip admin integrations vpn gateways get <key> [--tenant <name>]
uip admin integrations vpn gateways tenant-config [--tenant <name>]
uip admin integrations vpn gateways create --name <name> --vnet-address-space <cidr> [--description <text>] [--dns-server <ip>]... [--apipa-address <ip>]... [--trusted-cert <name=base64>]... [--tenant <name>]
uip admin integrations vpn gateways edit <key> [--name <name>] [--description <text>] [--dns-server <ip>]... [--clear-dns-servers] [--apipa-address <ip>]... [--clear-apipa-addresses] [--trusted-cert <name=base64>]... [--clear-trusted-certs] [--tenant <name>]
uip admin integrations vpn gateways redeploy <key> [--tenant <name>]
uip admin integrations vpn gateways delete <key> --confirm [--tenant <name>]

uip admin integrations vpn connections get <key> [--tenant <name>]
uip admin integrations vpn connections create <gateway-key> --name <name> --shared-key <key> --target-ip <ip> [--target-address-space <cidr>]... [--bgp-enabled --asn <num> --bgp-peer-address <ip>] [ipsec flags...] [--tenant <name>]
uip admin integrations vpn connections edit <key> --shared-key <key> --confirm [options...]
uip admin integrations vpn connections refresh <key> [--tenant <name>]
uip admin integrations vpn connections delete <key> --confirm [--tenant <name>]

--tenant <name> 适用于两组中的每个动词（默认为登录上下文中的租户）。

uip admin 集成 vpn 网关

uip admin 集成 VPN 网关列表

列出当前租户的所有 VPN 网关 — 密钥、名称、状态、类型、SKU、VNet、位置、公共 IP、连接计数。

选项

长	值	描述
--tenant <name>	字符串	目标租户。默认为您的登录上下文。

示例

uip admin integrations vpn gateways list

数据形状（--输出 json）

{
  "Code": "VpnGatewayList",
  "Data": {
    "count": 1,
    "value": [
      {
        "key": "00000000-0000-0000-0000-000000000001",
        "name": "prod-gw",
        "state": "Deployed",
        "gatewayType": "Vpn",
        "sku": "Basic",
        "vnetAddressSpace": "10.0.0.0/24",
        "location": "westus",
        "publicIp": "20.0.0.1",
        "connections": []
      }
    ]
  }
}

uip admin 集成 vpn 网关获取

按密钥获取网关及其连接。

参数

名称	必填	用途
<key>	是	VPN 网关密钥 (GUID)。

示例

uip admin integrations vpn gateways get 00000000-0000-0000-0000-000000000001

数据形状（--输出 json）

{
  "Code": "VpnGatewayGet",
  "Data": {
    "key": "00000000-0000-0000-0000-000000000001",
    "name": "prod-gw",
    "state": "Deployed",
    "gatewayType": "Vpn",
    "sku": "Basic",
    "vnetAddressSpace": "10.0.0.0/24",
    "location": "westus",
    "publicIp": "20.0.0.1",
    "connections": [
      { "key": "11111111-1111-1111-1111-111111111111", "name": "site-a", "state": "Connected", "targetIpAddress": "203.0.113.10" }
    ],
    "trustedCertificates": [
      { "name": "corp-root-ca", "publicCertificateData": "MIIDazCCAlOgAwIBAgIUHs9..." }
    ]
  }
}

uip admin 集成 VPN 网关 租户配置

检查是否允许当前租户配置 VPN 网关。

示例

uip admin integrations vpn gateways tenant-config

数据形状（--输出 json）

{ "Code": "VpnGatewayTenantConfig", "Data": { "canCreateVpnGateway": true } }

当 Data 为 validationError 时，canCreateVpnGateway 也带有 false。

uip admin 集成 vpn 网关创建

配置新的 VPN 网关。异步 — 使用 gateways get/list 追踪状态；在 Failed，使用 gateways redeploy。

选项

长	值	必填	描述
--name <name>	字符串	是	网关名称。
--vnet-address-space <cidr>	CIDR，/8–/27	是	VNet 地址空间。创建后不可变。拒绝169.254.0.0/16 APIPA 范围。
--description <text>	字符串	否	自由格式说明。
--dns-server <ip>	IPv4，可重复，最多 3 个	否	DNS 服务器 IP。
--apipa-address <ip>	169.254.21.0/24 或 169.254.22.0/24 中的 IPv4，可重复，最多 2 次	否	APIPA BGP 对等地址。
--trusted-cert <cert-name=base64>	<name>=<base64-X509>，可重复，最多 10 次	否	受信任的根证书。
--tenant <name>	字符串	否	目标租户。

示例

uip admin integrations vpn gateways create --name prod-gw --vnet-address-space 10.0.0.0/24

# Full lifecycle: provision, wait for Deployed, then attach a BGP connection
ROOT=$(cat root.b64); INTER=$(cat inter.b64)
GW_KEY=$(uip admin integrations vpn gateways create \
  --name prod-gw \
  --vnet-address-space 10.0.0.0/24 \
  --dns-server 172.23.0.105 --dns-server 172.23.2.89 \
  --apipa-address 169.254.21.10 \
  --trusted-cert "Root=$ROOT" --trusted-cert "Inter=$INTER" \
  --output-filter Data.key --output plain)
until uip admin integrations vpn gateways get $GW_KEY \
  --output-filter Data.state --output plain | grep -q Deployed; do
  sleep 30
done
uip admin integrations vpn connections create $GW_KEY \
  --name site-a --shared-key "MyS3cr3tP4ssphr4se" \
  --target-ip 203.0.113.10 \
  --bgp-enabled --asn 65001 --bgp-peer-address 169.254.21.9

数据形状（--输出 json）

{
  "Code": "VpnGatewayCreated",
  "Data": {
    "key": "00000000-0000-0000-0000-000000000001",
    "name": "prod-gw",
    "state": "Provisioning",
    "gatewayType": "Vpn",
    "sku": "Basic",
    "vnetAddressSpace": "10.0.0.0/24"
  }
}

uip admin 集成 vpn 网关编辑

更新网关的可变字段。保留未传递的标量；您通过批量替换现有列表的列表（请参阅概念）。如果未提供编辑字段，则失败。

参数

名称	必填	用途
<key>	是	VPN 网关密钥 (GUID)。

选项

长	值	描述
--name <name>	字符串	重命名网关。
--description <text>	字符串	更新说明。
--dns-server <ip>	IPv4，可重复，最多 3 个	替换 DNS 服务器列表。与 --clear-dns-servers 互斥。
--clear-dns-servers	标记	删除所有 DNS 服务器。
--apipa-address <ip>	IPv4，可重复，最多 2 个	替换 APIPA 地址列表。与 --clear-apipa-addresses 互斥。
--clear-apipa-addresses	标记	删除所有 APIPA BGP 地址。
--trusted-cert <cert-name=base64>	可重复，最多 10 次	替换受信任证书列表。与 --clear-trusted-certs 互斥。
--clear-trusted-certs	标记	删除所有受信任证书。
--tenant <name>	字符串	目标租户。

示例

uip admin integrations vpn gateways edit 00000000-0000-0000-0000-000000000001 --name new-name

uip admin integrations vpn gateways edit 00000000-0000-0000-0000-000000000001 --clear-dns-servers

数据形状（--输出 json）

{
  "Code": "VpnGatewayEdited",
  "Data": { "key": "00000000-0000-0000-0000-000000000001", "name": "new-name" }
}

Data 仅回显已更改的字段。

uip admin 集成 vpn 网关重新部署

如果网关之前的部署尝试未完全完成，则在网关上重试上一个后台任务。如果网关被冻结、有正在进行的任务或处于不受支持的状态，则被拒绝。

参数

名称	必填	用途
<key>	是	VPN 网关密钥 (GUID)。

示例

uip admin integrations vpn gateways redeploy 00000000-0000-0000-0000-000000000001

数据形状（--输出 json）

{ "Code": "VpnGatewayRedeployRequested", "Data": { "Key": "00000000-0000-0000-0000-000000000001" } }

uip admin 集成 vpn 网关删除

删除网关和所有相关基础架构。具有破坏性且不可逆。

参数

名称	必填	用途
<key>	是	VPN 网关密钥 (GUID)。

选项

长	值	必填	描述
--confirm	标记	是	必需 — 如果没有它，命令将无法执行。
--tenant <name>	字符串	否	目标租户。

示例

uip admin integrations vpn gateways delete 00000000-0000-0000-0000-000000000001 --confirm

数据形状（--输出 json）

{ "Code": "VpnGatewayDeleted", "Data": { "Key": "00000000-0000-0000-0000-000000000001" } }

uip admin 集成 vpn 连接

附加到 VPN 网关的站点到站点连接。每个连接将一个本地网络与网关对等互连。

UIP 管理员集成 VPN 连接获取

参数

名称	必填	用途
<key>	是	VPN 网关连接密钥 (GUID)。

示例

uip admin integrations vpn connections get 00000000-0000-0000-0000-000000000001

数据形状（--输出 json）

{
  "Code": "VpnGatewayConnectionGet",
  "Data": {
    "key": "00000000-0000-0000-0000-000000000001",
    "name": "site-a",
    "state": "Connected",
    "targetIpAddress": "203.0.113.10",
    "targetAddressSpaces": ["192.168.1.0/24"],
    "bgpEnabled": false
  }
}

UIP 管理员集成 VPN 连接 创建

将新的站点到站点连接附加到网关。

参数

名称	必填	用途
<gateway-key>	是	父级 VPN 网关密钥 (GUID)。

选项

长	值	必填	描述
--name <name>	字符串	是	连接名称。
--shared-key <key>	字符串，最多包含 128 个可打印 ASCII 字符，不得使用空格/短划线/波浪线	是	预共享密钥。
--target-ip <ip>	IPv4	是	内部部署 VPN 设备公共 IP。
--target-address-space <cidr>	CIDR，可重复	有条件地	未设置--bgp-enabled时为必填项（至少需要一个） 。0.0.0.0/0 被拒绝。
--bgp-enabled	标记	否	使用 BGP 进行动态路由。
--asn <num>	正整数	有条件地	需要适用于--bgp-enabled 。65515 和 64512 已保留。
--bgp-peer-address <ip>	IPv4	有条件地	需要适用于--bgp-enabled 。必须是网关 /30 的本地部署 --apipa-address 合作伙伴。
--ipsec-sa-lifetime <seconds>	整数，最小值为 300	否	IPsec SA 生存期。出现以下 7 个标志的“全有或全无”。
--ipsec-sa-data-size <kb>	整数、0 或 1024–2147483647	否	IPsec SA 数据大小。
--ipsec-encryption <alg>	None|AES128|AES192|AES256|GCMAES128|GCMAES192|GCMAES256	否	IPsec 加密算法。
--ipsec-integrity <alg>	MD5|SHA1|SHA256|SHA384|GCMAES128|GCMAES256	否	必须与 GCMAES --ipsec-encryption 完全匹配。
--ike-encryption <alg>	AES128|AES192|AES256|GCMAES128|GCMAES256	否	IKE 加密算法。
--ike-integrity <alg>	MD5|SHA1|SHA256|SHA384|GCMAES128|GCMAES256	否	IKE 完整性算法。
--dh-group <group>	None|DHGroup1|DHGroup2|DHGroup14|DHGroup24|DHGroup2048|ECP256|ECP384	否	Diffie-Hellman 组。
--pfs-group <group>	None|PFS1|PFS2|PFS14|PFS24|PFS2048|ECP256|ECP384|PFS	否	完全前向保密组。
--tenant <name>	字符串	否	目标租户。

示例

# Static routes, no BGP
uip admin integrations vpn connections create 00000000-0000-0000-0000-0000000000aa \
  --name site-a --shared-key 'MyS3cr3tP4ssphr4se' \
  --target-ip 203.0.113.10 --target-address-space 192.168.1.0/24

# With BGP
uip admin integrations vpn connections create 00000000-0000-0000-0000-0000000000aa \
  --name site-a --shared-key 'MyS3cr3tP4ssphr4se' \
  --target-ip 203.0.113.10 --bgp-enabled --asn 65001 --bgp-peer-address 169.254.21.1

数据形状（--输出 json）

{
  "Code": "VpnGatewayConnectionCreated",
  "Data": {
    "key": "00000000-0000-0000-0000-000000000001",
    "name": "site-a",
    "state": "Connecting",
    "targetIpAddress": "203.0.113.10",
    "bgpEnabled": true,
    "asn": 65001
  }
}

uip admin 集成 VPN 连接 编辑

更新连接的可变字段。无论其他内容发生变化， --shared-key和--confirm在每次调用时均为必需（请参阅概念）。

参数

名称	必填	用途
<key>	是	VPN 网关连接密钥 (GUID)。

选项

长	值	必填	描述
--shared-key <key>	字符串	是	每次编辑时重新提供当前的预共享密钥。
--confirm	标记	是	确认大多数编辑操作导致的简短连接下降。
--name <name>	字符串	否	重命名连接。
--target-ip <ip>	IPv4	否	内部部署 VPN 设备公共 IP。
--target-address-space <cidr>	可重复	否	替换本地 CIDR 列表。0.0.0.0/0 已被拒绝。与 --clear-target-address-spaces 互斥。
--clear-target-address-spaces	标记	否	删除所有目标地址空间。无配置的非 BGP 连接配置不正确。
--bgp-enabled / --no-bgp-enabled	标记	否	启用/禁用 BGP。要在以前的非 BGP 连接上启用，需要 --asn 和 --bgp-peer-address。
--asn <num>	整数	否	BGP ASN。
--bgp-peer-address <ip>	IPv4	否	BGP 对等体地址。
--ipsec-sa-lifetime、 --ipsec-sa-data-size 、 --ipsec-encryption 、 --ipsec-integrity 、 --ike-encryption 、 --ike-integrity 、 --dh-group 、 --pfs-group	请参阅 connections create	否	通过所有 8 项以替换 IPsec 策略；省略所有 8 个以将其保留。
--clear-ipsec	标记	否	删除 IPsec 策略。与 8 个 IPsec/IKE 标志互斥。
--tenant <name>	字符串	否	目标租户。

示例

uip admin integrations vpn connections edit 00000000-0000-0000-0000-000000000001 \
  --shared-key 'MyS3cr3tP4ssphr4se' --name new-name --confirm

uip admin integrations vpn connections edit 00000000-0000-0000-0000-000000000001 \
  --shared-key 'MyS3cr3tP4ssphr4se' --no-bgp-enabled --confirm

数据形状（--输出 json）

{
  "Code": "VpnGatewayConnectionEdited",
  "Data": { "key": "00000000-0000-0000-0000-000000000001", "name": "new-name" }
}

uip admin 集成 vpn 连接刷新

将来自 Azure 的连接状态的后台刷新加入队列 — 连接也会在定期作业上自动刷新；仅当您不想等待下一个周期时才使用此选项。如果正在进行其他操作，则将被拒绝。

参数

名称	必填	用途
<key>	是	VPN 网关连接密钥 (GUID)。

示例

uip admin integrations vpn connections refresh 00000000-0000-0000-0000-000000000001

数据形状（--输出 json）

{ "Code": "VpnGatewayConnectionRefreshRequested", "Data": { "Key": "00000000-0000-0000-0000-000000000001" } }

UIP 管理员集成 VPN 连接 删除

删除连接。具有不可逆的破坏性 — 本地部署对等体必须之后重新连接到重新创建的连接。

参数

名称	必填	用途
<key>	是	VPN 网关连接密钥 (GUID)。

选项

长	值	必填	描述
--confirm	标记	是	必需 — 如果没有它，命令将无法执行。
--tenant <name>	字符串	否	目标租户。

示例

uip admin integrations vpn connections delete 00000000-0000-0000-0000-000000000001 --confirm

数据形状（--输出 json）

{ "Code": "VpnGatewayConnectionDeleted", "Data": { "Key": "00000000-0000-0000-0000-000000000001" } }

另请参阅

• uip admin 概述
• 全局选项
• 退出代码