Wechseln zu:Navigation, Suche
Wiki
K 1 Version importiert
K 14.2.0
 
Zeile 3: Zeile 3:
{{#vardefine:headerIcon|spicon-utm}}
{{#vardefine:headerIcon|spicon-utm}}
{{:UTM/CLI/Cluster.lang}}
{{:UTM/CLI/Cluster.lang}}
{{var | neu--Umbenennung master
| Umbenennung der <s>master</s> in Primary
|  }}
{{var | neu--Rückgabewerte
| Geänderte Rückgabewerte bei ''cluster info''
|  }}
{{var | Rückgabewerte geändert
| Rückgabewerte geändert ab
|  }}


{{var | neu--Verweis system
{{var | neu--Verweis system
Zeile 12: Zeile 22:


</div><div class="new_design"></div><noinclude>{{Select_lang}}{{TOC2}}
</div><div class="new_design"></div><noinclude>{{Select_lang}}{{TOC2}}
{{Header|12.6.1|
{{Header|14.2.0|
* {{#var:neu--Umbenennung master}}
* {{#var:neu--Rückgabewerte}}
| vorher-ver=12.6.1
| vorher=
* {{#var:neu--rwi}}
* {{#var:neu--rwi}}
* {{#var:neu--Wartungsmodus Status}}
* {{#var:neu--Wartungsmodus Status}}
|[[UTM/CLI/Cluster_08.2023 | 08.2023]]
| [[UTM/CLI/Cluster_v12.6.1 | 12.6.1]]
[[UTM/CLI/Cluster_08.2023 | 08.2023]]
|{{Menu-UTM|Extras|CLI}}
|{{Menu-UTM|Extras|CLI}}
|zuletzt=07.2024
}}
}}
----
----
Zeile 32: Zeile 46:
! style="min-width: 180px;" | {{#var:cli-befehl}} !! style="min-width: 225px;" | {{#var:Ausgabe}} !! {{#var:desc}}
! style="min-width: 180px;" | {{#var:cli-befehl}} !! style="min-width: 225px;" | {{#var:Ausgabe}} !! {{#var:desc}}
|-
|-
| rowspan="3" | {{code|cli>&ensp;'''cluster info'''|boldcode}} || {{code|{{td|cluster_state| &#8739;master<br>&ensp;''backup<br>&ensp;none''|w=110px}} }} || {{#var:cli--cluster-info--desc}}
| rowspan="5" | {{code|cli>&ensp;'''cluster info'''|boldcode}} || <pre>attribute    |value
-------------+-----
cluster_state|primary
sync_state  |synchronized
hotwire_dev  |A2
maintainance |false </pre>
| {{#var:cli--cluster-info}}
|-
| {{code|{{td|cluster_state| &#8739;primary<br>&ensp;''spare<br>&ensp;disabled''|w=110px}} | class=mw17 }} || {{#var:cli--cluster-info--desc}}
{{Hinweis-box|{{#var:Rückgabewerte geändert}} v14.2.0|gr|14.2.5|status=update}}
|-
| style="width: 240px;" | {{code|{{td|sync_state | &#8739;synchronized<br>&ensp;''pending<br>&ensp;error''<br>&ensp;disabled''|w=110px}}  | class=mw17 }} || {{#var:cli--sync-state}}
|-
|-
| style="width: 240px;" | {{code|{{td|sync_state | &#8739;synchronized<br>&ensp;''pending<br>&ensp;error''|w=110px}} }} || {{#var:cli--sync-state}}
| {{code|{{td|hotwire_dev | &#8739;A''x''|w=110px}} | class=mw17 }} || {{#var:cli--hotwire}}
|-
|-
| {{code|{{td|hotwire_dev | &#8739;eth''x''|w=110px}} }} || {{#var:cli--hotwire}}
| {{code|{{td|maintenance | &#8739;false|w=110px}} | class=mw17 }} || {{#var:cli--maintenance--desc}}
|-
|-
| {{code|cli&gt;&ensp;'''system config save name &lt;Name der Konfiguration&gt;'''|boldcode inline-block}} || || {{#var:cli--config-save}}
| {{code|cli&gt;&ensp;'''system config save name &lt;Name der Konfiguration&gt;'''|boldcode inline-block}} || || {{#var:cli--config-save}}
Zeile 56: Zeile 81:
| {{code|OK}} || {{#var:CLI-Wartungsmodus deaktivieren--desc}}
| {{code|OK}} || {{#var:CLI-Wartungsmodus deaktivieren--desc}}
|-
|-
| <i class="host utm">Master</i><br> {{code|cli&gt; '''cluster info'''|boldcode inline-block}} ||<pre>attribute    |value
| {{Host|Primary}} <br>{{code|cli&gt; '''cluster maintainance''' set value "'''1'''" <br>cli&gt; '''cluster info'''|boldcode inline-block}} ||<pre>attribute    |value
-------------+-----
-------------+-----
cluster_state|backup
cluster_state|spare
sync_state  |synchronized
sync_state  |synchronized
hotwire_dev  |eth2
hotwire_dev  |A2
maintainance |true </pre>  
maintainance |true </pre>  
| {{#var:Zustand Wartungsmodus Master--desc}}
| {{#var:Zustand Wartungsmodus Master--desc}}
Zeile 67: Zeile 92:
| <pre>attribute    |value
| <pre>attribute    |value
-------------+-----
-------------+-----
cluster_state|master
cluster_state|primary
sync_state  |synchronized
sync_state  |synchronized
hotwire_dev  |eth2
hotwire_dev  |A2
maintainance |false</pre>
maintainance |false</pre>
| {{#var:Zustand Wartungsmodus Spare--desc}}
| {{#var:Zustand Wartungsmodus Spare--desc}}
|}
|}

Aktuelle Version vom 15. Juni 2026, 16:48 Uhr










































Syntax des CLI-Befehls cluster

Letzte Anpassung zur Version: 14.2.0(06.2026)

Neu:
  • Beta Nur für Teilnehmer am Beta-Channel:
  • Umbenennung der master in Primary
  • Geänderte Rückgabewerte bei cluster info
notempty
Dieser Artikel bezieht sich auf eine Beta-Version
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


CLI Befehle

Im folgenden werden Befehle für das Securepoint CLI beschrieben.

CLI Befehl Ausgabe Beschreibung
cli> cluster info
attribute    |value
-------------+-----
cluster_state|primary
sync_state   |synchronized
hotwire_dev  |A2 
maintainance |false 
Cluster Status Meldungen der aktuellen UTM
cluster_state
∣primary
spare
 disabled
Gibt an welche Rolle eine UTM im Cluster gerade hat:
  • Primary: Gerät ist die aktive Cluster-UTM
  • Spare: Gerät ist die passive Cluster-UTM (Backup bzw. Hot-Standby)
  • disabled: Es ist kein Cluster konfiguriert
notempty
Rückgabewerte geändert ab v14.2.0
sync_state
∣synchronized
pending
 error

 disabled
Gibt an, in welchem Zustand sich die Konfiguration befindet.
  • synchronized: Die Konfiguration ist auf beiden UTMS des Clusters gleich
  • pending: Die Konfiguration der UTMs haben einen unterschiedlichen Stand.
    In beiden Fällen können die Mitglieder miteinander kommunizieren.
  • error: Die beiden UTMs können keine Daten austauschen
    Das könnte z.B. der Fall sein, wenn kein Hotwire Interface konfiguriert ist, die Verkabelung nicht korrekt ist, falsche SSH Keys verwendet oder nicht ausgetauscht wurden oder falls die Gegenstelle offline bzw. down ist
  • disabled: Es ist kein Cluster konfiguriert
    notempty
    Neu ab v14.2.0
hotwire_dev
∣Ax
Gibt das Interface an, auf dem das Hotwire Interface konfiguriert ist.
maintenance
∣false
Gibt an, ob die UTM im Wartungsmodus (true) ist oder nicht (false)
cli> system config save name <Name der Konfiguration> Falls in der CLI eine Konfigurationsänderung durchgeführt wurde, muss diese erst lokal gespeichert werden. Erst dann wird eine Synchronisierung des Clusters übertragen.
cli> system config synchronize Durch diesen Befehl kann die jeweilige Start-Konfiguration über die Hotwire Schnittstelle an den Cluster Partner übertragen werden.
Dabei wird die Konfiguration von der UTM verwendet, auf der der Befehl ausgeführt wird.
Ein Artikel zu den system-Befehlen findet sich hier.
cli> extc value get application "securepoint_firewall" variable "UPDATE_TRIGGER_DELAY" Value ∣2 Zeigt den Delay in Sekunden an, bevor im Fehlerfall, von der Primary-UTM auf die Spare-UTM geschaltet wird. Der Standardwert ist 2 Sekunden.
cli> extc value set application "securepoint_firewall" variable "UPDATE_TRIGGER_DELAY" value 2 OK Verändert den Delay, für den Fehlerfall, das von der Primary auf die Spare geschaltet wird. Der Standardwert ist 2 Sekunden und sollte nicht niedriger eingestellt werden. Falls die Appliances im Cluster eine hohe Grundlast haben sollten, kann der Wert höher eingestellt werden.
Die Einstellung ist sofort aktiv und kann via system config synchronize auf den Partner übertragen werden.

Wartungsmodus

cli> cluster maintainance get value
-----
1
bzw. value
-----
0
Gibt aus ob der Wartungsmodus aktiv ist (1) oder nicht (0)
cli> cluster maintainance set value "1"
cli> system update interface
OK Aktiviert den Wartungsmodus
  • Der Wartungsmodus dient dazu, kontrolliert auf die Spare umzuschalten und verhindert mehrfaches Umschwenken bei mehreren Einzelschritten (Update, IP-Adressen ändern etc.)
  • Die im Wartungsmodus zur Verfügung stehenden Dienste werden im Assistenten im Schritt 4 bzw. unter Netzwerk Clusterkonfiguration Bereich Anwendungen konfiguriert
  • Die UTM ist im Wartungsmodus nicht über die virtuelle IP sondern nur über eine feste IP-Adresse erreichbar
cli> cluster maintainance set value "0"
cli> system update interface
OK Deaktiviert den Wartungsmodus
Primary
cli> cluster maintainance set value "1"
cli> cluster info
attribute    |value
-------------+-----
cluster_state|spare
sync_state   |synchronized
hotwire_dev  |A2 
maintainance |true 
Zustand während des gesetzten Maintainance Mode auf der Primary
Spare
cli> cluster info
attribute    |value
-------------+-----
cluster_state|primary
sync_state   |synchronized
hotwire_dev  |A2 
maintainance |false
Zustand während des gesetzten Maintenance Mode auf der Spare