ZEVENET-Befehlszeilenschnittstelle ZCLI-Benutzerhandbuch

GESCHRIEBEN VON Zevenet | 1. April 2020

Was ist ZCLI?

zcli ist das Akronym von ZEVENET-Befehlszeilenschnittstelle. Dieses Tool ermöglicht die Verwaltung mehrerer Load Balancer über eine Befehlszeile oder die Automatisierung von Load Balancer-Aktionen in den Operationsskripten.

zcli ist ein Wrapper der ZAPI (ZEVENET Application Programming Interface) verfügt über eine Autocompletion-Funktion, mit der Sie einfacher durch die Load Balancer-Module und ihre Objekte navigieren können.

Es kann mit ZEVENET Load Balancern mit Version EE 6.1 oder höher verwendet werden.

Erste Schritte mit zcli

Montage

zcli ist im erhältlich offizielle ZEVENET APT-Repositories und es kann in einem ZEVENET Load Balancer installiert werden mit:

apt-get update && apt-get install zcli

Dieses Paket gilt auch für Debian, Ubuntu oder jede Distribution in deb Pakete, um Befehle remote auf Ihren Load Balancern zu starten.

Benutzerprofil

Benutzerprofil Enthalten die Informationen zum Load Balancer, in dem die Befehle ausgeführt werden, und zum Benutzer, der den Befehl ausführt. Das Benutzer Die Funktion ist nur für ZEVENET Enterprise verfügbar und wird im RBAC-Modul verwaltet. Die Befehle werden abhängig von den Berechtigungen des Benutzers ausgeführt. zcli kann verschiedene Profile verwalten.

Einrichtung

Vor dem Laufen zcli a ZAPI-Schlüssel ist erforderlich. Sie kann über die ZEVENET-Web-GUI im Menü aktiviert werden System> Benutzer.

ZEVENET zcli zapi Schlüsselkonfiguration

Once zcli installiert ist, kann es durch Ausführen gestartet werden zcli in der Schale. Wenn es vom Load Balancer ausgeführt wird, wird es mit dem Standardprofil ausgeführt localhost Es wird angefordert, welcher den lokalen Load Balancer und den ZAPI-Schlüssel verwaltet. In jedem anderen Fall wird der Konfigurationsassistent gestartet.

ZEVENET zcli-Profilerstellung

Wenn die Profileinstellungen geändert oder ein anderes Profil erstellt werden muss, wird die zcli Profil Objekt sollte ausgeführt werden.

Es ist möglich, das Profil während der zcli Aufrufzeit mit dem -p Option wie unten gezeigt.

sh:~$ zcli -p my_profile

oder mit dem Befehl mit zcli in einem interaktiven Modus:

zcli: profile apply my_profile

Ein Beispiel ist unten gezeigt:

ZEVENET zcli interaktiver Modus mit Profil

Wie es benutzt wird

zcli hat zwei Arbeitsmodi:

1. Ohne Argumente gestartet, die zcli Shell wird im interaktiven Modus ausgeführt. Dieser Modus bietet eine automatische Vervollständigung und wird nicht beendet, sobald ein Befehl ausgeführt wird, um den zu verlassen zcli Shell, Typ verlassen oder drücken Sie Ctrl + D.

2. zcli wird mit Argumenten aufgerufen. Dadurch wird der Befehl ausgeführt, ohne dass der Befehl eingegeben wird zcli interaktive Shell und die Rückkehr zur Systemkonsole.

Im Folgenden sehen Sie die Befehle, die in der ZEVENET-Befehlszeilenschnittstelle verfügbar sind.

Befehle

Ein Befehl hat die folgende Syntax:

sh:~$  zcli [   options   ] [        object      ] [action] [   ids list   ] [    parameters    ]

Als Beispiel:

sh:~$ zcli -nc -p test-lb2 farms-services-backend   set    farm1 service1 0 -ip 1.1.1.1 -port 80
           ^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^   ^^^    ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
               options            object           action      ids list         parameters

Nachfolgend finden Sie die Beschreibung aller Parameter.

Optionen: Sie sind in der eingestellt zcli Aufruf. Die vollständige Optionsliste finden Sie in der Hilfe.
Objekt: Es ist die Art des Load Balancer-Objekts, das ausgewählt wird.
Aktion: Es ist das Verb, das ausgeführt wird.
IDs Liste: Sie sind die Bezeichner, die sich auf das Objekt beziehen. Diese IDs beziehen sich auf das Modul.
Parameter: Dies sind die Parameter, die im Objekt festgelegt werden sollen. Meist werden sie erwartet, wenn ein Objekt erstellt / hinzugefügt oder geändert wird.

Alle diese Parameter können im JSON-Format mit dem verwendet werden -j (–Json) Möglichkeit.

Die erwarteten Befehlsargumente können durch Drücken von abgerufen werden Weiter. Manchmal werden Parameter erst erweitert, wenn die vorherigen Argumente festgelegt wurden.

ZEVENET zcli Hilfebeschreibungen

zcli verfügt über eine automatische Vervollständigungsfunktion, die durch Drücken von double ausgelöst werden kann TAB .

ZEVENET zcli Autocompletion

Die aktualisierte Hilfe kann mit dem folgenden Befehl überprüft werden.

sh:~$ zcli help

Ausgabedaten

Das zcli Die Eingabeaufforderung ändert die Farbe abhängig vom Befehlsfehlercode. Die Ausgabe wird also in angezeigt Grün wenn der Befehl erfolgreich war oder rot wenn während der Befehlsausführung ein Fehler aufgetreten ist. Außerdem wird der Profilname als gedruckt grau wann zcli Es konnte keine Verbindung zum Load Balancer hergestellt werden. Für solche Fehler ist es hilfreich, die Profilkonfiguration und den ZAPI-Schlüssel des Load Balancers zu überprüfen.

Die Ausgabe wird in einem farbigen JSON-Format gedruckt, sie können jedoch mit dieser Option deaktiviert werden -nc (–Keine Farben). Einige Informationsmeldungen könnten angezeigt werden, diese Meldungen werden weggelassen, wenn zcli wird im Befehlsausführungsmodus gestartet (ohne interaktiv zcli).

Die Fehlermeldungen werden über die angezeigt STDERR Ausgabe.

Befehlsbeispiele

Eine vollständige Liste der Beispiele finden Sie in der ZAPI-Dokumentation. Hier nur einige nützliche Beispiele:

Systeminformationen abrufen

sh:~$ zcli system get

Holen Sie sich Systemstatistiken

sh:~$ zcli statistic-system get

Listen Sie eine Übersicht der Betriebe auf

sh:~$ zcli farm list

Erstellen Sie eine Farm

sh:~$ zcli farm create -profile http -farmname farm1 -vip 10.0.0.241 -vport 443

Rufen Sie die Konfiguration einer Farm ab

sh:~$ zcli farm get farm1

Ändern Sie eine Farm

sh:~$ zcli farm set farm1 -listener https

Starten Sie eine Farm neu

sh:~$ zcli farm restart farm1

Erstellen Sie einen Service

sh:~$ zcli farm-service add farm1 -id images

Ändern Sie einen Dienst

sh:~$ zcli farm-service set farm1 images -urlp /images

Fügen Sie ein Backend hinzu

sh:~$ zcli farm-service-backend add farm1 images -ip 10.0.4.40 -port 443

Ändern Sie ein Backend

sh:~$ zcli farm-service-backend set farm1 images 0 -priority 1

Löschen Sie ein Backend

sh:~$ zcli farm-service-backend remove farm1 images 0

Deaktivieren Sie ein Backend im Wartungsmodus

sh:~$ zcli farm-service-backend maintenance farm1 images 0

Stellen Sie ein Backend im Wartungsmodus ein

sh:~$ zcli farm-service-backend non_maintenance farm1 images 0

Quellcode-Repository

Das zcli Das Quellcode-Projekt ist in der URL verfügbar https://github.com/zevenet/zcli

Sich am Ergebnis freuen zcli, die ZEVENET-Befehlszeilenschnittstelle!

Teilen:

Dokumentation unter den Bedingungen der GNU Free Documentation License.

War dieser Artikel hilfreich?

Verwandte Artikel