UTM/CLI/User

---

Benutzerverwaltung mit dem CLI-Befehl user

Letzte Anpassung: 09.2023

Neu:

• Korrektur Syntax user attribute otpsecret

notempty

Dieser Artikel bezieht sich auf eine Resellerpreview

v11

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: user set id "10" groups [ ] (Leerzeichen zwischen den Klammern beachten!)

Sollen mehrere Werte in einem Parameter übergeben werden, müssen diese in Anführungszeichen gesetzt werden und von eckigen Klammern mit einem Leerzeichen Abstand umschlossen werden.
Beispiel: user set id "10" groups [ "Gruppe1" "Gruppe2" "Gruppe3" ]

Befehl		Beschreibung	Beispiel
user user get user get		Zeigt alle oder einzelne Benutzer an Wert Beschreibung name Name des Benutzeraccounts id ID des Benutzeraccounts groups Gruppe des Benutzeraccounts permission Berechtigungen des Benutzeraccounts	Alle Benutzer anzeigen: user get
	name	' Name des Benutzeraccounts	Benutzer "benutzer1" anzeigen: user get name "benutzer1"
user new user new		Erstellt einen neuen Benutzer	user new name "benutzer2" password "insecure" groups "ssl-user"
	name	Name des Benutzeraccounts
	password	Passwort des Benutzeraccounts
	groups	Gruppe des Benutzeraccounts
user set user set		Ändert Benutzereinstellungen	user set id "183" groups vpn-benutzer
	id	ID des Benutzeraccounts
	name	' Name des Benutzeraccounts
	groups	Gruppe des Benutzeraccounts
user delete user delete		Löscht einen Benutzer. Ein Parameter hinreichend.	user delete id "193"
	id	ID des Benutzeraccounts
	name	Name des Benutzeraccounts
user check user check		Überprüft, ob ein Benutzer Mitglied einer bestimmten Gruppe ist	user check name "benutzer1" groups "vpn-user"
	name	Name des Benutzeraccounts
	groups	Gruppe des Benutzeraccounts
user checkotp user checkotp		Überprüfen des OTP Code aus dem Token	user checkotp name "user1" code "1234562"
	name	Name des Benutzeraccounts
	code	OTP-Code, der auf Gültigkeit überprüft werden soll
user who user who	–	Zeigt an, welcher Benutzer verbunden und eingeloggt ist	user who
user attribute user attribute get user attribute get		Zeigt die Attribute eines oder aller Benutzer an Wert Beschreibung name Name des Benutzeraccounts attribute Zugewiesene Attribute des Benutzeraccounts value Wert des Attributs	user attribute get
	name	' Name des Benutzeraccounts	user attribute get name "benutzer1"
user attribute set user attribute set		Ändert die Attribute des Benutzers	user attribute set name "admin" attribute "password_change" value "1"
	user	Name des Benutzeraccounts
	attribute	Zugewiesene Attribute des Benutzeraccounts mailfilter_download_attachments_filtered mailfilter_email_addresses openvpn_certificate openvpn_client_download openvpn_gateway openvpn_name openvpn_redirectgateway password_change password_chars_case password_chars_numbers password_chars_special password_length vpn_l2tp_ip vpn_openvpn_ip vpn_pptp_ip wake_on_lan_hosts
	value	Wert des Attributs
user attribute otpsecret user attribute otpsecret		Generiert einen neuen OTP shared secret code	user attribute otpsecret name "user1" notempty Known Issue: : spcli user attribute otpsecret name "user1"
	user	Name des Benutzeraccounts
user captiveportal user captiveportal get user captiveportal get	–	Auflistung aller Captive Portal Benutzeraccounts	user captiveportal get
user captiveportal new user captiveportal new		Erstellt einen Captive Portal Benutzeraccounts	user captiveportal new name "CP-User" password "InSecure" expirydate "24:00"
	name	Name des Captive Portal Benutzeraccounts
	password	Passwort des Captive Portal Benutzeraccounts
	expirydate	Datum des Ablaufs
user captiveportal set user captiveportal set		Änderung des Passwortes oder des Ablaufdatums des Captive Portal Benutzeraccounts	Änderung Passwort: user captiveportal set name "CP-User" password "CP-InSecure" Änderung Ablaufdatum: user captiveportal set name "CP-User" expirydate "12:00"
	name	Name des Captive Portal Benutzeraccounts
	password	Passwort des Captive Portal Benutzeraccounts
	expirydate	Datum des Ablaufs
user captiveportal delete user captiveportal delete		Löscht einen Captive Portal Benutzeraccount	user captiveportal delete name "CP-User"
	name	Name des Captive Portal Benutzeraccounts
user group user group get user group get	–	Zeigt die Gruppen an Wert Beschreibung id ID der Gruppe name Name der Gruppe directory_name Name des Verzeichnis Dienstes der Gruppe permission Berechtigung der Gruppe ibf_flags IBF Beschränkungen der Gruppe	user group get
user group new user group new		Erstellt eine neue Gruppe	user group new name "proxy-user" permission "HTTP_PROXY"
	name	Name der Gruppe
	permission	Berechtigung der Gruppe MAILDIGESTS ADMIN VPN_PPTP VPN_L2TP MAILFILTER_ADMIN HTTP_PROXY WEB_USER VPN_OPENVPN MAIL_RELAY IPSEC_XAUTH VPN_CLIENTLESS
user group set user group set		Ändert die Einstellungen einer Gruppe	user group set id "194" permission [ WEB_USER VPN_CLIENTLESS ]
	id	ID der Gruppe
	name	' Name der Gruppe
	permission	Berechtigung der Gruppe MAILDIGESTS ADMIN VPN_PPTP VPN_L2TP MAILFILTER_ADMIN HTTP_PROXY WEB_USER VPN_OPENVPN MAIL_RELAY IPSEC_XAUTH VPN_CLIENTLESS
user group delete user group delete		Löscht eine Gruppe. Ein Parameter hinreichend.	user group delete id "194"
	id	ID der Gruppe
	name	Name der Gruppe
user group attribute get user group attribute get		Zeigt die Attribute der Gruppen Wert Beschreibung name Name der Gruppe attribute Zugewiesene Attribute der Gruppe value Wert des Attributs	user group attribute get
user group attribute set user group attribute set		Fügt Attribute einer Gruppe hinzu	user group attribute set name "Userinterface" attribute "openvpn_client_download" value "0"
	name	Name der Gruppe
	attribute	Zugewiesene Attribute der Gruppe
	value	Wert des Attributs
user group attribute delete user group attribute delete		Löscht ein Attribut einer Gruppe	user group attribute delete name "Userinterface" attribute "openvpn_client_download"
	name	Name der Gruppe
	attribute	Zugewiesene Attribute der Gruppe mailfilter_download_attachments_filtered mailfilter_email_addresses openvpn_certificate openvpn_gateway openvpn_name openvpn_redirectgateway wake_on_lan_hosts
user support new user support new		Erstellt einen Support-Benutzer	user support new name "Support" password "InSecure" groups "User" expirydate "24:00"
	name	Name des Benutzeraccounts
	password	Passwort des Benutzeraccounts
	groups	Gruppe des Benutzeraccounts
	expirydate	Datum des Ablaufs
	flags	' Beschränkungen des Benutzeraccounts