UTM/EXTRAS/CLI: Unterschied zwischen den Versionen

← Zum vorherigen Versionsunterschied Zum nächsten Versionsunterschied →

Version vom 30. Juni 2023, 15:42 Uhr

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

Letzte Anpassung: 06.2023

Neu:

Befehl für das Alertingcenter
Layoutanpassungen

notempty

Dieser Artikel bezieht sich auf eine Beta-Version

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.

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
ldap	Senden vom LDAP-Anfragen
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 webuser
webfilter	Konfiguration des Webfilters
wireguard	Konfiguration von WireGuard
wlan	Verwaltung der WLAN-Funktionalität
wrapper

2007nx / v10

Befehl	Beschreibung
add	Fügt Konfigurationseinstellungen hinzu
change	Ändert Konfigurationseinstellungen
clear	Löscht den aktuellen Inhalt des Terminals
config	Konfigurationsverwaltung
debug	Debug-Routinen
delete	Entfernen von Konfigurationseinstellungen
export	Export-Funktionen
import	Import-Funktionen
load	Laden von Einstellungen
logout	Benutzer wird nach Beendigung der CLI-Session abgemeldet
reboot	Startet die Appliance neu
register	Liest das Lizenzfile ein
restart	Neustart von Anwendungen
run	Ausführen von bestimmten Befehlen (z. B. ping)
show	Ausgabe von Konfigurationseinstellungen
start	Starten von Anwendungen
stop	Stoppen von Anwendungen
update	Befehle für die Aktualisierung
help	Auflistung aller Befehle

@@ Zeile 1: / Zeile 1: @@
 {{Set_lang}}
 {{#vardefine:headerIcon|spicon-utm}}
+{{:UTM/EXTRAS/CLI.lang}}
+{{var	| neu--Verlinkung
+		| Befehl für das [[#Alertingcenter| Alertingcenter ]]
+		| Command for the [{{#var:host}}UTM/EXTRAS/CLI#Alertingcenter Alertingcenter] }}
+{{var	| neu--Layoutanpassungen
+		| Layoutanpassungen
+		| Layout adjustments }}
-</div>{{DISPLAYTITLE:Securepoint UTM CLI}}
+</div>{{TOC2}}{{Select_lang}}
-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>
+{{Header|06.2023|
+* {{#var:neu--Verlinkung}}
+* {{#var:neu--Layoutanpassungen}}
+||{{Menu|Extras|CLI}}
+}}
+----
-Dieser Artikel soll Ihnen eine Übersicht über die möglichen Befehle geben und in einigen Beispielen die Arbeitsweise mit dem CLI darstellen.
-__TOC__
+== {{#var:Einleitung}} ==
+<div class="Einrücken">
+{{#var:Einleitung--desc}}
+<br clear=all></div>
-=v11=
-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 unterhalb 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>
-'''Ab Version 11.6 ist bei der Übergabe mehrerer Parameter zu beachten, dass diese in Eckige Klammern gesetzt und mit einem Leerzeichen voneinander getrennt werden.'''<br>
+== {{#var:Befehle}} ==
-Beispiel:<br>
+<div class="Einrücken">
-{{code| user group new name ''gruppenname'' permission [ ''perm1 perm2 ...''] }}
+{{#var:Befehle--desc}}
+<br>
+<code>user group new name ''gruppenname'' permission [ ''perm1 perm2 ...'']</code>
+<br clear=all></div>
-{| border="0" {{prettytable}}
+{| class="sptable2 pd5 zh1 striped Einrücken"
+|-
+! {{#var:Befehl}} !! {{#var:Beschreibung}}
+|-
+| <span id=Alertingcenter></span> {{Hinweis-neu|{{#var:neu im Wiki}}|12.4|status=neu}}<br> [[UTM/CLI/Alertingcenter| alertingcenter ]]  || {{#var:alertingcenter--desc}}
+|-
+| [[UTM/CLI/Appmgmt| appmgmt]] || {{#var:appmgmt--desc}}
+|-
+| {{Hinweis-neu|{{#var:neu im Wiki}}|12.4|status=neu}}<br> [[UTM/CLI/Captiveportal| captiveportal ]] || {{#var:captiveportal--desc}}
+|-
+| {{Hinweis-neu|{{#var:Aktualisiert}}|12.4|status=update}}<br> [[CLI/Cert| cert ]] || {{#var:cert--desc}}
+|-
+| clear || {{#var:clear--desc}}
+|-
+| cli || {{#var:cli--desc}}
+|-
+| [[clientlessvpn_cli_v11| clientlessvpn ]] || {{#var:clientlessvpn--desc}}
 |-
-! Befehl !! Beschreibung
+| [[UTM/CLI/Cluster| cluster ]] || {{#var:cluster--desc}}
 |-
-| [[UTM/CLI/Appmgmt| appmgmt]] || Management der Anwendungen (starten/stoppen)
+| [[UTM/CLI/Debug | debug ]] || {{#var:debug--desc}}
 |-
-| [[CLI/Cert| cert ]] || Zertifikatsverwaltung
+| [[dhcp_cli_v11| dhcp ]] || {{#var:dhcp--desc}}
 |-
-| clear || löscht den aktuellen Inhalt des Terminals
+| [[dns_cli_v11| dns ]] || {{#var:dns--desc}}
 |-
-| cli || Einstellungen zum Ausgabeverhalten des CLI
+| exit || {{#var:exit--desc}}
 |-
-| [[clientlessvpn_cli_v11| clientlessvpn ]] || Einstellungen für das Clientlessvpn
+| [[extc_cli_v11| extc ]] || {{#var:extc--desc}}
 |-
-| cluster || ''cluster info'' gibt informationen über das Cluster aus
+| {{Hinweis-neu|{{#var:neu im Wiki}}|12.4|status=neu}}<br> [[UTM/CLI/Geolocation| geolocation ]] || {{#var:geolocation--desc}}
 |-
-| [[UTM/CLI/Debug | debug ]] || Verwalten der Kernel Module
+| help || {{#var:help--desc}}
 |-
-| [[dhcp_cli_v11| dhcp ]] || Einstellungen für den DHCP-Server
+| [[UTM/CLI/Interface| interface ]] || {{#var:interface--desc}}
 |-
-| [[dns_cli_v11| dns ]] || Einstellungen für den DNS-Server
+| [[UTM/CLI/Ipsec| ipsec ]] || {{#var:ipsec--desc}}
 |-
-| [[extc_cli_v11| extc ]] || Verwaltung von Variablen sowie Templates für Anwendungen
+| [[ldap_cli_v11| ldap ]] || {{#var:ldap--desc}}
 |-
-| help || Auflistung aller Befehle
+| logout || {{#var:logout--desc}}
 |-
-| [[UTM/CLI/Interface | interface ]] || Einstellungen bezüglich der Interfaces
+| [[mail_cli_v11| mail ]] || {{#var:mail--desc}}
 |-
-| [[ipsec_cli_v11| ipsec ]] || Einstellungen für IPSec-Verbindungen
+| [[manager_cli_v11| manager ]] || {{#var:manager--desc}}
 |-
-| [[ldap_cli_v11| ldap ]] || Senden vom LDAP-Anfragen
+| [[node_cli_v11| node ]] || {{#var:node--desc}}
 |-
-| [[mail_cli_v11| mail ]] || Einstellungen für den Mailfilter/Mailarchive
+| [[object_cli_v11| object ]] || {{#var:object--desc}}
 |-
-| [[manager_cli_v11| manager ]] || Freigabe der Administration
+| [[openvpn_cli_v11| openvpn ]] || {{#var:openvpn--desc}}
 |-
-| [[node_cli_v11| node ]] || Konfiguration von Netzwerk-Objekten und -Gruppen
+| {{Hinweis-neu|{{#var:neu im Wiki}}|12.4|status=neu}}<br> [[UTM/CLI/Pkey| pkey ]] || {{#var:pkey--desc}}
 |-
-| [[object_cli_v11| object ]] || Auflistung aller Objekte
+| [[qos_cli_v11| qos ]] ||  {{#var:qos--desc}}
 |-
-| [[openvpn_cli_v11| openvpn ]] || Konfiguration von OpenVPN-Verbindungen
+| quit  || {{#var:quit--desc}}
 |-
-| [[qos_cli_v11| qos ]] || Einstellungen für QoS Profile
+| [[route_cli_v11| route ]] || {{#var:route--desc}}
 |-
-| quit  || Beendet die aktuelle CLI-Sitzung
+| [[rproxy_cli_v11| rproxy ]] || {{#var:rproxy--desc}}
 |-
-| [[route_cli_v11| route ]] || Verwaltung von Netzwerk-Routen
+| [[rsa_cli_v11| rsa ]] || {{#var:rsa--desc}}
 |-
-| [[rproxy_cli_v11| rproxy ]] || Konfiguration des Reverse-Proxy
+| [[rule_cli_v11| rule ]] || {{#var:rule--desc}}
 |-
-| [[rsa_cli_v11| rsa ]] || Verwaltung der RSA-Keys
+| [[server_cli_v11| server ]] || {{#var:server--desc}}
 |-
-| [[rule_cli_v11| rule ]] || Verwaltung des Portfilters (Regelwerk)
+| [[service_cli_v11| service ]] || {{#var:service--desc}}
 |-
-| [[server_cli_v11| server ]] || Verwaltung der Backend-Server für den Reverse-Proxy
+| [[UTM/CLI/spf2bd | spf2bd ]] || {{#var:spf2bd--desc}}
 |-
-| [[service_cli_v11| service ]] || Verwaltung der Dienste (Regelwerk)
+| [[SSH_cli_V11.6| ssh ]] || {{#var:ssh--desc}}
 |-
-| [[UTM/CLI/spf2bd | spf2bd]] || Verwaltung des FailToBan Dienstes
+| [[syslog_cli_v11| syslog ]] || {{#var:syslog--desc}}
 |-
-| [[SSH_cli_V11.6| ssh]] || Erstellen und verwalten der SSH-Schlüssel für das Cluster
+| [[system_cli_v11| system ]] || {{#var:system--desc}}
 |-
-| [[syslog_cli_v11| syslog ]] || Verwaltung der Syslog-Server sowie Ausgabe des Livelogs
+<!--
+| [[UTM/CLI/Transaction| transaction ]] ||
 |-
-| [[system_cli_v11| system ]] || System-spezifische Konfigurationspunkte
+-->
+| {{Hinweis-neu|{{#var:neu im Wiki}}|12.4|status=neu}}<br> [[UTM/CLI/Usc_vhost| usc_vhost ]] || {{#var:usc_vhost--desc}}
 |-
-| [[user_cli_v11| user ]] || Benutzerverwaltung
+| {{Hinweis-neu|{{#var:neu im Wiki}}|12.4|status=neu}}<br> [[UTM/CLI/User| user ]] || {{#var:user--desc}}
 |-
-| [[webfilter_cli_v11| webfilter ]] || Konfiguration des Webfilters
+| view webuser || {{#var:view webuser--desc}}
 |-
-| [[wlan_cli_v11| wlan ]] || Verwaltung der WLAN-Funktionalität
+| [[webfilter_cli_v11| webfilter ]] || {{#var:webfilter--desc}}
 |-
-| wrapper || Internes Kommando
+| {{Hinweis-neu|{{#var:neu im Wiki}}|12.4|status=neu}}<br> [[UTM/CLI/Wireguard| wireguard ]] || {{#var:wireguard--desc}}
+|-
+| [[wlan_cli_v11| wlan ]] || {{#var:wlan--desc}}
+|-
+| wrapper || {{#var:wrapper--desc}}
 |}
-=2007nx / v10=
-Anders als in der v11 sind die Befehle in der 2007nx/v10 nicht thematisch gegliedert, sondern funktionell . <br>
-{| border="0" {{prettytable}}
+== 2007nx / v10 ==
+<div class="Einrücken">
+{{#var:2007--desc}}
+<br clear=all></div>
+{| class="sptable2 pd5 zh1 striped Einrücken"
 |-
-! Befehl !! Beschreibung
+! {{#var:Befehl}} !! {{#var:Beschreibung}}
 |-
-| add || Fügt Konfigurationseinstellungen hinzu
+| add || {{#var:add--desc}}
 |-
-| change || Ändert Konfigurationseinstellungen
+| change || {{#var:change--desc}}
 |-
-| clear || löscht den aktuellen Inhalt des Terminals
+| clear || {{#var:clear--desc}}
 |-
-| config || Konfigurationsverwaltung
+| config || {{#var:config--desc}}
 |-
-| debug || Debug-Routinen
+| debug || {{#var:debug--desc}}
 |-
-| delete || Entfernen von Konfigurationseinstellungen
+| delete || {{#var:delete--desc}}
 |-
-| export || Export-Funktionen
+| export || {{#var:export--desc}}
 |-
-| import || Import-Funktionen
+| import || {{#var:import--desc}}
 |-
-| load || Laden von Einstellungen
+| load || {{#var:load--desc}}
 |-
-| logout || Beendet die aktuelle CLI-Sitzung
+| logout || {{#var:logout--desc}}
 |-
-| reboot || Startet die Appliance neu
+| reboot || {{#var:reboot--desc}}
 |-
-| register || Liest das Lizenzfile ein
+| register || {{#var:register--desc}}
 |-
-| restart || Neustart von Anwendungen
+| restart || {{#var:restart--desc}}
 |-
-| run|| Ausführen von bestimmten Befehlen (z.B. ping)
+| run || {{#var:run--desc}}
 |-
-| show || Ausgabe von Konfigurationseinstellungen
+| show || {{#var:show--desc}}
 |-
-| start || Starten von Anwendungen
+| start || {{#var:start--desc}}
 |-
-| stop || Stoppen von Anwendungen
+| stop || {{#var:stop--desc}}
 |-
-| update || Befehle für die Aktualisierung
+| update || {{#var:update--desc}}
 |-
-| help || Anzeige von allen Kommandos
+| help || {{#var:help--desc}}
 |}