Skip to main content
Version: 7.25

wireguard


interface/wireguard​

Type: Directory

WireGuard creates encrypted IP tunnels between peers identified by public keys.

FlagNameDescription
XdisabledWhether an item is disabled.
RrunningWhether the interface is running.
ArgumentTypeDescription
namestringName of the tunnel.
mtunumLayer3 maximum transmission unit.
listen-portnumPort for the WireGuard service to listen on for incoming sessions.
private-keystringA base64 private key. If not specified, it is automatically generated upon interface creation. Each network interface has a private key and a list of peers.
vrfenumSpecifies which VRF the WireGuard UDP socket uses to determine how encrypted packets are sent or received.
Read-only ArgumentTypeDescription
public-keystringA base64 public key calculated from the private key. Public keys are used by peers to authenticate each other.