N1 Service Provisioning System 4.1 リファレンスガイド

必須引数とオプション引数

このマニュアルのコマンドの説明とヘルプフラグによって参照できる各コマンドの説明では、コマンドの必須引数とオプション引数は以下のように表記されます。

表 4–5 引数の O/R 表記


表記	意味
[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) とホストタイプ ID (-tID) だけです。ただし、新しいホストのホストタイプで、ホストの属性を指定する必要がある場合、-attr 引数も使用しなければなりません。

注 –

上の例のように、コマンドのヘルプ情報では、必須引数を意味する [R] 表記は使用されません。必須引数は、[O] や [O/R] を付けずに一覧表示されるだけです。上の -name 引数がこの例です。