コマンドの種類と概念の概要は、「CLI コマンドとパラメータの概要」を参照してください。基本 CLI コマンドが使用するパラメータの詳細は、「定義済みのパラメータとフラグ」を参照してください。
説明
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 [group=groupName [name=attribName] [-key]]
browse コマンドは、トポロジをブラウズモードにします。
構文
browse
説明
cd コマンドは、現在のトポロジパスを変更します。パスが指定されなかった場合は、現在のパスにデフォルトドメインが設定されます。数値 (n) が指定された場合は、list コマンドで示される順序で n 番目の子パスが現在のパスに設定されます。
構文
cd [path|number]
説明
clear コマンドは、現在のセッション中に設定されたすべてのパラメータを削除します。ただし、コマンド行から設定されたパラメータは削除しません。このコマンドは unset コマンドと似ていますが、パラメータ名を引数として指定する必要はありません。
構文
clear
data コマンドは、トポロジオブジェクトの詳細を表示します。数値 (n) が指定された場合は、list コマンドで示される順序で n 番目の子パスに現在のパスが設定されます。
構文
data [path|number|-key]
end コマンドは、トポロジのブラウズモードを解除します。
構文
end
説明
exit コマンドは、サーバーとの接続を切断して CLI セッションを終了します。
構文
exit [-onError]
パラメータ
onError
onError パラメータは、以前のコマンドの実行で例外が発生した場合に CLI セッションを終了する指定です。このパラメータはバッチモードでのみ使用します。
goto コマンドは、大文字と小文字が区別されるパターンに一致するトポロジパスに移動します。複数のパスが見つかった場合は、パスを選択するよう求められます。
構文
goto <pattern>
説明
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 コマンドは、CLI セッションで以前に入力されたコマンドを表示または実行します。履歴が以前に作成されていて、引数を付けずに history コマンドを呼び出すと、以前に入力されたすべてのコマンドが表示されます。履歴が以前に作成されていて、数値引数を付けて history コマンドが呼び出された場合は、その引数に一致するコマンドが実行されます。
構文
history [num]
説明
kill コマンドは、バックグラウンドで起動しているコマンドをすべて終了します。
構文
kill
説明
list コマンドは、パス下のオブジェクトを一覧表示します。数値 (n) が指定された場合は、このコマンドの示す順番で n 番目の子パスにパスが設定されます。
構文
list [path|number]
説明
locate コマンドは、指定されたパターンに一致するすべてのトポロジパスを検索します。パターンは大文字と小文字が区別されます。
構文
locate <pattern>
説明
login コマンドは、Sun Management Center サーバーとの接続を確立します。引数として serverHost と serverPort (省略可能) パラメータを指定できます。ホストが指定されていないと、ホストのプロンプトが表示されます。ポートが指定されなかった場合は、2099 が使用されます。login コマンドは、ユーザー名とパスワードのプロンプトも表示します。
構文
login [serverHost=host] [serverPort=portNumber] [user=userName] [password=userPassword]
パラメータ
serverHost、serverPort、 user、password
説明
logout コマンドは、Sun Management Center サーバーとの接続を切断します。ただし、CLI セッションは終了しません。
構文
logout
説明
print コマンドは、最後の拡張コマンドの出力を、指定された出力形式で指定された出力先に送信します。デフォルトでは、出力は端末画面にプレーンテキスト形式で送信します。パラメータの append または o が設定された場合、出力は、そのパラメータによって指定されたファイルにリダイレクトされ、画面には表示されません。ncols が指定されなかった場合、デフォルト列数は 4 に設定されます。
構文
print [f=plain|xml|html] [style=table|list|<custom>] [columns= columnList] [ncols=num] [o=outputFile | append=appendFile]
パラメータ
f、style、columns、 ncols、o、append
説明
quit コマンドは、サーバーとの接続を切断して CLI セッションを終了します。
構文
quit
説明
reset コマンドは、コマンド行に指定されたすべてのパラメータ値を、CLI セッションの起動時に指定された値に復元します。ただし、セッション中に定義されたがコマンド行に指定されなかったパラメータは、そのまま変わりません。コマンド行に指定したパラメータの名前を引数として reset に使用すると、そのパラメータの値は初期値に復元されます。それ以外の場合、パラメータ値は変わりません。
構文
reset [<parameter>]*
説明
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
説明
unalias コマンドは、引数として指定されたエイリアスを削除します。
構文
unalias [<pseudonym>]*
説明
unset コマンドは、現在のセッションから指定されたパラメータを削除します。
構文
unset [<parameter>]*
unset コマンドは、コマンド履歴に保存されません。
説明
where コマンドは、現在のトポロジパスを表示します。
構文
where
次の各節では、CLI で使用可能な各種拡張コマンドについて説明します。
「インポートとエクスポートのコマンド行インタフェース」(トポロジのインポートコマンドとエクスポートコマンドの説明)
モジュールを管理するための拡張コマンドは 7 つあります。
モジュールコマンドが使用するパラメータを次に示します。a および m パラメータの詳細は、「定義済みのパラメータとフラグ」を参照してください。
モジュールの国際化名
モジュールの説明テキスト
モジュールパラメータのコンマ区切りのリスト
モジュールのデフォルト設定
説明
エージェント内の 1 つ以上のモジュールを使用不可にします。
構文
disableModule a=host[:port][,host[:port]]* m=module[+instance][,module[+instance]]*
パラメータ
a 、m
説明
エージェント内の 1 つ以上のモジュールを使用可能にします。
構文
enableModule a=host[:port][,host[:port]]* m=module[+instance][,module[+instance]]*
パラメータ
a 、m
説明
エージェントに読み込まれているモジュールのリストを取得します。
構文
getLoadedModules a=host[:port][,host[:port]]*
パラメータ
a
説明
構文
getModule a=host[:port][,host[:port]]* m=module[+instance]
パラメータ
a 、m
説明
構文
getModules a=host[:port][,host[:port]]*
パラメータ
a
説明
構文
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 。
説明
エージェントから 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 パラメータの詳細は、「定義済みのパラメータとフラグ」を参照してください。
rowValues パラメータの値は、名前と値のペアからなる、コンマ区切りのリストです。name は行の列名、value はその列の値です。
attribute パラメータの値は、属性とプロパティーを設定する、または読み出すプロパティーに属する属性名からなる、コンマ区切りのリストです。このパラメータを setAttributes コマンドで使用する場合、attribute パラメータの各属性名は該当する value パラメータの値でなければなりません。
value パラメータの値は、attribute パラメータで指定された属性に対応する値からなる、コンマ区切りのリストです。このパラメータを setAttributes コマンドで使用する場合は、各属性ごとに値を指定する必要があります。
次のコマンドを使用して、オブジェクト属性および属性値を設定、読み出すことができます。
説明
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 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 コマンドは、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 コマンドは、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 (肯定応答) と NOACK (未確認) です。
domain パラメータの値は、アラーム監視の対象となる Sun Management Center のドメイン名です。指定ドメインがない場合は、デフォルトドメインが使用されます。
severity パラメータの値は、監視されたアラームの重大度をコンマ区切りで併記します。次に、severity パラメータで使用可能な値を示します。
state パラメータの値は、監視されたアラームの状態値をコンマ区切りで併記します。state パラメータの有効な値は、Open、Closed 、Fixed です。
次のコマンドを使用して、アラーム値を確認したり、アラーム処理を設定したりできます。
説明
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 コマンドは、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 コマンドは、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 コマンドは、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 コマンドは、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 の指定がないと、デフォルト値の 161 になります。agentPort パラメータは、省略可能で、url パラメータの指定がなくデフォルトポートも使用しないときにだけ使用します。
domain パラメータの値は、setCurrentDomain コマンドに必要な Sun Management Center のドメイン名です。
domainmode パラメータの値は、follow または ignore です。値が follow の場合、import コマンドは、指定されたターゲットドメインにファイルからグループとドメイン情報の両方をインポートします。ignore の場合は、ドメイン情報が無視されます。
family パラメータの値は、トポロジオブジェクトのオブジェクトファミリです。省略された場合は、自動的に取得されます。
filename パラメータの値はファイルの名前です。このパラメータは、export および import コマンドでのトポロジデータのエクスポートやインポートに使用します。
isPolled パラメータの値は、true または false です。このパラメータ値が true の場合、エンティティーは、ポーリングタイプ (pollType) に従って状態情報のポーリングを行います。デフォルト値は true です。
mode パラメータの値は append または overwrite です。append の場合、export コマンドはファイルの終わりにトポロジデータを付加します。overwrite の場合は、新しいトポロジデータでファイルが上書きされます。
nodemode パラメータの値は、replace または ignore です。replace の場合、ファイルとドメインの間に矛盾するデータがあると、ドメイン内のデータはファイル内のデータで置き換えられます。ignore の場合、矛盾するデータは無視されます。
pollType パラメータの値は、エンティティーのポーリングタイプです。次に、pollType パラメータで使用可能な値を示します。
readInfo パラメータの値は、SNMP ポーリングされたオブジェクトに対する SNMPv1 読み取りコミュニティーの名前です。
url パラメータの値は、ポーリングするエンティティーの URL です。url パラメータの値は、次のような形式で指定できます。
ping://hostname snmp://hostname:port/oid/#.#.#.# snmp://hostname:port/[mod,sym]/path
validity パラメータの値は、エクスポートしたトポロジデータの有効期間を示す日数です。validity パラメータの有効な値は、Unlimited、 7、15、30、または 90 です。
writeInfo パラメータの値は、ポーリングされた SNMP オブジェクトに対する SNMPv1 書き込みコミュニティーの名前です。
説明
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 t=topoObject [family=base|building-view|campus-view|network-view|subnetwork-view] [fullDesc=desc]
パラメータ
t、family、fullDesc 。
作成するエンティティーがグループの場合、family パラメータは必須です。
説明
delTopoObject コマンドは、管理トポロジ階層の管理トポロジオブジェクトを削除します。指定したトポロジオブジェクトの下位オブジェクトもすべて削除されます。
構文
delTopoObject t=topoObject
パラメータ
t
説明
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 コマンドは、トポロジドメインの指定ホスト上で動作する Sun Management Center エージェントのポート番号を返します。エージェントが複数の場合は、ポート番号のリストを返します。
構文
getAgentPort a=host[,host]* [t=topoObject]
パラメータ
a および t。
説明
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
パラメータ
なし
説明
getDomains コマンドは、現在のサーバーコンテキスト内のすべての管理ドメインを返します。
構文
getDomains
パラメータ
なし
説明
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.
説明
export コマンドは、ファイルからドメインにトポロジデータをインポートします。
構文
import filename=filename domainmode=follow|ignore nodemode=replace|ignore [domain=domain]
パラメータ
filename、domainmode、 nodemode、domain。
説明
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 |