ZEVENETコマンドラインインターフェースZCLIユーザーガイド

投稿者 Zevenet | 1年2020月XNUMX日

ZCLIとは

zcli の頭字語です ZEVENETコマンドラインインターフェイス。 このツールを使用すると、コマンドラインから複数のロードバランサーを管理したり、操作スクリプトのロードバランサーアクションを自動化したりできます。

zcli のラッパーです ZAPI (ZEVENETアプリケーションプログラミングインターフェイス)、ロードバランサーモジュールとそのオブジェクトを簡単にナビゲートするオートコンプリート機能があります。

バージョンEE 6.1以降のZEVENETロードバランサーで使用できます。

zcliの最初のステップ

インストール

zcli で利用可能です ZEVENET APTの公式リポジトリ そしてそれはZEVENETロードバランサーにインストールすることができます:

apt-get update && apt-get install zcli

また、このパッケージは、Debian、Ubuntu、または deb ロードバランサーに対してリモートでコマンドを起動するためのパッケージ。

ユーザープロファイル

ユーザープロファイル コマンドが実行されるロードバランサーとコマンドを実行するユーザーに関する情報が含まれています。 の user この機能はZEVENET Enterpriseでのみ使用でき、RBACモジュールで管理されます。コマンドは、ユーザーの権限に応じて実行されます。 zcli さまざまなプロファイルを管理できます。

セットアップ

走る前に zcli a ZAPIキー 必要とされている。 メニューのZEVENET Web GUIから有効にすることができます システム>ユーザー.

ZEVENET zcli zapiキー構成

Once zcli インストールされている場合は、 zcli シェルで。 ロードバランサーから実行すると、デフォルトのプロファイルで実行されます ローカルホスト ローカルロードバランサーを管理するZAPIキーが要求されます。 それ以外の場合は、構成アシスタントが開始されます。

ZEVENET zcliプロファイルの作成

プロファイル設定を変更する必要がある場合、または別のプロファイルを作成する必要がある場合は、 zcli プロフィール オブジェクトを実行する必要があります。

中にプロファイルを設定することが可能です zcli を使用した呼び出し時間 -p 以下に示すようなオプション。

sh:~$ zcli -p my_profile

またはコマンドを使用して zcli 対話モード:

zcli: profile apply my_profile

以下に例を示します。

ZEVENET zcli対話モード(プロファイルあり)

どのように使用される

zcli にはXNUMXつの動作モードがあります。

1. 引数なしで起動され、 zcli シェルは対話モードで実行されます。 このモードはオートコンプリートを提供し、コマンドが実行されると終了せず、 zcli シェル、タイプ やめます またはプレス Ctrlキー+ D.

2. zcli 引数付きで呼び出されます。 これはコマンドを実行しますが、 zcli インタラクティブシェル、そしてシステムコンソールに戻ります。

ZEVENETコマンドラインインターフェースで利用可能なコマンドを以下に見てみましょう。

コマンド

コマンドの構文は次のとおりです。

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

例として:

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

各パラメータの説明を以下に示します。

オプション:それらは zcli 呼び出し。 完全なオプションリストについては、ヘルプで詳しく説明しています。
オブジェクト:選択されるのはロードバランサーオブジェクトの一種です。
アクション:実行される動詞です。
IDリスト:オブジェクトを参照する識別子です。 これらのIDはモジュールに関連しています。
パラメータ:オブジェクトに設定するパラメータです。 ほとんどの場合、オブジェクトが作成/追加または変更されたときに期待されます。

これらのパラメータはすべて、JSON形式で使用できます。 -j (–json)オプション。

予想されるコマンド引数は、 入力します。 以前の引数が設定されるまで、パラメータが展開されない場合があります。

ZEVENET zcliヘルプの説明

zcli ダブルを押してトリガーできるオートコンプリート機能があります TAB ボタン。

ZEVENET zcliオートコンプリート

更新されたヘルプは、以下のコマンドで確認できます。

sh:~$ zcli help

出力データ

挽き目 zcli プロンプトは、コマンドエラーコードに応じて色を変更します。 したがって、出力は次のように表示されます (緑字) コマンドが成功した場合、または コマンドの実行中にエラーが発生した場合。 また、プロファイル名は次のように印刷されます グレー いつ zcli ロードバランサーに接続できませんでした。 このような種類のエラーについては、プロファイル構成とロードバランサーのZAPIキーを確認すると便利です。

出力は色付きのJSON形式で印刷されますが、オプションを使用して無効にすることができます -nc (–色なし)。 いくつかの情報メッセージが表示される可能性があり、それらのメッセージは、 zcli コマンド実行モードで起動されます(インタラクティブなし) zcli).

エラーメッセージは、 STDERR 出力。

コマンドの例

例の完全なリストは、 ZAPIドキュメント。 ここにいくつかの有用な例のみを示します

システム情報を取得する

sh:~$ zcli system get

システム統計を取得する

sh:~$ zcli statistic-system get

農場の概要をリストする

sh:~$ zcli farm list

ファームを作成する

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

ファームの構成を取得する

sh:~$ zcli farm get farm1

ファームを変更する

sh:~$ zcli farm set farm1 -listener https

ファームを再起動します

sh:~$ zcli farm restart farm1

サービスを作成する

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

サービスを変更する

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

バックエンドを追加する

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

バックエンドを変更する

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

バックエンドを削除する

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

メンテナンスモードでバックエンドを設定解除する

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

メンテナンスモードでバックエンドを設定する

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

ソースコードリポジトリ

挽き目 zcli ソースコードプロジェクトはURLで入手できます https://github.com/zevenet/zcli

楽しみます zcli、ZEVENETコマンドラインインターフェース!

上の共有:

GNU Free Documentation Licenseの条項に基づくドキュメンテーション。

この記事は役に立ちましたか?

関連記事