UTM/EXTRAS/CLI: Unterschied zwischen den Versionen

← Zum vorherigen Versionsunterschied

Aktuelle Version vom 29. September 2025, 10:45 Uhr

Mögliche Befehle im "Command Line Interface" der Securepoint UTM

Letzte Anpassung zur Version: 14.1.0 (08.2025)

Neu:

Kopieren im CLI des Webinterfaces per Kontextmenü (Rechtsklick)

Die History des CLI per SSH ist jetzt persistent

notempty

Dieser Artikel bezieht sich auf eine Beta-Version

14.0 12.7 06.2023

Einleitung

Das Command Line Interface oder kurz CLI ist die eigentliche Schnittstelle, mit der man die UTM konfiguriert.
Die grafischen Administrationstools (Webinterface, Security Operation Center oder der Security Manager) wandeln alle Einstellungen zu Befehlen um, die auf dem CLI ausgeführt werden können.
Zwischen den einzelnen Versionen gibt es Unterschiede im Aufbau und Umfang der Befehle.

Dieser Artikel gibt eine Übersicht über die möglichen Befehle. In einigen Beispielen wird zudem die Arbeitsweise mit dem CLI gezeigt.

CLI im Webinterface

Das CLI im Webinterface findet man unter Extras CLI .
Oben rechts ist eine Dropdown-Schaltfläche, mit der man die Orientierung des CLI-Fensters auf Oben, Unten, Rechts, Links oder auch Vollbild ändern kann.

Gleichzeitig wird bei jeder dieser Einstellungen die Höhe bzw. Breite des Fensters standardmäßig auf 50% eingestellt. Das kann man aber auch mithilfe der Maus an der Kante des Fensters individuell anpassen.

notempty
Neu ab v14.1.0:
Mithilfe des Kontextmenüs (Aufruf per Rechtsklick) kann direkt aus dem Terminal kopiert werden.
Es gibt die Optionen
- Anfrage kopieren
- Anfrage und Antwort kopieren und
- Alles kopieren.

CLI per SSH

Das CLI per SSH ruft man auf, indem man zunächst eine SSH-Verbindung für den root- oder admin-Benutzer aufbaut.
Beispiel: ssh admin@<IP-Adresse>

notempty

Neu ab v14.0.1

Wenn man das CLI via SSH nutzt, wird die Historie persistent gespeichert. Somit sind jetzt auch nach einem Reboot die eingegeben Befehle noch verfügbar.
Mit der Pfeiltaste hoch ↑ bewegt man sich in der Historie rückwärts und mit der Pfeiltaste runter ↓ vorwärts.

Zu beachten: Bei einer Anmeldung als admin öffnet sich direkt das CLI, wohingegen root-Nutzer es mit der Eingabe spcli explizit starten müssen.

Befehle

Die Befehle auf dem CLI sind in diverse Themenbereiche gegliedert. So befinden sich z. B. alle für Interface-Konfigurationen relevanten Befehle unterhalb von interface.

Der Befehl interface address get zeigt z. B. alle vorhandenen IP-Adressen an. Nachfolgend findet sich eine Auflistung aller Befehle auf der ersten Ebene.

notempty

Bei der Übergabe mehrerer Parameter ist zu beachten, dass diese in eckige Klammern gesetzt und mit einem Leerzeichen voneinander getrennt werden.

Beispiel:

user group new name gruppenname permission [ perm1 perm2 ...]

Befehl	Beschreibung
alertingcenter	Management des Alertingcenters
appmgmt	Management der Anwendungen (starten/stoppen)
captiveportal	Einstellungen des Captive Portal
cert	Zertifikatsverwaltung
clear	Löscht den aktuellen Inhalt des Terminals
cli	Einstellungen zum Ausgabeverhalten des CLI
clientlessvpn	Einstellungen für das ClientlessVPN
cluster	Einstellungen über den Cluster
debug	Debug-Routinen
dhcp	Einstellungen für den DHCP-Server
dns	Einstellungen für den DNS-Server
exit	Beendet die aktuelle CLI-Sitzung
extc	Verwaltung von Variablen sowie Templates für Anwendungen
geolocation	Auflistung von Geolocation
help	Auflistung aller Befehle
interface	Einstellungen bezüglich der Interfaces
ipsec	Einstellungen für IPSec-Verbindungen
logout	Benutzer wird nach Beendigung der CLI-Session abgemeldet
mail	Einstellungen für den Mailfilter/das Mailarchiv
manager	Freigabe der Administration
node	Konfiguration von Netzwerkobjekten und -Gruppen
object	Auflistung aller Objekte
openvpn	Konfiguration von OpenVPN-Verbindungen
pkey	Einstellungen der öffentlichen Schlüssel
qos	Einstellungen für QoS Profile
quit	Beendet die aktuelle CLI-Sitzung
route	Verwaltung von Netzwerk-Routen
rproxy	Konfiguration des Reverse-Proxy
rsa	Verwaltung der RSA-Keys
rule	Verwaltung des Portfilters (Regelwerk)
server	Verwaltung der Backend-Server für den Reverse-Proxy
service	Verwaltung der Dienste (Regelwerk)
spf2bd	Verwaltung des FailToBan Dienstes
ssh	Erstellen und verwalten der SSH-Schlüssel für das Cluster
syslog	Verwaltung der Syslog-Servers sowie Ausgabe des Livelogs
system	System-spezifische Konfigurationspunkte
usc_vhost	Management der Unified Security Console (USC)
user	Benutzerverwaltung
view	Verschiedene Anzeigeinformationen
webfilter	Konfiguration des Webfilters
wireguard	Konfiguration von WireGuard
wlan	Verwaltung der WLAN-Funktionalität

@@ Zeile 1: / Zeile 1: @@
-Das Command Line Interface oder kurz CLI ist die eigentliche Schnittstelle, über die die Konfiguration der Securepoint UTM erfolgt. Alle graphischen Administrationstools wie das Webinterface, das Security Operation Center oder der Security Manager wandeln alle Ihre Einstellungen zu Befehlen um, die auf dem CLI ausgeführt werden können. Zwischen den einzelnen Versionen gibt es natürlich Unterschiede im Aufbau und Umfang der Befehle. <br>
+{{Set_lang}}
-Dieser Artikel soll Ihnen eine Übersicht über die möglichen Befehle geben und in einigen Beispielen die Arbeitsweise mit dem CLI darstellen.
+{{#vardefine:headerIcon|spicon-utm}}
+{{:UTM/EXTRAS/CLI.lang}}
-__TOC__
+{{var   | neu--CLI-Historie
-[[kategorie:UTMv11]]
+        | Die History des [[#CLI_per_SSH|CLI per SSH]] ist jetzt persistent
-=v11=
+        |  The history of the [[#CLI_via_SSH|CLI via SSH]] is now persistent }}
-Die Befehle auf dem CLI lassen sich in verschiedene Ebenen aufteilen. In der v11 wurden diese Ebenen in thematische Punkte gegliedert. So befinden sich z.B. alle für Interface-Konfigurationen relevanten Befehle unter halb von "interface" wie z.B. der Befehl "interface address get" (zeigt alle vorhandenen IP-Adressen an). Nachfolgend finde Sie eine Auflistung aller Befehle auf der ersten Ebene.<br>
-{| border="0" {{prettytable}}
+{{var	| neu--Kopieren per Kontextmenü
+		| Kopieren im [[#CLI im Webinterface|CLI des Webinterfaces]] per Kontextmenü (Rechtsklick)
+		| Copy in [[#CLI_on_the_interface | CLI of the web interface]] via context menu (right-click) }}
+</div>{{TOC2}}{{Select_lang}}
+{{Header|14.1.0|
+* {{#var:neu--Kopieren per Kontextmenü}}
+|vorher-ver=14.0.1
+|vorher=
+* {{#var:neu--CLI-Historie}}
+|[[UTM/EXTRAS/CLI_v14.0 | 14.0]]
+[[UTM/EXTRAS/CLI_v12.7 | 12.7]]
+[[UTM/EXTRAS/CLI_06.2023| 06.2023]]
+|{{Menu-UTM|Extras|CLI}}
+}}
+----
+=== {{#var:Einleitung}} ===
+<div class="Einrücken">
+{{#var:Einleitung--desc}}
+</div>
+----
+=== {{#var:CLI im Webinterface}} ===
+<div class="einrücken">
+{{Bild|{{#var:CLI im Webinterface--Bild}}|{{#var:CLI im Webinterface--cap}}|class=Bild-t}}
+{{#var:CLI im Webinterface--desc}}<br>
+<br clear=all></div>
+----
+=== {{#var:CLI per SSH}} ===
+<div class="einrücken">
+{{#var:CLI per SSH--desc}}
+<br>
+{{Hinweis-box|{{#var:neu ab}} v14.0.1|gr|14.0.2|status=neu}} {{#var:CLI via SSH Historie Speicherung}}
+{{#var:CLI per SSH Fortsetzung}}
+</div>
+----
+=== {{#var:Befehle}} ===
+<div class="Einrücken">
+{{#var:Befehle--desc}}
+{{#var:Befehl--Bsp}}
+<br><br>
+</div>
+{| class="sptable2 pd5 zh1 striped Einrücken"
 |-
-! Befehl !! Beschreibung
+! {{#var:Befehl}} !! {{#var:desc}}
 |-
-| [[appmgmt_cli_v11| appmgmt]] || Management der Anwendungen (starten/stoppen)
+| <span id=Alertingcenter></span>[[UTM/CLI/Alertingcenter| alertingcenter ]] || {{#var:alertingcenter--desc}}
 |-
-| [[cert_cli_v11| cert ]] || Zertifikatsverwaltung
+| [[UTM/CLI/Appmgmt| appmgmt]] || {{#var:appmgmt--desc}}
 |-
-| clear || löscht den aktuellen Inhalt des Terminals
+| [[UTM/CLI/Captiveportal| captiveportal ]] || {{#var:captiveportal--desc}}
 |-
-| cli || Einstellungen zum Ausgabeverhalten des CLI
+| [[CLI/Cert| cert]] || {{#var:cert--desc}}
 |-
-| [[clientlessvpn_cli_v11| clientlessvpn ]] || Einstellungen für das Clientlessvpn
+| clear || {{#var:clear--desc}}
 |-
-| [[dhcp_cli_v11| dhcp ]] || Einstellungen für den DHCP-Server
+| cli || {{#var:cli--desc}}
 |-
-| [[dns_cli_v11| dns ]] || Einstellungen für den DNS-Server
+| [[UTM/CLI/Clientlessvpn| clientlessvpn]] || {{#var:clientlessvpn--desc}}
 |-
-| [[extc_cli_v11| extc ]] || Verwaltung von Variablen sowie Templates für Anwendungen
+| [[UTM/CLI/Cluster| cluster]] || {{#var:cluster--desc}}
 |-
-| help || Auflistung aller Befehle
+| [[UTM/CLI/Debug | debug]] || {{#var:debug--desc}}
 |-
-| [[interface_cli_v11| interface ]] || Einstellungen bezüglich der Interfaces
+| [[UTM/CLI/DHCP| dhcp]] || {{#var:dhcp--desc}}
 |-
-| [[ipsec_cli_v11| ipsec ]] || Einstellungen für IPSec-Verbindungen
+| [[UTM/CLI/DNS| dns]] || {{#var:dns--desc}}
 |-
-| [[ldap_cli_v11| ldap ]] || Senden vom LDAP-Anfragen
+| exit || {{#var:exit--desc}}
 |-
-| [[mail_cli_v11| mail ]] || Einstellungen für den Mailfilter/Mailarchive
+| [[UTM/CLI/Extc| extc]] || {{#var:extc--desc}}
 |-
-| [[node_cli_v11| node ]] || Konfiguration von Netzwerk-Objekten und -Gruppen
+| [[UTM/CLI/Geolocation| geolocation]] || {{#var:geolocation--desc}}
 |-
-| [[object_cli_v11| object ]] || Auflistung aller Objekte
+| help || {{#var:help--desc}}
 |-
-| [[openvpn_cli_v11| openvpn ]] || Konfiguration von OpenVPN-Verbindungen
+| [[UTM/CLI/Interface| interface ]] || {{#var:interface--desc}}
 |-
-| [[qos_cli_v11| qos ]] || Einstellungen für QoS Profile
+| [[UTM/CLI/Ipsec| ipsec ]] || {{#var:ipsec--desc}}
+<!--
 |-
-| quit  || Beendet die aktuelle CLI-Sitzung
+| [[ldap_cli_v11| ldap]] || {{#var:ldap--desc}}
+-->
 |-
-| [[route_cli_v11| route ]] || Verwaltung von Netzwerk-Routen
+| logout || {{#var:logout--desc}}
 |-
-| [[rproxy_cli_v11| rproxy ]] || Konfiguration des Reverse-Proxy
+| [[UTM/CLI/Mail| mail]] || {{#var:mail--desc}}
 |-
-| [[rsa_cli_v11| rsa ]] || Verwaltung der RSA-Keys
+| [[UTM/CLI/Manager| manager]] || {{#var:manager--desc}}
 |-
-| [[rule_cli_v11| rule ]] || Verwaltung des Portfilters (Regelwerk)
+| [[node_cli_v11| node]] || {{#var:node--desc}}
 |-
-| [[server_cli_v11| server ]] || Verwaltung der Backend-Server für den Reverse-Proxy
+| [[object_cli_v11| object]] || {{#var:object--desc}}
 |-
-| [[service_cli_v11| service ]] || Verwaltung der Dienste (Regelwerk)
+| [[UTM/CLI/Openvpn| openvpn]] || {{#var:openvpn--desc}}
 |-
-| [[syslog_cli_v11| syslog ]] || Verwaltung der Syslog-Server sowie Ausgabe des Livelogs
+| [[UTM/CLI/Pkey| pkey]] || {{#var:pkey--desc}}
 |-
-| [[system_cli_v11| system ]] || System-spezifische Konfigurationspunkte
+| [[qos_cli_v11| qos]] || {{#var:qos--desc}}
 |-
-| [[user_cli_v11| user ]] || Benutzerverwaltung
+| quit || {{#var:quit--desc}}
 |-
-| [[webfilter_cli_v11| webfilter ]] || Konfiguration des Webfilters
+| [[route_cli_v11| route]] || {{#var:route--desc}}
 |-
-| [[wlan_cli_v11| wlan ]] || Verwaltung der WLAN-Funktionalität
+| [[rproxy_cli_v11| rproxy]] || {{#var:rproxy--desc}}
 |-
-| wrapper || Internes Kommando
+| [[rsa_cli_v11| rsa]] || {{#var:rsa--desc}}
-|}
-=2007nx / v10=
-Anders als in der v11 sind die Befehle in der 2007nx/v10 nicht thematisch gegliedert, sondern funktionell . <br>
-{| border="0" {{prettytable}}
 |-
-! Befehl !! Beschreibung
+| [[rule_cli_v11| rule]] || {{#var:rule--desc}}
 |-
-| add || Fügt Konfigurationseinstellungen hinzu
+| [[server_cli_v11| server]] || {{#var:server--desc}}
 |-
-| change || Ändert Konfigurationseinstellungen
+| [[service_cli_v11| service]] || {{#var:service--desc}}
 |-
-| clear || löscht den aktuellen Inhalt des Terminals
+| [[UTM/CLI/spf2bd | spf2bd]] || {{#var:spf2bd--desc}}
 |-
-| config || Konfigurationsverwaltung
+| [[SSH_cli_V11.6| ssh]] || {{#var:ssh--desc}}
 |-
-| debug || Debug-Routinen
+| [[syslog_cli_v11| syslog]] || {{#var:syslog--desc}}
 |-
-| delete || Entfernen von Konfigurationseinstellungen
+| [[UTM/CLI/System| system]] || {{#var:system--desc}}
 |-
-| export || Export-Funktionen
+<!--
+| [[UTM/CLI/Transaction| transaction]] ||
 |-
-| import || Import-Funktionen
+-->
+| [[UTM/CLI/Usc_vhost| usc_vhost]] || {{#var:usc_vhost--desc}}
 |-
-| load || Laden von Einstellungen
+| [[UTM/CLI/User| user]] || {{#var:user--desc}}
 |-
-| logout || Beendet die aktuelle CLI-Sitzung
+| [[UTM/EXTRAS/CLI/view| view]] || {{#var:view--desc}}
 |-
-| reboot || Startet die Appliance neu
+| [[webfilter_cli_v11| webfilter]] || {{#var:webfilter--desc}}
 |-
-| register || Liest das Lizenzfile ein
+| [[UTM/CLI/Wireguard| wireguard]] || {{#var:wireguard--desc}}
 |-
-| restart || Neustart von Anwendungen
+| [[UTM/CLI/Wlan| wlan]] || {{#var:wlan--desc}}
-|-
+<!--|-
-| run|| Ausführen von bestimmten Befehlen (z.B. ping)
+| wrapper || {{#var:wrapper--desc}}-->
-|-
-| show || Ausgabe von Konfigurationseinstellungen
-|-
-| start || Starten von Anwendungen
-|-
-| stop || Stoppen von Anwendungen
-|-
-| update || Befehle für die Aktualisierung
-|-
-| help || Anzeige von allen Kommandos
 |}