コマンドライン パラメータ

11.40リリースの新しいコマンドライン パラメータ

SANtricity OS 11.40リリースでは、Webサービスが組み込まれたE2800およびE5700コントローラ向けに、セキュアなHTTPSプロトコルを使用してコマンドラインを操作する機能が導入されました。これらのコントローラでは、必要に応じてSYMbolプロトコルを使用してコマンドラインを操作することもできます。SYMbolプロトコルは、E2700およびE5600コントローラでサポートされる唯一のプロトコルです。既存のスクリプトを引き続き使用できるようにし、移行の手間を最小限に抑えるために、CLIのオプションと構文はできるだけそのままにしてあります。ただし、E2800およびE5700コントローラのセキュリティ、認証、AutoSupport、アラート メッセージの機能にはいくつかの変更があるため、これらのコントローラでは一部のCLI構文が廃止されています。一部の構文は、E2800またはE5700で新しいHTTPSプロトコルが使用される場合にのみ廃止されます。

httpsクライアント タイプにのみ適用される新しいパラメータは、E2800またはE5700コントローラにのみ適用されます。

このリリースの新しいコマンドと廃止されたコマンドのリストは、新機能に対応したCLIコマンドとスクリプト コマンドの変更点を参照してください。

パラメータ 定義
-clientType

この引数は、適切なスクリプト エンジンを作成します。このパラメータはオプションで、次のいずれかの値を指定します。

  • auto - デバイス検出が自動的に実行されて適切なスクリプト エンジンが検出されます。
  • https - RESTベースのスクリプト エンジンが作成されます。
  • symbol - SYMbolベースのスクリプト エンジンが作成されます。
-u

このパラメータに続けてusername変数を指定します。usernameはhttpsクライアント タイプでのみ必須です。symbolクライアント タイプには該当しないため、無視されます。

username引数を指定すると、デバイス検出が実行されて正しいクライアント タイプ(httpsまたは symbol)が特定されます。

-P

この引数には、次の2つの引数のどちらかが必要です。

  • password_file - 認証に使用するパスワードを含むファイルを指定します。
  • - (1つのダッシュ) - stdinからパスワードを読み込みます。

この引数は、クライアント タイプ(httpsまたはsymbol)に関係なく、すべてのコントローラで使用できます。

-k この引数はオプションで、httpsクライアントをセキュアでないモードで実行する場合に指定します。指定した場合、ストレージ アレイの証明書は検証されません。デフォルト(この引数を省略)では、適切な認証が実行されます。symbolクライアント タイプには該当しないため、無視されます。

E2700またはE5600コントローラにのみ該当するコマンドライン パラメータ

E2700およびE5600コントローラにはアラート管理機能が組み込まれていないため、以下のコマンドライン パラメータを使用できます。これらのパラメータは、E2800またはE5700コントローラには該当しません。

パラメータ 定義
-a 簡易ネットワーク管理プロトコル(SNMP)トラップの送信先またはアラートの送信先のEメール アドレスを追加します。
  • SNMPトラップの送信先を追加する場合、SNMPコミュニティがトラップのコミュニティ名として自動的に定義されます。hostには、トラップの送信先システムのIPアドレスまたはDNSホスト名を指定します。
  • アラートの送信先のEメール アドレスを追加する場合、email-addressに送信先のEメール アドレスを指定します。
制約事項: このコマンドライン オプションは、E2800E5700のストレージ アレイに対しては廃止されています。RESTful API、SANtricity System Manager、またはcURLコマンドを使用してください。
-m Eメール アラート通知の送信元であるEメール サーバのホスト名またはIPアドレスを指定します。
制約事項: このコマンドライン オプションは、E2800E5700のストレージ アレイに対しては廃止されています。RESTful API、SANtricity System Manager、またはcURLコマンドを使用してください。
-s(小文字) -dパラメータとともに使用し、構成ファイル内のアラート設定を表示します。
制約事項: このコマンドライン オプションは、E2800E5700のストレージ アレイに対しては廃止されています。RESTful API、SANtricity System Manager、またはcURLコマンドを使用してください。
-x(小文字) SNMPトラップの送信先またはアラートの送信先Eメール アドレスを削除します。communityはトラップのSNMPコミュニティ名、hostはトラップの送信先システムのIPアドレスまたはDNSホスト名です。
制約事項: このコマンドライン オプションは、E2800E5700のストレージ アレイに対しては廃止されています。RESTful API、SANtricity System Manager、またはcURLコマンドを使用してください。

symbolクライアント タイプが実行されているすべてのコントローラに該当するコマンドライン パラメータ

パラメータ 定義
-R(大文字) パスワードのユーザ ロールを定義します。ロールには次のどちらかを指定できます。
  • admin – ストレージ アレイ構成を変更する権限が割り当てられます。
  • monitor – ストレージ アレイ構成を表示する権限が割り当てられますが、変更を行うことはできません。

-Rパラメータは、ストレージ アレイのパスワードを定義する–pパラメータとともに使用する場合にのみ有効です。

-Rパラメータは、ストレージ アレイでデュアル パスワード機能が有効になっている場合にのみ必須です。以下の条件に該当する場合、-Rパラメータは必要ありません。

  • ストレージ アレイでデュアル パスワード機能が有効になっていない。
  • ストレージ アレイにAdminロールが1つだけ設定されていて、Monitorロールが設定されていない。

すべてのコントローラおよびクライアント タイプに該当するコマンドライン パラメータ

パラメータ 定義
host-name-or-IP-address インバンド管理またはアウトオブバンド管理のストレージ アレイのホスト名またはインターネット プロトコル(IP)アドレス(xxx.xxx.xxx.xxx)を指定します。
  • ホストからインバンドでストレージ アレイを管理していて、複数のストレージ アレイがホストに接続されている場合、-nパラメータまたは-wパラメータを使用する必要があります。
  • 各コントローラ上のイーサネット接続からアウトオブバンドでストレージ アレイを管理している場合は、コントローラのhost-name-or-IP-addressを指定する必要があります。
  • 以前にEnterprise Management Windowでストレージ アレイを設定済みの場合は、-nパラメータにユーザが設定したストレージ アレイ名を指定できます。
  • 以前にEnterprise Management Windowでストレージ アレイを設定済みの場合は、-wパラメータにストレージ アレイのWorld Wide Identifier(WWID)を指定できます。
-A 構成ファイルにストレージ アレイを追加します。-Aパラメータに続けてhost-name-or-IP-addressを指定しないと、ローカル サブネットがスキャンされてストレージ アレイが自動で検出されます。
-c 指定したストレージ アレイで実行するスクリプト コマンドを入力することを示します。各コマンドの末尾にセミコロン(;)を入力してください。同じコマンド行に-cパラメータを複数配置することはできません。-cパラメータに続けて複数のスクリプト コマンドを指定できます。
-d スクリプト構成ファイルの内容を表示します。ファイルの内容は次の形式になります。storage-system-name host-name1 host-name2
-e 構文チェックを実行せずにコマンドを実行します。
-F(大文字) すべてのアラートの送信元となるEメール アドレスを指定します。
-f(小文字) 指定したストレージ アレイで実行するスクリプト コマンドを含むファイルの名前を指定します。-fパラメータと-cパラメータはどちらもスクリプト コマンドを実行するためのコマンドです。-cパラメータは個々のスクリプト コマンドを実行するのに対し、 -fパラメータはスクリプト コマンドのファイルを実行します。

デフォルトでは、ファイル内のスクリプト コマンドの実行時に発生したエラーは無視され、ファイルは引き続き実行されます。この動作を上書きするには、スクリプト ファイル内にset session errorAction=stopコマンドを記述します。

-g Eメール送信者の連絡先情報が格納されたASCIIファイルを指定します。この連絡先はすべてのEメール アラート通知に記載されます。区切り記号や書式設定のない、テキストのみのASCIIファイルを指定する必要があります。userdata.txtファイルが存在する場合は、-gパラメータを使用しないでください。
-h ストレージ アレイの接続先であるSNMPエージェントを実行しているホストの名前を指定します。-hパラメータは以下のパラメータとともに使用します。
  • -a
  • -x
-I(大文字) Eメール アラート通知に含める情報のタイプを指定します。以下の値を選択できます。
  • eventOnly – イベント情報のみ。
  • profile – イベント情報とアレイ プロファイル情報。

-qパラメータを使用すると、Eメール通知の配信頻度を指定できます。

-i(小文字) 既知のストレージ アレイのIPアドレスを表示します。-iパラメータは-dパラメータとともに使用します。ファイルの内容は次の形式になります。

storage-system-name IP-address1 IPaddress2

-n スクリプト コマンドを実行するストレージ アレイの名前を指定します。host-name-or-IP-addressを使用する場合、この名前は省略可能です。ストレージ アレイをインバンドで管理していて、複数のストレージ アレイが指定したアドレスのホストに接続されている場合、-nパラメータを使用する必要があります。host-name-or-IP-addressを使用しない場合、ストレージ アレイ名は必須です。Enterprise Management Windowで使用するように設定したストレージ アレイの名前(構成ファイルに定義されている名前)が、設定済みの他のストレージ アレイの名前と重複しないようにしてください。
-o スクリプト コマンドの実行で生成されるすべての出力テキストの保存先ファイル名を指定します。-oパラメータは以下のパラメータとともに使用します。
  • -c
  • -f

出力ファイルを指定しない場合、出力テキストは標準出力(stdout)に出力されます。このパラメータが設定されているかどうかに関係なく、スクリプト コマンド以外のコマンドからの出力はすべてstdoutに送信されます。

-p コマンドを実行するストレージ アレイのパスワードを定義します。以下の条件に該当する場合、パスワードは必要ありません。
  • ストレージ アレイにパスワードが設定されていない。
  • 実行するスクリプト ファイル内にパスワードが指定されている。
  • -cパラメータと次のコマンドを使用してパスワードを指定する。
set session password=password
-P

この引数には、次の2つの引数のどちらかが必要です。

  • password_file - 認証に使用するパスワードを含むファイルを指定します。
  • -(ダッシュ) - stdinからパスワードを取得します。

この引数は、クライアント タイプ(httpsまたはsymbol)に関係なく、すべてのコントローラで使用できます。

-q イベント通知を受信する頻度およびイベント通知で返される情報のタイプを指定します。重大イベントについては、最低でも基本的なイベント情報を含むEメール アラート通知が生成されます。

-qパラメータの有効な値は次のとおりです。

  • everyEvent – すべてのEメール アラート通知で情報が返されます。
  • 2 – 情報が返される頻度を2時間に1回以下に設定します。
  • 4 – 情報が返される頻度を4時間に1回以下に設定します。
  • 8 – 情報が返される頻度を8時間に1回以下に設定します。
  • 12 – 情報が返される頻度を12時間に1回以下に設定します。
  • 24 – 情報が返される頻度を24時間に1回以下に設定します。

-Iパラメータを使用すると、Eメール アラート通知で返される情報のタイプを指定できます。

  • -IパラメータをeventOnlyに設定した場合、-qパラメータに指定できる値はeveryEventのみです。
  • -IパラメータをprofileまたはsupportBundleに設定した場合、-qパラメータで指定した頻度で情報がEメールに含まれます。
-quick 単一行の処理に要する時間を短縮します。単一行の処理の例としては、recreate snapshot volumeコマンドがあります。このパラメータは、コマンドの実行中にバックグラウンド プロセスを実行しないことで時間を短縮します。

単一行の処理が複数含まれる処理には、このパラメータを使用しないでください。このコマンドを多用した場合、コントローラの処理能力を超える数のコマンドが実行されてオーバーランが発生し、処理が失敗する可能性があります。また、通常バックグラウンド プロセスから収集されるステータスおよび構成の更新をCLIで使用できなくなります。このパラメータを使用すると、バックグラウンド情報に依存する処理が失敗します。

-S(大文字) スクリプト コマンドの実行時に表示される、進捗状況を示す情報メッセージが表示されないようにします (このモードはサイレント モードとも呼ばれます)。このパラメータを使用すると、以下のメッセージが表示されなくなります。
  • Performing syntax check
  • Syntax check complete
  • Executing script
  • Script execution complete
  • SMcli completed successfully
-v -dパラメータとともに使用すると、構成ファイル内の既知のデバイスの現在のグローバル ステータスを表示します。
-w ストレージ アレイのWWIDを指定します。このパラメータは、-nパラメータの代わりに使用します。既知のストレージ アレイのWWIDを表示するには、-wパラメータを-dパラメータとともに使用します。ファイルの内容は次の形式になります。

storage-system-name world-wide-ID IP-address1 IP-address2

-X(大文字) ストレージ アレイを構成から削除します。
-? CLIコマンドの使用方法を表示します。