test

Sun Management Center 3.5 ユーザーガイド

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

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

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

Sun Management Center CLI の概要

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

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

システム要件

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

CLI の対話モード

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

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

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

CLI コマンドの概要

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

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

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

CLI パラメータの概要

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

入力機能と出力機能

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

CLI コマンドヘルプ

CLI では、CLI コマンドごとにオンラインヘルプが提供されます。ユーザは、GUI を通さずに CLI 内から直接ヘルプにアクセスして、各コマンドの使用方法や関連パラメータリストを入手することができます。

CLI パラメータ

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

パラメータの範囲

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

パラメータ構文

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

file=/home/examples/example1

この場合、パラメータ name は file、パラメータ値は /home/examples/example1 です。ただし、イコール記号 (=) とパラメータ名やパラメータ値の間に空白文字 (スペース、タブ記号など) は入りません。空白文字 が含まれていると、その値は二重引用符 (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

このフラグの名前は小文字の 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) 。

CLI コマンド

コマンドのタイプと概念の概要は、CLI コマンドとパラメータの概要を参照してください。

CLI の基本コマンド

以下では、CLI の基本コマンドについて説明します。

alias

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


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

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


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

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

exit

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

注 –

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

help

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


> help getAlarms
getAlarms [a=host[,host]+] [alarm_filter_list]
 - エージェント (またはエージェントリスト) のアラーム情報をフィルタ条件セットに基づいて取得します。エージェントを指定しない場合、すべての (エージェントの) アラームが取得されます。すべてのフィルタ条件は「論理積」がとられて、その結果が提供されます。このフィルタ条件は以下で構成される alarm_filter_list を指定します。
  domain=domain、      	  
  m=module[+instance]、
  managed_object=managed_object、
  property=property、
  property_instance=property_instance、
  qualifier=qualifier、
  severity=[DIS,DWN,ERR,OFF,INF,IRR,WRN]、
  state=[C,F,O]、
  ack=[A,N]
kill

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

login

login コマンドは、Sun Management Center サーバへの接続を確立します。まず serverHost を指定し、必要に応じて serverPort パラメータを引数として指定します。ホストが指定されていないと、ホストのプロンプトが表示されます。login コマンドは、ユーザ名とパスワードのプロンプトも表示します。

logout

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

more

more コマンドは、画面へのコマンド出力の形式を制御するために設定したパラメータの情報を表示します。定義済みパラメータの height と more についての詳細は、定義済みのパラメータとフラグを参照してください。

print

print コマンドは、最後の拡張コマンドの出力を、指定された出力形式で指定された出力先に送信します。デフォルトでは、print は、端末画面にプレーンテキスト形式で送信します。a パラメータまたは o パラメータを設定すると、出力はこれらのパラメータで指定されたファイルに送信されますが、画面には表示されません。

注 –

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

quit

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

注 –

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

reset

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

注 –

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

set

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


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

status コマンドは、バックグラウンドで稼動する全コマンドの状態を表示します。

unalias

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

unset

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

注 –

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

CLI の拡張コマンド

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

モジュール拡張コマンド

管理モジュールには 7 つの拡張コマンドがあります。a、m、 f、columns の各パラメータの詳細は、定義済みのパラメータとフラグを参照してください。

モジュールコマンド

disableModule

1 つ以上のエージェントのモジュールを使用不可にします。disableModule コマンドが使用するパラメータは、a と m です。

enableModule

1 つ以上のエージェントのモジュールを使用可能にします。enableModule コマンドが使用するパラメータは、a、f、m、columns です。

getLoadedModules

1 つ以上のエージェントで読み込まれたモジュールを取り込みます。getLoadedModules コマンドが使用するパラメータは、a、 f、columns です。

getModule

特定モジュールの情報を取り込みます。getModule コマンドが使用するパラメータは、a、f、 m、columns です。

getModules

単一エージェントのモジュール群を取り込みます。getModules コマンドが使用するパラメータは、a、f、columns です。

loadModule

1 つ以上のエージェントの単一モジュールを読み込みます。loadModule コマンドが使用するパラメータは、a、f、 m、columnsです。

さらに loadModule コマンドでは、 moduleName (国際的に認知されたモジュール名)と、 moduleDesc (モジュールのテキスト説明) の 2 つのパラメータを使用することができます。

unloadModule

1 つ以上のエージェントの、1 つ以上のモジュールを読み込み解除します。unloadModule コマンドが使用するパラメータは、a、 f、m、columns です。

モジュールコマンド例

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


> getLoadedModules a=seattle

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


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

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

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

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

以下は、オブジェクト属性コマンドが使用するパラメータです。a、m、 f、columns の各パラメータの詳細は、定義済みのパラメータとフラグを参照してください。

mgtObj

mgtObj パラメータの値は、属性とプロパティが設定または取り出された管理オブジェクトの名前です。

property

property パラメータの値は、属性と値が設定または取り出されたプロパティの名前です。

propInst

propInst パラメータの値は、属性と値が設定または取り出されたプロパティのインスタンス名です。

rowValues

rowValues パラメータの値は、名前と値のペアをコンマ区切りで併記します。名前は行の列名、値は列の値です。

attributes

attributes パラメータの値は、属性と値が設定または取り出されたプロパティに含まれる属性名をコンマ区切りで併記します。このパラメータを setAttributes コマンドで使用する場合、attributes パラメータの各属性名は該当する values パラメータの値でなければなりません。

values

values パラメータの値は、attributes パラメータで指定された属性の値をコンマ区切りで併記します。このパラメータを setAttributes コマンドで使用する場合は、各属性ごとに値を指定する必要があります。

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

以下は、オブジェクト属性と属性値を設定したり取り出すためのコマンドです。

addRow

addRow コマンドは、テーブルに行を追加します。使用可能なパラメータは、a、 m、mgtObj、property、 propInst、rowValues などです。

delRow

delRow コマンドは、テーブルから行を削除します。使用可能なパラメータは、a、 m、mgtObj、property、 propInst、rowValues などです。

getAttributes

getAttributes コマンドは、1 つ以上のエージェントから指定された属性を取り出します。使用可能なパラメータは、a、f、m、columns、mgtObj、property、propInst、attributes などです。

setAttributes

setAttributes コマンドは、1 つ以上のエージェントの指定された属性に値を割り当てます。使用可能なパラメータは、a、m、mgtObj、property、propInst、attributes、values などです。

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

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

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


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

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


> setAttributes a=haiku:1161 m=agent-stats mgtObj=totalstats \
property=size attributes=alarmlimits.error-gt values=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 パラメータの値は、管理アラームが肯定応答されたかどうかを示す値をコンマ区切りで併記します。使用可能な値は、A (肯定応答) と N (無応答) です。

command

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

domain

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

managed_object

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

note

note パラメータの値は、起動されたコマンドのテキスト注釈です。

property

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

property_instance

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

qualifier

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

アラームレベル

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

  • ERR — エラー

  • WRN — 警告

  • INF — 詳細

  • IRR — 不合理

  • DWN — 停止

  • DIS — 使用不可

  • OFF — オフ

state

state パラメータの値は、監視されたアラームの状態値をコンマ区切りで併記します。使用可能な状態パラメータは、O (開く) と C (閉じる) です。

アラームコマンド

以下は、アラーム値の確認やアラーム処理の設定を行うためのコマンドです。

ackAlarms

ackAlarms コマンドは、1 つ以上のコマンドのアラームに肯定応答します。使用可能なパラメータは、a、ack、columns、domain、f、m、managed_object、note、 property、property_instance、qualifier、severity、state などです。

state パラメータ値の指定がないと、state はデフォルト値の O (開く) になります。

delAlarms

delAlarms コマンドは、1 つ以上のエージェントのアラームを削除します。使用可能なパラメータは、 a、ack、columns、domain、f、m、managed_object、 note、property、property_instance、qualifier、 severity、state などです。

state パラメータ値の指定がないと、state はデフォルト値の C (閉じる) になります。

getAlarms

getAlarms コマンドは、1 つ以上のエージェントのアラーム情報を取り出します。使用可能なパラメータは、a、ack、 columns、domain、f、m、managed_object、property, property_instance、qualifier、severity、state などです。

パラメータの指定がないと、getAlarms は全てのアラーム情報を返します。

runAlarmAction

runAlarmAction コマンドは、1 つ以上のエージェントで、手動のアラーム処理または表示されたアラーム処理を実行します。使用可能なパラメータは、a と domain です。

setAlarmAction

setAlarmAction コマンドは、単一または複数エージェントの既存アラームに対して、手動または遅延のアラーム処理を設定します。使用可能なパラメータは、 a、command、domain です。

アラームコマンド例

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


> getAlarms a=haiku severity=ERR,DWN

トポロジ拡張コマンド

CLI には、トポロジを管理する 9 つの拡張コマンドが用意されています。

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

以下に、トポロジの拡張コマンドが使用するパラメータを示します。a、columns、 f、t の各パラメータの詳細は、定義済みのパラメータとフラグ を参照してください。

agentPort

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

arch

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

domain

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

family

family パラメータの値は、トポロジオブジェクトのオブジェクトファミリです。

fullDesc

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

isPolled

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

pollType

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

  • 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
writeInfo

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

トポロジコマンド

CLI には、トポロジを管理する 9 つの拡張コマンドが用意されています。

createEntity

createEntity コマンドは、管理エンティティを生成します。管理エンティティのプロパティを指定するパラメータは、次のとおりです。agentPort、arch、family、fullDesc、isPolled、pollType、 readInfo、targetHost、targetIP、topoCfg、topoType、url、 columns、f、t。

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

createGroup

createGroup コマンドは、トポロジのドメインやグループを作成します。作成するエンティティがグループの場合、family パラメータと fullDesc パラメータでグループエンティティを指定します。さらに createGroup コマンドは、 columns、f、t の各パラメータも使用します。

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

delTopoObjects

delTopoObjects コマンドは、管理トポロジ階層の管理トポロジオブジェクトを削除します。指定したトポロジオブジェクトの下位オブジェクトも全て削除されます。使用可能なパラメータは、columns、f、t です。

getAgentPort

getAgentPort コマンドは、トポロジドメインの指定ホスト上で動作する Sun Management Center エージェントのポート番号を返します。エージェントが複数の場合は、ポート番号のリストを返します。使用可能なパラメータは、columns、f、t です。

t の指定があると、デフォルトドメインが使用されます。

getAllTopoObjects

getAllTopoObjects コマンドは、 arch、family、pollType の各パラメータで指定された条件を満たす管理トポロジ階層の管理オブジェクトを全て返します。getAllTopoObjects コマンドは、columns、f、tなどのパラメータも使用します。使用可能なパラメータは、columns、f、t です。

getCurrentDomain

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

getDomains

getDomains コマンドは、全ての管理ドメインを返します。

getTopoObject

getTopoObject コマンドは、t パラメータで指定されたトポロジオブジェクトの下位にあり、arch、family、pollType の各パラメータで指定された条件を満たす管理トポロジオブジェクトを全て返します。getTopoObject コマンドは、 columns パラメータと f パラメータも使用します。

setCurrentDomain

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

CLI からトポロジ情報をエクスポートおよびインポートする方法については、インポートとエクスポートのコマンド行インタフェースを参照してください。

トポロジコマンド例

次のコマンドは、menlo_park ドメインのグループ ビル 12 の sun4u ファミリ上に設定され、SunOS 5.7 ソフトウェアを実行する Sun Management Center のエージェントホストを全て返します。


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

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


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

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


> 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 コマンドとパラメータの概要 を参照してください。

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

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

コマンド出力の論理画面サイズを定義するには、height パラメータに希望する値を設定します。出力を同一の画面に一括表示するには、more パラメータを設定します。これらのパラメータについての説明は、定義済みのパラメータとフラグを参照してください。

例 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 パラメータにコマンドの記録先ファイルを設定します。ログファイルの形式は次のとおりです。

日時; 期間もしくはメッセージ; コマンドとパラメータ
例 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 手順

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

Solaris オペレーティング環境で CLI にアクセスする

  1. 対話型セッションを開始するには、コマンド installed-root-directory/sbin/es-cli の次に希望するグローバルパラメータを入力します。

  2. CLI プロンプト (>) の次に login を入力します。

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

  4. ログインプロンプトとパスワードプロンプトの次に、ユーザのログイン名とパスワードを入力します。

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


    installed-root-directory/sbin/es-cli parameters
> login
ホスト: myhost
ログイン: mylogin
パスワード: mypasswordログインに成功しました。
>
    ヒント –

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

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

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

    CLI 画面が表示されます。

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

    ログインプロセスプロンプトが表示されるので、希望するホスト名とユーザのログイン名を入力します。

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


    > login
ホスト: seattle
ログイン: susan
パスワード:
>
CLI のオンラインヘルプにアクセスする

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

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

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


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

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

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


    > set height=20

  2. 出力を 1 ページに一括表示するには、more パラメータに on を設定します。


    > set more=on
CLI コマンドをログファイルに記録する

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


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

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

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

  2. 記録を停止するには、log パラメータを解除します。


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

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


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

    記録を停止するには、o パラメータを解除します。


    > unset o
CLI セッションを終了する

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


    > exit