integrações de administrador do uip vpn

Sintaxe e opções para "uip admin Integrations vpn", que gerencia gateways VPN e conexões site a site que permitem que robôs de nuvem e serverless alcancem redes locais de forma privada.

uip admin integrations vpn gerencia gateways VPN e suas conexões site a site. Um gateway de VPN permite que os Cloud e os Serverless Robots alcancem redes locais de forma privada por meio de um túnel IPsec entre sites, hospedado em uma rede cujo espaço de endereço você fornece no momento da criação. Um gateway pode ter várias conexões, cada uma emparelhando o gateway com uma rede local.

Essa árvore de comando é implementada pelo pacote @uipath/admin-vpngateway-commands publicado separadamente, um dos vários pacotes compostos em uip admin (consulte a Visão geral deuip admin ) — não possui nenhum verbo CLI de nível superior próprio; integrations é um namespace pai compartilhado que outras ferramentas de integração de administrador podem registrar posteriormente.

Conceitos

• Operações assíncronas. Cada verbo variante (create, edit, redeploy, delete, refresh) retorna assim que a tarefa é enfileirada, não depois de aplicada. Pesquise gateways get <key> / connections get <key> até que state atinja um valor terminal (Deployed para um gateway, qualquer coisa diferente de Connecting/Updating para uma conexão) antes de emitir a próxima transformação. Mutações simultâneas no mesmo gateway retornam HTTP 409 — aguarde alguns segundos e tente novamente.
• Os verbos destrutivos exigem --confirm. gateways delete e connections delete se recusam a ser executados sem ele, especificamente para que os chamadores não interativos não possam disparar a exclusão por engano. connections edit também requer --confirm em cada chamada, pois a maioria das edições causa uma breve renegociação do túnel e quebra de conectividade.
• Semântica de substituição da lista em edit. Para gateways edit e connections edit, sinalizadores em forma de lista (--dns-server, --apipa-address, --trusted-cert, --target-address-space) substituem a lista existente por completo quando aprovados — passe novamente todas as entradas que deseja manter. Cada um tem um sinalizador --clear-* correspondente para esvaziar a lista explicitamente, mutuamente exclusivo com o formulário preenchido.
• connections edit sempre requer --shared-key. Mesmo quando não a estiver alterando, você deve fornecer novamente a chave pré-compartilhada atual em cada chamada de edição — o back-end não tem caminho de atualização parcial para ela.
• A política IPsec é tudo ou nada. Se você definir qualquer um dos 8 sinalizadores IPsec/IKE (--ipsec-sa-lifetime, --ipsec-sa-data-size, --ipsec-encryption, --ipsec-integrity, --ike-encryption, --ike-integrity, --dh-group, --pfs-group), você deve definir todos os 8 . Uma variante do GCMAES --ipsec-encryption requer um GCMAES --ipsec-integrity idêntico. connections edit preserva a política existente por padrão; passar todos os 8 sinalizadores para substituí-lo ou --clear-ipsec para removê-lo ( mutuamente exclusivo com os 8 sinalizadores).
• Convenção de emparelhamento de BGP. --bgp-peer-address (o ponto de extremidade BGP do dispositivo local) deve ser o parceiro /30 de um endereço no pool --apipa-address do gateway, ambos extraídos de 169.254.21.0/24 ou de 169.254.22.0/24. Convenção: o gateway pega o endereço utilizável mais alto do /30 (por exemplo .10), o par on-prem leva o inferior (por exemplo .9). Habilitar o BGP em uma conexão que não era habilitada para BGP antes requer passar --asn e --bgp-peer-address juntos — caso contrário, a CLI rejeita a edição inicial.
• é--vnet-address-space após gateways create e deve ser um CIDR com prefixo entre /8 e /27; o intervalo 169.254.0.0/16 APIPA é rejeitado porque colide com os blocos BGP APIPA usados internamente.

Resumo

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á disponível em cada verbo em ambos os grupos (o padrão é o tenant em seu contexto de logon).

integrações de administrador do uip gateways vpn

integrações de administrador do uip lista de gateways vpn

Liste todos os gateways de VPN para o tenant atual — chave, nome, estado, tipo, SKU, VNet, local, IP público, contagem de conexões.

Opções

Long	Valor	Description
--tenant <name>	String	Tenant de destino. O padrão é o seu contexto de login.

Exemplo

uip admin integrations vpn gateways list

Formato dos dados (--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": []
      }
    ]
  }
}

integrações de administrador do uip gateways vpn obter

Busca um gateway e suas conexões por chave.

Argumentos

Name	Required	Finalidade
<key>	sim	Chave de gateway da VPN (GUID).

Exemplo

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

Formato dos dados (--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..." }
    ]
  }
}

integrações de administrador do uip gateways de vpn tenant-config

Verifique se o tenant atual tem permissão para provisionar um gateway de VPN.

Exemplo

uip admin integrations vpn gateways tenant-config

Formato dos dados (--output json)

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

Data também carrega validationError quando canCreateVpnGateway é false.

integrações de administrador do uip gateways vpn criar

Provisione um novo gateway de VPN. Assíncrono — rastrear o estado com gateways get/list; em Failed, use gateways redeploy.

Opções

Long	Valor	Required	Description
--name <name>	String	sim	Nome do gateway.
--vnet-address-space <cidr>	CIDR, /8–/27	sim	Espaço de endereço VNet. Imutável após a criação. Rejeita o intervalo 169.254.0.0/16 da APIPA.
--description <text>	String	não	Descrição de forma livre.
--dns-server <ip>	IPv4, repetível, máx. 3	não	IP do servidor DNS.
--apipa-address <ip>	IPv4 em 169.254.21.0/24 ou 169.254.22.0/24, repetível, máximo 2	não	Endereço de peering APIPA BGP.
--trusted-cert <cert-name=base64>	<name>=<base64-X509>, repetível, máx. 10	não	Certificado raiz confiável.
--tenant <name>	String	não	Tenant de destino.

Exemplos

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

Formato dos dados (--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"
  }
}

edição dos gateways de VPN das integrações de administrador do uip

Atualizar os campos roláveis de um gateway. Os escalares que você não aprova são preservados; as listas que você aprova substituem a lista existente por completo (consulte Conceitos). A falha ocorre se nenhum campo de edição é fornecido.

Argumentos

Name	Required	Finalidade
<key>	sim	Chave de gateway da VPN (GUID).

Opções

Long	Valor	Description
--name <name>	String	Renomeie o gateway.
--description <text>	String	Atualizar descrição.
--dns-server <ip>	IPv4, repetível, máx. 3	Substitua a lista de servidores DNS. mutuamente exclusivo com --clear-dns-servers.
--clear-dns-servers	Bandeira	Remova todos os servidores DNS.
--apipa-address <ip>	IPv4, repetível, máx. 2	Substitua a lista de endereços APIPA. mutuamente exclusivo com --clear-apipa-addresses.
--clear-apipa-addresses	Bandeira	Remova todos os endereços APIPA para BGP.
--trusted-cert <cert-name=base64>	repetível, máx. 10	Substitua a lista de certificados confiáveis. mutuamente exclusivo com --clear-trusted-certs.
--clear-trusted-certs	Bandeira	Remova todos os certificados confiáveis.
--tenant <name>	String	Tenant de destino.

Exemplos

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

Formato dos dados (--output json)

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

Data apenas retorna os campos que foram alterados.

reimplantação dos gateways de VPN das integrações de administrador do uip

Tente novamente a última tarefa em segundo plano em um gateway cuja tentativa de implantação anterior não foi concluída corretamente. Rejeitado se o gateway estiver congelado, tiver uma tarefa em andamento ou estiver em um estado não compatível.

Argumentos

Name	Required	Finalidade
<key>	sim	Chave de gateway da VPN (GUID).

Exemplo

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

Formato dos dados (--output json)

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

administrador uip integrações gateways vpn excluir

Exclua o gateway e toda a infraestrutura relacionada. Destrutivo e irreversível.

Argumentos

Name	Required	Finalidade
<key>	sim	Chave de gateway da VPN (GUID).

Opções

Long	Valor	Required	Description
--confirm	Bandeira	sim	Necessário — o comando recusa sem ele.
--tenant <name>	String	não	Tenant de destino.

Exemplo

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

Formato dos dados (--output json)

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

integrações de administrador do uip conexões vpn

Conexões site a site anexadas a um gateway VPN. Cada conexão emparelha uma rede local com o gateway.

integrações de administrador do uip conexões vpn obter

Argumentos

Name	Required	Finalidade
<key>	sim	Chave de conexão do gateway de VPN (GUID).

Exemplo

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

Formato dos dados (--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
  }
}

integrações de administrador do uip conexões vpn criar

Anexe uma nova conexão site a site a um gateway.

Argumentos

Name	Required	Finalidade
<gateway-key>	sim	Chave do gateway da VPN pai (GUID).

Opções

Long	Valor	Required	Description
--name <name>	String	sim	Nome da conexão.
--shared-key <key>	string, ≥ 128 caracteres ASCII imprimíveis, sem espaços/traços/tils	sim	Chave pré-compartilhada.
--target-ip <ip>	IPv4	sim	IP público do dispositivo VPN local.
--target-address-space <cidr>	CIDR, repetível	condicionalmente	Necessário (pelo menos um) quando --bgp-enabled não está definido. 0.0.0.0/0 foi rejeitada.
--bgp-enabled	Bandeira	não	Use o BGP para roteamento dinâmico.
--asn <num>	número inteiro positivo	condicionalmente	Necessário com --bgp-enabled. 65515 e 64512 estão reservados.
--bgp-peer-address <ip>	IPv4	condicionalmente	Necessário com --bgp-enabled. Deve ser o parceiro /30 local de um gateway --apipa-address.
--ipsec-sa-lifetime <seconds>	inteiro, mín. 300	não	Tempo de vida do IPsec SA. Tudo ou nada com os sete sinalizadores abaixo.
--ipsec-sa-data-size <kb>	inteiro, 0 ou 1024–2147483647	não	Tamanho dos dados do IPsec SA.
--ipsec-encryption <alg>	None|AES128|AES192|AES256|GCMAES128|GCMAES192|GCMAES256	não	Algoritmo de criptografia IPsec.
--ipsec-integrity <alg>	MD5|SHA1|SHA256|SHA384|GCMAES128|GCMAES256	não	Deve corresponder exatamente a um GCMAES --ipsec-encryption.
--ike-encryption <alg>	AES128|AES192|AES256|GCMAES128|GCMAES256	não	Algoritmo de criptografia IKE.
--ike-integrity <alg>	MD5|SHA1|SHA256|SHA384|GCMAES128|GCMAES256	não	Algoritmo de integridade IKE.
--dh-group <group>	None|DHGroup1|DHGroup2|DHGroup14|DHGroup24|DHGroup2048|ECP256|ECP384	não	Grupo Diffie-Hellman.
--pfs-group <group>	None|PFS1|PFS2|PFS14|PFS24|PFS2048|ECP256|ECP384|PFS	não	Grupo Salvo para encaminhamento.
--tenant <name>	String	não	Tenant de destino.

Exemplos

# 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

Formato dos dados (--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
  }
}

administradores uip integrações conexões vpn editar

Atualiza os campos migráveis de uma conexão. --shared-key e --confirm são necessários em cada chamada, independentemente do que mais mudar (consulte Conceitos).

Argumentos

Name	Required	Finalidade
<key>	sim	Chave de conexão do gateway de VPN (GUID).

Opções

Long	Valor	Required	Description
--shared-key <key>	String	sim	Forneça novamente a chave pré-compartilhada atual a cada edição.
--confirm	Bandeira	sim	Reconhecer a breve quebra de conectividade que a maioria das edições causa.
--name <name>	String	não	Renomeie a conexão.
--target-ip <ip>	IPv4	não	IP público do dispositivo VPN local.
--target-address-space <cidr>	repetível	não	Substitua a lista de CIDR no local. 0.0.0.0/0 rejeitado. Mutualmente exclusivo com --clear-target-address-spaces.
--clear-target-address-spaces	Bandeira	não	Remova todos os espaços de endereço de destino. Uma conexão não BGP sem nenhum está configurada incorretamente.
--bgp-enabled / --no-bgp-enabled	Bandeira	não	Habilite/desabilite o BGP. A habilitação em uma conexão anteriormente não BGP requer --asn e --bgp-peer-address juntos.
--asn <num>	Número inteiro	não	ASN do BGP.
--bgp-peer-address <ip>	IPv4	não	Endereço de pares do BGP.
--ipsec-sa-lifetime, --ipsec-sa-data-size, --ipsec-encryption, --ipsec-integrity, --ike-encryption, --ike-integrity, --dh-group, --pfs-group	Veja connections create	não	Aprovar todos os 8 para substituir a política do IPsec; omita todos os 8 para preservá-lo.
--clear-ipsec	Bandeira	não	Remova a política IPsec. mutuamente exclusivo com os oito sinalizadores IPsec/IKE.
--tenant <name>	String	não	Tenant de destino.

Exemplos

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

Formato dos dados (--output json)

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

atualização das conexões vpn das integrações do administrador do uip

Faça uma atualização em segundo plano do estado da conexão do Azure — as conexões também são atualizadas automaticamente em um trabalho periódico; use isso apenas quando você não quiser esperar pelo próximo ciclo. Rejeitado se outra operação estiver em andamento.

Argumentos

Name	Required	Finalidade
<key>	sim	Chave de conexão do gateway de VPN (GUID).

Exemplo

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

Formato dos dados (--output json)

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

administradores uip integrações conexões vpn excluir

Exclua a conexão. Destrutivo e irreversível — o par no local deve se reconectar a uma conexão recriada posteriormente.

Argumentos

Name	Required	Finalidade
<key>	sim	Chave de conexão do gateway de VPN (GUID).

Opções

Long	Valor	Required	Description
--confirm	Bandeira	sim	Necessário — o comando recusa sem ele.
--tenant <name>	String	não	Tenant de destino.

Exemplo

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

Formato dos dados (--output json)

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

Veja também

• Visão geral de uip admin
• Opções globais
• Códigos de saída