UIP 管理者連携 VPN

「uip admin integrations vpn」の構文とオプション。VPN ゲートウェイとサイト間接続を管理し、クラウド ロボットとサーバーレス ロボットがオンプレミス ネットワークにプライベートに接続できるようにします。

uip admin integrations vpn は、VPN ゲートウェイとそのサイト間接続を管理します。VPN ゲートウェイを使用すると、クラウド ロボットとサーバーレス ロボットは、作成時に指定したアドレス空間のネットワークでホストされているサイト間 IPsec トンネルを介してオンプレミス ネットワークにプライベートにアクセスできます。ゲートウェイには複数の接続を設定でき、それぞれの接続は 1 つのオンプレミス ネットワークでゲートウェイをピアリングします。

このコマンド ツリーは、uip admin (uip adminの概要を参照) で構成されるいくつかのパッケージの 1 つである、個別に公開された @uipath/admin-vpngateway-commands パッケージによって実装されます。integrationsは、他の管理連携ツールが後から登録できる共有の親名前空間です。

概念

• 非同期操作。すべての変更動詞 (create、 edit、 redeploy、 delete、 refresh) は、タスクが適用されるとではなく、タスクが キューに挿入されるとすぐに返されます。次のミューテーションを発行する前に、state最終値 (ゲートウェイの場合はDeployed、接続の場合は Connecting/Updating 以外) に達するまで、gateways get <key>/connections get <key> をポーリングします。同じゲートウェイで同時発生したミューテーションは 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 つすべてを設定する必要があります。GCMAES --ipsec-encryption のバリアントには、同一の GCMAES --ipsec-integrityが必要です。connections edit では、既定で既存のポリシーが保持されます。8 つのフラグをすべて渡して置き換えるか、 --clear-ipsec を渡して削除します (8 つのフラグと相互に排他的)。
• BGP ペアリング規則。--bgp-peer-address (オンプレミス デバイスの BGP エンドポイント) は、ゲートウェイの --apipa-address プール内のアドレスの/30 パートナーである必要があります。どちらも 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 管理者との連携 VPN ゲートウェイ

UIP 管理者との連携 VPN ゲートウェイのリスト

現在のテナントのすべての VPN ゲートウェイ (キー、名前、ステート、種類、SKU、VNet、場所、パブリック IP、接続数) を一覧にします。

オプション

長押し	値 (Value)	説明
--tenant <name>	string	対象のテナント。既定値は、ユーザーのログイン コンテキストです。

例

uip admin integrations vpn gateways list

データシェイプ(--output 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 管理者連携 vpn ゲートウェイの取得

ゲートウェイとその接続をキーで取得します。

引数

名前	Required	目的
<key>	○	VPN ゲートウェイ キー (GUID)。

例

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

データシェイプ(--output 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 管理者連携 vpn ゲートウェイ tenant-config

現在のテナントに VPN ゲートウェイのプロビジョニングを許可されているかどうかを確認します。

例

uip admin integrations vpn gateways tenant-config

データシェイプ(--output json)

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

Data は、canCreateVpnGateway が falseの場合もvalidationErrorを運びます。

UIP 管理者との連携 VPN ゲートウェイの作成

新しい VPN ゲートウェイをプロビジョニングします。非同期 — gateways get/listで状態を追跡します。 Failedでは、 を使用します gateways redeploy。

オプション

長押し	値 (Value)	Required	説明
--name <name>	string	○	ゲートウェイ名。
--vnet-address-space <cidr>	CIDR、 /8–/27	○	VNet アドレス空間。作成後は変更できません。169.254.0.0/16 APIPA 範囲を拒否します。
--description <text>	string	×	自由形式の説明。
--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>	string	×	対象のテナント。

例

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

データシェイプ(--output 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 管理者連携 VPN ゲートウェイ 編集

ゲートウェイの変更可能なフィールドを更新します。パスしなかったスカラーは保持されます。渡すリストは既存のリストを卸売りで置き換えます ( 「概念」を参照)。編集フィールドが指定されていない場合は失敗します。

引数

名前	Required	目的
<key>	○	VPN ゲートウェイ キー (GUID)。

オプション

長押し	値 (Value)	説明
--name <name>	string	ゲートウェイの名前を変更します。
--description <text>	string	説明を更新します。
--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>	string	対象のテナント。

例

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

データシェイプ(--output json)

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

Data は、変更されたフィールドのみをエコーバックします。

UIP 管理者との連携 VPN ゲートウェイの再デプロイ

前回のデプロイ試行が正常に完了しなかったゲートウェイで、最後のバックグラウンド タスクをリトライします。ゲートウェイがフリーズしている場合、進行中のタスクがある場合、またはサポートされていないステートの場合は拒否されます。

引数

名前	Required	目的
<key>	○	VPN ゲートウェイ キー (GUID)。

例

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

データシェイプ(--output json)

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

UIP 管理者との連携 VPN ゲートウェイの削除

ゲートウェイおよび関連するすべてのインフラストラクチャを削除します。破壊的で不可逆的です。

引数

名前	Required	目的
<key>	○	VPN ゲートウェイ キー (GUID)。

オプション

長押し	値 (Value)	Required	説明
--confirm	フラグ	○	必須 — コマンドは [必須] なしで拒否します。
--tenant <name>	string	×	対象のテナント。

例

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

データシェイプ(--output json)

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

UIP 管理者との連携 VPN 接続

VPN ゲートウェイに接続されたサイト間接続。各接続は、1 つのオンプレミス ネットワークをゲートウェイとピアリングします。

uip admin 連携 vpn 接続 get

引数

名前	Required	目的
<key>	○	VPN ゲートウェイの接続キー (GUID)。

例

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

データシェイプ(--output 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 接続 作成

新しいサイト間接続をゲートウェイに接続します。

引数

名前	Required	目的
<gateway-key>	○	親 VPN ゲートウェイ キー (GUID)。

オプション

長押し	値 (Value)	Required	説明
--name <name>	string	○	コネクション名。
--shared-key <key>	string、≤128 印刷可能な ASCII 文字、スペース/ダッシュ/チルダなし	○	事前共有キー。
--target-ip <ip>	IPv4	○	オンプレミス VPN デバイスのパブリック IP。
--target-address-space <cidr>	CIDR、繰り返し可能	条件付き	--bgp-enabledが設定されていない場合は必須です (少なくとも 1 つ)。0.0.0.0/0 却下されます。
--bgp-enabled	フラグ	×	動的ルーティングには BGP を使用します。
--asn <num>	正の整数	条件付き	--bgp-enabledで必須です。65515 と 64512 は予約されています。
--bgp-peer-address <ip>	IPv4	条件付き	--bgp-enabledで必須です。ゲートウェイ --apipa-addressのオンプレミスの /30 パートナーである必要があります。
--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	×	Perfect Forward Secrecy グループ。
--tenant <name>	string	×	対象のテナント。

例

# 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

データシェイプ(--output 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 管理者連携 VPN 接続 編集

コネクションの変更可能なフィールドを更新します。--shared-key と --confirm は、他の変更に関係なく、すべての呼び出しで必要です ( 「概念」を参照)。

引数

名前	Required	目的
<key>	○	VPN ゲートウェイの接続キー (GUID)。

オプション

長押し	値 (Value)	Required	説明
--shared-key <key>	string	○	編集のたびに、現在の事前共有キーを再指定します。
--confirm	フラグ	○	ほとんどの編集によって短時間の接続が切断されることを認識してください。
--name <name>	string	×	コネクションの名前を変更します。
--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>	integer	×	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	×	IPsec ポリシーを置き換えるには、8 つすべてを渡します。8 つをすべて省略して保存します。
--clear-ipsec	フラグ	×	IPsec ポリシーを削除します。8 つの IPsec/IKE フラグと相互に排他的です。
--tenant <name>	string	×	対象のテナント。

例

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

データシェイプ(--output json)

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

UIP 管理者との連携 VPN 接続の更新

キューに入れる Azure からの接続の状態のバックグラウンド更新 — 接続は、定期的なジョブでも自動的に更新されます。次のサイクルを待ちたくない場合にのみ使用します。別の操作が進行中の場合は拒否されます。

引数

名前	Required	目的
<key>	○	VPN ゲートウェイの接続キー (GUID)。

例

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

データシェイプ(--output json)

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

uip 管理者連携 vpn 接続 削除

コネクションを削除します。破壊的で元に戻せない — オンプレミスのピアは、後で再作成された接続に再接続する必要があります。

引数

名前	Required	目的
<key>	○	VPN ゲートウェイの接続キー (GUID)。

オプション

長押し	値 (Value)	Required	説明
--confirm	フラグ	○	必須 — コマンドは [必須] なしで拒否します。
--tenant <name>	string	×	対象のテナント。

例

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

データシェイプ(--output json)

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

参照

• uip admin の概要
• グローバル オプション
• 終了コード