コマンド行インタフェース (CLI)

コマンド行インタフェース (CLI) は、Windows プロンプト、シェル、スクリプトなど、HTML ではないインタフェースを介して プロビジョニングソフトウェア にアクセスするためツールの集まりです。 CLI コマンドをスクリプトで使用すると、ファイルのチェックインなどの操作が自動化できます。 CLI コマンドは、Web ブラウザや HTTP 接続が使用できないシステムから Master Server にアクセスするためにも使用できます。

CLI は、Master Server にネットワークで接続可能なすべてのコンピュータにインストールできる、Command-Line Interface Client です。 このクライアントはコマンドをネイティブオブジェクトに解析し、それらを Master Server に送信します。 続いてコマンドの結果は、クライアントによりテキスト形式に変換され、ユーザーに表示されます。

大部分の CLI コマンドには認証が必要です。 ユーザーは、ユーザー名とパスワードを指定するか、各コマンドにセッション ID を指定することにより、自分自身の認証を行います。 詳細については、『N1 Service Provisioning System 4.1 リファレンスガイド』を参照してください。

CLI を起動するツールには、次の 2 つがあります。

• cr_cli - シングル行コマンドモードで動作し、一度に 1 つのコマンドを実行します。

• cr_clij - Jython インタプリタを使用して、対話型コマンドモードで動作します。

cr_cli: シングル行コマンドモード

シングル行コマンドモードでは、一度に 1 つのコマンドを入力として受け取ります。 発行される各コマンドは完全である必要があります。ユーザーが対話形式で次の入力パラメータを求められることはありません。 このモードで動作すると、Command-Line Interface Client はコマンドの履歴を保持しません。

cr_cli ツールを使用して実行された CLI コマンドの例を示します。 このコマンドにより、型 prodserver のホストがホストデータベースに追加されます。 このコマンド rbarnes を実行するユーザーは、パスワードを入力して Master Server に対して自分自身を認証します。

cr_cli –cmd hdb.h.add -u barnes -p bar123 -name webb1  -desc `web server 1' –tID prodserver 

cr_cliコマンドは、ファイルとして保存し、シェルスクリプトから呼び出すことができます。 これは、実行プラン、比較、ホストの生成など、繰り返しの多いタスクに便利です。

cr_clij: 対話型コマンドモード

対話型コマンドモードは、シェルとして Jython インタプリタを使用します。 このモードで動作すると、CLI には次のような利点があります。

• コマンド全体を 1 行で入力する必要がない。 単にコマンド名を入力してから、cr_clij により入力のプロンプトが表示された時点で、コマンド引数を入力できる。

• シェルにより保存されるコマンド履歴を活用できる。

• Jython スクリプト内から N1 Service Provisioning System ソフトウェア コマンドを呼び出すことができる。

• より複雑で繰り返しの多い操作のための、強力なスクリプトを作成できる。

• 自動化のために、対話型モードの結果はより詳細になっている。

  ---

  注 –

  Jython スクリプトの内部からコマンドを呼び出すには、スクリプトの先頭に次の行を追加します。

  from clui import * app=PyCLUI() make Jython calls to the N1 Service Provisioning System app.execStr(CLI command) invoke Jython methods from the new Jython object App.close() delete the instance of this Jython class

  ---

CLI コマンドの構造

cr_cli と cr_clij のどちらから呼び出されたかに関係なく、すべての CLI コマンドは次の形式を使用します。

サブシステム.オブジェクト.コマンド引数 

たとえば、 N1 Service Provisioning System ソフトウェア データベースにホストを追加するコマンドは、hdb.h.add となります。 このコマンドは、次のものを特定する 3 つの要素から構成されています。

• N1 Service Provisioning System ソフトウェア のサブシステム。この場合はホストデータベース (hdb)。

• 操作対象のオブジェクト。この場合はホスト (h)。

• コマンドまたは操作。この場合は追加 (add)。

表 1–4 に、各 N1 Service Provisioning System ソフトウェア のサブシステムの CLI 接頭辞と、そのサブシステムを説明する、このガイドの章の一覧を示します。

このユーザーマニュアルには、CLI コマンドの完全なリストはありません。 各セクションには、特定のトピックに関連する使用頻度の高い CLI コマンドの一覧があります。 CLI コマンドの完全なリストは、『N1 Service Provisioning System 4.1 リファレンスガイド』を参照してください。