vpn de integraciones de administrador de uip

Sintaxis y opciones para `uip admin Integrations VPN`, que gestiona las puertas de enlace VPN y las conexiones sitio a sitio que permiten a los robots en la nube y sin servidor llegar a las redes locales de forma privada.

uip admin integrations vpn gestiona las puertas de enlace VPN y sus conexiones sitio a sitio. Una puerta de enlace VPN permite a los robots en la nube y sin servidor llegar a las redes locales de forma privada a través de un túnel IPsec de sitio a sitio, alojado en una red cuyo espacio de direcciones proporcionas en el momento de la creación. Una puerta de enlace puede tener varias conexiones, cada una de las cuales empareja la puerta de enlace con una red local.

Este árbol de comandos se implementa mediante el paquete @uipath/admin-vpngateway-commands publicado por separado, uno de los varios paquetes compuestos en uip admin (consulta la descripción generaluip admin ): no posee un verbo CLI propio de nivel superior; integrations es un espacio de nombres principal compartido en el que otras herramientas de integración de administración pueden registrarse más adelante.

Conceptos

• Operaciones asíncronas. Cada verbo mutante (create, edit, redeploy, delete, refresh) vuelve tan pronto como la tarea se pone en cola, no una vez que se aplica. Sondea gateways get <key> / connections get <key> hasta que state alcance un valor terminal (Deployed para una puerta de enlace, cualquier cosa que no sea Connecting/Updating para una conexión) antes de emitir la siguiente mutación. Las mutaciones simultáneas en la misma puerta de enlace devuelven HTTP 409: espere unos segundos y vuelva a intentarlo.
• Los verbos destructivos requieren --confirm. gateways delete y connections delete se niegan a ejecutarse sin él, específicamente para que las personas que llaman no interactivas no puedan desencadenar la eliminación por accidente. connections edit también requiere --confirm en cada llamada, ya que la mayoría de las ediciones provocan una breve renegociación del túnel y una caída de la conectividad.
• Semántica de reemplazo de lista en edit. Tanto para gateways edit como para connections edit, los marcadores en forma de lista (--dns-server, --apipa-address, --trusted-cert, --target-address-space) reemplazan la lista existente al por mayor cuando se pasan: vuelve a pasar cada entrada que quieras conservar. Cada uno tiene un marcador --clear-* coincidente para vaciar la lista de forma explícita, mutuamente excluyente con el formulario rellenado.
• connections edit siempre requiere --shared-key. Incluso cuando no la estás cambiando, debes volver a proporcionar la clave precompartida actual en cada llamada de edición; el backend no tiene una ruta de actualización parcial para ello.
• La política de IPsec es todo o nada. Si estableces cualquiera de los 8 marcadores IPsec/IKE (--ipsec-sa-lifetime, --ipsec-sa-data-size, --ipsec-encryption, --ipsec-integrity, --ike-encryption, --ike-integrity, --dh-group, --pfs-group), debes establecer los 8 . Una variante de GCMAES --ipsec-encryption requiere un GCMAES --ipsec-integrity idéntico. connections edit conserva la política existente de forma predeterminada; pasar los 8 marcadores para reemplazarlo, o --clear-ipsec para eliminarlo (mutuamente excluyente con los 8 marcadores).
• Convención de emparejamiento BGP. --bgp-peer-address (el punto final BGP del dispositivo local) debe ser el socio /30 de una dirección en el grupo --apipa-address de la puerta de enlace, ambos extraídos de 169.254.21.0/24 o 169.254.22.0/24. Convención: la puerta de enlace toma la dirección utilizable más alta de /30 (por ejemplo .10), el par local toma el inferior (por ejemplo .9). Habilitar BGP en una conexión que no estaba habilitada para BGP requiere pasar --asn y --bgp-peer-address juntos; de lo contrario, la CLI rechaza la edición por adelantado.
• --vnet-address-space es inmutable después de gateways create y debe ser un CIDR con un prefijo entre /8 y /27; el rango APIPA 169.254.0.0/16 se rechaza porque colisiona con los bloques APIPA BGP utilizados internamente.

Sinopsis

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 en todos los verbos de ambos grupos (el valor predeterminado es el tenant en tu contexto de inicio de sesión).

uip admin integraciones puertas de enlace vpn

lista de puertas de enlace vpn de integraciones de administrador de uip

Enumera todas las puertas de enlace VPN para el tenant actual: clave, nombre, estado, tipo, SKU, VNet, ubicación, IP pública, recuento de conexiones.

Opciones

Largo	Valor	Descripción
--tenant <name>	String	Tenant de destino. El valor predeterminado es su contexto de inicio de sesión.

Ejemplo

uip admin integrations vpn gateways list

Forma de datos (--json de salida)

{
  "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 integraciones puertas de enlace vpn get

Obtener una puerta de enlace y sus conexiones por clave.

Argumentos

Nombre	Obligatorio	Propósito
<key>	Sí	Clave de puerta de enlace VPN (GUID).

Ejemplo

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

Forma de datos (--json de salida)

{
  "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 integraciones puertas de enlace vpn tenant-config

Comprueba si el tenant actual puede aprovisionar una puerta de enlace VPN.

Ejemplo

uip admin integrations vpn gateways tenant-config

Forma de datos (--json de salida)

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

Data también lleva validationError cuando canCreateVpnGateway es false.

uip admin integraciones puertas de enlace vpn crear

Aprovisiona una nueva puerta de enlace VPN. Asíncrono: estado de seguimiento con gateways get/list; en Failed, utiliza gateways redeploy.

Opciones

Largo	Valor	Obligatorio	Descripción
--name <name>	String	Sí	Nombre de la puerta de enlace.
--vnet-address-space <cidr>	CIDR, /8–/27	Sí	Espacio de direcciones de VNet. Inmutable después de crear. Rechaza el rango APIPA 169.254.0.0/16.
--description <text>	String	No	Descripción de forma libre.
--dns-server <ip>	IPv4, repetible, máx. 3	No	IP del servidor DNS.
--apipa-address <ip>	IPv4 en 169.254.21.0/24 o 169.254.22.0/24, repetible, máx. 2	No	Dirección de emparejamiento APIPA BGP.
--trusted-cert <cert-name=base64>	<name>=<base64-X509>, repetible, máx. 10	No	Certificado raíz de confianza.
--tenant <name>	String	No	Tenant de destino.

Ejemplos

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

Forma de datos (--json de salida)

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

edición de puertas de enlace vpn de integraciones de administrador de uip

Actualizar los campos mutables de una puerta de enlace. Los escalares que no apruebas se conservan; las listas que pases reemplazan la lista existente al por mayor (consulta Conceptos). Falla si no se proporciona un campo de edición.

Argumentos

Nombre	Obligatorio	Propósito
<key>	Sí	Clave de puerta de enlace VPN (GUID).

Opciones

Largo	Valor	Descripción
--name <name>	String	Cambia el nombre de la puerta de enlace.
--description <text>	String	Actualizar descripción.
--dns-server <ip>	IPv4, repetible, máx. 3	Reemplaza la lista de servidores DNS. Mutuamente exclusivo con --clear-dns-servers.
--clear-dns-servers	Marca	Eliminar todos los servidores DNS.
--apipa-address <ip>	IPv4, repetible, máx. 2	Reemplaza la lista de direcciones APIPA. Mutuamente exclusivo con --clear-apipa-addresses.
--clear-apipa-addresses	Marca	Eliminar todas las direcciones BGP de APIPA.
--trusted-cert <cert-name=base64>	repetible, máximo 10	Reemplaza la lista de certificados de confianza. Mutuamente exclusivo con --clear-trusted-certs.
--clear-trusted-certs	Marca	Elimina todos los certificados de confianza.
--tenant <name>	String	Tenant de destino.

Ejemplos

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

Forma de datos (--json de salida)

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

Data solo repite los campos que cambiaron.

redespliegue de puertas de enlace vpn de integraciones de administrador de uip

Vuelva a intentar la última tarea en segundo plano en una puerta de enlace cuyo intento de implementación anterior no se haya completado correctamente. Se rechaza si la puerta de enlace está congelada, tiene una tarea en vuelo o está en un estado no compatible.

Argumentos

Nombre	Obligatorio	Propósito
<key>	Sí	Clave de puerta de enlace VPN (GUID).

Ejemplo

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

Forma de datos (--json de salida)

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

eliminación de puertas de enlace vpn de integraciones de administrador de uip

Elimina la puerta de enlace y toda la infraestructura relacionada. Destructivo e irreversible.

Argumentos

Nombre	Obligatorio	Propósito
<key>	Sí	Clave de puerta de enlace VPN (GUID).

Opciones

Largo	Valor	Obligatorio	Descripción
--confirm	Marca	Sí	Requerido: el comando se niega sin él.
--tenant <name>	String	No	Tenant de destino.

Ejemplo

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

Forma de datos (--json de salida)

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

uip admin integraciones conexiones vpn

Conexiones sitio a sitio adjuntas a una puerta de enlace VPN. Cada conexión empareja una red local con la puerta de enlace.

uip administrador integraciones conexiones vpn obtener

Argumentos

Nombre	Obligatorio	Propósito
<key>	Sí	Clave de conexión de puerta de enlace VPN (GUID).

Ejemplo

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

Forma de datos (--json de salida)

{
  "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 administrador integraciones conexiones vpn crear

Adjunta una nueva conexión sitio a sitio a una puerta de enlace.

Argumentos

Nombre	Obligatorio	Propósito
<gateway-key>	Sí	Clave de puerta de enlace VPN principal (GUID).

Opciones

Largo	Valor	Obligatorio	Descripción
--name <name>	String	Sí	Nombre de la conexión.
--shared-key <key>	cadena, ≤128 caracteres ASCII imprimibles, sin espacios/guiones/tildes	Sí	Clave precompartida.
--target-ip <ip>	IPv4	Sí	IP pública del dispositivo VPN local.
--target-address-space <cidr>	CIDR, repetible	condicionalmente	Obligatorio (al menos uno) cuando --bgp-enabled no está establecido. 0.0.0.0/0 ha sido rechazado.
--bgp-enabled	Marca	No	Usa BGP para el enrutamiento dinámico.
--asn <num>	entero positivo	condicionalmente	Obligatorio con --bgp-enabled. 65515 y 64512 están reservados.
--bgp-peer-address <ip>	IPv4	condicionalmente	Obligatorio con --bgp-enabled. Debe ser el socio /30 local de una puerta de enlace --apipa-address.
--ipsec-sa-lifetime <seconds>	entero, mínimo 300	No	Vida útil de IPsec SA. Todo o nada con los 7 marcadores siguientes.
--ipsec-sa-data-size <kb>	entero, 0 o 1024–2147483647	No	Tamaño de datos de IPsec SA.
--ipsec-encryption <alg>	None|AES128|AES192|AES256|GCMAES128|GCMAES192|GCMAES256	No	Algoritmo de cifrado IPsec.
--ipsec-integrity <alg>	MD5|SHA1|SHA256|SHA384|GCMAES128|GCMAES256	No	Debe coincidir exactamente con un GCMAES --ipsec-encryption.
--ike-encryption <alg>	AES128|AES192|AES256|GCMAES128|GCMAES256	No	Algoritmo de cifrado IKE.
--ike-integrity <alg>	MD5|SHA1|SHA256|SHA384|GCMAES128|GCMAES256	No	Algoritmo de integridad IKE.
--dh-group <group>	None|DHGroup1|DHGroup2|DHGroup14|DHGroup24|DHGroup2048|ECP256|ECP384	No	Grupo Diffie-Hellman.
--pfs-group <group>	None|PFS1|PFS2|PFS14|PFS24|PFS2048|ECP256|ECP384|PFS	No	Grupo Perfect Forward Serecy.
--tenant <name>	String	No	Tenant de destino.

Ejemplos

# 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

Forma de datos (--json de salida)

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

edición de conexiones vpn de integraciones de administrador de uip

Actualizar los campos mutables de una conexión. --shared-key y --confirm son necesarios en cada llamada independientemente de qué más cambie (consulta Conceptos).

Argumentos

Nombre	Obligatorio	Propósito
<key>	Sí	Clave de conexión de puerta de enlace VPN (GUID).

Opciones

Largo	Valor	Obligatorio	Descripción
--shared-key <key>	String	Sí	Vuelve a proporcionar la clave precompartida actual en cada edición.
--confirm	Marca	Sí	Reconoce la breve caída de conectividad que causan la mayoría de las ediciones.
--name <name>	String	No	Cambia el nombre de la conexión.
--target-ip <ip>	IPv4	No	IP pública del dispositivo VPN local.
--target-address-space <cidr>	Repetible	No	Reemplaza la lista CIDR local. 0.0.0.0/0 rechazado. Mutuamente exclusivo con --clear-target-address-spaces.
--clear-target-address-spaces	Marca	No	Eliminar todos los espacios de direcciones de destino. Una conexión no BGP sin ninguna está mal configurada.
--bgp-enabled / --no-bgp-enabled	Marca	No	Habilitar/deshabilitar BGP. Habilitar en una conexión que anteriormente no era BGP requiere --asn y --bgp-peer-address juntos.
--asn <num>	Entero	No	ASN de BGP.
--bgp-peer-address <ip>	IPv4	No	Dirección del par BGP.
--ipsec-sa-lifetime, --ipsec-sa-data-size, --ipsec-encryption, --ipsec-integrity, --ike-encryption, --ike-integrity, --dh-group, --pfs-group	Consulta connections create	No	Pasa los 8 para reemplazar la política IPsec; omita los 8 para conservarlo.
--clear-ipsec	Marca	No	Elimina la política IPsec. Mutuamente exclusivo con los 8 marcadores IPsec/IKE.
--tenant <name>	String	No	Tenant de destino.

Ejemplos

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

Forma de datos (--json de salida)

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

actualización de conexiones vpn de integraciones de administrador de uip

Poner en cola una actualización en segundo plano del estado de la conexión desde Azure: las conexiones también se actualizan automáticamente en un trabajo periódico; utilízalo solo cuando no quieras esperar al siguiente ciclo. Se rechaza si hay otra operación en curso.

Argumentos

Nombre	Obligatorio	Propósito
<key>	Sí	Clave de conexión de puerta de enlace VPN (GUID).

Ejemplo

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

Forma de datos (--json de salida)

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

eliminación de conexiones vpn de integraciones de administrador de uip

Elimina la conexión. Destructivo e irreversible: el par local debe volver a conectarse a una conexión recreada después.

Argumentos

Nombre	Obligatorio	Propósito
<key>	Sí	Clave de conexión de puerta de enlace VPN (GUID).

Opciones

Largo	Valor	Obligatorio	Descripción
--confirm	Marca	Sí	Requerido: el comando se niega sin él.
--tenant <name>	String	No	Tenant de destino.

Ejemplo

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

Forma de datos (--json de salida)

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

Ver también

• Información general de uip admin
• Opciones globales
• Códigos de salida