Device Manager CLIのコマンドを実行する場合の書式(コマンド構文)を説明します。
C:¥HiCommand>HiCommandCLI.bat [URL] [コマンド] [オプション] [パラメーター]
# ./HiCommandCLI.sh [URL] [コマンド] [オプション] [パラメーター]
Device Manager CLIの引数(URL,オプション,およびパラメーター)について説明します。
URL
Device Managerサーバのネットワーク上での位置を示すURLです。例えば,http://localhost:2001/serviceのように指定します。
URLは次の項目を含めて指定してください。
HTTPSを使用する場合の実行例を次に示します。この例では,オプション-s(または--secure)を指定してGetServerInfoコマンドを実行します。
HiCommandCLI.bat -s https://Device Managerサーバのホスト名:2443/service GetServerInfo
HiCommandCLI.sh -s https://Device Managerサーバのホスト名:2443/service GetServerInfo
コマンド
GetStorageArrayやGetLogicalGroupなど,Device Managerサーバに処理を要求するためのコマンドです。コマンド名の大文字と小文字は区別されません。
オプション
オプションは,Device Manager CLIの動作を制御します。オプションは一般的なUNIX方式で入力します。大文字と小文字は区別されます。つまり,各オプションには1文字表現と単語表現があり,1文字の場合は,1本のダッシュが接頭部となり,単語表現の場合は,2本のダッシュが接頭部となります。例えば,1文字の場合は,「-t」となり,単語の場合は,「--messagetrace」となります。オプションには,そのあとに引数の指定が必要なものがあります。例えば,「-u」のあとにはユーザーIDを指定します。Device Manager CLIで使用できるオプションについては「表3-1 Device Manager CLIのオプション」を参照してください。
同じオプションを重複して指定すると,あとから指定した値が有効になります。
パラメーター
サーバに要求の一部として渡されるパラメーターです。必要なパラメーターは,要求したコマンドによって異なります。各パラメーターは,例えば,パラメーター名=パラメーター値など,名前と値の組み合わせで表現されます。パラメーター名の大文字と小文字は区別されません。指定する値にスペースが含まれる場合は引用符(”)で囲みます(例:hostmode=”Windows Extension, Solaris Extension”)。
パラメーターの説明で特に記載がない場合,パラメーター値の大文字と小文字が区別されます。
パラメーターには必ず指定しなければならないものと,任意で指定するものがあります。必ず指定しなければならないパラメーターに,指定漏れなどの誤りがある場合,コマンドを実行できません。
同じパラメーターを重複して指定すると,あとから指定した値が有効になります。
各コマンドで使用できるパラメーターについては「4. コマンドリファレンス」を参照してください。
表3-1 Device Manager CLIのオプション
オプション | オプションの引数 | 指定のレベル | 説明 |
---|---|---|---|
-uまたは --user | ユーザーID ※1 | 必須 | Device Managerサーバの有効なログインユーザーID 使用する前に,ユーザーIDをDevice Managerに登録しておくことが必要です。 |
-pまたは --password | パスワード※1または パスワードファイル | 必須 | Device Managerサーバのログインパスワード,またはログインパスワードが書かれたパスワードファイルへのパス※1,※2,※3 パスワードは直接指定するか,またはパスワードが書かれたファイルで指定できます。アプリケーションユーザーはパスワードファイルへのアクセス権が必要です。一般ユーザーには,パスワードファイルへのアクセス権を与えないでください。 パスワードファイルを指定する場合,パスの先頭に「@」を付けます。指定したファイルの先頭行のテキストが読み込まれ,パスワードとして使用されます。 パスワードファイルには,平文ではなくコード化した文字列を設定することをお勧めします。 |
-sまたは --secure | 引数なし | 任意 | Device Managerサーバとの通信にHTTPSを使用します。 |
-oまたは --output | ファイル名 ※2 | 任意 | 実行結果を出力するファイル 結果をコンソールに出力する代わりに,指定したファイルに出力します。 このオプションを指定した場合,標準出力に実行結果は表示されません。 すでに存在するファイルを指定した場合,上書きします。 |
-fまたは --format | csvまたはxml | 任意 | 実行結果の出力形式
省略した場合は,標準形式で出力します。 このオプションは,オプション-b(または--batch)と同時に指定できません。 |
-tまたは --messagetrace | 引数なし | 任意 | メッセージトレースの有効化フラグ Device Managerサーバとの間の通信で,XML形式で送受信される要求と応答をMessageTrace.logファイルに出力します。 |
-bまたは --batch | バッチファイル名 ※2 | 任意 | バッチファイル内に設定したコマンドをまとめて実行します。 このオプションは,オプション-f(または--format)と同時に指定できません。 |
-qまたは --quiet | 引数なし | 任意 | コマンド実行結果の出力抑止有効化フラグ コマンド実行が成功した場合に,実行結果の出力を抑止します。 ただし,情報を参照するコマンド(GetStorageArrayなどのGetで始まるコマンド)の場合,このオプションを指定しても無視されます。 オプション-t(または--messagetrace)と同時に指定した場合,実行結果は抑止されますが,メッセージトレースファイルに出力されるログは抑止されません。 |
関連項目