...
| Property | Description |
|---|---|
| allowed-address (IP/IPv6 prefix; Default: ) | List of IP (v4 or v6) addresses with CIDR masks from which incoming traffic for this peer is allowed and to which outgoing traffic for this peer is directed. This IP address has to be in the same subnet as WireGuard interface set on ROS. If WireGuard interface is at 192.168.99.1/24, You have to input 192.168.99.2 to the client. By adding this IP under 'Allowed Address', you are saying that only this specific client (phone for example) is permitted to connect to this peer configuration. Allowed-address range cannot overlap on one interface, so you need to set own range for each peer. |
| comment (string; Default: ) | Short description of the peer. |
| disabled (yes | no; Default: no) | Enables/disables the peer. |
| endpoint-address (IP/Hostname; Default: ) | The IP address or hostname. It is used by WireGuard to establish a secure connection between two peers. |
| endpoint-port (integer:0..65535; Default: ) | The Endpoint port is the UDP port on which a WireGuard peer listens for incoming traffic. |
| interface (string; Default: ) | Name of the WireGuard interface the peer belongs to. |
| persistent-keepalive (integer:0..65535; Default: 0) | A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from a peer, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. |
| preshared-key (string; Default: ) | A base64 preshared key. Optional, and may be omitted. This option adds an additional layer of symmetric-key cryptography to be mixed into the already existing public-key cryptography, for post-quantum resistance. Also can be generated automatically or entered manually, when the key is provided by the system administrator. |
| private-key (auto/none; Default: none) | Can be generated automatically or entered manually, when the key is provided by the system administrator. With version 7.14.1, the situation is no longer allowed that public key is not generated from the private one, if a private-key is specified, the public-key is generated from it. |
public-key (string; Default: ) | The remote peer's calculated public key. It will be generated if private-key is specified, do not enter manually starting from 7.14.1. |
show-client-config | Will show already created Peer configuration and generate a QR code for easier peer setup on a client device. Does not affect the WireGuard Server. |
Used for the client-server setup scenario, when the configuration is imported using a qr code for a client, configuration details on tab with qrcode will appear once it has been set in the fields: | |
client-address (IP/IPv6 prefix; Default: ) | When imported using a qr code for a client (for example, a phone), then this address for the wg interface is set on that device. |
client-dns (IP/IPv6 prefix; Default: ) | Specify when using WireGuard Server as a VPN gateway for peer traffic. |
client-endpoint (IP/IPv6 prefix; Default: ) | The IP address and port number of the WireGuard Server. |
client-keepalive (integer:0..65535; Default: 0) | Same as persistent-keepalive but from peer side. |
client-listen-port (integer:0..65535; Default: ) | The local port upon which this WireGuard tunnel will listen for incoming traffic from peers, and the port from which it will source outgoing packets. |
name (string; Default: ) | Allows adding name to a peer. Name will be used as a reference for a peer in WireGuard logs. (Available from RouterOS version 7.15) |
is-responder (yes | no; Default: no) | Specifies if peer is intended to be connection initiator or only responder. Should be used on WireGuard devices that are used as "servers" for other devices as clients to connect to. Otherwise router will all repeatedly try to connect "endpoint-address" or "current-endpoint-address" causing unnecessary system logs to be written. |
...