CLI 指令
請參閱 CLI 指令與參數簡介以得知指令類型和概念的簡介。如需關於基本 CLI 指令使用的參數詳細資訊，請參閱預先定義的參數和旗標。
基本 CLI 指令
- alias
-
說明
alias 指令會建立常用指令的別名，或者具有複雜參數之指令的別名。別名不能與現有的 CLI 指令同名。別名定義中的空格必須用雙引號 ("， ASCII 字元 0x22) 括住。
當使用者結束 CLI 階段作業時，使用者指定的別名會儲存在 aliases 目錄的檔案中。當使用者登入 CLI 階段作業時，將可以使用這些別名。
Syntax
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)，目前的路徑將被設為 nth 子系路徑，如 list 指令所顯示。
語法
cd [path|number]
- clear
-
說明
clear 指令會移除在目前階段作業期間所設的所有參數。但是，此指令將不會移除從指令行所設的參數。該指令與 unset 指令相似，但是無需參數名稱作為引數。
語法
clear
- data
-
data 指令會顯示拓樸物件的詳細資訊。若有指定某數字 (n)，路徑將被設為 nth 子系路徑，如 list 指令所顯示。
語法
data [path|number|-key]
- end
-
end 指令會關閉拓樸的瀏覽模式。
語法
end
- exit
-
說明
exit 指令會終止伺服器連接和 CLI 階段作業。
語法
exit [-onError]
參數
onError
若在執行前一個指令時發生異常，就可使用 onError 參數來終止 CLI 階段作業。此參數僅可用於批次模式。
備註 –
- goto
-
goto 指令可瀏覽到符合大小寫式樣的拓樸路徑。若找到數個相符的路徑，便會要求使用者選擇路徑。
語法
goto <pattern>
- help
-
說明
help 指令會顯示關於 CLI 指令與其參數的資訊。說明資訊可在未使用點陣圖的終端機上顯示。如果不帶引數執行 help，說明會按字母順序顯示可用 CLI 指令的清單及簡短說明。首先列出基本指令，然後再列出延伸指令。當以 CLI 指令名稱作為引數呼叫 help 時，help 可列出針對該指令的資訊。當搭配 about 參數呼叫 help 時，help 會顯示 Sun Management Center 的版本。
語法
help [<command>|about]
參數
command 和 about。
範例
以下範例顯示 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
- list
-
說明
list 指令會列出某路徑下的物件。若有指定某數字 (n)，路徑將被設為 nth 子系路徑，如下列指令所顯示。
語法
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 [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
- reset
-
說明
reset 指令可將在指令行上指定的所有參數值復原為 CLI 階段作業開始時指定的值。在階段作業期間而不是在指令行上定義的參數保持不變。如果將特定參數名稱作為引數提供給 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]
範例
以下範例顯示該指令的所有三種變化形式。
> set height=10 > set height=10 > set height height=10
- status
-
說明
語法
status
- unalias
-
說明
語法
unalias [<pseudonym>]*
- unset
-
說明
unset 指令會從目前階段作業移除指定的參數。
語法
unset [<parameter>]*
備註 –unset 指令不會儲存在指令歷程中。
- where
-
說明
where 指令會顯示目前拓樸路徑。
語法
where
延伸 CLI 指令
以下小節將說明在 CLI 中可用的數種類型的延伸指令：
-
匯入和匯出 CLI 介面中的拓樸匯入與匯出指令
模組延伸指令
有七個延伸指令可用來管理模組。
模組指令參數
模組指令可以使用以下參數。如需關於 a 和 m 參數的詳細資訊，請參閱預先定義的參數和旗標。
- moduleName
-
模組的國際化名稱
- moduleDesc
-
模組的文字說明
- moduleParams
-
以逗號分隔之模組參數清單
- -default
-
模組的預設設定
模組指令
- disableModule
-
說明
語法
disableModule a=host[:port][,host[:port]]* m=module[+instance][,module[+instance]]*
參數
a 和 m
- enableModule
-
說明
語法
enableModule a=host[:port][,host[:port]]* m=module[+instance][,module[+instance]]*
參數
a 和 m
- getLoadedModules
-
說明
getLoadedModules 指令可取得代理程式中已載入的模組清單。
語法
getLoadedModules a=host[:port][,host[:port]]*
參數
a
- getModule
-
說明
語法
getModule a=host[:port][,host[:port]]* m=module[+instance]
參數
a 和 m
- getModules
-
說明
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
-
說明
unloadModule 指令會卸載代理程式中的模組。
語法
unloadModule a=host[:port][,host[:port]]* m=module[+instance][,module[+instance]]*
參數
a 和 m
模組指令範例
若要決定將哪個模組載入到 agentHost 名稱為 seattle 的主機，您應在 CLI 提示符號處鍵入以下指令：
> getLoadedModules a=seattle |
若要將 kernel-reader 模組載入在連接埠 1776 的主機 seattle ，您應該鍵入以下指令：
> loadModule a=seattle:1776 m=kernel-reader |
物件屬性延伸指令
有四個延伸指令可用來管理物件屬性及屬性值。
物件屬性指令的參數
下列參數可被物件屬性指令所用：如需關於 a 和 m 參數的詳細資訊，請參閱預先定義的參數和旗標。
- mgtObj
- property
- propInst
- rowValues
- attribute
-
attribute 參數的值是以逗號分隔之已設定或擷取其屬性和值之特性的屬性名稱清單。當與 setAttributes 指令配合使用時，attribute 參數中的每個屬性名稱在 value 參數中均必須具有對應的值。
- value
-
value 參數的值是以逗號分隔並對應於 attributes 參數中指定屬性的值清單。當與 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
-
說明
getAttributes 指令會擷取特性資訊，或從代理程式或代理程式清單擷取指定屬性。
語法
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 指令會設定特性，或者為代理程式的指定屬性設定值。
語法
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 參數中必須有對應的值。
物件屬性指令的範例
以下指令可擷取主機 haiku 連接埠 1161 上的 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 |
以下指令可從 mgtObj 中指定的受管理物件中刪除在 rowValues 中指定的列：
> delRow a=haiku:1161 \ m=filemon mgtObj=filemonstats/filemonTable/filemonEntry \ rowValues="name=test,desc=this,filename=/etc/passwd" |
警示延伸指令
有五個延伸指令可用於管理警示。
警示指令參數
下列參數可被延伸指令用來管理警示。如需關於 a 和 m 參數的詳細資訊，請參閱預先定義的參數和旗標。
- ack
-
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 指令會確認代理程式或代理程式清單中的警示。
語法
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 指令會刪除代理程式或代理程式清單中的警示。
語法
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 指令會擷取代理程式或一組代理程式的警示資訊。
語法
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 指令會為代理程式或代理程式清單中之網域下的所有警示執行手動或延遲警示動作。
語法
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 指令會為代理程式或代理程式清單中之網域下的所有警示設定手動或延遲警示動作。
語法
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]
參數
a、command、domain、m、mgtObj、property、propInst、qualifier、severity、state 和 ack。
警示指令範例
以下指令可從主機 haiku 中擷取所有嚴重性為 ERR 或 DWN 的警示：
> getAlarms a=haiku severity=ERR,DWN |
拓樸延伸指令
有九個延伸指令可用於管理拓樸。
拓樸指令參數
下列參數可被延伸指令用來管理拓樸：如需關於 a 和 t 參數的詳細資訊，請參閱預先定義的參數和旗標。
- agentPort
-
agentPort 參數的值是代理程式的連接埠號。如果未指定 agentPort，將使用預設值 161。agentPort 參數為可選。僅在未指定 url 參數並且您不想使用預設連接埠時，才需要指定此參數。
- arch
- domain
-
domain 參數的值是您必須為 setCurrentDomain 指令指定的 Sun Management Center 網域名稱。
- domainmode
-
domainmode 參數的值可以是 follow 或 ignore。若值為 follow，import 指令則會從檔案將群組和網域資訊匯入到指定的目標網域。若值為 ignore，則 import 指令會忽略網域資訊。
- family
- filename
-
filename 參數的值是檔案名稱。此參數是被 export 和 import 指令用來匯出和匯入拓樸資料。
- fullDesc
- isPolled
-
isPolled 參數的值可以是 true 或 false。如果值為 true，實體可根據輪詢類型 (pollType) 輪詢狀況資訊。預設值為 true。
- mode
-
mode 參數的值可以是 append 或 overwrite。若值為 append，export 指令會將拓樸資料加到檔案末端。若值為 overwrite，export 指令會使用拓樸資料覆寫檔案。
- nodemode
-
nodemode 參數的值可以是 replace 或 ignore。若在檔案和網域中有資料不相符，replace 值會以檔案中的資料取代網域中的資料。ignore 值會忽略資料的不相符。
- pollType
-
pollType 參數的值是該實體的輪詢類型。pollType 參數允許使用以下值：
- readInfo
- 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 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
參數
無
- 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 和 pollType。
- import
-
說明
語法
import filename=filename domainmode=follow|ignore nodemode=replace|ignore [domain=domain]
參數
filename、domainmode、 nodemode 和 domain。
- setCurrentDomain
-
說明
setCurrentDomain 指令可將主網域設定為 domain 參數中指定的值。
語法
setCurrentDomain domain=domainName
參數
domain
拓樸指令範例
以下指令可傳回執行 SunOS 5.7 軟體的 menlo_park 網域 building12 群組內 sun4u 家族中所有 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