---
id: "vpn-gateway"
type: "kind"
category: "edge"
url: "https://localhost:3000/catalogue/kinds/vpn-gateway"
---

# VPN gateway

An encrypted tunnel endpoint joining a network to a remote peer.

| | |
|---|---|
| Category | Edge |
| Properties | 6 |
| Components | 19 |
| Rules | 0 |

## Properties

| property | type | values | required | default |
|---|---|---|---|---|
| `activeActive` | boolean | — | no | false |
| `bgp` | boolean | — | no | false |
| `managed` | boolean | — | no | false |
| `peerType` | enum | `site-to-site`, `point-to-site`, `cloud-to-cloud` | no | — |
| `throughputMbps` | integer | — | no | — |
| `tunnelType` | enum | `ipsec`, `ssl`, `wireguard` | no | — |

## Rules for this kind · 0

No rule selects this kind or its category.

## Components · 19

### vendor-neutral

- [Generic VPN gateway](https://localhost:3000/catalogue/components/vpn-gateway.md) `vpn-gateway` — the kind itself

### alibabacloud

- [VPN Gateway](https://localhost:3000/catalogue/components/alibaba-vpn-gateway.md) `alibaba-vpn-gateway` — 1 defaults

### aws

- [AWS Client VPN](https://localhost:3000/catalogue/components/aws-client-vpn.md) `aws-client-vpn` — 3 defaults
- [AWS Site-to-Site VPN](https://localhost:3000/catalogue/components/aws-site-to-site-vpn.md) `aws-site-to-site-vpn` — 4 defaults

### azure

- [Azure VPN Gateway](https://localhost:3000/catalogue/components/azure-vpn-gateway.md) `azure-vpn-gateway` — 4 defaults

### default

- [NetBird](https://localhost:3000/catalogue/components/netbird.md) `netbird` — 5 defaults
- [OpenVPN](https://localhost:3000/catalogue/components/openvpn.md) `openvpn` — 5 defaults
- [strongSwan](https://localhost:3000/catalogue/components/strongswan.md) `strongswan` — 5 defaults
- [Submariner](https://localhost:3000/catalogue/components/submariner.md) `submariner` — 5 defaults
- [Tailscale](https://localhost:3000/catalogue/components/tailscale.md) `tailscale` — 5 defaults
- [WireGuard](https://localhost:3000/catalogue/components/wireguard.md) `wireguard` — 5 defaults
- [ZeroTier](https://localhost:3000/catalogue/components/zerotier.md) `zerotier` — 4 defaults

### gcp

- [Cloud VPN](https://localhost:3000/catalogue/components/google-cloud-vpn.md) `google-cloud-vpn` — 5 defaults

### ibm

- [IBM Cloud VPN for VPC](https://localhost:3000/catalogue/components/ibm-vpn-gateway.md) `ibm-vpn-gateway` — 3 defaults
- [Client VPN for VPC](https://localhost:3000/catalogue/components/ibm-vpn-server.md) `ibm-vpn-server` — 3 defaults

### oci

- [Site-to-Site VPN](https://localhost:3000/catalogue/components/oci-site-to-site-vpn.md) `oci-site-to-site-vpn` — 5 defaults

### openstack

- [Neutron VPNaaS](https://localhost:3000/catalogue/components/openstack-neutron-vpnaas.md) `openstack-neutron-vpnaas` — 3 defaults

### outscale

- [Client Gateway](https://localhost:3000/catalogue/components/outscale-client-gateway.md) `outscale-client-gateway` — 3 defaults
- [Virtual Gateway](https://localhost:3000/catalogue/components/outscale-virtual-gateway.md) `outscale-virtual-gateway` — 4 defaults

## Source (`kind` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../schema/kind.schema.json
# A terminating gateway with a tunnel type and a peer, not the connectivity plane network-fabric describes. throughputMbps and bgp stay open so capacity and routing rules can test for absence.
schemaVersion: "1"
type: "kind"
id: "vpn-gateway"
category: "edge"
properties:
  peerType:
    type: "enum"
    values: ["site-to-site", "point-to-site", "cloud-to-cloud"]
  tunnelType:
    type: "enum"
    values: ["ipsec", "ssl", "wireguard"]
  bgp:
    type: "boolean"
    default: false
  activeActive:
    type: "boolean"
    default: false
  throughputMbps:
    type: "integer"
  managed:
    type: "boolean"
    default: false
```

Human page: https://localhost:3000/catalogue/kinds/vpn-gateway