Hitachi Command Suite Software CLI リファレンスガイド

3.1 コマンド構文

Device Manager CLIのコマンドを実行する場合の書式（コマンド構文）を説明します。
Windowsの場合
Device Manager CLIを「C:\HiCommand」にインストールした場合の例を示します。
C:\HiCommand>HiCommandCLI.bat [URL] [コマンド] [オプション] [パラメーター]
Solaris，AIX，LinuxまたはHP-UXの場合
# ./HiCommandCLI.sh [URL] [コマンド] [オプション] [パラメーター]
重要

Device Manager CLIでは，ASCIIコードの文字だけサポートしています。サーバへの要求にASCIIコード以外の文字が含まれた場合，要求を正確に処理できないため予期しないエラーが発生することがあります。

コマンドラインからコマンドを入力するには，プラットフォームに応じたシェルエスケープを実行する必要があります。

Device Manager CLIの引数（URL，オプション，およびパラメーター）について説明します。

URL

Device Managerサーバのネットワーク上での位置を示すURLです。例えば，http://localhost:2001/serviceのように指定します。

URLは次の項目を含めて指定してください。

通信プロトコル

HTTPを使用する場合：http://

HTTPSを使用する場合：https://

Device Managerサーバのホスト名

HTTPを使用する場合：Device Managerサーバのホスト名またはIPアドレス（IPアドレスがIPv6の場合，IPアドレスを角括弧[ ]で囲みます）

HTTPSを使用する場合：環境設定時にDevice Managerサーバのサーバ証明書に指定したホスト名

ポート番号

HTTPを使用する場合：Device ManagerサーバのHTTPポート（デフォルトは2001）

HTTPSを使用する場合：Device ManagerサーバのHTTPSポート（デフォルトは2443）

Device Manager CLIが動作するマシンとDevice Managerサーバとの間にファイアウォールが設置されている場合は，Device Managerサーバのポート番号が使用できるようにファイアウォールを設定する必要があります。

ベースアドレス
Device Managerサーバのベースアドレス（サーバが標準外のサーブレットエイリアスで構成されている場合を除き，デフォルトはserviceです）

HTTPSを使用する場合の実行例を次に示します。この例では，オプション-s（または--secure）を指定してGetServerInfoコマンドを実行します。
Windowsの場合
HiCommandCLI.bat -s https://Device Managerサーバのホスト名:2443/service GetServerInfo
 
Solaris，AIX，LinuxまたはHP-UXの場合
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. コマンドリファレンス」を参照してください。

参考

URL，オプション，およびパラメーターはプロパティファイルに設定することでコマンドラインからの指定を省略できます。プロパティファイルとコマンドラインの両方に指定した場合，コマンドラインで入力した値が優先して使用されます。

表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 任意実行結果の出力形式

このオプションは，GetStorageArrayコマンドを実行する場合にだけ使用できます。GetStorageArrayコマンドの実行結果を次の形式で出力します。

csv：CSV形式^※4

xml：XML形式

csv，xmlは小文字で指定してください。
省略した場合は，標準形式で出力します。
このオプションは，オプション-b（または--batch）と同時に指定できません。

-tまたは
--messagetrace
引数なし任意メッセージトレースの有効化フラグ
Device Managerサーバとの間の通信で，XML形式で送受信される要求と応答をMessageTrace.logファイルに出力します。

-bまたは
--batch
バッチファイル名 ^※2 任意バッチファイル内に設定したコマンドをまとめて実行します。
このオプションは，オプション-f（または--format）と同時に指定できません。

-qまたは
--quiet
引数なし任意コマンド実行結果の出力抑止有効化フラグ
コマンド実行が成功した場合に，実行結果の出力を抑止します。
ただし，情報を参照するコマンド（GetStorageArrayなどのGetで始まるコマンド）の場合，このオプションを指定しても無視されます。
オプション-t（または--messagetrace）と同時に指定した場合，実行結果は抑止されますが，メッセージトレースファイルに出力されるログは抑止されません。

注※1

ユーザーIDおよびパスワードの登録は，GUIから実施します。

注※2

ファイルパスは，相対パスまたは絶対パスのどちらでも設定できます。

注※3

ログインユーザーIDを指定して，ログインパスワードをオプションとプロパティどちらにも指定しないで，ヘルプ機能以外のコマンドを実行した場合，ログインパスワードを入力するメッセージが表示されます。

注※4

GetStorageArrayコマンドのパラメーターの中には，オプション-f（または--format）でcsvを指定した場合，同時に指定できないものがあります。同時に指定できないパラメーターについては，「B.1.1 GetStorageArrayコマンドの実行結果をCSV形式で出力するときに指定できないパラメーター」を参照してください。

関連項目

2.7 プロパティファイルまたはパスワードファイルに指定するパスワードのコード化について

6.4 バッチ機能を実行する

8. Device Manager CLIのプロパティファイル

付録B. GetStorageArrayコマンドの実行結果の出力形式

オプション	オプションの引数	指定のレベル	説明
`-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`	任意	実行結果の出力形式このオプションは，`GetStorageArray`コマンドを実行する場合にだけ使用できます。`GetStorageArray`コマンドの実行結果を次の形式で出力します。 `csv`：CSV形式^※4 `xml`：XML形式 `csv`，`xml`は小文字で指定してください。省略した場合は，標準形式で出力します。このオプションは，オプション`-b`（または`--batch`）と同時に指定できません。
`-t`または `--messagetrace`	引数なし	任意	メッセージトレースの有効化フラグ Device Managerサーバとの間の通信で，XML形式で送受信される要求と応答を`MessageTrace.log`ファイルに出力します。
`-b`または `--batch`	`バッチファイル名` ^※2	任意	バッチファイル内に設定したコマンドをまとめて実行します。このオプションは，オプション`-f`（または`--format`）と同時に指定できません。
`-q`または `--quiet`	引数なし	任意	コマンド実行結果の出力抑止有効化フラグコマンド実行が成功した場合に，実行結果の出力を抑止します。ただし，情報を参照するコマンド（`GetStorageArray`などのGetで始まるコマンド）の場合，このオプションを指定しても無視されます。オプション`-t`（または`--messagetrace`）と同時に指定した場合，実行結果は抑止されますが，メッセージトレースファイルに出力されるログは抑止されません。

[目次] [前へ] [次へ]