CLI コマンドの構造

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

cr_cli -cmd command authentication-arguments [ other-arguments ]

ほとんどのコマンドは、認証引数 -u および -p、または -s を使用する必要があります。 コマンドが認証引数を必要とするかどうかについては、そのコマンドの説明を参照してください。コマンド行内の認証引数の位置は決まっていませんが、必ず引数 -cmd、-h、-o、-of の後ろに挿入してください。

-cmd command

実行するコマンドの名前。

すべての CLI コマンドは、次の書式を使用する。

subsystem.object.command

たとえば、ホストをデータベースに追加するコマンドは hdb.h.add。

subsystem はサブシステムの名前。たとえばホストデータベースコマンドは、hdb で表される。

object はコマンドの影響を受けるオブジェクト。たとえばホストは、h で表される。

command はコマンドが実行するアクション。たとえばホストをデータベースに追加するアクション、add などがある

authentication-arguments

ほとんどの CLI コマンドは認証を必要とするが、ヘルプの表示や使用可能なコマンドの一覧表示には認証は不要。

-u user-name

認証に使用するユーザー名。認証を行うためには、このユーザーのパスワードも指定する必要がある。

ユーザー名とパスワードを入力する代わりに、セッション ID を指定する方法もある

-p password

-u で指定されたユーザーの認証に使用されるパスワード。

コマンド行に指定したパスワードは保護されていない。プロセスリストやシェルのコマンド行履歴に、このパスワードが含まれている可能性がある。したがって、パスワードを保護するには、ユーザー名とパスワードをローカルファイルシステム上のファイルに保存し、コマンドへの入力としてこのファイルを参照するとよい。これについては、例 1–1 の最初の例を参照のこと。また、ユーザーがこのファイルを所有していることと、このファイルの読み取りがこのユーザーだけに許可されていることを確認すること

-s session-ID

セッションの認証に使用されるセッション ID。

セッション ID を取得し、認証用として使用する方法については、「ファイルからの入力の読み取り」を参照のこと。

セッション ID を入力する代わりに、引数 -u と -p を使ってユーザー名とパスワードを指定することもできる

other-arguments

command に関連付けられた引数と値

cr_cli コマンドは成功時に 0、失敗時に 1 を返します。

例 1–1 CLI の使用

以下に、プロビジョニングソフトウェアの CLI の使用例を示します。

• ファイルからユーザー名とパスワードを読み取る例。ファイル .terrypw には、Terry のユーザー名とパスワードが以下のような書式で格納されています。

  -u terry -p securepasswd

  hdb.h.lo コマンドを認証する場合、Terry は次のコマンドを実行します。

  cr_cli -cmd hdb.h.lo -exp:.terrypw

  このファイルをローカルファイルシステムに格納し、ファイルのアクセス許可を設定して、このファイルへのアクセスを制限します。詳細については、「ファイルからの CLI 引数の読み取り」を参照してください。

• ユーザー terry がホスト barolo7 の情報を取得する例。このコマンドでは、コマンド行に直接パスワードを入力します。

  cr_cli -cmd hdb.h.lo -ID NM:barolo7 -u terry -p password

  この方法で指定したパスワードは保護されません。

• 文字列を引用記号で囲むことによって、空白文字を含む引数を渡す例。ユーザー terry が、myWebServer という名前のコンポーネントの説明を変更します。

  cr_cli -cmd cdb.c.mod -comp myWebServer -desc "Version 3.7 of My Web Server" -u terry -p 123xyz

  UNIX® システムでは、空白文字のエスケープ文字として、バックスラッシュ (\) を使用します。

  cr_cli -cmd cdb.c.mod -comp myWebServer -u terry -p 123xyz -desc Version\ 3.7\ of\ My\ Web\ Server

NM: を使った ID 置換

ユーザーが作成したほとんどのオブジェクトには、ID 番号が付けられます。ID 番号は、リポジトリ内のオブジェクト (ユーザーアカウント、コンポーネントなど) を識別する一意の識別子です。

ID 番号は便利ですが、扱いにくい場合もあります。ID 番号の代わりに名前を使用する場合は、NM: 表記を使ってオブジェクト名を入力します。

サポートされている NM: マッピングの一覧は、付録 A 「入力タイプ」に記載されています。

たとえば、ホスト、ユーザー名、ユーザーグループ名、ホストタイプ名などのオブジェクト ID の代わりに、次のような構文を使用することができます。

NM:host
NM:user-name
NM:user-group-name
NM:host-type-name

NM: 構文では、名前やオプションのバージョン番号を指定して、コンポーネントやプランを識別することができます。

NM:plan-name[:version]

以下に、この表記の使用例を示します。

NM:simplePlan
NM:simplePlan:1.0
NM:/foo/bar/simplePlan:1.1

バージョン番号の指定を省略した場合、最新バージョンが使用されます。