Intégrations d’administrateur UIP vpn

Syntaxe et options pour `uip admin Integrations vpn`, qui gère les passerelles VPN et les connexions de site à site qui permettent aux robots Cloud et sans serveur d'accéder aux réseaux sur site en privé.

uip admin integrations vpn gère les passerelles VPN et leurs connexions de site à site. Une passerelle VPN permet aux robots Cloud et sans serveur d’accéder aux réseaux sur site de manière privée via un tunnel IPSec de site à site, hébergé dans un réseau dont vous fournissez l’espace d’adressage au moment de la création. Une passerelle peut avoir plusieurs connexions, chacune apparaissant à la passerelle avec un réseau sur site.

Cette arborescence de commandes est implémentée par le package @uipath/admin-vpngateway-commands publié séparément, l'un de plusieurs packages composé dans uip admin (voir la vue d'ensemble deuip admin ) — il ne possède pas de verbe CLI de niveau supérieur; integrations est un espace de noms parent partagé sous lequel d’autres outils d’intégration d’administrateur peuvent s’enregistrer ultérieurement.

Concepts

• Opérations asynchrones. Chaque verbe de mutating (create, edit, redeploy, delete, refresh) renvoie dès que la tâche est mise en file d'attente, et pas une fois qu'elle est appliquée. Interrogez gateways get <key> / connections get <key> jusqu'à ce que state atteigne une valeur limite (Deployed pour une passerelle, tout autre que Connecting/Updating pour une connexion) avant d'émettre la prochaine transformation. Les modifications simultanées sur la même passerelle renvoient HTTP 409 — attendez quelques secondes et réessayez.
• Les verbes structurateurs nécessitent --confirm. gateways delete et connections delete refusent de s'exécuter sans cela, spécifiquement pour que les appelants non interactifs ne puissent pas déclencher la suppression par accident. connections edit nécessite également --confirm sur chaque appel, car la plupart des modifications entraînent une brève renégociation du tunnel et une perte de connectivité.
• Sémantique de remplacement de liste sur edit. Pour gateways edit et connections edit, les indicateurs en forme de liste (--dns-server, --apipa-address, --trusted-cert, --target-address-space) remplacent la liste existante en bloc lorsqu'ils sont transmis - transmettez à nouveau chaque entrée que vous souhaitez conserver. Chacun a un indicateur --clear-* correspondant pour vider la liste explicitement, mutuellement exclusif avec le formulaire rempli.
• connections edit nécessite toujours --shared-key. Même lorsque vous ne la modifiez pas, vous devez fournir à nouveau la clé pré-partagée actuelle à chaque appel de modification - le backend ne dispose d'aucun chemin de mise à jour partielle.
• La politique IPsec est tout ou rien. Si vous définissez l'un des 8 indicateurs IPsec/IKE (--ipsec-sa-lifetime, --ipsec-sa-data-size, --ipsec-encryption, --ipsec-integrity, --ike-encryption, --ike-integrity, --dh-group, --pfs-group), vous devez définir les 8 . Une variante GCMAES --ipsec-encryption nécessite un GCMAES --ipsec-integrity identique. connections edit préserve la stratégie existante par défaut; transmettez les 8 indicateurs pour le remplacer, ou --clear-ipsec pour le supprimer (s’excluant mutuellement avec les 8 indicateurs).
• Convention de couplage BGP. --bgp-peer-address (le point de terminaison BGP du périphérique sur site) doit être le partenaire /30 d’une adresse dans le pool --apipa-address de la passerelle, tous deux issus de 169.254.21.0/24 ou de 169.254.22.0/24. Convention: la passerelle prend l'adresse utilisable la plus élevée de /30 (par exemple .10), le pair sur site prend la plus faible (par ex. .9). L'activation de BGP sur une connexion qui n'était pas activée par BGP auparavant nécessite de transmettre --asn et --bgp-peer-address ensemble - la CLI rejette la modification initiale.
• --vnet-address-space est immuable après gateways create et doit être un CIDR avec le préfixe compris entre /8 et /27; la plage APIPA 169.254.0.0/16 est rejetée, car elle correspond aux blocs APIPA BGP utilisés en interne.

Synthèse

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> est disponible sur chaque verbe des deux groupes (par défaut, le locataire dans votre contexte de connexion).

Intégrations d'administrateur uip - Passerelles vpn

Intégrations d'administrateurs UiPath - Liste des passerelles VPN

Répertoriez toutes les passerelles VPN pour le locataire actuel - clé, nom, état, type, UGS, VNet, emplacement, IP publique, nombre de connexions.

Options

Long	Valeur (Value)	Description
--tenant <name>	string	Locataire cible. La valeur par défaut est votre contexte de connexion.

Exemple

uip admin integrations vpn gateways list

Format des données (--sortie 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": []
      }
    ]
  }
}

Intégrations d'administrateur uip - Obtenir les passerelles VPN

Récupérez une passerelle et ses connexions par clé.

Arguments

Nom	Requis	Objectif
<key>	oui	Clé de passerelle VPN.

Exemple

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

Format des données (--sortie 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..." }
    ]
  }
}

Intégrations d'administrateurs uip passerelles vpn tenant-config

Vérifiez si le locataire actuel est autorisé à enregistrer une passerelle VPN.

Exemple

uip admin integrations vpn gateways tenant-config

Format des données (--sortie json)

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

Data transporte également validationError lorsque canCreateVpnGateway est false.

Intégrations d'administrateurs uip création de passerelles vpn

Enregistrer une nouvelle passerelle VPN. Asynchrone: suivez l’état avec gateways get/list; sur Failed, utilisez gateways redeploy.

Options

Long	Valeur (Value)	Requis	Description
--name <name>	string	oui	Nom de la passerelle.
--vnet-address-space <cidr>	CIDR, /8–/27	oui	Espace d'adressage VNet. Immuable après la création. Rejete la plage APIPA 169.254.0.0/16.
--description <text>	string	non	Description sous forme libre.
--dns-server <ip>	IPv4, répétable, max. 3	non	IP du serveur DNS.
--apipa-address <ip>	IPv4 dans 169.254.21.0/24 ou 169.254.22.0/24, répétable, max 2	non	Adresse d'appairage BGP APIPA.
--trusted-cert <cert-name=base64>	<name>=<base64-X509>, répétable, max 10	non	Certificat racine approuvé.
--tenant <name>	string	non	Locataire cible.

Exemples

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

Format des données (--sortie 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"
  }
}

Intégrations d'administrateurs UiPath - Modification des passerelles VPN

Mettez à jour les champs modifiables d'une passerelle. Les escalades que vous ne transmettez pas sont conservées; les listes que vous réussissez remplacent la liste existante en bloc (voir Concepts). Échoue si aucun champ de modification n’est fourni.

Arguments

Nom	Requis	Objectif
<key>	oui	Clé de passerelle VPN.

Options

Long	Valeur (Value)	Description
--name <name>	string	Renommez la passerelle.
--description <text>	string	Mettre à jour la description.
--dns-server <ip>	IPv4, répétable, max. 3	Remplacez la liste des serveurs DNS. Capture mutuellement exclusive avec --clear-dns-servers.
--clear-dns-servers	Drapeau	Supprimez tous les serveurs DNS.
--apipa-address <ip>	IPv4, répétable, max 2	Remplacez la liste d'adresses APIPA. Capture mutuellement exclusive avec --clear-apipa-addresses.
--clear-apipa-addresses	Drapeau	Supprimer toutes les adresses BGP APIPA.
--trusted-cert <cert-name=base64>	répétable, max 10	Remplacez la liste des certificats approuvés. Capture mutuellement exclusive avec --clear-trusted-certs.
--clear-trusted-certs	Drapeau	Supprimez tous les certificats approuvés.
--tenant <name>	string	Locataire cible.

Exemples

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

Format des données (--sortie json)

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

Data renvoie uniquement les champs qui ont été modifiés.

Intégrations d'administrateur UiP - Redéploiement des passerelles VPN

Réessayez la dernière tâche en arrière-plan sur une passerelle dont la tentative de déploiement précédente ne s'est pas terminée correctement. Rejeté si la passerelle est gelée, a une tâche en cours ou est dans un état non pris en charge.

Arguments

Nom	Requis	Objectif
<key>	oui	Clé de passerelle VPN.

Exemple

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

Format des données (--sortie json)

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

Intégrations d'administrateur uip suppression des passerelles vpn

Supprimez la passerelle et toute l'infrastructure associée. Destructeur et irréversible.

Arguments

Nom	Requis	Objectif
<key>	oui	Clé de passerelle VPN.

Options

Long	Valeur (Value)	Requis	Description
--confirm	Drapeau	oui	Obligatoire — la commande se refuse sans cela.
--tenant <name>	string	non	Locataire cible.

Exemple

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

Format des données (--sortie json)

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

Intégrations d'administrateur UIP - Connexions VPN

Connexions de site à site associées à une passerelle VPN. Chaque connexion associe un réseau local à la passerelle.

Intégrations d'administrateurs uip - Obtenir des connexions VPN

Arguments

Nom	Requis	Objectif
<key>	oui	Clé de connexion de la passerelle VPN.

Exemple

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

Format des données (--sortie 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
  }
}

Intégrations d'administrateurs uip création de connexions vpn

Associez une nouvelle connexion de site à site à une passerelle.

Arguments

Nom	Requis	Objectif
<gateway-key>	oui	Clé de passerelle VPN parente.

Options

Long	Valeur (Value)	Requis	Description
--name <name>	string	oui	Nom de connexion.
--shared-key <key>	chaîne, ≥ 128 caractères ASCII imprimables, sans espaces, tirets, ni tildes	oui	Clé pré-partagée.
--target-ip <ip>	IPv4	oui	IP publique du périphérique VPN sur site.
--target-address-space <cidr>	CIDR, répétable	Conditionnel	Obligatoire (au moins un) lorsque --bgp-enabled n'est pas défini. 0.0.0.0/0 est rejeté.
--bgp-enabled	Drapeau	non	Utilisez BGP pour le routage dynamique.
--asn <num>	entier positif	Conditionnel	Requis avec --bgp-enabled. 65515 et 64512 sont réservés.
--bgp-peer-address <ip>	IPv4	Conditionnel	Requis avec --bgp-enabled. Doit être le partenaire /30 local d’une passerelle --apipa-address.
--ipsec-sa-lifetime <seconds>	entier, min 300	non	Durée de vie d'IPSec SA. Tout ou rien avec les 7 indicateurs ci-dessous.
--ipsec-sa-data-size <kb>	entier, 0 ou 1024–2147483647	non	Taille des données SA IPSec.
--ipsec-encryption <alg>	None|AES128|AES192|AES256|GCMAES128|GCMAES192|GCMAES256	non	Algorithme de chiffrement IPsec.
--ipsec-integrity <alg>	MD5|SHA1|SHA256|SHA384|GCMAES128|GCMAES256	non	Doit correspondre exactement à une GCMAES --ipsec-encryption.
--ike-encryption <alg>	AES128|AES192|AES256|GCMAES128|GCMAES256	non	Algorithme de chiffrement IKE.
--ike-integrity <alg>	MD5|SHA1|SHA256|SHA384|GCMAES128|GCMAES256	non	Algorithme d'intégrité IKE.
--dh-group <group>	None|DHGroup1|DHGroup2|DHGroup14|DHGroup24|DHGroup2048|ECP256|ECP384	non	Groupe Diffie-Hellman.
--pfs-group <group>	None|PFS1|PFS2|PFS14|PFS24|PFS2048|ECP256|ECP384|PFS	non	Groupe Confiance parfaitement transmise.
--tenant <name>	string	non	Locataire cible.

Exemples

# 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

Format des données (--sortie json)

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

Intégrations d'administrateur uip modification des connexions vpn

Mettez à jour les champs modifiables d'une connexion. --shared-key et --confirm sont requis pour chaque appel, indépendamment de tout autre changement (voir Concepts).

Arguments

Nom	Requis	Objectif
<key>	oui	Clé de connexion de la passerelle VPN.

Options

Long	Valeur (Value)	Requis	Description
--shared-key <key>	string	oui	Fournissez à nouveau la clé pré-partagée actuelle à chaque modification.
--confirm	Drapeau	oui	Confirmez la brève perte de connectivité causée par la plupart des modifications.
--name <name>	string	non	Renommez la connexion.
--target-ip <ip>	IPv4	non	IP publique du périphérique VPN sur site.
--target-address-space <cidr>	Répétable	non	Remplacez la liste CIDR sur site. 0.0.0.0/0 rejeté. Capture mutuellement exclusive avec --clear-target-address-spaces.
--clear-target-address-spaces	Drapeau	non	Supprimer tous les espaces d'adressage cible. Une connexion non-BGP avec aucun est mal configurée.
--bgp-enabled / --no-bgp-enabled	Drapeau	non	Activez/Désactivez le protocole BGP. L'activation sur une connexion précédemment non-BGP nécessite --asn et --bgp-peer-address ensemble.
--asn <num>	Integer	non	ASN BGP.
--bgp-peer-address <ip>	IPv4	non	Adresse de pair BGP.
--ipsec-sa-lifetime--ipsec-sa-data-size, --ipsec-encryption, --ipsec-integrity, --ike-encryption, --ike-integrity, --dh-group, --pfs-group	Voir connections create	non	Transmettez les 8 pour remplacer la politique IPsec; ometez tous les 8 pour le conserver.
--clear-ipsec	Drapeau	non	Supprimez la politique IPsec. Capture mutuellement exclusive avec les 8 indicateurs IPsec/IKE.
--tenant <name>	string	non	Locataire cible.

Exemples

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

Format des données (--sortie json)

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

Intégrations d'administrateur UIP - Actualiser les connexions VPN

Mettre en file d'attente une actualisation en arrière-plan de l'état de la connexion à partir d'Azure — les connexions sont également actualisées automatiquement lors d'une tâche périodique; n'utilisez cette option que lorsque vous ne souhaitez pas attendre le cycle suivant. Rejeté si une autre opération est en cours.

Arguments

Nom	Requis	Objectif
<key>	oui	Clé de connexion de la passerelle VPN.

Exemple

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

Format des données (--sortie json)

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

Intégrations d'administrateurs uip suppression des connexions vpn

Supprimez la connexion. Destructeur et irréversible - le pair sur site doit se reconnecter à une connexion recréée par la suite.

Arguments

Nom	Requis	Objectif
<key>	oui	Clé de connexion de la passerelle VPN.

Options

Long	Valeur (Value)	Requis	Description
--confirm	Drapeau	oui	Obligatoire — la commande se refuse sans cela.
--tenant <name>	string	non	Locataire cible.

Exemple

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

Format des données (--sortie json)

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

Voir également

• Vue d’ensemble du type uip admin
• Options globales
• Codes de sortie