Relianoid-Befehlszeilenschnittstelle – noid-cli – Benutzerhandbuch

Kategorien anzeigen

Relianoid-Befehlszeilenschnittstelle – noid-cli – Benutzerhandbuch

5 min gelesen

Was ist noid-cli #

noid-cli ist das Akronym von RELIANOID Befehlszeilenschnittstelle. Dieses Tool ermöglicht die Verwaltung mehrerer Load Balancer über eine Befehlszeile oder die Automatisierung von Load Balancer-Aktionen in den Betriebsskripten.

noid-cli ist ein Wrapper des API (RELIANOID Anwendungsprogrammierschnittstelle) verfügt es über eine Autovervollständigungsfunktion, um einfacher durch die Load Balancer-Module und deren Objekte zu navigieren.

Es kann mit verwendet werden RELIANOID Load Balancer mit Version EE 8.1 oder höher.

Erste Schritte mit noid-cli #

Installation #

noid-cli ist erhältlich im offiziellen RELIANOID APT-Repositories und kann in einem RELIANOID Lastenausgleich mit:

apt-get update und apt-get installiere noid-cli

Dieses Paket ist auch gültig für alle Debian-, Ubuntu- oder anderen Distributionen in deb Pakete, um Befehle remote an Ihre Load Balancer zu senden.

Benutzerprofil #

Benutzerprofil enthalten die Informationen zum Load Balancer, auf dem die Befehle ausgeführt werden, und zum Benutzer, der den Befehl ausführen wird. Die Benutzer Funktion ist nur verfügbar für RELIANOID Enterprise und wird im RBAC-Modul verwaltet. Die Ausführung der Befehle hängt von den Berechtigungen des Benutzers ab. noid-cli ist in der Lage, verschiedene Profile zu verwalten.

Einrichtung #

Vor dem Laufen noid-cli a API-Schlüssel ist erforderlich. Es kann aktiviert werden über RELIANOID Web-GUI, im Menü System > Benutzer.

Relianoid konfiguriert API-Benutzerberechtigungen

Sobald noid-cli installiert ist, kann es durch Ausführen von noid-cli in der Shell. Wenn es vom Load Balancer ausgeführt wird, wird es mit dem Standardprofil ausgeführt localhost der den lokalen Load Balancer verwaltet und der ZAPI-Schlüssel abgefragt wird. In allen anderen Fällen wird der Konfigurationsassistent gestartet.

Relianoid Noid-CLI-Befehlszeilen-Benutzeroberfläche

Wenn die Profileinstellungen geändert werden müssen oder ein neues Profil erstellt werden muss, noid-cli profile Objekt ausgeführt werden soll.

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

root@noid-ee-01:~$ noid-cli -p mein_profil

oder mit dem Befehl noid-cli im interaktiven Modus:

noid-cli: Profil anwenden my_profile

Wie es benutzt wird #

noid-cli hat zwei Arbeitsmodi:

1. Ohne Argumente gestartet, noid-cli Shell wird im interaktiven Modus ausgeführt. Dieser Modus bietet eine automatische Vervollständigung und wird nicht beendet, sobald ein Befehl ausgeführt wurde. Um den Modus zu beenden, noid-cli Schale, Typ verlassen oder drücken Sie Ctrl + D.

2. noid-cli wird mit Argumenten aufgerufen. Dadurch wird der Befehl ausgeführt, ohne in den noid-cli interaktive Shell und die Rückkehr zur Systemkonsole.

Sehen wir uns unten die verfügbaren Befehle an in RELIANOID Befehlszeilenschnittstelle.

Befehle #

Ein Befehl hat die folgende Syntax:

root@noid-ee-01:~$ noid-cli [ Optionen ] [ Objekt ] [Aktion] [ IDs-Liste ] [ Parameter ]

Als Beispiel:

root@noid-ee-01:~$ noid-cli -nc -p test-lb2 farms-services-backend set farm1 service1 0 -ip 1.1.1.1 -port 80 ^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^ ^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Optionen Objekt Aktion IDs Liste Parameter

Nachfolgend finden Sie die Beschreibung aller Parameter.

Optionen: Sie befinden sich im noid-cli Aufruf. Die vollständige Optionsliste finden Sie in der Hilfe.
Objekt: Dies ist die Art des ausgewählten Load Balancer-Objekts.
Aktion: Dies ist das Verb, das ausgeführt wird.
ID-Liste: Dies 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. Meistens werden sie erwartet, wenn ein Objekt erstellt/hinzugefügt oder geändert wird.

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

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

noid-cli verfügt über eine Autovervollständigungsfunktion, die durch zweimaliges Drücken ausgelöst werden kann TAB .

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

root@noid-ee-01:~$ noid-cli-Hilfe

Ausgabedaten #

Das noid-cli Eingabeaufforderung ändert die Farbe je nach Befehlsfehlercode. Die Ausgabe wird also in angezeigt grün ob der Befehl erfolgreich war oder rot markiert wenn während der Befehlsausführung ein Fehler aufgetreten ist. Außerdem wird der Profilname als grau wann noid-cli Es konnte keine Verbindung zum Load Balancer hergestellt werden. Bei solchen Fehlern ist es hilfreich, die Profilkonfiguration und den ZAPI-Schlüssel des Load Balancers zu überprüfen.

Die Ausgabe erfolgt in einem farbigen JSON-Format, diese können jedoch mit der Option deaktiviert werden. -nc (–Keine Farben). Einige Informationsmeldungen könnten angezeigt werden, diese Meldungen werden weggelassen, wenn noid-cli wird im Befehlsausführungsmodus gestartet (ohne interaktive noid-cli).

Die Fehlermeldungen werden angezeigt über das STDERR Ausgabe.

Befehlsbeispiele #

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

Systeminformationen abrufen

root@noid-ee-01:~$ noid-cli system get

Systemstatistiken abrufen

root@noid-ee-01:~$ noid-cli Statistiksystem abrufen

Liste eine Übersicht der Farmen

root@noid-ee-01:~$ noid-cli-Farmliste

Erstellen einer Farm

root@noid-ee-01:~$ noid-cli farm erstellen -profile http -farmname farm1 -vip 10.0.0.241 -vport 443

Abrufen der Konfiguration einer Farm

root@noid-ee-01:~$ noid-cli farm get farm1

Ändern einer Farm

root@noid-ee-01:~$ noid-cli farm set farm1 -listener https

Neustarten einer Farm

root@noid-ee-01:~$ noid-cli farm Neustart farm1

Erstellen Sie einen Service

root@noid-ee-01:~$ noid-cli farm-service add farm1 -id images

Ändern eines Dienstes

root@noid-ee-01:~$ noid-cli farm-service set farm1 images -urlp /images

Hinzufügen eines Backends

root@noid-ee-01:~$ noid-cli farm-service-backend add farm1 images -ip 10.0.4.40 -port 443

Ein Backend ändern

root@noid-ee-01:~$ noid-cli farm-service-backend setze farm1 Bilder 0 -Priorität 1

Löschen eines Backends

root@noid-ee-01:~$ noid-cli farm-service-backend entfernt farm1 Bilder 0

Aufheben der Konfiguration eines Backends im Wartungsmodus

root@noid-ee-01:~$ noid-cli farm-service-backend Wartung farm1 Bilder 0

Ein Backend in den Wartungsmodus versetzen

root@noid-ee-01:~$ noid-cli farm-service-backend nicht_wartungspflichtig farm1 Bilder 0

Genießen noid-cli, hat das RELIANOID Befehlszeilenschnittstelle!

📄 Laden Sie dieses Dokument im PDF-Format herunter #

    EMAIL: *

    Erhöhte Sicherheit. Geringerer Aufwand. Nachhaltiger Erfolg. BetterDocs