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
- property
- 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
- domain
-
domain パラメータの値は、アラーム監視の対象となる Sun Management Center のドメイン名です。指定ドメインがない場合は、デフォルトドメインが使用されます。
- mgtObj
- note
- property
- propInst
- qualifier
- severity
-
severity パラメータの値は、監視されたアラームの重大度をコンマ区切りで併記します。次に、severity パラメータで使用可能な値を示します。
- 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。
- 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。
- 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。
- 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
- domain
-
domain パラメータの値は、setCurrentDomain コマンドに必要な Sun Management Center のドメイン名です。
- domainmode
-
domainmode パラメータの値は、follow または ignore です。値が follow の場合、import コマンドは、指定されたターゲットドメインにファイルからグループとドメイン情報の両方をインポートします。ignore の場合は、ドメイン情報が無視されます。
- family
-
family パラメータの値は、トポロジオブジェクトのオブジェクトファミリです。省略された場合は、自動的に取得されます。
- filename
-
filename パラメータの値はファイルの名前です。このパラメータは、export および import コマンドでのトポロジデータのエクスポートやインポートに使用します。
- fullDesc
- isPolled
-
isPolled パラメータの値は、true または false です。このパラメータ値が true の場合、エンティティーは、ポーリングタイプ (pollType) に従って状態情報のポーリングを行います。デフォルト値は true です。
- mode
-
mode パラメータの値は append または overwrite です。append の場合、export コマンドはファイルの終わりにトポロジデータを付加します。overwrite の場合は、新しいトポロジデータでファイルが上書きされます。
- nodemode
-
nodemode パラメータの値は、replace または ignore です。replace の場合、ファイルとドメインの間に矛盾するデータがあると、ドメイン内のデータはファイル内のデータで置き換えられます。ignore の場合、矛盾するデータは無視されます。
- pollType
-
pollType パラメータの値は、エンティティーのポーリングタイプです。次に、pollType パラメータで使用可能な値を示します。
- readInfo
-
readInfo パラメータの値は、SNMP ポーリングされたオブジェクトに対する SNMPv1 読み取りコミュニティーの名前です。
- targetHost
- targetIp
- topoCfg
- 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 書き込みコミュニティーの名前です。
トポロジコマンド
- 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。
- createGroup
-
説明
createGroup コマンドは、トポロジのドメインやグループを作成します。
構文
createGroup t=topoObject [family=base|building-view|campus-view|network-view|subnetwork-view] [fullDesc=desc]
パラメータ
t、family、fullDesc 。
作成するエンティティーがグループの場合、family パラメータは必須です。
- 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。
- 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 |
- © 2010, Oracle Corporation and/or its affiliates