test

Sun N1 Service Provisioning System 5.1 コマンド行インタフェース(CLI) リファレンスマニュアル

コマンド行ヘルプの利用

CLI に関する一般的なヘルプを表示するには、次のように入力します。


cr_cli -help

特定のコマンドのヘルプを表示するには、次のように入力します。


cr_cli -cmd command -h

コマンドの説明テキストでは、次の記号で、引数が必須であるかオプションであるかを区別しています。

[O]

引数はオプションです。

[R]

引数は必須です。

[O/R]

引数は通常はオプションですが、必須になることもあります。

この場合、引数がいつ必要になるかについてのヘルプが表示されます。

以下に、例として hdb.h.add コマンドのヘルプを示します。


-u [O/R]: The user username for authentication: String
-p [O/R]: The user password for authentication: String
-s [O/R]: The session ID for authentication: SessionID
-name: The host name: String
-desc [O]: The host description: String
-tID: The ID of the host type: HostTypeID
-attr [O/R]: The host attributes; required if the host type requires
  them: Hashtable

この例の場合、必要な引数は -name、 -tID、および認証引数 (-u と -p、または -s) だけです。新しいホストが、ホスト属性を必要とするホストタイプである場合は、-attr 引数も必須になります。

-h を使ってヘルプを呼び出した場合、必須引数を識別する記号、[R] は使用されません。必須引数は、特別な記号なしで表示されます。

CLI コマンドの一覧

使用可能なコマンドを一覧表示するには、次のように入力します。


cr_cli -cmd -l

同じコマンド接頭辞を持つコマンドを一覧表示するときは、その接頭辞の後ろにワイルドカード * を指定します。場合によっては、* の前にエスケープ文字としてバックスラッシュ (\) を入力するか、コマンド名の部分を二重引用符で囲む必要があります。たとえば、hdb コマンドを一覧表示するには、次のように入力します。


cr_cli -cmd -l "hdb.*"

CLI コマンドは、以下のカテゴリにグループ分けされています。