UTM/CLI/Wireguard

---

Syntax des CLI-Befehls wireguard

Letzte Anpassung: 07.2024

Neu im Wiki:

• wireguard export
• wireguard ping

notempty

Dieser Artikel bezieht sich auf eine Resellerpreview

Aufruf: UTM-IP:Port oder UTM-URL:Port
Port wie unter Netzwerk / Servereinstellungen / Webserver konfiguriert
Default-Port: 11115
z.B.: https://utm.ttt-point.de:11115
Default: https://192.168.175.1:11115 Extras CLI

---

Sollen keine Werte für einen Parameter übergeben werden, so wird dieser Parameter nicht mit angegeben. Soll ein Parameterwert mit <leer> überschrieben werden, müssen zwei eckige Klammern verwendet werden.
Beispiel: wireguard peer set peer_id "3" peer_psk [ ]

Befehl		Beschreibung	Beispiel
wireguard wireguard update wireguard update	–	Nach jedem Wireguard-CLI-Befehl muss dies eingegeben werden, damit diese Befehle abgespeichert werden	wireguard update
wireguard get wireguard get	–	Auflistung aller Wireguard-Verbindungen Wert Beschreibung interface_id ID des Wireguard-Interfaces interface_name Name des Wireguard-Interfaces interface_description Verbindungsname in der Übersicht interface_listen_port Port, auf dem die Wireguard-Verbindung entgegen genommen wird interface_fwmark wird zur Zeit nicht verwendet interface_keyobj_id ID des Schlüssels für die Wireguard-Verbindung interface_keyobj_name Name des Schlüssels für die Wireguard-Verbindung interface_public_key Wert des öffentlichen Schlüssels der Wireguard-Verbindung interface_address_list IP-Adressen die das Wireguard-Interface verwendet peer_id ID des Peers peer_name Name des Peers peer_psk Pre-Shared Key des Peers peer_endpoint Endpunkt des Peers peer_keepalive Zeit des Keepalive in Sekunden des Peers peer_public_keyobj_id ID des öffentlichen Schlüssels des Peers peer_public_keyobj_name Name des öffentlichen Schlüssels des Peers peer_public_key öffentlicher Schlüssel des Peers peer_address_list IP-Adressen die der Peer verwendet	wireguard get
wireguard interface wireguard interface get wireguard interface get	–	Auflistung aller Wireguard-Interfaces Wert Beschreibung interface_id ID des Wireguard-Interfaces interface_keyobj_id ID des Schlüssels für die Wireguard-Verbindung interface_listen_port Port, auf dem die Wireguard-Verbindung entgegen genommen wird interface_fwmark wird zur Zeit nicht verwendet interface_description Verbindungsname in der Übersicht interface_peer_id_list Liste der IDs der Peers des Interfaces	wireguard interface get
wireguard interface new wireguard interface new		Erstellt ein neues Wireguard-Interface. Zuvor muss ein neues Interface erstellt werden.	interface new name "wg0" type WIREGUARD
	interface_name	Name des Wireguard-Interfaces	wireguard interface new interface_name "wg0" interface_description "wg_server" interface_keyobj_id "689" interface_listen_port "51820"
	interface_description	Verbindungsname in der Übersicht
	interface_keyobj_id	ID des Schlüssels für die Wireguard-Verbindung
	interface_listen_port	Port, auf dem die Wireguard-Verbindung entgegen genommen wird
wireguard interface set wireguard interface set		Bearbeitung eines Wireguard-Interfaces	wireguard interface set interface_id "691" interface_listen_port "51820" interface_keyobj_id "689" interface_keyobj_name "Wireguard-Key"
	interface_id	ID des Wireguard-Interfaces
	interface_listen_port	Port, auf dem die Wireguard-Verbindung entgegen genommen wird
	interface_keyobj_id	ID des Schlüssels für die Wireguard-Verbindung
	interface_keyobj_name	Name des Schlüssels für die Wireguard-Verbindung
wireguard interface delete wireguard interface delete		Löscht das Wireguard-Interface	wireguard interface delete interface_id "691"
	interface_id	ID des Wireguard-Interfaces
wireguard peer wireguard peer get wireguard peer get	–	Auflistung aller Wireguard-Peers Wert Beschreibung peer_id ID des Peers peer_name Name des Peers peer_public_keyobj_id ID des öffentlichen Schlüssels des Peers peer_psk Pre-Shared Key des Peers peer_keepalive Zeit des Keepalive in Sekunden des Peers peer_address_id_list Liste der IDs der IP-Adressen zum Peer peer_interface_id_list Liste der IDs der Interfaces	wireguard peer get
wireguard peer new wireguard peer new		Erstellt ein neues Peer für den Wireguard	wireguard peer new peer_name "peer" peer_public_keyobj_id "690" peer_endpoint [ ] peer_keepalive "25" peer_address_list [ 192.168.10.1/24 ] peer_interface_name_list [ wg0 ] notempty Syntax korrigiert Die Parameter der Werte bei peer_address_list und peer_interface_name_list müssen mit Leerzeichen angegeben werden.
	peer_name	Name des Peers
	peer_public_keyobj_id	ID des öffentlichen Schlüssels des Peers
	peer_psk	Pre-Shared Key des Peers
	peer_endpoint	Endpunkt des Peers
	peer_keepalive	Zeit des Keepalive in Sekunden des Peers
	peer_address_list	IP-Adressen die der Peer verwendet
	peer_interface_name_list	Liste der Interfacenamen zum Peer
wireguard peer set wireguard peer set		Bearbeitung eines Wireguard-Peers	wireguard peer set peer_name "peer1" peer_public_keyobj_id "706" peer_endpoint [ ] peer_address_list ["192.168.11.1/24"] peer_keepalive "25" peer_interface_id_list ["710"] peer_id "5"
	peer_name	Name des Peers
	peer_public_keyobj_id	ID des öffentlichen Schlüssels des Peers
	peer_endpoint	Endpunkt des Peers
	peer_address_list	IP-Adressen die der Peer verwendet
	peer_psk	Pre-Shared Key des Peers
	peer_keepalive	Zeit des Keepalive in Sekunden des Peers
	peer_interface_id_list	Liste der IDs der Interfaces
	peer_id	ID des Peers
wireguard peer delete wireguard peer delete		Löscht einen Peer	wireguard peer delete peer_id "5"
	peer_id	ID des Peers
wireguard export wireguard export		Exportiert eine Wireguard Verbindung	wireguard export
wireguard ping wireguard ping		Pingt alle Peers einer Liste	wireguard ping peer_id_list "1"
	peer_id_list	Liste der zu pingenen Peers