大多數 CLI 參數為名稱 - 值組:每個參數均具有名稱和值。少數參數僅有名稱,沒有值。這些參數稱為旗標。
您可以在 CLI 階段作業中的多個位址指定參數值:
CLI 啟動 – 您可以在啟動 CLI 時在 UNIX 指令行上指定參數。在啟動時指定的參數對於該階段作業來說是通用的。通用參數將保留它們的值,直至用 set 指令置換或使用 unset 指令從目前階段作業中移除。
CLI 指令 – 您可以為在階段作業期間執行的個別 CLI 指令指定參數。被指定為指令一部份的值會暫時置換該指令期間的通用參數值。
輸入檔案 – 參數定義可以儲存在外部檔案中,並可在 CLI 階段作業中隨時被呼叫。在外部檔案中定義的參數值會被通用參數和個別指令參數置換。
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。這些是正確的參數名稱,而非錯誤。
如果旗標包含在 UNIX 指令行上,則啟動 CLI 時,該旗標將指示 CLI 以批次模式執行。該旗標在階段作業模式中將被忽略。
當該旗標用作階段作業模式中指令的參數時,它將指示 CLI 顯示該指令的輔助說明文字。
該旗標的名稱為小寫字母 l(ASCII 字元 0x6c),而非數字 1(ASCII 字元 0x31)。當該旗標用作階段作業模式中延伸指令的參數時,它將指示 CLI 在執行目前指令時保留最近延伸指令的參數。如果已指定 -l 旗標,則為目前指令指定的任何其他參數均被忽略。該旗標對基本指令不起作用。以下範例說明 -l 旗標的用法:
> getLoadModules a=myHostName ... ... > getAlarms -l |
當 getAlarms 指令執行時,該指令使用先前執行的 getLoadModules 指令中參數 a (myHostName) 的值。
a 參數的值是代理程式,可將此值指定為代理程式主機和(可選)連接埠號。如果您要指定連接埠號,請使用冒號 (:) 將該號碼與主機名稱隔開。一般語法為 a=agentHost[:agentPort] 。例如,若要指定在主機 example_host 上執行並收聽連接埠 12345 的代理程式,您可以使用以下語法:
a=example_host:12345 |
a 參數的值也可以是以逗號分隔的代理程式設定清單:a=agent[, agent]+。
append 參數的值是將指令的輸出附加到其中的檔案名稱。如果該檔案不存在,會建立該檔案。如果您將 append 參數設定為通用參數,則該階段作業的所有指令輸出都將附加到指定的檔案中。您還可以為特定指令設定該參數,如以下範例所示。
append=/home/examples/cli_output |
如果 append 和 o 參數均已設定,則 append 優先於 o。僅有指令結果會被記錄在指定檔案中。並不記錄實際指令。使用 log 參數可記錄指令資訊。
columns 參數的值是指要透過 print 指令顯示的一個或多個指令輸出欄位的名稱。欄位名稱區分大小寫。多個欄位名稱以逗號隔開。以下範例使用了數個欄位名稱。
columns="Alarm Id,Node URL,Target Host,Severity" |
f 參數的值決定指令輸出的格式。目前的格式為 plain 和 html。請參閱指令輸出格式,以取得更多資訊。若要將格式設定為 HTML,請使用以下語法:
f=html |
height 參數的值是要顯示在螢幕上的指令輸出的行數。以下範例將高度設定為大約等於標準終端螢幕的高度:
height=24 |
i 參數的值是輸入檔案的名稱,該檔案中包含目前階段作業中要包括的參數定義。在輸入檔案中,每個參數定義均應位於單獨的行上。例如,假定以下各行位於檔案 /home/examples/myParams 中:
more=off serverHost=myserver a=myagent:161 |
您可以使用以下行將這些參數包括在目前 CLI 階段作業中:
i=/home/examples/myParams |
log 參數的值是記錄所有 CLI 指令及指令執行時間的檔案名稱。請注意,日誌檔僅記錄指令名稱和執行時間。指令輸出記錄在由 a 或 o 參數指定的檔案中。設定該參數之後,後續執行的所有指令都會附加至該檔案中。如果該檔案不存在,會建立該檔案。因為日誌檔在記錄開啟時不會被覆寫,因此如果您想獲取不同的日誌,請確定指定不同的檔案。若要關閉記錄,請 unset(取消設定)log 參數。以下範例先開啟日誌,然後停止日誌。
> log=/home/examples/sunmc-log ... ... > unset log |
m 參數的值是 Sun Management Center 模組的名稱。該值也可以是以逗號分隔的模組清單。
m=kernel-reader |
more 參數的值可控制顯示器上指令輸出的分頁。可能的值為 on 和 off。如果將 more 設定為 on,則輸出至終端的所有後續輸出都將一次顯示在一個畫面上。 畫面的大小由高度和寬度參數定義。批次模式的預設值為 off,階段作業模式的預設值為 on。
more=on |
o 參數的值是指令輸出所寫入檔案的名稱。如果該檔案存在,則覆寫該檔案。您可以透過將 o 參數指定給特定指令, 使用 o 參數捕捉指令的輸出。您還可以使用 set 指令將該參數設定為通用參數,以將所有後續輸出寫入檔案。
如果 append 和 o 參數均已設定,則 append 優先於 o。輸出會附加至指定的檔案。僅有指令輸出會被寫入該檔案。 並不記錄實際指令。使用 log 參數可記錄指令資訊。以下範例定義指令輸出所寫入的檔案。
o=/home/examples/sunmc-output |
serverHost 參數的值決定 CLI 登入時連接的伺服器主機。一旦 CLI 連接至伺服器,該通用參數將無法變更。
serverPort 參數的值是登入的伺服器連接埠。建立登入階段作業之後,該通用參數將無法設定。如果未設定該參數,則使用預設連接埠 2099。
t 參數的值是拓樸代理程式中受管理物件的名稱。物件可以是領域、檢視群組或實體。物件名稱是以領域開頭的完整名稱,例如 /domain/group/host。