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