Interface de Linha de Comando ZEVENET Guia do Usuário ZCLI

POSTADO POR Zevenet | 1 de abril de 2020

O que é ZCLI

zcli é o acrônimo de Interface de linha de comando ZEVENET. Essa ferramenta permite gerenciar vários balanceadores de carga a partir de uma linha de comandos ou automatizar as ações do balanceador de carga nos scripts de operação.

zcli é um invólucro do ZAPI (Interface de programação de aplicativos ZEVENET), possui um recurso de preenchimento automático para navegar mais facilmente pelos módulos do balanceador de carga e seus objetos.

Pode ser usado com balanceadores de carga ZEVENET com a versão EE 6.1 ou superior.

Primeiros passos com zcli

Instalação

zcli está disponível no repositórios oficiais do ZEVENET APT e pode ser instalado em um balanceador de carga ZEVENET usando:

apt-get update && apt-get install zcli

Além disso, este pacote também é válido para qualquer Debian, Ubuntu ou qualquer distribuição baseada em deb pacotes para iniciar comandos remotamente para seus balanceadores de carga.

Perfis de usuário

Perfis de usuário contém as informações relacionadas ao balanceador de carga em que os comandos serão executados e o usuário que executará o comando. o usuário recurso está disponível apenas para ZEVENET Enterprise e é gerenciado no módulo RBAC, os comandos serão executados dependendo das permissões do usuário. zcli é capaz de gerenciar perfis diferentes.

instalação

Antes de executar zcli a Chave ZAPI É necessário. Pode ser ativado na GUI da Web ZEVENET, no menu Sistema> Usuário.

Configuração de chave ZEVENET zcli zapi

Uma vez zcli está instalado, pode ser iniciado executando zcli na concha. Se for executado a partir do balanceador de carga, será executado com o perfil padrão localhost que gerencia o balanceador de carga local e a chave ZAPI será solicitada. Em qualquer outro caso, o assistente de configuração será iniciado.

Criação de perfil zcli ZEVENET

Se as configurações do perfil precisarem ser modificadas ou outro perfil tiver que ser criado, o zcli perfis objeto deve ser executado.

É possível definir o perfil durante o zcli tempo de chamada usando o -p opção como é mostrado abaixo.

sh:~$ zcli -p my_profile

ou usando o comando com zcli em um modo interativo:

zcli: profile apply my_profile

Um exemplo é mostrado abaixo:

Modo interativo ZEVENET zcli com perfil

Como é usado

zcli tem dois modos de trabalho:

1. Lançado sem argumentos, o zcli shell é executado no modo interativo. Esse modo fornece preenchimento automático e não termina quando um comando é executado, para sair do zcli concha, tipo desistir ou pressione Ctrl + D.

2. zcli é invocado com argumentos. Isso executará o comando, sem entrar no zcli shell interativo e o retorno ao console do sistema.

Vejamos abaixo os comandos disponíveis na interface de linha de comando ZEVENET.

comandos

Um comando tem a seguinte sintaxe:

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

Como um exemplo:

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

Encontre abaixo a descrição de cada parâmetro.

opções: Eles estão definidos no zcli invocação. A lista completa de opções está detalhada na ajuda.
objeto: É o tipo de objeto do balanceador de carga selecionado.
açao: É o verbo que será executado.
lista de ids: São os identificadores que se referem ao objeto. Esses IDs estão relacionados ao módulo.
parâmetros: São os parâmetros a serem definidos no objeto. Principalmente, eles são esperados quando um objeto é criado / adicionado ou modificado.

Todos esses parâmetros podem ser usados ​​no formato JSON usando o comando -j (–Json) opção.

Os argumentos de comando esperados podem ser recuperados pressionando Entrar. Às vezes, os parâmetros não são expandidos até que os argumentos anteriores sejam definidos.

Descrições da ajuda do ZEVENET zcli

zcli possui uma funcionalidade de preenchimento automático que pode ser acionada pressionando ABA botão.

Preenchimento automático zEVENET zcli

A ajuda atualizada pode ser verificada com o comando abaixo.

sh:~$ zcli help

Dados de saída

A zcli O prompt mudará a cor, dependendo do código de erro do comando. Portanto, a saída será mostrada em verde se o comando foi bem sucedido ou vermelho se houve um erro durante a execução do comando. Além disso, o nome do perfil será impresso como cinzento quando zcli não foi possível conectar ao balanceador de carga. Para esse tipo de erro, é útil revisar a configuração do perfil e a chave ZAPI do balanceador de carga.

A saída é impressa em um formato JSON colorido, mas eles podem ser desativados usando a opção -nc (-Não há cores) Algumas mensagens informativas podem ser mostradas, essas mensagens são omitidas quando zcli é iniciado no modo de execução de comando (sem interativo zcli).

As mensagens de erro são exibidas através do STDERR saída.

Exemplos de comando

Uma lista completa de exemplos pode ser consultada no Documentação ZAPI. Aqui apenas alguns exemplos úteis:

Obter informações do sistema

sh:~$ zcli system get

Obter estatísticas do sistema

sh:~$ zcli statistic-system get

Listar uma visão geral dos farms

sh:~$ zcli farm list

Crie um farm

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

Recuperar a configuração de um farm

sh:~$ zcli farm get farm1

Modificar um farm

sh:~$ zcli farm set farm1 -listener https

Reinicie um farm

sh:~$ zcli farm restart farm1

Crie um serviço

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

Modifique um serviço

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

Adicionar um back-end

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

Modificar um back-end

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

Excluir um back-end

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

Desativar um back-end no modo de manutenção

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

Definir um back-end no modo de manutenção

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

Repositório do Código Fonte

A zcli projeto de código-fonte está disponível no URL https://github.com/zevenet/zcli

Apreciar zcli, a interface de linha de comando ZEVENET!

Compartilhar no:

Documentação sob os termos da Licença de Documentação Livre GNU.

Esse artigo foi útil?

Artigos Relacionados