Peers

The peers for this VPN tunnel.

Peer

A WireGuard tunnel peer.

• Routes - Network routes to the peer over the tunnel.

Properties

Enable

Enable connection to this peer.

• Data type: boolean
• Default: true
• Configuration

CLI: (cli)> config vpn wireguard <key> peer <index> enable

Public key

The peer's public key.

• Data type: string
• Configuration
• Required

CLI: (cli)> config vpn wireguard <key> peer <index> public-key

Pre-shared key

The pre-shared key or secret required for this VPN connection.

• Data type: string
• Configuration
• Optional

CLI: (cli)> config vpn wireguard <key> peer <index> pre-shared-key

Address

The IP address or hostname of the peer for initiating an outgoing connections.

• Data type: string
• Configuration
• Required

CLI: (cli)> config vpn wireguard <key> peer <index> initiate-address

Port

The port number of the peer's WireGuard endpoint for initiating an outgoing connections.

• Data type: integer
• Default: 51820
• Minimum: 0
• Configuration
• Required

CLI: (cli)> config vpn wireguard <key> peer <index> initiate-port

Connected address

The remote IP address of the current connection to the peer.

• Data type: string
• Status

CLI: (cli)> show vpn wireguard <key> peer <index> connected-address

Connected port

The remote port number of current connection to the peer.

• Data type: integer
• Minimum: 0
• Status

CLI: (cli)> show vpn wireguard <key> peer <index> connected-port

Last handshake at

The handshake process occur every 2 minutes.

• Data type: integer
• Units: seconds since epoch
• Status

CLI: (cli)> show vpn wireguard <key> peer <index> handshake-timestamp

Persistent keepalive interval

Send a keepalive packet at a regular interval to keep the connection alive through stateful firewalls.

• Data type: integer
• Units: seconds
• Default: 25
• Minimum: 1
• Configuration
• Optional

CLI: (cli)> config vpn wireguard <key> peer <index> keepalive-interval