UIP-Administratorintegrationen VPN

Syntax und Optionen für „uip admin Integrations vpn“, das VPN-Gateways und Site-to-Site-Verbindungen verwaltet, über die Cloud- und serverlose Roboter lokale Netzwerke privat erreichen können.

uip admin integrations vpn verwaltet VPN-Gateways und deren Site-to-Site-Verbindungen. Mit einem VPN-Gateway können Cloud- und serverlose Roboter lokale Netzwerke privat über einen Site-to-Site-IPsec-Tunnel erreichen, der in einem Netzwerk gehostet wird, dessen Adressraum Sie zum Zeitpunkt der Erstellung angeben. Ein Gateway kann mehrere Verbindungen haben, die jeweils mit einem lokalen Netzwerk dem Gateway zugeordnet sind.

Diese Befehlsstruktur wird durch das separat veröffentlichte @uipath/admin-vpngateway-commands -Paket implementiert, eines von mehreren Paketen, die in uip admin zusammengefasst sind (siehe uip admin -Übersicht) – es besitzt kein eigenes CLI-Verb der obersten Ebene; integrations ist ein gemeinsam genutzter übergeordneter Namespace, unter dem andere Administratorintegrationstools später möglicherweise registriert werden.

Konzepte

• Asynchrone Vorgänge. Jedes veränderte Verb (create, edit, redeploy, delete, refresh) wird zurückgegeben, sobald die Aufgabe in die Warteschlange eingereiht wird, nicht sobald sie angewendet wird. Abfragen Sie gateways get <key> / connections get <key>, bis state einen Endwert erreicht (Deployed für ein Gateway, etwas anderes als Connecting/Updating für eine Verbindung), bevor die nächste Variation ausgegeben wird. Gleichzeitige Migrationen auf demselben Gateway geben HTTP 409 zurück – warten Sie einige Sekunden, und versuchen Sie es erneut.
• Destruktive Verben erfordern --confirm. gateways delete und connections delete verweigern die Ausführung ohne sie, insbesondere damit nicht interaktive Aufrufer das Löschen nicht versehentlich auslösen können. connections edit erfordert auch --confirm bei jedem Aufruf, da die meisten Änderungen zu einer kurzen Neuaushandelung des Tunnels und einem Verbindungsabbruch führen.
• Semantik zum Ersetzen von Listen für edit. Sowohl für gateways edit als auch für connections edit ersetzen listig-Flags (--dns-server, --apipa-address, --trusted-cert, --target-address-space) den vorhandenen Listen Wenn übergeben – übergeben Sie jeden Eintrag, den Sie beibehalten möchten. Jeder hat ein passendes --clear-* -Flag, um die Liste explizit zu leeren, was sich gegenseitig mit dem ausgefüllten Formular ausschließt.
• connections edit erfordert immer --shared-key. Auch wenn Sie ihn nicht ändern, müssen Sie den aktuellen vorab freigegebenen Schlüssel bei jedem Bearbeitungsaufruf erneut angeben – das Back-End hat keinen teilweisen Aktualisierungspfad dafür.
• Die IPsec-Richtlinie ist alles oder nichts. Wenn Sie eines der 8 IPsec/IKE-Flags festlegen (--ipsec-sa-lifetime, --ipsec-sa-data-size, --ipsec-encryption, --ipsec-integrity, --ike-encryption, --ike-integrity, --dh-group, --pfs-group), müssen Sie alle 8 . Eine GCMAES --ipsec-encryption -Variante erfordert eine identische GCMAES --ipsec-integrity-Variante. connections edit behält die vorhandene Richtlinie standardmäßig bei; Übergeben Sie alle 8 Flags, um es zu ersetzen, oder --clear-ipsec, um es zu entfernen (was sich mit den 8 Flags gegenseitig ausschließt).
• BGP-Paarkonvention. --bgp-peer-address (der BGP-Endpunkt des lokalen Geräts) muss der /30 -Partner einer Adresse im --apipa-address -Pool des Gateways sein, der beide aus 169.254.21.0/24 oder 169.254.22.0/24 entnommen wird. Konvention: Das Gateway verwendet die höhere nutzbare Adresse von /30 (z. B. .10), übernimmt der lokale Peer die niedrigere (z. B. .9). Das Aktivieren von BGP für eine Verbindung, die zuvor nicht BGP-aktiviert war, erfordert die Übergabe sowohl von --asn als auch von --bgp-peer-address zusammen – die CLI weist die Bearbeitung im Voraus zurück.
• --vnet-address-space ist nach gateways createunveränderlich und muss ein CIDR mit Präfix zwischen /8 und /27 sein; Der APIPA-Bereich 169.254.0.0/16 wird abgelehnt, da er mit den intern verwendeten BGP-APIPA-Blöcken kollaboriert.

Zusammenfassung

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> ist für jedes Verb in beiden Gruppen verfügbar (standardmäßig ist der Mandant in Ihrem Anmeldekontext).

UIP-Administratorintegrationen VPN-Gateways

Liste der UIP-Administratorintegrationen VPN-Gateways

Listen Sie alle VPN-Gateways für den aktuellen Mandanten auf – Schlüssel, Name, Status, Typ, SKU, VNet, Standort, öffentliche IP, Verbindungsanzahl.

Optionen

Long	Wert	Beschreibung
--tenant <name>	string	Zielmandant. Die Standardeinstellung ist Ihr Anmeldekontext.

Beispiel

uip admin integrations vpn gateways list

Datenform (--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": []
      }
    ]
  }
}

Abrufen von UIP-Administratorintegrationen VPN-Gateways

Rufen Sie ein Gateway und seine Verbindungen nach Schlüssel ab.

Argumente

Name	Erforderlich	Zweck
<key>	ja	VPN-Gatewayschlüssel (GUID).

Beispiel

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

Datenform (--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-Administratorintegrationen VPN-Gateways Mandantenkonfiguration

Überprüfen Sie, ob der aktuelle Mandant ein VPN-Gateway bereitstellen darf.

Beispiel

uip admin integrations vpn gateways tenant-config

Datenform (--output json)

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

Data hat auch validationError, wenn canCreateVpnGateway gleich false ist.

UIP-Administratorintegrationen VPN-Gateways erstellen

Stellen Sie ein neues VPN-Gateway bereit. Asynchron – Verfolgen Sie den Status mit gateways get/list; Verwenden Sie auf Failed gateways redeploy.

Optionen

Long	Wert	Erforderlich	Beschreibung
--name <name>	string	ja	Gateway-Name.
--vnet-address-space <cidr>	CIDR, /8–/27	ja	VNet-Adressraum. Unveränderlich nach der Erstellung. Ablehnung des APIPA-Bereichs 169.254.0.0/16 aus.
--description <text>	string	nein	Freiform-Beschreibung.
--dns-server <ip>	IPv4, wiederholbar, max. 3	nein	DNS-Server-IP.
--apipa-address <ip>	IPv4 in 169.254.21.0/24 oder 169.254.22.0/24, wiederholbar, max. 2	nein	APIPA BGP-Peering-Adresse.
--trusted-cert <cert-name=base64>	<name>=<base64-X509>, wiederholbar, max. 10	nein	Vertrauenswürdiges Stammzertifikat.
--tenant <name>	string	nein	Zielmandant.

Beispiele

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

Datenform (--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-Administratorintegration VPN-Gateways bearbeiten

Aktualisieren Sie die veränderbaren Felder eines Gateways. Skalare, die Sie nicht übergeben, werden beibehalten; Listen, die Sie übergeben, ersetzen die vorhandene Liste (siehe Konzepte). Schlägt fehl, wenn kein Bearbeitungsfeld angegeben ist.

Argumente

Name	Erforderlich	Zweck
<key>	ja	VPN-Gatewayschlüssel (GUID).

Optionen

Long	Wert	Beschreibung
--name <name>	string	Benennen Sie das Gateway um.
--description <text>	string	Aktualisieren Sie die Beschreibung.
--dns-server <ip>	IPv4, wiederholbar, max. 3	Ersetzen Sie die DNS-Serverliste. Sich gegenseitig mit --clear-dns-servers ausschließen.
--clear-dns-servers	Markieren	Entfernen Sie alle DNS-Server.
--apipa-address <ip>	IPv4, wiederholbar, max. 2	Ersetzen Sie die APIPA-Adressliste. Sich gegenseitig mit --clear-apipa-addresses ausschließen.
--clear-apipa-addresses	Markieren	Entfernen Sie alle APIPA-BGP-Adressen.
--trusted-cert <cert-name=base64>	wiederholbar, max. 10	Ersetzen Sie die Liste der vertrauenswürdigen Zertifikate. Sich gegenseitig mit --clear-trusted-certs ausschließen.
--clear-trusted-certs	Markieren	Entfernen Sie alle vertrauenswürdigen Zertifikate.
--tenant <name>	string	Zielmandant.

Beispiele

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

Datenform (--output json)

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

Data gibt nur die geänderten Felder zurück.

UIP-Administratorintegrationen VPN-Gateways werden erneut bereitgestellt

Wiederholen Sie die letzte Hintergrundaufgabe auf einem Gateway, dessen vorheriger Bereitstellungsversuch nicht sauber abgeschlossen wurde. Abgelehnt, wenn das Gateway eingefroren ist, eine Aufgabe im Gange ist oder sich in einem nicht unterstützten Status befindet.

Argumente

Name	Erforderlich	Zweck
<key>	ja	VPN-Gatewayschlüssel (GUID).

Beispiel

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

Datenform (--output json)

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

UIP-Administratorintegrationen VPN-Gateways löschen

Löschen Sie das Gateway und die gesamte zugehörige Infrastruktur. Destruktiv und irreversibel.

Argumente

Name	Erforderlich	Zweck
<key>	ja	VPN-Gatewayschlüssel (GUID).

Optionen

Long	Wert	Erforderlich	Beschreibung
--confirm	Markieren	ja	Erforderlich – der Befehl wird ohne dies abgelehnt.
--tenant <name>	string	nein	Zielmandant.

Beispiel

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

Datenform (--output json)

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

UIP-Administratorintegrationen VPN-Verbindungen

Site-to-Site-Verbindungen, die an ein VPN-Gateway angehängt sind. Jede Verbindung ist ein lokales Netzwerk mit dem Gateway.

Abrufen von UIP-Administratorintegrationen VPN-Verbindungen

Argumente

Name	Erforderlich	Zweck
<key>	ja	VPN-Gateway-Verbindungsschlüssel (GUID).

Beispiel

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

Datenform (--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-Administratorintegrationen VPN-Verbindungen erstellen

Hängen Sie eine neue Site-to-Site-Verbindung an ein Gateway an.

Argumente

Name	Erforderlich	Zweck
<gateway-key>	ja	Übergeordneter VPN-Gatewayschlüssel (GUID).

Optionen

Long	Wert	Erforderlich	Beschreibung
--name <name>	string	ja	Verbindungsname.
--shared-key <key>	Zeichenfolge, ≥128 druckbare ASCII-Zeichen, keine Leerzeichen/striche/ Tilde	ja	Vorab freigegebener Schlüssel.
--target-ip <ip>	IPv4	ja	Öffentliche IP des lokalen VPN-Geräts.
--target-address-space <cidr>	CIDR, wiederholbar	bedingt	Erforderlich (mindestens eines), wenn --bgp-enabled nicht festgelegt ist. 0.0.0.0/0 wurde abgelehnt.
--bgp-enabled	Markieren	nein	Verwenden Sie BGP für das dynamische Routing.
--asn <num>	positiver Integer	bedingt	Erforderlich mit --bgp-enabled. 65515 und 64512 sind reserviert.
--bgp-peer-address <ip>	IPv4	bedingt	Erforderlich mit --bgp-enabled. Muss der lokale /30 -Partner eines Gateways --apipa-address sein.
--ipsec-sa-lifetime <seconds>	Integer, min. 300	nein	IPsec-SA-Lebensdauer. All-oder-Nothing mit den sieben Flags unten.
--ipsec-sa-data-size <kb>	Integer, 0 oder 1024–2147483647	nein	IPsec-SA-Datengröße.
--ipsec-encryption <alg>	None|AES128|AES192|AES256|GCMAES128|GCMAES192|GCMAES256	nein	IPsec-Verschlüsselungsalgorithmus.
--ipsec-integrity <alg>	MD5|SHA1|SHA256|SHA384|GCMAES128|GCMAES256	nein	Muss exakt mit einem GCMAES --ipsec-encryption übereinstimmen.
--ike-encryption <alg>	AES128|AES192|AES256|GCMAES128|GCMAES256	nein	IKE-Verschlüsselungsalgorithmus.
--ike-integrity <alg>	MD5|SHA1|SHA256|SHA384|GCMAES128|GCMAES256	nein	IKE-Integritätsalgorithmus.
--dh-group <group>	None|DHGroup1|DHGroup2|DHGroup14|DHGroup24|DHGroup2048|ECP256|ECP384	nein	Diffe-Hellman-Gruppe.
--pfs-group <group>	None|PFS1|PFS2|PFS14|PFS24|PFS2048|ECP256|ECP384|PFS	nein	Perfekte Forward Secret-Gruppe.
--tenant <name>	string	nein	Zielmandant.

Beispiele

# 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

Datenform (--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-Administratorintegrationen VPN-Verbindungen bearbeiten

Aktualisieren Sie die veränderbaren Felder einer Verbindung. --shared-key und --confirm sind bei jedem Aufruf erforderlich, unabhängig davon, was sich sonst noch ändert (siehe Konzepte).

Argumente

Name	Erforderlich	Zweck
<key>	ja	VPN-Gateway-Verbindungsschlüssel (GUID).

Optionen

Long	Wert	Erforderlich	Beschreibung
--shared-key <key>	string	ja	Geben Sie den aktuellen vorab freigegebenen Schlüssel bei jeder Bearbeitung erneut an.
--confirm	Markieren	ja	Bestätigen Sie, dass die meisten Änderungen die Ursache für die kurze Konnektivität sind.
--name <name>	string	nein	Benennen Sie die Verbindung um.
--target-ip <ip>	IPv4	nein	Öffentliche IP des lokalen VPN-Geräts.
--target-address-space <cidr>	wiederholbar	nein	Ersetzen Sie die lokale CIDR-Liste. 0.0.0.0/0 abgelehnt. Sich gegenseitig mit --clear-target-address-spaces ausschließen.
--clear-target-address-spaces	Markieren	nein	Entfernen Sie alle Zieladressbereiche. Eine Nicht-BGP-Verbindung mit keinem ist falsch konfiguriert.
--bgp-enabled / --no-bgp-enabled	Markieren	nein	Aktivieren/Deaktivieren von BGP. Das Aktivieren für eine zuvor Nicht-BGP-Verbindung erfordert --asn und --bgp-peer-address zusammen.
--asn <num>	Integer	nein	BGP-ASN.
--bgp-peer-address <ip>	IPv4	nein	BGP-Peer-Adresse.
--ipsec-sa-lifetime, --ipsec-sa-data-size, --ipsec-encryption, --ipsec-integrity, --ike-encryption, --ike-integrity, --dh-group, --pfs-group	Siehe connections create	nein	Alle 8 übergeben, um die IPsec-Richtlinie zu ersetzen; lassen Sie alle 8 weg, um sie zu erhalten.
--clear-ipsec	Markieren	nein	Entfernen Sie die IPsec-Richtlinie. Sich gegenseitig mit den 8 IPsec/IKE-Flags ausschließen.
--tenant <name>	string	nein	Zielmandant.

Beispiele

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

Datenform (--output json)

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

Aktualisierung der UIP-Administratorintegrationen VPN-Verbindungen

Stellen Sie eine Hintergrundaktualisierung des Status der Verbindung von Azure in die Warteschlange ein – Verbindungen werden auch automatisch bei einem regelmäßigen Auftrag aktualisiert; Verwenden Sie dies nur, wenn Sie nicht auf den nächsten Zyklus warten möchten. Abgelehnt, wenn sich ein anderer Vorgang im Gange befindet.

Argumente

Name	Erforderlich	Zweck
<key>	ja	VPN-Gateway-Verbindungsschlüssel (GUID).

Beispiel

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

Datenform (--output json)

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

UIP-Administratorintegrationen VPN-Verbindungen löschen

Löschen Sie die Verbindung. Destruktiv und kann nicht rückgängig gemacht werden – der lokale Peer muss sich danach wieder mit einer neu erstellten Verbindung verbinden.

Argumente

Name	Erforderlich	Zweck
<key>	ja	VPN-Gateway-Verbindungsschlüssel (GUID).

Optionen

Long	Wert	Erforderlich	Beschreibung
--confirm	Markieren	ja	Erforderlich – der Befehl wird ohne dies abgelehnt.
--tenant <name>	string	nein	Zielmandant.

Beispiel

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

Datenform (--output json)

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

Siehe auch

• uip admin-Übersicht
• Globale Optionen
• Exitcodes