ZEVENET Kommandolinjegrænseflade ZCLI Brugervejledning

SENDT AF Zevenet | 1. april 2020

Hvad er ZCLI

zcli er forkortelsen til ZEVENET kommandolinjegrænseflade. Dette værktøj gør det muligt at styre flere belastningsbalancere fra en kommandolinie eller automatisering af belastningsbalanceringshandlinger i operationsskripterne

zcli er en indpakning af ZAPI (ZEVENET Application Programming Interface), det har en autofuldførelsesfunktion for lettere at navigere gennem belastningsbalancermodulerne og dens objekter.

Det kan bruges sammen med ZEVENET belastningsbalancere med version EE 6.1 eller nyere.

Første trin med zcli

Installation

zcli er tilgængelig i officielle ZEVENET APT-lagre og det kan installeres i en ZEVENET belastningsafbalancering ved hjælp af:

apt-get update && apt-get install zcli

Denne pakke er også gyldig for enhver Debian, Ubuntu eller enhver distro baseret i deb pakker for at starte kommandoer eksternt til dine belastningsbalancere.

Brugerprofiler

Brugerprofiler indeholde oplysningerne om belastningsbalanceren, hvor kommandoerne udføres, og den bruger, der udfører kommandoen. Det bruger funktionen er kun tilgængelig for ZEVENET Enterprise, og den styres i RBAC-modulet. Kommandoerne udføres afhængigt af brugerens tilladelser. zcli er i stand til at administrere forskellige profiler.

Opsætning

Før du løber zcli a ZAPI-nøgle er påkrævet. Det kan aktiveres fra ZEVENET Web GUI i menuen System> Bruger.

ZEVENET zcli zapi-nøglekonfiguration

Når zcli er installeret, kan det startes ved at udføre zcli i skallen. Hvis den udføres fra belastningsbalancen, kører den med standardprofilen localhost som administrerer den lokale belastningsafbalancering og ZAPI-nøglen vil blive anmodet om. I ethvert andet tilfælde starter konfigurationsassistenten.

ZEVENET oprettelse af zcli-profil

Hvis profilindstillingerne skal ændres, eller en anden profil skal oprettes, skal zcli profil objekt skal udføres.

Det er muligt at indstille profilen under zcli indkaldelsestid ved hjælp af -p mulighed som den er vist nedenfor.

sh:~$ zcli -p my_profile

eller ved hjælp af kommandoen med zcli i en interaktiv tilstand:

zcli: profile apply my_profile

Et eksempel vises nedenfor:

ZEVENET zcli interaktiv tilstand med profil

Hvordan det bruges

zcli har to arbejdstilstande:

1. Lanceret uden argumenter zcli shell udføres i interaktiv tilstand. Denne tilstand giver autofuldførelse, og den afsluttes ikke, når en kommando udføres, for at afslutte zcli skal, type afslut eller tryk på Ctrl + D.

2. zcli påberåbes med argumenter. Dette vil udføre kommandoen uden at gå ind i zcli interaktiv skal, og tilbagevenden tilbage til systemkonsollen.

Lad os se nedenfor de tilgængelige kommandoer i ZEVENET Command Line Interface.

Kommandoer

En kommando har følgende syntaks:

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

Som et eksempel:

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

Find nedenfor beskrivelsen af ​​hver parameter.

optioner: De er indstillet i zcli påkaldelse. Den komplette indstillingsliste er detaljeret i hjælpen.
objekt: Det er den slags belastningsbalanceringsobjekt, der er valgt.
Action: Det er verbet, der udføres.
id-liste: De er de identifikatorer, der henviser til objektet. Disse ID'er er relateret til modulet.
parametre: Det er de parametre, der skal indstilles i objektet. Oftest forventes de, når et objekt oprettes / tilføjes eller ændres.

Alle disse parametre kan bruges i JSON-format ved hjælp af -j (–Json) mulighed.

De forventede kommando-argumenter kan hentes ved at trykke på Indtast. Nogle gange udvides parametre ikke, før de forrige argumenter er indstillet.

ZEVENET zcli hjælpebeskrivelser

zcli har en automatisk komplet funktion, der kan udløses ved at trykke dobbelt TAB .

ZEVENET zcli autofuldførelse

Den opdaterede hjælp kan kontrolleres med nedenstående kommando.

sh:~$ zcli help

Outputdata

zcli prompten ændrer farven afhængigt af kommandofejlkoden. Så output vises i grøn hvis kommandoen var vellykket eller rød hvis der opstod en fejl under kommandoudførelsen. Profilnavnet udskrives også som grå hvornår zcli kunne ikke oprette forbindelse til load balancer. For sådanne slags fejl er det nyttigt at gennemgå profilkonfigurationen og ZAPI-nøglen til load balancer.

Outputet udskrives i et farvet JSON-format, men de kan deaktiveres ved hjælp af indstillingen -NC (– Ingen farver). Nogle informationsmeddelelser kunne vises, disse meddelelser udelades, når zcli startes i kommandoudførelsestilstand (uden interaktiv zcli).

Fejlmeddelelserne vises gennem STDERR udgang.

Kommandoeksempler

En komplet liste over eksempler kan spørges i ZAPI-dokumentation. Her kun nogle nyttige eksempler:

Få systeminfo

sh:~$ zcli system get

Få systemstatistikker

sh:~$ zcli statistic-system get

Liste over oversigter over gårdene

sh:~$ zcli farm list

Opret en gård

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

Hent konfigurationen af ​​en gård

sh:~$ zcli farm get farm1

Ændre en gård

sh:~$ zcli farm set farm1 -listener https

Genstart en gård

sh:~$ zcli farm restart farm1

Opret en service

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

Rediger en service

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

Tilføj en backend

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

Rediger en backend

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

Slet en backend

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

Frakobl en backend i vedligeholdelsestilstand

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

Indstil en backend i vedligeholdelsestilstand

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

Kildekodelager

zcli kildekodeprojekt er tilgængeligt i URL'en https://github.com/zevenet/zcli

god fornøjelse zcli, ZEVENETs kommandolinjegrænseflade!

Del på:

Dokumentation i henhold til GNU Free Documentation License.

Var denne artikel til hjælp?

Relaterede artikler