CLI 參數

大多數 CLI 參數為一組名稱值：每個參數都有一個名稱和一個值。少數參數僅有名稱，沒有值。這些參數稱為旗標。

參數範圍

您可以在 CLI 階段作業中的多個位址指定參數值：

• CLI 啟動 – 您可以在啟動 CLI 時在指令行指定參數。在啟動時指定的參數對於該階段作業來說是屬於全域參數。全域參數將保留它們的值，直至以 set 指令覆寫或使用 unset 指令從目前階段作業中移除。

• CLI 指令 – 您可以為在階段作業中執行的個別 CLI 指令指定參數。被指定為指令一部份的值會暫時覆寫該指令期間的全域參數值。

• 輸入檔 – 參數定義可以儲存在外部檔案，而且可以隨時在 CLI 階段作業中被呼叫。在外部檔案中定義的參數值會被全域參數和個別指令參數覆寫。

參數語法

參數是被指定為一組 name=value：

file=/home/examples/example1

其中參數 name 是 file，而參數 value 則是 /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 時包含在指令行中，此旗標就會指示 CLI 在批次模式下執行。該旗標在階段作業模式中將被忽略。

-h

若此旗標是被當作在階段作業模式下的指令參數來使用，此旗標就會指示 CLI 顯示指令的說明文字。

-l

當此旗標是被當作階段作業模式下延伸指令的參數來使用，它將指示 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]*.

about

about 參數是搭配 help 指令使用。此參數會顯示 CLI 的版本資訊。

append

append 參數的值是將指令的輸出附加到其中的檔案名稱。如果該檔案不存在，會建立該檔案。如果您將 append 參數設定為全域參數，則該階段作業的所有指令輸出都將附加到指定的檔案中。您還可以為特定指令設定該參數，如以下範例所示。

append=/home/examples/cli_output

若皆已設定 append 和 o 參數，append 將會優先 o。僅有指令結果會被記錄在指定檔案中。實際指令不會被記錄下來。使用 log 參數可記錄指令資訊。

columns

columns 參數的值是 print 指令顯示之指令輸出的一欄或多欄的名稱。欄名稱有區分大小寫。多個欄位名稱以逗號隔開。以下範例使用了數個欄名稱。

columns="Alarm Id,Node URL,Target Host,Severity"

f

f 參數的值會判定指令輸出的格式。目前的格式為 plain 和 html。請參閱指令輸出格式以得知更多資訊。若要將格式設定為 HTML，請使用以下語法：

f=html

height

height 參數的值是顯示在螢幕上的指令輸出行數。以下範例將高度設定為大約等於標準終端螢幕的高度：

height=24

history

history 參數的值是儲存在指令歷程中的指令數。指令歷程可允許使用者檢視之前執行過的指令。此參數是由 set 指令所使用。

history=10

i

i 的值是包含在目前階段作業中之參數定義的輸入檔名稱。在輸入檔案中，每個參數定義均應位於單獨的行上。例如，假設以下各行位於 /home/examples/myParams 檔中：

more=off serverHost=myserver a=myagent:161

您可以使用下行將這些參數包含在目前的 CLI 階段作業中：

i=/home/examples/myParams

log

log 參數的值是記錄所有 CLI 指令和執行指令時間的檔案名稱。請注意，記錄檔僅會記錄指令名稱和執行時間。指令輸出會記錄在由 a 或 o 參數指定的檔案中。設定該參數之後，後續執行的所有指令都會附加至該檔案中。如果該檔案不存在，則會建立該檔案。因為記錄檔在記錄開啟時不會被覆寫，因此如果您想獲取不同的記錄，請確定指定不同的檔案。要關閉記錄功能，請搭配 log 參數使用 unset 指令。以下範例先開啟日誌，然後停止日誌。

> log=/home/examples/sunmc-log ... ... > unset log

logmode

logmode 參數的值可以是 detailed、command 或 from n。detailed 的值會將指令資訊儲存在指令記錄檔中。command 值僅會將指令和其相關參數儲存在指令記錄檔中。from n 值會將所有項目 (從 n^th 項目開始) 從指令歷程附加到指令記錄檔。logmode 參數的預設值為 detailed。

m

m 參數的值是 Sun Management Center 模組的名稱。該值也可以是以逗號分隔的模組清單。

m=kernel-reader

more

more 參數的值會控制顯示的指令輸出頁數。可能的值為 on 和 off。若將 more 設定為 on，則輸出至終端機的所有後續輸出都將一次顯示在一個畫面上。畫面的大小由高度和寬度參數定義。批次模式的預設值為 off，階段作業模式的預設值為 on。

more=on

ncols

ncols 參數的值是 print 指令顯示的指令輸出最大欄數。

o

o 參數的值是指令輸出所寫入檔案的名稱。如果該檔案存在，則覆寫該檔案。您可以透過將 o 參數指定給特定指令，使用 o 參數捕捉指令的輸出。您還可以使用 set 指令將該參數設定為全域參數，以將所有後續輸出寫入檔案。

若皆已設定 append 和 o 參數，append 將會優先 o。輸出會附加至指定的檔案。僅有指令輸出會被寫入該檔案。並不記錄實際指令。使用 log 參數可記錄指令資訊。以下範例定義指令輸出所寫入的檔案。

o=/home/examples/sunmc-output

prompt

prompt 參數的值是用來設定不同的 CLI 提示符號。

serverPort

serverPort 參數的值是用來登入的伺服器連接埠。建立登入階段作業之後，該通用參數將無法設定。如果未設定該參數，則使用預設連接埠 2099。

style

style 參數會判定指令輸出的風格。此參數可使用的值為 table、 list 和 <custom>。table 值會以表格格式顯示輸出。list 值會以清單顯示輸出，各欄間以逗號分隔。<custom> 值可確保以使用者定義的格式顯示輸出。每欄會以 %a 顯示。自訂值可以包含特殊字元，例如 :、\t 和 \n。

t

t 參數的值是在拓樸代理程式中受管理的物件名稱。物件可以是網域、檢視群組或實體。物件名稱是在網域層級的完整名稱，例如 /domain/group/host。