CLI パラメータ

ほとんどの CLI パラメータは、名前と値のペアとなっています。すなわち、名前と値を 1 つずつとります。ただし、ごく一部のパラメータ は名前のみで値がありません 。これらのパラメータはフラグとして知られています。

パラメータの範囲

パラメータ値は、CLI セッションのいくつかの時点で指定できます。

• CLI 起動時 – CLI の起動時に、UNIX コマンド行のパラメータを指定できます。 起動時に指定されたパラメータは、セッションに対してグローバルです。グローバルパラメータの値は、 set コマンドが優先するか、unset コマンドで現在のセッションから削除されないかぎり、維持されます。

• CLI コマンド – セッション中に実行する CLI コマンドごとにパラメータを指定することができます。コマンドの一部として指定された値が、そのコマンドの実行中だけ一時的にグローバルパラメータの値を優先します。

• 入力ファイル – パラメータの定義を外部ファイルに格納して、CLI セッションのどの時点でも呼び出せるようにできます。グローバルパラメータと個々のコマンドパラメータが、外部ファイルで定義されたパラメータ値を優先します。

パラメータ構文

パラメータは name= value のペアで定義されます。

file=/home/examples/example1

ここでは、file がパラメータ name、/home/examples/example1 がパラメータ value です。等号 (=) とパラメータ名または等号とパラメータ値の間には空白文字を入れてはいけません。空白文字 (スペース、タブ記号) が含まれていると、その値は二重引用符 (ASCII 文字 0x22) で囲まれます。

moduleDesc="Local File Scanning"

複数のパラメータ値はコンマ区切りで併記できますが、次の例に示すように、値と値の間に空白文字を入れることはできません。

severity=DIS,DWN,ERR

パラメータリストは、空白文字で区切られた一連のパラメータです。

m=kernel-reader moduleDesc="My Kernel Reader"

正しいパラメータ構文と不正なパラメータ構文の例

次は正しいパラメータ構文です。

ok1="This is just a test"
ok2=hello
ok3=hello,hi,aloha
ok4="hello,hi,aloha"

次は不正なパラメータ構文です。

broken1="How are you?","Who are you?"
broken2="Testing",1,2,3
broken3="Hello
broken4=Hello"

パラメータの入力ファイル形式

パラメータは、ファイルに格納し、必要に応じて読み込むことができます。パラメータファイルは必要な数だけ作成できます。また組み込み式の i パラメータを使用して、パラメータ入力ファイルの名前を指定することも可能です。

定義済みのパラメータとフラグ

ここでは、CLI 内で事前に定義されているパラメータについて説明します。

定義済みパラメータには、名前が一文字だけのものがあります。たとえば、a、f、 o などです。

-b

CLI 起動時にこのフラグが UNIX コマンド行に含まれている場合、CLI はバッチモードで起動します。このフラグはセッションモードでは無視されます。

-h

セッションモードでコマンドパラメータとしてこのフラグが使用された場合、CLI はそのコマンドのヘルプテキストを表示します。

-l

セッションモードで拡張コマンドのパラメータとしてこのフラグが使用された場合、CLI は、現在のコマンドを実行している間、最後に実行された拡張コマンドのすべてのパラメータを保持します。-l フラグを指定すると、現在のコマンドに対するパラメータはすべて無視されますが、基本コマンドへの影響はありません。次に、-lフラグの使用例を示します。

> getLoadModules a=myHostName ... ... > getAlarms -l

getAlarms コマンドは、以前に実行された getLoadModules コマンドのパラメータ値 a (myHostName) を使用して実行します。

a

a パラメータの値は、エージェントホスト名とポート番号 (省略可能) で指定されたエージェントです。ポート番号を指定する場合は、番号とホスト名をコロン (:) で区切ります。一般構文は a=agentHost[: agentPort] です。たとえば、ホスト example_host 上で動作して、ポート 12345 で待機するエージェントを指定する場合は、次の構文を使用します。

a=example_host:12345

a パラメータの値は、複数のエージェントをコンマ区切りで併記することもできます。例: a=agent[,agent]*.

about

about パラメータは、 help コマンドで使用します。このパラメータは、CLI のバージョン情報を表示します。

append

append パラメータの値は、コマンド出力の付加先のファイル名です。 ファイルが存在しない場合は、新たに作成されますappend パラメータをグローバルに設定すると、このセッションのコマンド出力はすべて指定ファイルの後ろに追加されます。また、このパラメータを特定コマンドに設定することも可能です。

append=/home/examples/cli_output

append パラメータおよび o パラメータの両方を設定すると、append が o に優先します。 この場合、コマンド結果のみが特定ファイルに記録され、実行中のコマンドは記録されません。コマンド情報を記録する場合は、log パラメータを使用してください。

columns

columns パラメータの値は、print コマンドで表示されるコマンド出力の 1 つまたは複数の列の名前です。列名は大文字と小文字が区別されます。また、複数の場合は名前と名前の間をコンマで区切ります。次の例は、複数の列名を記述した例です。

columns="Alarm Id,Node URL,Target Host,Severity"

f

f パラメータの値は、コマンド出力形式を定義します。 現在使用できる形式は plain および html です。詳細は、「コマンド出力形式」 を参照してください。HTML 形式に設定する場合は、次の構文を使用します。

f=html

height

height パラメータの値は、画面に表示するコマンド出力の行数です。次の例は、標準的な端末画面とほぼ同じ高さに height パラメータを設定しています。

height=24

history

history パラメータの値は、コマンド履歴に保持するコマンド数です。コマンド履歴により、以前に実行したコマンドを表示することができます。このパラメータは、set コマンドによって使用されます。

history=10

i

i パラメータの値は、現在のセッションに含まれるパラメータ定義の入力ファイル名です。入力ファイル内では、各行に 1 つのパラメータが定義されます。たとえば、/home/examples/myParams ファイルに次の行があると仮定します。

more=off serverHost=myserver a=myagent:161

次の行を使用することによって、これらのパラメータを現在の CLI セッションに含めることができます。

i=/home/examples/myParams

log

log パラメータの値は、すべての CLI コマンドとコマンドの実行時間を記録するファイル名です。ただし、ログファイルはコマンド名と実行時間だけしか記録しません。コマンド出力は、a パラメータまたは o パラメータで指定したファイルに記録されます。いったんパラメータを設定すると、後続のコマンドがすべてファイルの後ろに付加されます。ファイルが存在しない場合は、新たに作成されますロギングを開始するとログファイルは上書きされないため、別のログが必要なときは必ず別のファイルを指定してください。ロギングを停止する場合は、log パラメータを付けて unset コマンドを使用します。次の例は、ログを開始したあとにログを中止します。

> log=/home/examples/sunmc-log ... ... > unset log

logmode

logmode パラメータの値は、 detailed、command、または from n のいずれかです。detailed 値は、コマンドログファイルにコマンドの詳細情報を書き込みます。command 値は、コマンドログファイルにコマンドとそのパラメータのみ書き込みます。from n 値は、コマンド履歴の、n 番目のエントリ以降のすべてのエントリをコマンドログファイルに付加します。logmode パラメータのデフォルト値は detailed です。

m

m パラメータの値は、Sun Management Center のモジュール名です。モジュールが複数ある場合は、コンマ区切りで併記することもできます。

m=kernel-reader

more

more パラメータの値は、コマンド出力画面のページングを制御します。使用できる値は on と off です。more を on に設定すると、端末への出力が一度に 1 画面ずつ表示されます。画面のサイズは、height パラメータと width パラメータで定義します。デフォルト値は、バッチモードでは off、セッションモードでは on です。

more=on

ncols

ncols パラメータの値は、print コマンドが表示するコマンド出力の最大列数です。

o

o パラメータの値は、コマンド出力の書き込み先ファイル名です。すでにこのファイルが存在する場合は、上書きされます。ユーザーは、o パラメータを特定のコマンドに指定して、そのコマンドの出力を取り込むことができます。また、このパラメータを set コマンドでグローバルに設定して、出力をすべてファイルに書き込むこともできます。

append パラメータおよび o パラメータの両方を設定すると、append が o に優先し、出力は、指定されたファイルに付加されます。この場合、コマンド出力だけがファイルに書き込まれ、実行中のコマンドは記録されません。コマンド情報を記録する場合は、log パラメータを使用してください。次の例では、コマンド出力の書き込み先ファイルを定義します。

o=/home/examples/sunmc-output

prompt

prompt パラメータは、CLI プロンプトを変更するときに使用します。

serverPort

serverPort パラメータの値は、ログイン用のサーバーポートです。このグローバルパラメータは、ログインセッションの確立後には設定できません。このパラメータが設定されない場合は、デフォルトポート 2099 が使用されます。

style

style パラメータの値は、コマンド出力形式を定義します。このパラメータに指定できる値は、table、list、および <custom> です。 table 値は、表形式で出力を表示します。list 値は、コンマ区切りの列からなる一覧形式で出力を表示します。 <custom> 値は、出力をユーザー定義の形式で表示するために使用します。各列は %a で表します。custom 値には、 \t や \n などの特殊文字を使用できます。

t

t パラメータの値は、トポロジエージェントで管理されるオブジェクト (ドメイン、表示グループ、エンティティーなど) の名前です。オブジェクト名には、ドメインから始まる完全修飾名を使用します (例: /domain/group/host)。