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

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

定義済みパラメータには一文字だけの名前 (a、f、 oなど) を持つものがありますが、これらは間違いではなく正しいパラメータ名です。

-b

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

-h

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

-l

このフラグの名前は小文字の l (ASCII 文字 0x6c) で、数字の 1 (ASCII 文字 0x31) ではありません。セッションモードの拡張コマンドパラメータとしてこのフラグが使用される場合、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]+)。

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

i

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

more=off serverHost=myserver a=myagent:161

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

i=/home/examples/myParams

log

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

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

m

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

m=kernel-reader

more

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

more=on

o

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

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

o=/home/examples/sunmc-output

serverHost

serverHost パラメータの値は、ログイン時に CLI が接続するサーバホストを定義します。このグローバルパラメータは、CLI がサーバに接続されると変更することはできません。

serverPort

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

t

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