test

Sun Management Center 3.6.1 ユーザーガイド

第 20 章 コマンド行インタフェースの使用

Sun Management Center のコマンド行インタフェース (CLI) は、Java コンソールや Web コンソールのグラフィカルインタフェースに代わってシステムの監視と管理を行なう、文字方式の軽量コンソールです。

この章の内容は次のとおりです。

Sun Management Center CLI の概要

Sun Management Center のコマンド行インタフェース (CLI) は、システムの監視と管理を行う文字方式のコンソールアプリケーションです。次の有用な機能があります。

CLI で実行可能なタスクは、次のとおりです。

注 –

(Solaris および Linux) パラメータファイルを使用してコンソールに自動的にログインできます。パラメータファイルにユーザー名とパスワードが含まれる場合、そのファイルのアクセス権は 400 である必要があります。そうでない場合、CLI からの自動ログインは行えません。

システム要件

CLI へは、次のいずれかのシステム構成のユーザー端末セッションからアクセスできます。

CLI の対話モード

CLI は、次の2つの対話モードをサポートしています。

CLI バッチモードの設定

CLI バッチモードは、/opt/SUNWsymon/cli にある cli.properties ファイルを編集することによって設定できます。このファイルには、設定可能なパラメータが 9 つ含まれています。

表 20–1 は、これらの設定可能なパラメータの説明です。

表 20–1 CLI バッチモードを設定するためのパラメータ

パラメータ 

説明 

デフォルト値 

process_time_out

この時間を過ぎると、CLI バックエンドプロセスがシステムから削除されます。 

プロセスタイムアウト (24 時間)

process_time_out = 86400 (秒単位)

uds_dgram_wait_time

DGRAM クライアントは、CLI バックエンドプロセスからの応答を待ちます。指定時間内に応答がなかった場合は、「Error receiving data from Backend」というエラーメッセージが表示されます。 

UDS DGRAM 待ち時間 (秒単位)

uds_dgram_wait_time = 300

uds_stream_wait_time

STREAM クライアントは、CLI バックエンドプロセスからの応答を待ちます。指定時間内に応答がなかった場合は、「Error receiving data from Backend」というエラーメッセージが表示されます。 

UDS STREAM 待ち時間 (秒単位)

uds_stream_wait_time = 180

out_file

現在動作中の CLI バックエンドプロセスの詳細情報が含まれるファイルへのパス。このファイルの形式は次のとおりです。 

<user>:<hostname>:<C Process ID>:<Java Process ID>

ユーザーおよびプロセス情報ファイル

out_file = /var/opt/SUNWsymon/cli/process-file

socket_pathclnt

クライアントのブローカ UDS ファイルへのパス。処理された CLI コマンドの出力は、このファイルに送られます。 

UDS ファイルへのパス

socket_pathclnt = /var/opt/SUNWsymon/cli/broker_uds_client_file

cli_log_path

CLI ログファイルへのパス。 

CLI ログファイルの場所

cli_log_path = /tmp/sunmclog/cli

cli_log_file

CLI ログファイルの名前。 

バックエンド (ブローカ) ログファイルの場所

cli_log_file = /tmp/sunmclog/cli/cli-batch-mode-log

uds_file_path

STREAM および DGRAM UDS ファイルの場所。 

UDS ファイルの場所

uds_file_path = /var/opt/SUNWsymon/cli/

log_level

使用するログレベルを指定します。本稼働環境の場合は ERROR、デバッグ環境の場合は INFO に設定してください。

バッチモードのログレベル [options : INFO|ERROR]

log_level=ERROR

CLI コマンドとパラメータの概要

ここでは、CLI コマンドとパラメータの概要について説明します。

CLI コマンドの概要

CLIコマンドは、「基本」コマンドと「拡張」コマンドの 2 種類に分けられます。

セッションモードは、フォアグラウンドでもバックグラウンドでもコマンドを実行することができます。

CLI はエイリアスもサポートしています。そのため、より複雑なコマンドやパラメータに省略語や仮名を定義することができます。ユーザー定義のエイリアスは、さまざまな CLI セッションで使用できます。

CLI パラメータの概要

CLI パラメータは、名前と値のペアです。すなわち、名前と値を 1 つずつとります。一部のパラメータは CLI 内に最初から組み込まれており、名前と値も事前に定義されています。その他のパラメータ (変数) は、ユーザーが定義できます。パラメータのなかには有効範囲がグローバルなものがあります。このグローバルパラメータは、特定のセッションにおける CLI コマンドの実行を制御します。これ以外のパラメータは、特定コマンドやコマンドグループに固有です。

入力機能と出力機能

CLI は、いくつかの入力機能と出力機能を提供します。

CLI コマンドヘルプ

CLI では、CLI コマンドごとにオンラインヘルプが提供されます。CLI 内から直接ヘルプにアクセスすることができ、GUI は必要ありません。すべてのコマンドについて、その使用方法や関連パラメータリストを表示することができます。

CLI パラメータ

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

パラメータの範囲

パラメータ値は、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)。

CLI コマンド

コマンドの種類と概念の概要は、「CLI コマンドとパラメータの概要」を参照してください。基本 CLI コマンドが使用するパラメータの詳細は、「定義済みのパラメータとフラグ」を参照してください。

CLI の基本コマンド

ここでは、基本 CLI コマンドを一覧にまとめています

alias

説明

alias コマンドを使用して、頻繁に使用するコマンドや複雑なパラメータを持つコマンドのエイリアスを作成することができます。エイリアスには、既存の CLI コマンドと同じ名前は指定できません。また、エイリアスの定義に空白文字が含まれる場合は、二重引用符 (", ASCII 文字 0x22) で囲まれます。

CLI セッションを終了すると、ユーザーが指定したエイリアスは、aliases ディレクトリ内のファイルに保存されます。それらエイリアスは、CLI セッションにログインすると使用できるようになります。

構文

alias [<pseudonym>="command [parameters]"]

例 


> alias assign=set
> alias alarms="getAlarms severity=dwn"

引数を付けずに呼び出された場合、alias コマンドは定義済みのエイリアスとその値の一覧を表示します。次の例は、引数を指定しないで alias コマンドを呼び出した場合の結果を示しています。


> alias
assign - set
alarms - getAlarms severity=dwn
attrib

説明

attrib コマンドは、トポロジオブジェクトの属性を読み出します。

構文

attrib [group=groupName [name=attribName] [-key]]

browse

説明

browse コマンドは、トポロジをブラウズモードにします。

構文

browse

cd

説明

cd コマンドは、現在のトポロジパスを変更します。パスが指定されなかった場合は、現在のパスにデフォルトドメインが設定されます。数値 (n) が指定された場合は、list コマンドで示される順序で n 番目の子パスが現在のパスに設定されます。

構文

cd [path|number]

clear

説明

clear コマンドは、現在のセッション中に設定されたすべてのパラメータを削除します。ただし、コマンド行から設定されたパラメータは削除しません。このコマンドは unset コマンドと似ていますが、パラメータ名を引数として指定する必要はありません。

構文

clear

data

説明

data コマンドは、トポロジオブジェクトの詳細を表示します。数値 (n) が指定された場合は、list コマンドで示される順序で n 番目の子パスに現在のパスが設定されます。

構文

data [path|number|-key]

end

説明

end コマンドは、トポロジのブラウズモードを解除します。

構文

end

exit

説明

exit コマンドは、サーバーとの接続を切断して CLI セッションを終了します。

構文

exit [-onError]

パラメータ

onError

onError パラメータは、以前のコマンドの実行で例外が発生した場合に CLI セッションを終了する指定です。このパラメータはバッチモードでのみ使用します。

注 –

exit コマンドと quit コマンドは同じです。

goto

説明

goto コマンドは、大文字と小文字が区別されるパターンに一致するトポロジパスに移動します。複数のパスが見つかった場合は、パスを選択するよう求められます。

構文

goto <pattern>

help

説明

help コマンドは、CLI コマンドとそのパラメータ情報を表示します。ヘルプ情報は、ビットマップ以外の形式の端末画面での表示に適しています。 help を引数なしに実行すると、使用可能な CLI コマンドとその概略が、基本コマンドの次に拡張コマンドの順番で、アルファベット順に一覧表示されます。

構文

help [-e][-h] [<command>|about|legal]

パラメータ

-e、-h、 command、about、および legal

-e は、拡張モードでヘルプテキストを表示します。次の形式もサポートされています。<command> -e.

-h は、通常モードでヘルプテキストを表示します。次の形式もサポートされています。<command> -h.

command は、そのコマンド固有の情報を表示します。

about は、CLI のバージョン情報を表示します。

legal は、CLI のライセンス条項を表示します。

例

次は、getAlarms コマンドのヘルプ例です。


> help getAlarms
getAlarms [a=host[,host]+] [alarm_filter_list]
 - Get alarm information on an agent or a list of agents under a
set of filter conditions. If no agent is provided, all alarms will
be obtained. All the filter conditions are "ANDED" to provide the
result. The filter conditions as specified in alarm_filter_list
comprises:
  domain=domain and/or
  m=module[+instance] and/or
  managed_object=managed_object and/or
  property=property and/or
  property_instance=property_instance and/or
  qualifier=qualifier and/or
  severity=[DIS,DWN,ERR,OFF,INF,IRR,WRN] and/or
  state=[C,F,O] and/or
  ack=[A,N]
history

説明

history コマンドは、CLI セッションで以前に入力されたコマンドを表示または実行します。履歴が以前に作成されていて、引数を付けずに history コマンドを呼び出すと、以前に入力されたすべてのコマンドが表示されます。履歴が以前に作成されていて、数値引数を付けて history コマンドが呼び出された場合は、その引数に一致するコマンドが実行されます。

構文

history [num]

kill

説明

kill コマンドは、バックグラウンドで起動しているコマンドをすべて終了します。

構文

kill

list

説明

list コマンドは、パス下のオブジェクトを一覧表示します。数値 (n) が指定された場合は、このコマンドの示す順番で n 番目の子パスにパスが設定されます。

構文

list [path|number]

locate

説明

locate コマンドは、指定されたパターンに一致するすべてのトポロジパスを検索します。パターンは大文字と小文字が区別されます。

構文

locate <pattern>

login

説明

login コマンドは、Sun Management Center サーバーとの接続を確立します。引数として serverHost と serverPort (省略可能) パラメータを指定できます。ホストが指定されていないと、ホストのプロンプトが表示されます。ポートが指定されなかった場合は、2099 が使用されます。login コマンドは、ユーザー名とパスワードのプロンプトも表示します。

構文

login [serverHost=host] [serverPort=portNumber] [user=userName] [password=userPassword]

パラメータ

serverHost、serverPort、 user、password

logout

説明

logout コマンドは、Sun Management Center サーバーとの接続を切断します。ただし、CLI セッションは終了しません。

構文

logout

print

説明

print コマンドは、最後の拡張コマンドの出力を、指定された出力形式で指定された出力先に送信します。デフォルトでは、出力は端末画面にプレーンテキスト形式で送信します。パラメータの append または o が設定された場合、出力は、そのパラメータによって指定されたファイルにリダイレクトされ、画面には表示されません。ncols が指定されなかった場合、デフォルト列数は 4 に設定されます。

注 –

print コマンドは、コマンド履歴に保存されません。

構文

print [f=plain|xml|html] [style=table|list|<custom>] [columns= columnList] [ncols=num] [o=outputFile | append=appendFile]

パラメータ

f、style、columns、 ncols、o、append

quit

説明

quit コマンドは、サーバーとの接続を切断して CLI セッションを終了します。

注 –

quit コマンドと exit コマンドは同じです。

構文

quit

reset

説明

reset コマンドは、コマンド行に指定されたすべてのパラメータ値を、CLI セッションの起動時に指定された値に復元します。ただし、セッション中に定義されたがコマンド行に指定されなかったパラメータは、そのまま変わりません。コマンド行に指定したパラメータの名前を引数として reset に使用すると、そのパラメータの値は初期値に復元されます。それ以外の場合、パラメータ値は変わりません。

注 –

reset は、コマンド履歴に保存されません。

構文

reset [<parameter>]*

set

説明

set コマンドでは、パラメータ値を指定したり、表示したりできます。set コマンドで指定されたパラメータは、現在のセッションに対してグローバルになります。グローバルコマンドは、このセッションの全コマンドに使用することができます。また引数なしで set を実行すると、現在のセッション中に定義したすべてのパラメータ値が表示されます。パラメータを引数として指定して set を実行すると、そのパラメータの値が表示されます。

構文

set [<parameter>[=value]]* [height=num] [history=num] [log=file] [logmode=detailed|command|"from n"] [more=on|off] [prompt=prompt]

例

このコマンドで可能な 3 通りの記述例を次に示します。


> set height=10
> set
height=10
> set height
height=10
status

説明

status コマンドは、バックグラウンドで実行されている全コマンドの状態を表示します。

構文

status

unalias

説明

unalias コマンドは、引数として指定されたエイリアスを削除します。

構文

unalias [<pseudonym>]*

unset

説明

unset コマンドは、現在のセッションから指定されたパラメータを削除します。

構文

unset [<parameter>]*

注 –

unset コマンドは、コマンド履歴に保存されません。

where

説明

where コマンドは、現在のトポロジパスを表示します。

構文

where

CLI の拡張コマンド

次の各節では、CLI で使用可能な各種拡張コマンドについて説明します。

モジュール拡張コマンド

モジュールを管理するための拡張コマンドは 7 つあります。

モジュールコマンドのパラメータ

モジュールコマンドが使用するパラメータを次に示します。a および m パラメータの詳細は、「定義済みのパラメータとフラグ」を参照してください。

moduleName

モジュールの国際化名

moduleDesc

モジュールの説明テキスト

moduleParams

モジュールパラメータのコンマ区切りのリスト

-default

モジュールのデフォルト設定

モジュールコマンド

disableModule

説明

エージェント内の 1 つ以上のモジュールを使用不可にします。

構文

disableModule a=host[:port][,host[:port]]* m=module[+instance][,module[+instance]]*

パラメータ

a 、m

enableModule

説明

エージェント内の 1 つ以上のモジュールを使用可能にします。

構文

enableModule a=host[:port][,host[:port]]* m=module[+instance][,module[+instance]]*

パラメータ

a 、m

getLoadedModules

説明

エージェントに読み込まれているモジュールのリストを取得します。

構文

getLoadedModules a=host[:port][,host[:port]]*

パラメータ

a

getModule

説明

エージェント内の特定のモジュールの情報を取得します。

構文

getModule a=host[:port][,host[:port]]* m=module[+instance]

パラメータ

a 、m

getModules

説明

エージェントで使用可能なモジュールのリストを取得します。

構文

getModules a=host[:port][,host[:port]]*

パラメータ

a

loadModule

説明

エージェントにモジュールを読み込みます。

構文

loadModule a=host[:port][,host[:port]]* m=module[+instance] [moduleName= name] [moduleDesc=description] [moduleParams= key=value[,key=value]*] [-default]

パラメータ

a、m、moduleName、 moduleDesc、moduleParams、-default 。

unloadModule

説明

エージェントから 1 つ以上のモジュールを読み込み解除します。

構文

unloadModule a=host[:port][,host[:port]]* m=module[+instance][,module[+instance]]*

パラメータ

a 、m

モジュールコマンド例

たとえば agentHost 名が seattle のホストに読み込むモジュールを決定するには、CLI プロンプトで次のコマンドを入力します。


> getLoadedModules a=seattle

ポート 1776 のホスト seattle で kernel-reader モジュールを読み込むには、次のコマンドを入力します。


> loadModule a=seattle:1776 m=kernel-reader

オブジェクト属性拡張コマンド

CLI には、オブジェクト属性と属性値を管理する 4 つの拡張コマンドが用意されています。

オブジェクト属性コマンドのパラメータ

オブジェクト属性コマンドには、次のパラメータを使用できます。a および m パラメータの詳細は、「定義済みのパラメータとフラグ」を参照してください。

mgtObj

mgtObj パラメータの値は、属性とプロパティーを設定する、または読み出す管理オブジェクトの名前です。

property

property パラメータの値は、属性とプロパティーを設定する、または読み出すプロパティーの名前です。

propInst

propInst パラメータの値は、属性とプロパティーを設定する、または読み出すプロパティーのインスタンスの名前です。

rowValues

rowValues パラメータの値は、名前と値のペアからなる、コンマ区切りのリストです。name は行の列名、value はその列の値です。

attribute

attribute パラメータの値は、属性とプロパティーを設定する、または読み出すプロパティーに属する属性名からなる、コンマ区切りのリストです。このパラメータを setAttributes コマンドで使用する場合、attribute パラメータの各属性名は該当する value パラメータの値でなければなりません。

value

value パラメータの値は、attribute パラメータで指定された属性に対応する値からなる、コンマ区切りのリストです。このパラメータを setAttributes コマンドで使用する場合は、各属性ごとに値を指定する必要があります。

オブジェクト属性コマンド

次のコマンドを使用して、オブジェクト属性および属性値を設定、読み出すことができます。

addRow

説明

addRow コマンドは、指定された値を持つ行をテーブルに追加します。

構文

addRow a=host[:port][,host[:port]]* m=module[+instance] mgtObj=managedObject [property=property] [propInst=propertyInstance] rowValues=name=value[,name=value]

パラメータ

a、m、mgtObj、 property、propInst、rowValues。

delRow

説明

delRow は、指定された値を持つ行をテーブルから削除します。

構文

delRow a=host[:port][,host[:port]]* m=module[+instance] mgtObj=managedObject [property=property] [propInst=propertyInstance] rowValues=name=value[,name=value]

パラメータ

a、m、mgtObj、 property、propInst、rowValues。

getAttributes

説明

getAttributes コマンドは、1 つまたは複数のエージェントからプロパティーの情報を読み出すか、指定された属性を読み出します。

構文

getAttributes a=host[:port][,host[:port]]* m=module[+instance] mgtObj=managedObject property=property [propInst=propertyInstance] [attribute=attribute[,attribute]*]

パラメータ

a、m、mgtObj、 property、 propInst、attribute。

setAttributes

説明

setAttributes コマンドは、1 つ以上のエージェント内にプロパティーを設定するか、指定された属性に値を割り当てます。指定した属性の値を null に再設定することもできます。

構文

setAttributes a=host[:port][,host[:port]]* m=module[+instance] mgtObj=managedObject property=property [propInst=propertyInstance] [attribute=attribute[,attribute]*] value=value[,value]*

パラメータ

a、m、mgtObj、 property、 propInst、attribute、value。

attribute パラメータで指定した属性には、それぞれ該当する value パラメータの値が必要です。

オブジェクト属性コマンド例

次のコマンドは、ポート 1161 のホスト haiku に設定された agent-stats モジュールの totalstats 管理オブジェクトの size プロパティーに対応する属性をすべて読み出します。


> getAttributes a=haiku:1161 m=agent-stats mgtObj=totalstats \
property=size

次のコマンドは、上記の例で指定された size プロパティーの属性 alarmlimits.error-gt を値 2 に設定します。


> setAttributes a=haiku:1161 m=agent-stats mgtObj=totalstats \
property=size attribute=alarmlimits.error-gt value=2

次のコマンドは、rowValues で指定された行を、mgtObj で指定された管理オブジェクトから削除します。


> delRow a=haiku:1161 \
m=filemon mgtObj=filemonstats/filemonTable/filemonEntry \
rowValues="name=test,desc=this,filename=/etc/passwd"

アラーム拡張コマンド

CLI には、アラームを管理するための拡張コマンドが 5 つあります。

アラームコマンドパラメータ

アラーム拡張コマンドでは、次のパラメータを使用できます。a および m パラメータの詳細は、「定義済みのパラメータとフラグ」を参照してください。

ack

ack パラメータの値は、管理アラームが肯定応答されたかどうかを示す値をコンマ区切りで併記します。使用可能な値は ACK (肯定応答) と NOACK (未確認) です。

command

command パラメータの値は、実行するアラーム処理です。

domain

domain パラメータの値は、アラーム監視の対象となる Sun Management Center のドメイン名です。指定ドメインがない場合は、デフォルトドメインが使用されます。

mgtObj

mgtObj パラメータの値は、アラーム監視の対象となる管理オブジェクト名です。

note

note パラメータの値は、実行するコマンドに対するテキスト注釈です。

property

property パラメータの値は、アラーム監視の対象となるプロパティー名です。

propInst

propInst パラメータの値は、アラーム監視の対象となるプロパティーのインスタンス名です。

qualifier

qualifier パラメータの値は、アラーム監視の対象となる管理プロパティーに関連した修飾詞名です。

severity

severity パラメータの値は、監視されたアラームの重大度をコンマ区切りで併記します。次に、severity パラメータで使用可能な値を示します。

  • ERR — エラー

  • WRN — 警告

  • INF — 情報

  • IRR — 不合理

  • DWN — 停止

  • DIS — 使用不可

  • OFF — オフ

state

state パラメータの値は、監視されたアラームの状態値をコンマ区切りで併記します。state パラメータの有効な値は、Open、Closed 、Fixed です。

アラームコマンド

次のコマンドを使用して、アラーム値を確認したり、アラーム処理を設定したりできます。

ackAlarms

説明

ackAlarms コマンドは、1 つ以上のエージェント内のアラームに肯定応答します。

構文

ackAlarms a=host[:port][,host[:port]]* [domain=domain] [m=module[+instance][mgtObj=managedObject [property=property [propInst=propertyInstance] [qualifier=qualifier]]]] [severity=DIS|DWN|ERR|INF|IRR|OFF|WRN] [state=OPEN|CLOSED|FIXED] [note=reason]

パラメータ

a、domain、m、 mgtObj、property、propInst、 qualifier、severity、state、note。

state パラメータ値の指定がない場合、state はデフォルトで Open になります。

delAlarms

説明

delAlarms コマンドは、1 つ以上のエージェントのアラームを削除します。

構文

delAlarms a=host[:port][,host[:port]]* [domain=domain] [m=module[+instance][mgtObj=managedObject [property=property [propInst=propertyInstance] [qualifier=qualifier]]]] [severity=DIS|DWN|ERR|INF|IRR|OFF|WRN] [state=OPEN|CLOSED|FIXED] [ack=ACK|NOACK] [note=reason]

パラメータ

a、domain、m、 mgtObj、property、propInst、 qualifier、severity、state、 ack、note。

state パラメータ値の指定がない場合、state はデフォルトで Closed になります。

getAlarms

説明

getAlarms コマンドは、1 つ以上のエージェントのアラーム情報を読み出します。

構文

getAlarms a=host[:port][,host[:port]]* [domain=domain] [m=module[+instance][mgtObj=managedObject [property=property [propInst=propertyInstance] [qualifier=qualifier]]]] [severity=DIS|DWN|ERR|INF|IRR|OFF|WRN] [state=OPEN|CLOSED|FIXED] [ack=ACK|NOACK]

パラメータ

a、domain、m、 mgtObj、 property、propInst、 qualifier、severity、 state、ack。

パラメータが省略された場合、getAlarms はすべてのアラーム情報を返します。

runAlarmAction

説明

runAlarmAction コマンドは、1 つ以上のエージェントのドメインにあるすべてのアラームについて、手動または遅延アラーム処理を実行します。

構文

runAlarmAction a=host[:port][,host[:port]]* [domain=domain] [m=module[+instance][mgtObj=managedObject [property=property [propInst=propertyInstance] [qualifier=qualifier]]]] [severity=DIS|DWN|ERR|INF|IRR|OFF|WRN] [state=OPEN|CLOSED|FIXED] [ack=ACK|NOACK]

パラメータ

a、domain、m、 mgtObj、 property、propInst、 qualifier、severity、 state、ack。

setAlarmAction

説明

setAlarmAction コマンドは、1 つ以上のエージェントのドメインにあるすべてのアラームについて、手動または遅延アラーム処理を設定します。

構文

setAlarmAction a=host[:port][,host[:port]]* command=command [domain=domain] [m=module[+instance][mgtObj=managedObject [property=property [propInst=propertyInstance] [qualifier=qualifier]]]] [severity=DIS|DWN|ERR|INF|IRR|OFF|WRN] [state=OPEN|CLOSED|FIXED] [ack=ACK|NOACK]

アラーム用に電子メール警告を設定するコマンドの形式は、次のいずれかを使用できます。

command="email.sh:<email-id>:<message>" または

command="email:<email-id>:<message>"。

パラメータ

a、command、domain 、m、mgtObj、 property、propInst、qualifier、 severity、state、 ack。

アラームコマンド例

次のコマンドは、ホスト haiku から、重大度 ERR または DWN のアラームをすべて読み出します。


> getAlarms a=haiku severity=ERR,DWN

トポロジ拡張コマンド

CLI には、トポロジを管理するための拡張コマンドが 9 つあります。

トポロジコマンドパラメータ

トポロジ拡張コマンドでは、次のパラメータを使用できます。a および t パラメータの詳細は、「定義済みのパラメータとフラグ」を参照してください。

agentPort

agentPort パラメータの値は、エージェントポート番号です。agentPort の指定がないと、デフォルト値の 161 になります。agentPort パラメータは、省略可能で、url パラメータの指定がなくデフォルトポートも使用しないときにだけ使用します。

arch

arch パラメータの値は、トポロジオブジェクトのアーキテクチャです。

domain

domain パラメータの値は、setCurrentDomain コマンドに必要な Sun Management Center のドメイン名です。

domainmode

domainmode パラメータの値は、follow または ignore です。値が follow の場合、import コマンドは、指定されたターゲットドメインにファイルからグループとドメイン情報の両方をインポートします。ignore の場合は、ドメイン情報が無視されます。

family

family パラメータの値は、トポロジオブジェクトのオブジェクトファミリです。省略された場合は、自動的に取得されます。

filename

filename パラメータの値はファイルの名前です。このパラメータは、export および import コマンドでのトポロジデータのエクスポートやインポートに使用します。

fullDesc

fullDesc パラメータは、作成するエンティティーまたはグループを説明するテキストです。

isPolled

isPolled パラメータの値は、true または false です。このパラメータ値が true の場合、エンティティーは、ポーリングタイプ (pollType) に従って状態情報のポーリングを行います。デフォルト値は true です。

mode

mode パラメータの値は append または overwrite です。append の場合、export コマンドはファイルの終わりにトポロジデータを付加します。overwrite の場合は、新しいトポロジデータでファイルが上書きされます。

nodemode

nodemode パラメータの値は、replace または ignore です。replace の場合、ファイルとドメインの間に矛盾するデータがあると、ドメイン内のデータはファイル内のデータで置き換えられます。ignore の場合、矛盾するデータは無視されます。

pollType

pollType パラメータの値は、エンティティーのポーリングタイプです。次に、pollType パラメータで使用可能な値を示します。

  • agroup – アクティブなエージェントがインストールされ、動作しているグループを特定します。

  • ahost – アクティブエージェントがインストールされ、動作しているホストを特定します。

  • amod – アクティブエージェントを持つモジュールを特定します。

  • aprox – SNMP プロキシモジュールを実行中のエージェントを特定します。

  • dummy – 監視されていないデバイスを特定します。

  • ping – ICMP ping コマンドを使用して監視するホストを特定します。

  • snmp – SNMP ping コマンドを使用して監視するホストを特定します。

readInfo

readInfo パラメータの値は、SNMP ポーリングされたオブジェクトに対する SNMPv1 読み取りコミュニティーの名前です。

targetHost

targetHost パラメータの値は、ターゲットホストの名前です。

targetIp

targetIP パラメータの値は、ターゲットホストの IP アドレスです。

topoCfg

topoCfg パラメータの値は、管理エンティティーのトポロジ表現に対する構成情報です。

topoType

topoType パラメータの値は、管理エンティティーのトポロジ表現タイプです。

url

url パラメータの値は、ポーリングするエンティティーの URL です。url パラメータの値は、次のような形式で指定できます。

ping://hostname
snmp://hostname:port/oid/#.#.#.#
snmp://hostname:port/[mod,sym]/path
validity

validity パラメータの値は、エクスポートしたトポロジデータの有効期間を示す日数です。validity パラメータの有効な値は、Unlimited、 7、15、30、または 90 です。

writeInfo

writeInfo パラメータの値は、ポーリングされた SNMP オブジェクトに対する SNMPv1 書き込みコミュニティーの名前です。

トポロジコマンド

トポロジを管理するための拡張コマンドは 9 つあります。

createEntity

説明

createEntity コマンドは、管理エンティティーを生成します。

構文

createEntity t=topoObject pollType=ahost|amod|aprox|dummy|ping|snmp [fullDesc=text] [targetHost=host] [agentPort=port] [targetIp=ip] [family=family] [isPolled=true|false] [topoType=text] [topoCfg=text] [readInfo=text] [writeInfo=text] [url=url]

パラメータ

t、pollType、fullDesc、targetHost、agentPort、targetIp、family、isPolled、 topoType、topoCfg、readInfo、 writeInfo、url。

url または agentPort パラメータが指定された場合、デフォルトポートの 161 は使用されません。

createGroup

説明

createGroup コマンドは、トポロジのドメインやグループを作成します。

構文

createGroup t=topoObject [family=base|building-view|campus-view|network-view|subnetwork-view] [fullDesc=desc]

パラメータ

t、family、fullDesc 。

作成するエンティティーがグループの場合、family パラメータは必須です。

作成するエンティティーがドメインの場合、family および fullDesc パラメータは無視されます。

delTopoObject

説明

delTopoObject コマンドは、管理トポロジ階層の管理トポロジオブジェクトを削除します。指定したトポロジオブジェクトの下位オブジェクトもすべて削除されます。

構文

delTopoObject t=topoObject

パラメータ

t

export

説明

export コマンドは、1 つ以上のドメイン内のトポロジデータをファイルにエクスポートします。

構文

export filename=filename domain=domain|"All Domains" mode=append|overwrite validity=Unlimited|7|15|30|90 [comment=text]

パラメータ

filename、domain、 mode、validity、comment。

getAgentPort

説明

getAgentPort コマンドは、トポロジドメインの指定ホスト上で動作する Sun Management Center エージェントのポート番号を返します。エージェントが複数の場合は、ポート番号のリストを返します。

構文

getAgentPort a=host[,host]* [t=topoObject]

パラメータ

a および t。

t パラメータが省略された場合は、デフォルトドメインが使用されます。

getAllTopoObjects

説明

getAllTopoObjects コマンドは、管理トポロジ階層にあって、arch、family、または pollType パラメータで指定された条件を満たす全管理オブジェクトの一覧を返します。

構文

getAllTopoObjects t=topoObject [arch=os] [family=platform] [pollType=aview|ahost|amod|aprox|dummy|ping|snmp]

パラメータ

t、arch、family、pollType。

getCurrentDomain

説明

getCurrentDomain コマンドは、現在のドメインの名前を返します。

構文

getCurrentDomain

パラメータ

なし

getDomains

説明

getDomains コマンドは、現在のサーバーコンテキスト内のすべての管理ドメインを返します。

構文

getDomains

パラメータ

なし

getTopoObject

説明

getTopoObject コマンドは、 t パラメータで指定されたトポロジオブジェクトの直下にあって、arch、family、または pollType パラメータで指定された条件を満たす管理オブジェクトのリストを返します。

構文

getTopoObject t=topoObject [arch=os] [family=platform] [pollType=aview|ahost|amod|aprox|dummy|ping|snmp]

パラメータ

t, arch, family, and pollType.

import

説明

export コマンドは、ファイルからドメインにトポロジデータをインポートします。

構文

import filename=filename domainmode=follow|ignore nodemode=replace|ignore [domain=domain]

パラメータ

filename、domainmode、 nodemode、domain。

setCurrentDomain

説明

setCurrentDomain コマンドは、ホームドメインを domain パラメータで指定された値に設定します。

構文

setCurrentDomain domain=domainName

パラメータ

domain

トポロジコマンド例

次のコマンドは、menlo_park ドメインのグループ building12 の sun4u ファミリにあって SunOS 5.7 ソフトウェアを実行する、Sun Management Center のエージェントホストをすべて返します。


> getTopoObject t=/menlo_park/building12 pollType=ahost \
arch="SunOS 5.7" family=sun4u

次のコマンドは、既存ドメイン headquarters_test の下に building19 という名前のグループを作成します。


> createGroup t=/headquarters_test/building19 \
fullDesc="test headquarters domain" family=building-location

次のコマンドは、ドメイン test_domain のグループ building12 に myHost という名前の管理エンティティーを作成します。トポロジオブジェクトは、ポート 1161 で動作するエージェントを持つホストです。


> createEntity t=/test_domain/building12/myHost \
fullDesc="my test host" family=ultra-2 topoType="" \
topoCfg="" isPolled=false pollType=ahost readInfo="" \
writeInfo="" targetHost=osftserv targetIp="" agentPort=1161

CLI 出力

CLI には、次のような出力オプションがあります。

注 –

コマンドとログファイルはすべて英語のみに対応しています。ただし、コマンド説明とヘルプテキストは、Java の各国語化ガイドラインに従って英語以外の言語にも対応します。

コマンド出力形式

基本コマンドの出力形式はプレーンテキストのみです。基本および拡張コマンドについては、「CLI コマンドとパラメータの概要」を参照してください。

拡張コマンドの出力形式は 3 種類あります。

出力形式を指定するには、f パラメータに希望する形式値を設定します。現在サポートされている値は、plain 、xml、および html です。

コマンド出力の論理画面サイズを定義するには、height パラメータに目的の値を設定します。more パラメータを設定すると、一度に 1 画面ずつ出力を表示できます。これらのパラメータについては、「定義済みのパラメータとフラグ」を参照してください。

例 20–1 プレーンテキストでのコマンド出力

次の例は、プレーンテキスト形式で表示された getLoadedModules コマンド出力の一部です。


== getLoadedModules: Results 1/16 ===============================
Module Name=Dynamic Reconfiguration
Module Key=dr
Description=Dynamic Reconfiguration (Sunfire)
Agent Name=myhost-dev86
Agent Port=161
Version=2.0
== getLoadedModules: Results 2/16 ===============================
Module Name=Config-Reader(sun4u/sun4d)
Module Key=Config-Reader4u
Description=Config Reader (sun4u/sun4d)
Agent Name=myhost-dev86
Agent Port=161
Version=1.0
...
== getLoadedModules: Results 15/16 ==============================
Module Name=DNS Synthetic Transaction [dns]
Module Key=dnsST+dnstest
Description=DNS Synthetic Transaction
Agent Name=myhost-dev86
Agent Port=161
Version=1.0
================================================================

CLI ログファイル

CLI コマンドをログファイルに記録するには、log パラメータにコマンドの記録先ファイルを設定します。あとで実行できるよう、バッチモードでログファイルを CLI に渡すには、logmode パラメータを detailed、command、または from n に設定します。詳細は、「定義済みのパラメータとフラグ」 の log および logmore を参照してください。

ログファイルの形式は次のとおりです。

DATE & TIME;duration or message;command and parameters
例 20–2 CLI の部分ログファイル

次の例は、前述の getLoadedModules コマンド出力を取り込んだ一連のコマンドログの抜粋です。

Fri Dec 21 14:15:12 PST 2001;0 second;set o=\
/home/examples/output.3c23b455
Fri Dec 21 14:15:23 PST 2001;0 second;set f=plain
Fri Dec 21 14:15:45 PST 2001;0 second;set a=smtg-dev21
Fri Dec 21 14:16:08 PST 2001;== START OF THREAD ==;getLoadedModules
Fri Dec 21 14:16:08 PST 2001;2 seconds;getLoadedModules
Fri Dec 21 14:16:12 PST 2001;9 seconds;print
Fri Dec 21 14:21:28 PST 2001;== START OF THREAD ==;getAgentPort
Fri Dec 21 14:21:28 PST 2001;0 second;getAgentPort
Fri Dec 21 14:21:31 PST 2001;0 second;print
Fri Dec 21 14:22:01 PST 2001;0 second;exit

CLI へのアクセス

es-cli

説明

CLI へのアクセスには、es-cli コマンドを使用します。

構文

es-cli [-h] [-b <filename> -i <parameter-filename>] [-i <parameter-filename>]

es-cli のパラメータについては、「CLI パラメータ」を参照してください。

注 –

何もオプションが指定されなかった場合、CLI はセッションモードで起動します。

CLI 手順

この節では、一般的な CLI の手順について説明します。

ProcedureSolaris または Linux オペレーティング環境で CLI にアクセスする

始める前に
注 –

コンソールがデフォルトの /opt ディレクトリにインストールされていない場合、CLI アプリケーションは起動しません。この場合は、次のいずれかの方法で CLI アプリケーションを起動してください。

  1. 対話型セッションを開始するには、コマンド /opt/SUNWsymon/sbin/es-cli を入力し、使用するグローバルパラメータがある場合は、それらパラメータも入力します。

  2. CLI プロンプト (>) に対して login と入力します。

  3. Host プロンプトに対して、接続先のホスト名を入力します。

  4. Login プロンプトに対してユーザーのログイン名、Password プロンプトに対してパスワードをそれぞれ入力します。

    手順 1 から 手順 4 の入力例を示します。


    /opt/SUNWsymon/sbin/es-cli parameters
> login
Host: myhost
Login: mylogin
Password: mypassword
Login is successful.
>
    ヒント –

    CLI をバッチモードで起動する場合は、あらかじめ用意された CLI コマンドファイルを入力として使用し、次のコマンドを指定します。/opt/SUNWsymon/sbin/es-cli -b file

ProcedureMicrosoft Windows 環境で CLI にアクセスする

  1. Sun Management Center のコンソールレイヤーをインストールしたら、CLI フォルダにある es-cli をダブルクリックします。

    CLI 画面が表示されます。

  2. login コマンドを入力します。

    ログインプロセスプロンプトが表示されたら、目的のホスト名とユーザーのログイン名を入力します。

    次の例では、seattle がホストで susan がログイン名です。


    > login
Host: seattle
Login: susan
Password:
>

ProcedureCLI のオンラインヘルプにアクセスする

  1. CLI の全コマンドのヘルプリストにアクセスするには、CLI プロンプトで help と入力します。

  2. 特定コマンドの詳細な説明を参照するには、help に続けてコマンド名を入力します。

    たとえば、getLoadedModules コマンドの詳細ヘルプにアクセスするには、次のように入力します。


    > help getLoadedModules

Procedureコマンド出力画面サイズを制御する

  1. 画面サイズを定義するには、height パラメータに表示する行数を設定します。

    たとえば高さ 20 行の画面を定義する場合は、次のように入力します。


    > set height=20

  2. 一度に 1 ページずつ出力を表示できるようにするには、more パラメータに on を設定します。


    > set more=on

ProcedureCLI コマンドをログファイルに記録する

  1. log パラメータに、コマンドの記録先ファイル名を設定します。


    > set log=/home/examples/log.3c254030

    log パラメータの設定後は、後続のオブジェクトがすべてファイルの後ろに追加されます。ファイルが存在しない場合は、新たに作成されます

    このファイルは上書きされないため、複数のレコードを新規に作成する場合は、必ずファイルも作成してください。

  2. 記録を停止するには、log パラメータを付けて unset コマンドを使用します。


    > unset log

Procedureコマンド出力をファイルに記録する

    コマンド出力をファイルに記録するには、o パラメータに出力ファイル名を設定します。


    > set o=/home/examples/output.3c254030

    記録を停止するには、o パラメータを付けて unset コマンドを使用します。


    > unset o

ProcedureCLI セッションを終了する

    CLI セッションを終了するには、exit と入力します。


    > exit