---
id: "ibm-vpn-server"
type: "component"
kind: "vpn-gateway"
provider: "ibm"
category: "edge"
docs: "https://cloud.ibm.com/docs/vpc?topic=vpc-vpn-client-to-site-overview"
url: "https://localhost:3000/catalogue/components/ibm-vpn-server"
---

# Client VPN for VPC

OpenVPN-compatible VPN server that remote clients dial into, authenticating by certificate, user ID or both.

| | |
|---|---|
| Provider | [ibm](https://localhost:3000/catalogue?provider=ibm) |
| Kind | [VPN gateway](https://localhost:3000/catalogue/kinds/vpn-gateway) |
| Category | Edge |
| Official docs | [https://cloud.ibm.com/docs/vpc?topic=vpc-vpn-client-to-site-overview](https://cloud.ibm.com/docs/vpc?topic=vpc-vpn-client-to-site-overview) |

## Properties

| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| `activeActive` | boolean | — | no | false | inherited |
| `bgp` | boolean | — | no | false | inherited |
| `clientAuthentication` | enum | `certificate`, `username`, `certificate-and-username` | no | — | inherited |
| `highAvailability` | boolean | — | no | false | inherited |
| `managed` | boolean | — | no | false | **true** |
| `peerType` | enum | `site-to-site`, `point-to-site`, `cloud-to-cloud` | no | — | **"point-to-site"** |
| `throughputMbps` | integer | — | no | — | inherited |
| `tunnelType` | enum | `ipsec`, `ssl`, `wireguard` | no | — | **"ssl"** |

Bold values are the ones this component pins.

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 18

- [VPN Gateway](https://localhost:3000/catalogue/components/alibaba-vpn-gateway.md) `alibaba-vpn-gateway` — alibabacloud
- [AWS Client VPN](https://localhost:3000/catalogue/components/aws-client-vpn.md) `aws-client-vpn` — aws
- [AWS Site-to-Site VPN](https://localhost:3000/catalogue/components/aws-site-to-site-vpn.md) `aws-site-to-site-vpn` — aws
- [Azure VPN Gateway](https://localhost:3000/catalogue/components/azure-vpn-gateway.md) `azure-vpn-gateway` — azure
- [NetBird](https://localhost:3000/catalogue/components/netbird.md) `netbird` — default
- [OpenVPN](https://localhost:3000/catalogue/components/openvpn.md) `openvpn` — default
- [strongSwan](https://localhost:3000/catalogue/components/strongswan.md) `strongswan` — default
- [Submariner](https://localhost:3000/catalogue/components/submariner.md) `submariner` — default
- [Tailscale](https://localhost:3000/catalogue/components/tailscale.md) `tailscale` — default
- [Generic VPN gateway](https://localhost:3000/catalogue/components/vpn-gateway.md) `vpn-gateway` — default
- [WireGuard](https://localhost:3000/catalogue/components/wireguard.md) `wireguard` — default
- [ZeroTier](https://localhost:3000/catalogue/components/zerotier.md) `zerotier` — default
- [Cloud VPN](https://localhost:3000/catalogue/components/google-cloud-vpn.md) `google-cloud-vpn` — gcp
- [IBM Cloud VPN for VPC](https://localhost:3000/catalogue/components/ibm-vpn-gateway.md) `ibm-vpn-gateway` — ibm
- [Site-to-Site VPN](https://localhost:3000/catalogue/components/oci-site-to-site-vpn.md) `oci-site-to-site-vpn` — oci
- [Neutron VPNaaS](https://localhost:3000/catalogue/components/openstack-neutron-vpnaas.md) `openstack-neutron-vpnaas` — openstack
- [Client Gateway](https://localhost:3000/catalogue/components/outscale-client-gateway.md) `outscale-client-gateway` — outscale
- [Virtual Gateway](https://localhost:3000/catalogue/components/outscale-virtual-gateway.md) `outscale-virtual-gateway` — outscale

## Use it in a design

```yaml
nodes:
  - { id: "ibm-vpn-server", component: "ibm-vpn-server" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# Client VPN for VPC: an OpenVPN-compatible VPN server inside a VPC that remote clients dial
# into, authenticating with certificates, with IAM user IDs, or both ("Client-to-site VPN server
# overview"). Site-to-site tunnels are VPN for VPC instead (ibm-vpn-gateway).
schemaVersion: "1"
type: "component"
id: "ibm-vpn-server"
kind: "vpn-gateway"
provider: "ibm"
docs: "https://cloud.ibm.com/docs/vpc?topic=vpc-vpn-client-to-site-overview"
defaults:
  managed: true
  peerType: "point-to-site"
  tunnelType: "ssl"
properties:
  clientAuthentication:
    type: "enum"
    values: ["certificate", "username", "certificate-and-username"]
  highAvailability:
    type: "boolean"
    default: false
```

Human page: https://localhost:3000/catalogue/components/ibm-vpn-server