perfcli コマンドの -overview オプションを指定すると、コマンド・モードに関する情報が表示され、コマンド・フォーマット要件がリストされます。
コマンド・モード
管理コマンド行インターフェース (CLI) は、以下の 3 つのモードのうちのいずれかで使用できます。
- シングル・ショット・モード
- 単一のコマンドだけを実行する場合は、CLI プログラムとコマンドを指定して、シェル・プロンプトで実行します。例えば、次のようにします。
shell> perfcli settrace -devtype ess -dev ESS2105-123123-IBM -desc 『New
Task』 -sample 30 -interval 5 task_name return values
shell>
- 対話モード
- 複数のコマンドを実行する場合は、CLI プログラムを開始し、次にプログラム・プロンプトでコマンドを指定します。例えば、次のようにします。
shell> perfcli perfcli> setoutput -v on perfcli> setthresh -threshtype iorate -devtype ess -dev ESS2105-123123-
IBM
-status on
return values (verbose)
-
perfcli> exit
shell>
- スクリプト・モード
- ファイル内に定義したコマンド・セットを実行する場合は、CLI プログラムを開始し、コマンドを含むファイルを指定します。例えば、次のようにします。
shell> perfcli -script ~/bin/containersetup
shell>
 | 注: Multiple Device Manager (MDM) CLI は、最初のカラムにポンド記号 (#) が示されたコメントをサポートしており、そのコメントをインタープリットします。 |
コマンド出力
setoutput コマンドを使用して指定したフォーマット・オプションは、ファイル内のすべてのコマンドに適用されます。コマンドが正常に実行された場合の出力は標準出力に送られ、コマンドが失敗した場合の出力は標準エラー出力に送られます。いずれかのコマンドの実行中にエラーが発生すると、そのスクリプトは障害があった個所で終了し、システム・プロンプトに戻ります。
オブジェクト命名のガイドライン
有効なユーザー定義オブジェクトの名前に対する要件は、以下のとおりです。
- オブジェクト名には、少なくとも 1 つの英数字が含まれている必要があります。また、オブジェクト名の先頭文字は、英数字にする必要があります。
- オブジェクト名の先頭文字にダッシュ (-) を使用することはできません。また、ダッシュだけのオブジェクト名を指定することもできません (例えば、- というオブジェクト名を付けることはできません)。
- オブジェクト名の先頭文字に下線 (_) を使用することはできません。また、下線だけのオブジェクト名も指定できません (例えば、_ というオブジェクト名を付けることはできません)。
- オブジェクトに、ピリオド (.) またはコロン (:) という名前を付けることはできません。
- オブジェクト名に、空白文字は使用できません。
- ユーザー定義オブジェクトの名前の長さは、特に指定がない限り、250 文字以下です。
- ユーザー定義オブジェクトの名前は、ユーザーが入力したとおりのものである必要があり、翻訳または変更することはできません (ユーザー定義オブジェクトの名前は、大文字小文字の区別を保持している必要があります)。
ユーザー定義記述
有効なユーザー定義記述に対する要件は、以下のとおりです。
- 記述にスペースが含まれている場合は、その記述ストリングを (同じ) 単一または二重引用符記号で囲む必要があります。
- 同じ引用符ですでに囲まれている記述にアスタリスクが含まれている場合は、そのアスタリスクをエスケープする必要があります。
- ユーザー定義記述の長さは、256 文字以下です。ユーザー定義記述の先頭にスペースを使用することはできません。
- ユーザー定義記述は、翻訳またはその他の変更を行うことはできません (大文字小文字の区別を維持する必要があります)。
コマンド入力の変更
これらのコマンドは、コマンド入力を変更します。
- 『-f』 を使用すると、破壊的なアクションが強制的に行われます。例えば、LUN にすでにラベルがあっても、ボリュームが作成されます。確認メッセージとエラー・メッセージは表示されません。
- 『-quiet』 を使用すると、確認のプロンプトとメッセージは表示されません (すべての確認プロンプトには「『はい』」と応答されます)。
標準形式のパラメーター
標準形式のパラメーターは、管理 CLI におけるリスト・コマンド (ls で始まるコマンド) の出力形式を設定します。これらのパラメーターは、リスト・コマンド構文または setoutput コマンドのいずれかで使用することができます。形式設定は、セッションの期間中、またはリスト・コマンドでこれらのコマンドを指定するか、setoutput コマンドを使用してパラメーターをリセットするまで有効です。
- -p パラメーターは、一度に 1 ページのテキストを表示するか、一度に全テキストを表示するかを指定します。
- off パラメーターを指定すると、一度に全テキストが表示されます。perfcli コマンドがシングル・ショット・モードで実行している場合は、これがデフォルト値になります。
- on パラメーターを指定すると、一度に 1 ページのテキストが表示されます。なんらかのキーを押すと、次のページが表示されます。コマンドが対話モードで実行されている場合は、これがデフォルト値になります。
- -r number パラメーターは、-p パラメーターがオンになっている場合に、表示する 1 ページ当りの行数を指定します。デフォルトは 24 行です。1 - 100 の範囲の値を指定できます。
- -fmt パラメーターは、出力形式を指定します。次のいずれかの値を指定することができます。
- default パラメーターは、スペースを列の区切り文字として使用して、出力をテーブル形式で表示するよう指定します。これはデフォルト値です。
- delim character パラメーターは、指定した文字で列を区切って、出力をテーブル形式で表示するよう指定します。シェルのメタキャラクターを区切り文字として使用する場合は、この文字を単一引用符または二重引用符で囲んでください。ブランク・スペースは有効な文字ではありません。
- xml パラメーターは、出力を XML 形式で表示するよう指定します。
- -hdr パラメーターは、テーブル見出しを表示するかどうかを指定します。テーブル見出しを表示する場合は、on パラメーターを使用します。これはデフォルト値です。テーブル見出しを非表示にする場合は、off パラメーターを使用します。
- -v パラメーターは、冗長モードを使用可能にするかどうかを指定します。冗長モードを使用不可にする場合は、off パラメーターを使用します。これはデフォルト値です。冗長モードを使用可能にする場合は、on パラメーターを使用します。
標準のリスト・パラメーター
標準のリスト・パラメーターは、管理 CLI リスト・コマンドの出力を、デフォルト出力、長い出力、短い出力のいずれで表示するのかを指定します。リスト・コマンドで使用可能な標準パラメーター以外に、これらのパラメーターも指定することができます。リスト・パラメーターを指定しない場合は、次の例のように、すべてのオブジェクトと最も重要な列情報が、デフォルトのリストとして表示されます。
Name User Role Authorization
=====================================
JohnDoe Admin Current
MaryBlack Backup Not Current
JimSmith Operator Current
TomJones Monitor Not Current
構文図
構文図を読むには、ラインで示されるパスをたどっていきます。左から右に、そして上から下へと読みます。
- 主要なパスのラインは、2 つの矢印 (>>) が付いた左側から開始し、向き合う 2 つの矢印 (><) が付いた右側で終了します。
- 図が 1 行より長い場合は、継続される行ごとに単一矢印 (>) で終了し、新しい行は単一矢印で開始されます。
- ダッシュ (-) は、パラメーターを入力するのではなく、標準入力からパラメーターを提供することを示しています。
- 左に戻る矢印は、当該項目を繰り返すことができることを示しています。
- 矢印内の 1 文字または 1 つのスペースは、その文字またはスペースを使って、繰り返される項目を区切る必要があることを示しています。
- 項目のスタックの後に左に戻る矢印が続く場合は、複数の項目を選択できること、または場合によっては、単一の項目を繰り返すことができることを示しています。
- 長いグループ、または 1 つのコマンドで複数回使用されるセクションを含むコマンドは、メインの構文図に続く独立したフラグメントとして表示されます。
フラグメント名は、構文図では垂直バーに囲まれて表示されます。展開されたフラグメント名も、同一のフラグメント
名を持つ見出しの後に、垂直バーに囲まれて表示されます。
- イタリック体の小文字のエレメントは変数を示しています。
構文図では、以下で説明しているように位置を使用して、キーワード、変数、およびオペランドの必須値、オプション値、およびデフォルト値を示します。
- ライン上 (必須値)
- ラインよりも上 (デフォルト・エレメント)
- ラインよりも下 (オプション・エレメント)
- デフォルト値は、メイン・ラインよりも上に表示されます。デフォルトがキーワードの場合は、メイン・ラインの上にのみ表示されます。この項目は指定することも、デフォルトにすることもできます。次の例では、キーワード A がデフォルトです。B または C を選択して、このキーワードを指定変更することができます。また、デフォルト値を明示的に指定することもできます。
- オペランドの値がデフォルト値の場合は、そのオペランドはメイン・ラインよりも上および下の両方に表示されます。メイン・ラインよりも下の値は、オペランドを指定する場合には、デフォルト値または表示されている別の値のいずれかを指定することも必要であることを示しています。オペランドを指定しない場合は、
メイン・ラインよりも上のデフォルト値が使用されます。
- 1 つ以上の項目がメイン・ラインよりも下にある場合は、すべての項目はオプションです。
- キーワード、変数、またはオペランドがメイン・ライン上に表示される場合は、その項目を指定する必要があります。
- 複数の項目が積み重ねられており、それらのうちの 1 つがメイン・ライン上にある場合は、ライン上の項目を指定する必要があります。
確認プロンプト
コマンドを実行することにより、リカバリー不能な操作、データの損失、メモリー・ドレーン、長時間のタスク、並行操作に対する影響などが発生する可能性がある場合、特定のアクションを継続するかどうかを尋ねる対話式確認プロンプトが表示されます (「xxx を実行しますか? Y/N (Are you sure you want
to xxx? Y/N.)」など)。すべての確認プロンプトは、入力として YES、yes、Y、y、または NO、no、N、n を受け付けます。
コマンドのユーザー・アシスタンス
help コマンドまたは command-help パラメーターを使用すると、管理 CLI で使用可能なコマンドのユーザー・アシスタンスを得ることができます。help コマンドを使用すると、使用可能なコマンドのリストが表示されます。
各コマンドでサポートされている command-help パラメーターを使用すると、指定したコマンドの詳細な説明を表示することができます。以下の help パラメーターを使用できます。
-?
-h
-help
 | 注: help パラメーターを使用した場合は、他のすべてのパラメーターは無視されます。 |
(C) Copyright International Business Machines Corporation 2004