- 首頁
- /
- 文章
在 Cisco BroadWorks 上佈建電話的參數
此說明文章適用於已向Cisco BroadWorks 註冊的Cisco電話。此頁面上的資訊包括佈建參數及其語法。
佈建參數類型
本節描述了根據功能大致組織的佈建參數。
一般用途參數
通用參數 GPP_* (
) 在將電話設定為與特定佈建伺服器解決方案互動時,用作免費字串註冊。 依預設,GPP_* 參數為空。 可以將它們配置為包含各種值,包括以下值:-
加密金鑰
-
URL
-
多階段佈建狀態資訊。
-
後請求範本
-
參數名稱別名對應
-
部分字串值,最終會結合為完整的參數值。
GPP_* 參數可用於其他佈建參數中的巨集擴充。 因此,單個字母大寫的巨集名稱(A 到 P)足以識別 GPP_A 到 GPP_P 的內容。 另外,當用作以下URL選項的參數時,兩個字母的大寫宏名稱 SA 到 SD 將 GPP_SA 到 GPP_SD 識別為特殊情況:
鍵, uid ,以及密碼
這些參數可在佈建和升級規則中用作變數。 透過在變數名稱前加上「$」字元(例如 $GPP_A)來引用它們。
啟用參數
Provision_Enable 和Upgrade_Enable 參數控制所有設定檔重新同步,以及韌體升級操作。 這些參數相互獨立地控制重新同步和升級。 這些參數還控制透過管理Web 伺服器發出的重新同步和升級URL指令。 這兩個參數都設定為是預設情況下。
ReSync_From_SIP 參數控制重新同步操作的請求。 SIP NOTIFY 事件會從服務提供者的代理伺服器傳送至電話。 如果啟用,則 Proxy 可以請求重新同步。 為此,Proxy 會傳送包含以下事件的SIP NOTIFY 訊息: 將標頭重新同步到裝置。
裝置透過 401 回應(拒絕已使用的憑證授權)質詢該請求。 裝置在接受來自 Proxy 的重新重新同步要求之前,需要經過驗證的後續請求。 活動: reboot_now 和活動: restart_now 標頭分別執行冷啟動和熱重新啟動,這些重新啟動也會受到質詢。
其餘兩個啟用是 ReSync_On_Reset 和 ReSync_After_Upgrade_Attempt。 這些參數決定了裝置在啟動軟體重新啟動後以及每次升級嘗試後是否執行重新重新同步操作。
當啟用 ReSync_On_Reset 時,裝置會在啟動序列之後在執行重設之前引入隨機延遲。 延遲是一個隨機時間,最大為 ReSync_隨機_延遲(以秒為單位)指定的值。 在同時啟動的電話集區中,此延遲會分散來自每個裝置的重新同步請求的開始時間。 此功能在大型住宅部署中非常有用,以防發生區域電源故障。
觸發器
電話可讓您以特定的間隔或特定時間重新同步。
以特定時間間隔重新同步
電話會定期與佈建伺服器重新同步。 重新同步間隔以 ReSync_Periodic(秒)為單位配置。 如果此值保留為空,裝置不會定期重新同步。
重新同步通常發生在語音線路空閒時。 如果在到期時語音線路處於使用中,電話會延遲重新同步程序,直到線路再次變為空閒狀態。 重新同步可能會導致組態參數值變更。
重新重新同步操作可能會失敗,因為電話無法從伺服器中擷取設定檔、下載的檔案已損壞或發生內部錯誤。 裝置會在經過 ReSync_Error_Retry_Delay 中指定的時間(秒)之後嘗試再次重新同步。 如果 ReSync_Error_Retry_Delay 設定為 0,則裝置在重新同步嘗試失敗後不會嘗試再次重新同步。
如果升級失敗,會在Upgrade_Error_Retry_Delay 秒後重試。
有兩個可配置參數可用於有條件地觸發重新同步: ReSync_Trigger_1 和 ReSync_Trigger_2。 每個參數均可使用可進行巨集擴充的條件表達式來編程。 當重新同步間隔到期(下一次重新同步的時間)時,觸發器(若已設定)將阻止重新同步,除非一個或多個觸發器的評估結果為 true。
以下範例條件觸發重新同步。 在此範例中,上次電話升級嘗試已超過 5 分鐘 (300 秒),且自上次重新同步嘗試以來已至少 10 分鐘 (600 秒)。
$UPGTMR gt 300 和 $PRVTMR ge 600
在特定時間重新同步
ReSync_At 參數可讓電話在特定時間重新同步。 此參數使用 24 小時格式 (hhmm) 來指定時間。
ReSync_At_Random_Delay 參數可讓電話以未指定的延遲重新同步。 此參數使用正整數格式來指定時間。
應避免來自多部電話且設定為同時重新同步的重新同步請求淹沒伺服器。 為此,電話會在指定時間後最多 10 分鐘觸發重新同步。
例如,如果您將重新同步時間設定為 1000(上午 10 點),則電話會在上午 10 點到 10 點之間的任何時間觸發重新同步。
依預設,會停用此功能。 如果佈建了 ReSync_At 參數,則忽略 ReSync_Periodic 參數。
可配置的排程
您可以配置定期重新同步的排程,並且可以使用以下佈建參數指定重新同步和升級失敗的重試間隔:
-
重新同步_定期
-
ReSync_Error_Retry_Delay
-
升級_錯誤_重試_延遲
每個參數接受一個延遲值(秒)。 新的擴展語法允許使用逗號分隔的連續延遲元素清單。 序列中的最後一個元素會永遠隱式重複。
(可選)您可以使用加號來指定附加隨機額外延遲的另一個數值。
範例 1
在此範例中,電話會每隔 2 小時定期重新同步一次。 如果發生重新同步失敗,裝置會在以下時間間隔重試: 30 分鐘,1 小時,2 小時,4 小時。 裝置會繼續每隔 4 小時嘗試一次,直到它成功重新同步。
ReSync_Periodic=7200 ReSync_Error_Retry_Delay=1800,3600,7200,14400
範例 2
在此範例中,裝置會每小時定期重新同步(外加最多 10 分鐘的額外隨機延遲)。 如果重新同步失敗,裝置會在以下時間間隔重試: 30 分鐘(加上最多 5 分鐘)。 1 小時(最多 10 分鐘)、 2 小時(最多 15 分鐘)。 裝置會繼續每隔 2 小時嘗試一次(最多 15 分鐘),直到它成功重新同步。
ReSync_Periodic=3600+600 ReSync_Error_Retry_Delay=1800+300,3600+600,7200+900
範例 3
在此範例中,如果遠端升級嘗試失敗,裝置會在 30 秒後重試升級。 分鐘,然後在一小時後再次顯示,然後在兩個小時後再次顯示。 如果升級仍然失敗,裝置會每隔四到五個小時重試一次,直到升級成功。
升級_錯誤_重試_延遲 = 1800,3600,7200,14400+3600
設定檔規則
電話提供了多個遠端設定檔參數 (Profile_Rule*)。 因此,每個重新同步操作都可以擷取不同伺服器管理的多個檔案。
在最簡單的情況下,裝置會定期重新同步到中央伺服器上的單一設定檔,從而更新所有相關的內部參數。 或者,可以在不同的檔案之間分割設定檔。 一個檔案對部署中的所有電話通用。 我們會為每個帳戶提供一個單獨的唯一檔案。 加密金鑰和憑證資訊可由另一個設定檔提供,儲存在單獨的伺服器上。
每當重新同步操作到期時,電話都會順序評估四個 Profile_Rule* 參數:
-
Profile_Rule
-
Profile_Rule_B
-
Profile_Rule_C
-
Profile_Rule_D
每次評估都可能導致從遠端佈建伺服器擷取設定檔,並可能更新某些內部參數。 如果評估失敗,重新同步序列會中斷,並從 ReSync_Error_Retry_Delay 參數指定的開頭重試(以秒計)。 如果所有評估成功,裝置會等待 ReSync_Periodic 參數指定的秒數,然後執行另一次重新同步。
每個 Profile_Rule* 參數的內容都包含一組選項。 替代方案由 | 分隔。 (管道)字元。 每個替代項都包含條件表達式、指定表達式、設定檔URL以及任何關聯的URL選項。 在每個選項中,所有這些元件都是可選的。 以下是有效的組合及其必須出現的順序(若存在):
[ 條件表達式 ] [ 指派-表達 ] [[ 選項 ] URL ]
在每個 Profile_Rule* 參數中,除最後一個之外的所有選項都必須提供條件表達式。 此表達式的評估和處理方式如下:
-
條件的評估順序是從左到右,直到找到一個評估為 true 的條件(或直到找到一個沒有條件表達式的備選條件)。
-
評估任何隨附的指定表達式(如果存在)。
-
如果URL指定為該替代項的一部分,則係統會嘗試下載位於指定URL的設定檔。 系統會嘗試相應地更新內部參數。
如果所有備選方案都有條件表達式,而「無」的評估結果為 true(或如果整個設定檔規則為空),則會跳過整個 Profile_Rule* 參數。 評估序列中的下一個設定檔規則參數。
範例 1
此範例無條件地重新同步到指定URL處的設定檔,並且執行對遠端佈建伺服器的 HTTP GET 請求:
http://remote.server.com/cisco/$MA.cfg
範例 2
在此範例中,裝置會根據線路 1 的註冊狀態,重新同步至兩個不同的 URL。 如果丟失註冊,裝置會執行 CGI 指令檔的 HTTP POST。 裝置會傳送 GPP_A 巨集的內容,這可能會提供有關裝置狀態的其他資訊:
($PRVTMR ge 600)? http://p.tel.com/has-reg.cfg | [--發布] http://p.tel.com/lost-reg?
範例 3
在此範例中,裝置會重新同步到相同的伺服器。 若裝置中未安裝憑證,裝置會提供其他資訊(適用於 2.0 版之前的舊版裝置):
(「$CCERT」 當「已安裝」)? https://p.tel.com/config? | 家https://p.tel.com/config?cisco$MAU
範例 4
在此範例中,線路 1 被停用,直到 GPP_A 設定為 已佈建 透過第一個URL。 之後,它會重新同步到第二個URL:
(「$A」和「已佈建」)? ( Line_Enable_1_ = “否”;)! https://p.tel.com/init-prov | https://p.tel.com/configs
範例 5
在此範例中,假設伺服器傳回的設定檔包含XML元素標籤。 這些標籤必須透過儲存在 GPP_B 中的別名對映,重新對映為正確的參數名稱:
[--別名 b] https://p.tel.com/account/$PN$ MA.xml
如果未從伺服器接收到請求的設定檔,通常會認為重新同步失敗。 ReSync_Fails_On_FNF 參數可以覆寫此預設行為。 如果 ReSync_Fails_On_FNF 設定為「否」,裝置會接受來自伺服器的找不到檔案回應,作為成功的重新同步。 ReSync_Fails_On_FNF 的預設值是「是」。
升級規則
升級規則是告知裝置啟動至新的載入以及在必要時從哪裡取得載入。 若裝置上已存在載入,則不會嘗試取得載入。 因此,當所需的載入在非作用中分區中時,載入位置的有效性並不重要。
Upgrade_Rule 指定的韌體載入(若與目前的載入不同)將被下載並套用,除非受到條件表達式的限製或Upgrade_Enable 設定為無。
電話提供了一個可配置的遠端升級參數:Upgrade_Rule。 此參數接受與設定檔規則參數相似的語法。 升級不支援URL選項,但可以使用條件表達式和指定表達式。 如果使用了條件表達式,則可以在參數中填入多個選項,並以 | 分隔。字元。 每個替代項的語法如下:
[ 條件表達式 ] [ 指派-表達 ] URL
與 Profile_Rule* 參數的情況一樣,Upgrade_Rule 參數也會評估每個備選方案,直到滿足條件表達式或備選方案沒有條件表達式為止。 評估隨附的指定表達式(若指定)。 然後,會嘗試升級至指定的URL 。
如果Upgrade_Rule 包含沒有條件表達式的URL ,裝置會升級至URL指定的韌體映像。 在進行規則擴充和評估後,裝置不會重新嘗試升級,直到修改規則,或變更方案 + 伺服器 + 埠 + 檔案路徑的有效組合為止。
若要嘗試韌體升級,裝置會在程序開始時停用音訊,並在程序結束時重新啟動。 僅在所有語音線路目前均為非活躍狀態時,裝置才會自動開始由Upgrade_Rule 內容驅動的升級。
譬如,
https://10.73.10.223/韌體/PHONEOS-8875.1-0-1-0001-1.loads
在此範例中,Upgrade_Rule 將韌體升級為儲存在指定URL處的映像。
這是另一個範例:
(「$F」和「測試版客戶」)? http://p.tel.com/韌體/PHONEOS-8875.1-0-1-0001-1.loads | http://p.tel.com/韌體/PHONEOS-8875.1-0-1-0001-1.loads
此範例根據通用參數 GPP_F 的內容,引導裝置載入兩個影像之一。
佈建參數
您可以在下列網站上找到佈建參數:佈建電話網頁中的標籤。
配置設定檔參數
下表定義了配置設定檔參數區段下的佈建標籤。
參數名稱 |
描述和預設值 |
---|---|
啟用佈建 |
獨立於韌體升級動作控制所有重新同步動作。 設定為是以啟用遠端佈建。 預設值「是」。 |
重設時重新同步 |
每次重新啟動後觸發重新同步,由參數更新和韌體升級導致的重新同步除外。 預設值「是」。 |
重新同步隨機延遲 |
啟動序列後執行重設前的隨機延遲,以秒為單位指定。 在排定同時啟動的IP電話裝置集區內,這會引入每個裝置向佈建伺服器傳送重新重新同步要求的時間上的差異。 此功能在大型住宅部署中非常有用,以防發生區域電源故障。 此欄位的值必須是 0 到 65535 之間的整數。 預設值是 2。 |
重新同步於 (HHmm) |
裝置與佈建伺服器重新同步的時間 (HHmm)。 此欄位的值必須是從 0000 到 2400 的四位數字,才能以 HHmm 格式指示時間。 例如,0959 表示 09:59。 預設值空。 如果值無效,則會忽略此參數。 如果此參數設定了有效值,則會忽略「重新同步」參數。 |
隨機延遲時重新同步 |
當大量裝置同時開啟時,防止佈建伺服器超載。 為了避免從多部電話對伺服器發出大量重新同步請求,電話會在小時與分鐘之間以及小時與分鐘加上隨機延遲(hhmm、hhmm+隨機延遲)之間的範圍內重新同步。 例如,如果隨機延遲 = (在隨機延遲時重新同步 + 30)/60 分鐘,以秒為單位的輸入值會轉換為分鐘,並會四捨五入到下一分鐘以計算最終的隨機延遲間隔。 有效值範圍介於 600 和 65535 之間。 如果該值小於 600,則內部隨機延遲介於 0 與 600 之間。 預設值是 600 秒(10 分鐘)。 |
定期重新同步 |
與佈建伺服器定期重新同步之間的時間間隔。 僅在第一次成功與伺服器同步後,關聯的重新同步計時器才可用。 有效的格式如下:
將此參數設定為零以停用定期重新同步。 預設值是 3600 秒。 |
重新同步錯誤重試延遲 |
如果重新重新同步操作失敗,因為IP電話裝置無法從伺服器中擷取設定檔,下載的檔案已損壞,或發生內部錯誤,裝置會在指定的時間(以秒為單位)後嘗試再次重新同步。 有效的格式如下:
如果延遲設定為 0,則裝置在重新同步嘗試失敗後不會嘗試再次重新同步。 |
強制重新同步延遲 |
電話在執行重新同步前等待的延遲最大值 (以秒為單位)。 當其中一個電話線路在使用中時,裝置不會重新同步。 因為重新同步可能需要幾秒的時間,所以最好等到裝置長時間處於閒置狀態後再重新同步。 這可讓使用者不間斷地連續撥打電話。 裝置設有一個計時器,當其所有線路變為閒置狀態時,便開始倒數。 此參數是計數器的初始值。 重新同步事件會有所延遲,直到此計數器遞減至零。 有效值範圍介於 0 到 65535 之間。 預設值是 14,400 秒。 |
從SIP重新同步 |
允許透過SIP NOTIFY 訊息觸發重新同步。 預設值「是」。 |
嘗試升級後重新同步 |
在進行任何升級後啟用或停用重新重新同步操作。 如果選擇是,則會觸發同步。 預設值「是」。 |
重新同步觸發 1, 重新同步觸發 2 |
可配置的重新同步觸發條件。 當這些參數中的邏輯等式評估為 TRUE 時,會觸發重新同步。 預設值(空)。 |
在 FNF 上重新同步失敗 |
如果未從伺服器接收到請求的設定檔,則重新同步被視為失敗。 此參數可覆寫此功能。 當它設定為無,裝置接受找不到檔案重新同步成功。 預設值「是」。 |
設定檔規則 設定檔規則 B 設定檔規則 C 設定檔規則 D |
每個設定檔規則都會通知電話您要從中獲取設定檔(組態檔)的來源。 每次重新同步操作期間,電話都會順序套用所有設定檔。 預設值: 若您對組態檔套用AES-256-CBC 加密,請使用下列字元指定加密金鑰: --鍵關鍵字如下:
您可以選擇性地用雙引號 (") 括起加密金鑰。 |
使用的 DHCP選項 |
以逗號分隔的DHCP選項,用於擷取韌體和設定檔。 預設值是 66,160,159,150,60,43,125。 |
記錄請求訊息 |
此參數包含在重新同步嘗試開始時傳送至 syslog 伺服器的訊息。 預設值是 |
記錄成功訊息 |
成功完成重新同步嘗試後發出的 syslog 訊息。 預設值是 |
記錄失敗訊息 |
重新同步嘗試失敗後發出的 syslog 訊息。 預設值是 |
使用者可設定的重新同步 |
允許用戶從IP 電話屏幕重新同步電話。 預設值「是」。 |
韌體升級參數
下表定義了韌體升級的區段佈建標籤。
參數名稱 |
描述和預設值 |
---|---|
啟用升級 |
啟用獨立於重新同步動作的韌體升級操作。 預設值「是」。 使用以下其中一個方法配置此參數:
|
升級錯誤重試延遲 |
在升級失敗的情況下套用的升級重試間隔(以秒為單位)。 裝置設有韌體升級錯誤計時器,在韌體升級嘗試失敗後啟動。 計時器會使用此參數中的值初始化。 當此計時器倒計時至零時,會嘗試下一次韌體升級嘗試。 預設值是 3600 秒。 使用以下其中一個方法配置此參數:
|
升級規則 |
定義升級條件及關聯的韌體 URL 的韌體升級指令檔。 它使用與設定檔規則相同的語法。 使用以下格式輸入升級規則:
譬如:
如果未指定通訊協定,則假定為TFTP 。 若未指定伺服器名稱,則請求URL的主機會用作伺服器名稱。 若未指定通訊埠,將使用預設埠( TFTP為 69, HTTP 為 80 或 HTTPS 為 443)。 預設值空白。 使用以下其中一個方法配置此參數:
|
記錄升級請求訊息 |
開始嘗試升級韌體時發出 Syslog 訊息。 預設值: 使用以下其中一個方法配置此參數:
|
記錄升級成功訊息 |
韌體升級嘗試成功完成後發出 Syslog 訊息。 預設值是 使用以下其中一個方法配置此參數:
|
記錄升級失敗訊息 |
韌體升級嘗試失敗後發出 Syslog 訊息。 預設值是 使用以下其中一個方法配置此參數:
|
對等韌體共用 |
啟用或停用對等韌體共用 (PFS) 功能。 選取是或無啟用或停用該功能。 預設值: 是 使用以下其中一個方法配置此參數:
|
對等韌體共用記錄伺服器 |
指出接收UDP訊息的IP 位址和通訊埠。 譬如: 10.98.76.123:514,其中 10.98.76.123 是IP 位址,而 514 是通訊連接埠號碼。 使用以下其中一個方法配置此參數:
|
一般用途參數
下表定義了一般用途參數的區段佈建標籤。
參數名稱 |
描述和預設值 |
---|---|
GPP A - GPP P |
當將電話設定為與特定佈建伺服器解決方案互動時,通用參數 GPP_* 會用作自由字串寄存器。 可以將它們配置為包含各種值,包括以下值:
預設值空白。 |
宏擴充變數
可在下列佈建參數中識別某些宏變數:
-
Profile_Rule
-
Profile_Rule_*
-
ReSync_Tiger_*
-
Upgrade_Rule
-
記錄_*
-
GPP_*(在特定條件下)
在這些參數中,可識別和擴充語法類型,例如 $NAME 或 $(NAME)。
可使用表示法 $(NAME:p) 和 $(NAME:p:q) 來指定宏變數子字串,其中 p 和 q 是非負整數(在 2.0.11 版及以上版本中可用)。 產生的宏展開是從字元偏移量 p 開始、長度為 q 的子字串(如果未指定 q,則直到字串結束)。 例如,如果 GPP_A 包含 ABCDEF,則 $(A:2) 會擴充為 CDEF,而 $(A:2:3) 會擴充為 CDE。
無法識別的名稱將不被翻譯,且 $NAME 或 $(NAME) 形式在擴充後在參數值中保持不變。
參數名稱 |
說明和預設值 |
---|---|
$ |
表格 $$ 擴充為單個 $ 字元。 |
A 到 P |
已由通用參數 GPP_A 到 GPP_P 的內容取代。 |
SA 到 SD |
已由特殊用途參數 GPP_SA 到 GPP_SD 取代。 這些參數包含佈建中使用的金鑰或密碼。 $SA 到 $SD 被識別為可選重新同步URL限定詞 --key 的參數。 |
馬 |
MAC 位址使用小寫的十六進制數字,例如 000e08aabbcc。 |
MAU |
MAC 位址使用大寫的十六進制數字,例如 000E08AABBCC。 |
MAC |
MAC 位址使用小寫的十六進制數字,並使用冒號來分隔十六進制數字對。 例如 00:0e:08:aa:bb:cc。 |
PN |
產品名稱。 例如,CP-8875-CC-C-9K。 |
PSN | 產品系列號。 例如 V03。 |
SN |
序號字串。例如 88012BA01234。 |
CCERT |
SSL用戶端憑證狀態: 已安裝或未安裝。 |
IP |
電話本地子網的IP 位址。 例如 192.168.1.100。 |
EXTIP |
電話的外部IP ,如網際網路中所示。 例如 66.43.16.52。 |
SWVER |
軟體版本字串。 譬如, PHONEOS-8875.1-0-1-0001-1 |
硬體 |
硬體版本字串。 例如 2.0.1 |
PRVST |
佈建狀態(數字字串): -1 = 明確的重新同步要求 0 = 啟動時重新同步 1 = 定期重新同步 2 = 重新同步失敗,重試嘗試 |
UPGST |
升級狀態(數字字串): 1 = 第一次嘗試升級 2 = 升級失敗,請重試 |
UPGERR |
先前升級嘗試的結果訊息(ERR);例如 http_get 失敗。 |
PRVMR |
自上次嘗試重新同步以來的秒數。 |
UPGTMR |
自上次嘗試升級以來的秒數。 |
REGTMR1 |
自線路 1 失去與SIP伺服器的註冊以來的秒數。 |
REGTMR2 |
自線路 2 丟失SIP伺服器註冊以來的秒數。 |
UPGCOND |
舊版巨集名稱。 |
計劃 |
檔案存取方案, TFTP,HTTP 或 HTTPS 之一,在解析重新同步或升級URL後獲得。 |
SERV |
解析重新同步或升級URL後獲得的請求目標伺服器主持人名稱。 |
服務 |
請求目標伺服器 IP位址(在剖析重新同步或升級URL後)(可能在DNS查找之後)。 |
埠 |
解析重新同步或升級URL後獲得的請求目標UDP/ TCP 連接埠。 |
路徑 |
請求目標檔案路徑,如在剖析重新同步或升級URL後獲得的。 |
錯誤 |
重新同步或升級嘗試的結果訊息。 僅在產生結果 syslog 訊息時有用。 當嘗試升級時,該值將保留在 UPGERR 變數中。 |
UIDn |
「線路 n 使用者 ID」組態參數的內容。 |
EMS |
Extension Mobility狀態 |
MUID |
Extension Mobility使用者ID |
MPWD |
Extension Mobility密碼 |
內部錯誤代碼
電話定義了許多內部錯誤代碼(X00–X99),以便於進行設定,從而在某些錯誤情況下對裝置的行為提供更精確的控制。
參數名稱 |
描述和預設值 |
---|---|
X00 |
傳送SIP要求時,傳輸層(或 ICMP)錯誤。 |
X20 |
SIP請求在等待回應時逾時。 |
X40 |
一般SIP協定錯誤(例如,SDP 中的編解碼器在 200 和 ACK 訊息中不被接受,或者在等待 ACK 時逾時)。 |
X60 |
根據給定的撥號計劃,撥出號碼無效。 |