設定電話以進行設定檔重新同步

電話支援用於擷取設定檔的多種網路通訊協定。 最基本的設定檔傳送通訊協定是TFTP (RFC1350)。 TFTP廣泛用於私人 LAN 網路中的網路裝置的佈建。 雖然不建議在網際網路中部署遠端端點,但TFTP適合在小型組織內部署、內部預佈建以及開發和測試。 在以下流程中,從TFTP伺服器下載檔案後會修改設定檔。

1

在 LAN 環境中,將電腦和電話連接到集線器、交換器或小型路由器。

2

在電腦上,安裝並啟動TFTP伺服器。

3

使用文字編輯器來建立組態檔。

稍後要驗證該設定檔是否已在您的電話中佈建,您可以將部分值設定為標記。 例如,將 GPP_A 的值設定為 12345678,如以下範例所示:
 <flat-profile>  <GPP_A> 12345678   </GPP_A></flat-profile> 
4

將XML組態檔儲存在TFTP伺服器的根目錄中。

您可以驗證是否已正確設定TFTP伺服器: 使用電話以外的TFTP用戶端請求配置檔案。 最好使用在與佈建伺服器不同的主機上執行的TFTP用戶端。

5

在電腦上的 Web 瀏覽器中,開啟管理網頁。 例如,假設電話的IP 位址是 192.168.1.100,請在 Web 瀏覽器中開啟以下URL :

 http://192.168.1.100/admin/advance 
6

選取語音>佈建標籤,然後檢查通用參數 GPP_A 至 GPP_P 的值。 這些應該為空。

7

將測試電話重新同步至您在 Web 瀏覽器中開啟重新同步URL所建立的設定檔。

範例:

若TFTP伺服器的IP 位址為 192.168.1.200,則指令應該與以下範例相似:

 http://192.168.1.100/admin/reSync?tftp://192.168.1.200/basic.txt 

當電話收到此指令時,地址 192.168.1.100 處的裝置會請求配置檔案基本的.txt從IP 位址192.168.1.200 的TFTP伺服器。 然後,電話會剖析下載的檔案,並使用值 12345678 更新 GPP_A 參數。

8

驗證是否已正確更新參數。 重新整理管理網頁並轉至語音>佈建

GPP_A 參數現在應該包含值 12345678。

1

請從產品標籤上獲取電話的MAC 位址。 ( MAC 位址是使用數字和小寫十六進制數字的數字,例如 000e08aabbcc。

2

將您的組態檔重新命名為CP-xxxx MAC 位址.cfg (取代xxxx包含型號和MAC 地址使用電話的MAC 位址)。

範例:

CP-8875 000e08aabbcc.cfg

3

將新檔案移至TFTP伺服器的虛擬根目錄。

4

存取電話管理網頁。

5

選取語音 >佈建

6

在 中輸入設定檔的路徑設定檔規則欄位。

範例: 假設TFTP伺服器 IP位址為 192.168.1.200 而設定檔名為

 <Profile_Rule>tftp://192.168.1.200/CP-8875$MA.cfg</Profile_Rule> 
7

按一下提交所有變更。 這會導致立即重新啟動並重新同步。

下次重新同步時,電話會透過將 $MA 巨集表達式展開為其MAC 位址來擷取新檔案。

1

在本地電腦或其他可存取的主機上安裝 HTTP 伺服器。

可從互聯網下載開源 Apache 伺服器。

2

將組態檔上傳至已安裝伺服器的虛擬根目錄。

3

若要驗證伺服器安裝是否正確以及對設定檔的存取權,請使用 Web 瀏覽器開啟設定檔。

4

修改測試電話的 Profile_Rule 以指向 HTTP 伺服器來代替TFTP伺服器,以便定期下載其設定檔。

例如,假設 HTTP 伺服器位於 192.168.1.300 且設定檔名為 basic.txt,請輸入以下值:

<Profile_Rule>http://192.168.1.200/basic.txt</Profile_Rule>
5

按一下提交所有變更。 這會導致立即重新啟動並重新同步。

6

查看電話傳送的 syslog 訊息。 定期重新同步現在應該從 HTTP 伺服器獲取設定檔。

7

在 HTTP 伺服器記錄中,觀察識別測試電話的資訊在使用者代理記錄中的顯示方式。

這項資料應包括製造商、產品名稱、目前韌體版本和列序號。

裝置可以定期與佈建伺服器重新同步,以確保在伺服器上進行的任何設定檔變更都會傳播至端點裝置(而不是向端點傳送明確的重新重新同步要求)。

若要使電話定期重新同步至伺服器,請使用 Profile_Rule 參數定義設定檔URL ,並使用 ReSync_Periodic 參數定義重新同步週期。

1

存取電話管理網頁。

2

選取語音 >佈建

3

定義 Profile_Rule 參數。 此範例假設TFTP伺服器 IP位址為 192.168.1.200。

4

在定期重新同步欄位中,請輸入一個較小的值進行測試,例如30秒。

5

按一下提交所有變更。

使用新的參數設定,電話會每分鐘與URL指定的組態檔重新同步兩次。

6

查看 syslog 追踪中產生的訊息。

7

確保重設時重新同步欄位設定為是。

 <Resync_On_Reset>是</Resync_On_Reset> 
8

重新啟動電話,以強制其重新同步至佈建伺服器。

若重新同步操作由於任何原因失敗,譬如伺服器沒有回應,裝置會等待(在設定的秒數內)。重新同步錯誤重試延遲) 之前,它會嘗試再次重新同步。 如果重新同步錯誤重試延遲為零,則電話在嘗試重新同步失敗後不會嘗試重新同步。

9

(可選)設定下列屬性的值:重新同步錯誤重試延遲欄位為較小的數字,例如30 。

 <Resync_Error_Retry_Delay>30</Resync_Error_Retry_Delay> 
10

停用TFTP伺服器,並觀察 syslog 輸出中的結果。

下表定義了設定檔重新同步參數在配置設定檔區段下的語音>佈建電話網頁中的標籤。 它還會定義電話組態檔 ( XML ) 中新增的字串的語法,以配置參數。

表 1. 設定檔重新同步參數

參數

說明

啟用佈建

允許或拒絕設定檔重新同步動作。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Provision_Enable ua="na">是</Provision_Enable>
  • 在電話網頁,請將此欄位設定為是以允許重新同步動作,或無以封鎖重新同步動作。

預設值: 是

重設時重新同步

指定在啟動後以及每次嘗試升級後,電話是否將組態與佈建伺服器重新同步。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Resync_On_Reset ua="na">是</Resync_On_Reset>
  • 在電話網頁,請將此欄位設定為是允許在啟動或重設時重新同步,或無以封鎖在啟動或重設時的重新同步。

預設值: 是

重新同步隨機延遲

當大量裝置同時開啟並嘗試初始設定時,防止佈建伺服器超載。 此延遲僅對裝置開啟或重設後的初始設定嘗試有效。

此參數是裝置在與佈建伺服器建立聯絡之前所等待的最長時間間隔。 實際延遲是介於 0 與此值之間的偽隨機數。

此參數以 20 秒為單位。

有效值範圍介於 0 到 65535 之間。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Resync_Random_Delay ua="na">2</Resync_Random_Delay>
  • 在電話網頁,請指定電話在啟動或重設後要延遲重新同步的單位數(20 秒)。

預設值是 2(40 秒)。

重新同步於 (HHmm)

電話與佈建伺服器重新同步的時間 (HHmm)。

此欄位的值必須是從 0000 到 2400 的四位數字,才能以 HHmm 格式指示時間。 例如,0959 表示 09:59。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Resync_At__HHmm_ ua="na">0959</Resync_At__HHmm_>
  • 在電話網頁,請以 HHMM 格式指定電話開始重新同步的時間。

預設值空。 如果值無效,則會忽略此參數。 如果此參數設定了有效值,則會忽略「重新同步」參數。

隨機延遲時重新同步

當大量裝置同時開啟時,防止佈建伺服器超載。

為了避免從多部電話對伺服器發出大量重新同步請求,電話會在小時與分鐘之間以及小時與分鐘加上隨機延遲(hhmm、hhmm+隨機延遲)之間的範圍內重新同步。 例如,如果隨機延遲 =(隨機延遲時重新同步 + 30)/60 分鐘,則以秒為單位的輸入值會轉換為分鐘,並四捨五入到下一分鐘以計算最終的 random_delay 間隔。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Resync_At_Random_Delay ua="na">600</Resync_At_Random_Delay>
  • 在電話網頁,以秒為單位指定時期範圍。

有效值範圍介於 600 和 65535 之間。

如果該值小於 600,則內部隨機延遲介於 0 與 600 之間。

預設值是 600 秒 (10 分鐘)。

定期重新同步

與佈建伺服器定期重新同步的時間間隔。 僅在第一次成功與伺服器同步後,關聯的重新同步計時器才可用。

有效的格式如下:

  • 整數

    範例: 的輸入3000表示下一次重新同步發生在 3000 秒後。

  • 多個整數

    範例: 的輸入600,1200,300表示第一次重新同步在 600 秒後發生,第二次重新同步在第一次重新同步後的 1200 秒後發生,第三次重新同步在第二次重新同步後的 300 秒內發生。

  • 時間範圍

    譬如,輸入2400+30表示下一次重新同步發生在成功重新同步後的 2400 秒到 2430 秒之間。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Resync_Periodic ua="na">3600</Resync_Periodic>
  • 在電話網頁,以秒為單位指定時期範圍。

將此參數設定為零以停用定期重新同步。

預設值是 3600 秒。

重新同步錯誤重試延遲

如果重新重新同步操作失敗,因為電話無法從伺服器中擷取設定檔,下載的檔案已損壞,或發生內部錯誤,電話會在指定的時間(以秒為單位)後嘗試再次同步。

有效的格式如下:

  • 整數

    範例: 的輸入300表示下一次重新同步重試發生在 300 秒後。

  • 多個整數

    範例: 的輸入600,1200,300表示第一次重試在失敗後 600 秒內進行,第二次重試在第一次重試失敗後 1200 秒進行,而第三次重試在第二次重試失敗後 300 秒內進行。

  • 時間範圍

    譬如,輸入2400+30表示下一次重試發生在重新同步失敗後的 2400 到 2430 秒之間。

如果延遲設定為 0,則裝置在重新同步嘗試失敗後不會嘗試再次重新同步。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Resync_Error_Retry_Delay ua="na">60,120,240,480,960,1920,3840,7680,15360,30720,61440,86400</Resync_Error_Retry_Delay>
  • 在電話網頁,以秒為單位指定時期範圍。

預設值: 60,120,240,480,960,1920,3840,7680,15360,30720,61440,86400

強制重新同步延遲

電話在執行重新同步前等待的延遲最大值 (以秒為單位)。

當其中一個電話線路在使用中時,裝置不會重新同步。 因為重新同步可能需要幾秒的時間,所以最好等到裝置長時間處於閒置狀態後再重新同步。 這可讓使用者不間斷地連續撥打電話。

裝置設有一個計時器,當其所有線路變為閒置狀態時,便開始倒數。 此參數是計數器的初始值。 重新同步事件會有所延遲,直到此計數器遞減至零。

有效值範圍介於 0 到 65535 之間。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Forced_Resync_Delay ua="na">14400</Forced_Resync_Delay>
  • 在電話網頁,以秒為單位指定時期範圍。

預設值是 14,400 秒。

從SIP重新同步

透過從服務提供者的代理伺服器傳送至電話的SIP NOTIFY 事件,控制重新同步作業的請求。 如果啟用,則代理可以透過傳送包含以下事件的SIP NOTIFY 訊息來請求重新同步: 將標頭重新同步到裝置。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Resync_From_SIP ua="na">是</Resync_From_SIP>
  • 在電話網頁,選取是啟用此功能,或無以停用它。

預設值: 是

嘗試升級後重新同步

在進行任何升級後啟用或停用重新重新同步操作。 如果是已選取,則在韌體升級後會觸發同步。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Resync_After_Upgrade_Attempt ua="na">是</Resync_After_Upgrade_Attempt>
  • 在電話網頁,選取是在韌體升級後觸發重新同步,或者無不重新同步。

預設值: 是

重新同步觸發器 1

重新同步觸發器 2

如果這些參數中的邏輯等式的評估結果為 FALSE,則即使在以下情況下也不會觸發重新同步:重設時重新同步設定為TRUE 。 僅透過直接動作URL重新同步和SIP通知會忽略這些重新同步觸發器。

可使用可進行宏展開的條件表達來對參數進行編程。 有關有效的宏擴充,請參閱宏擴充變數下佈建參數。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Resync_Trigger_1 ua="na">$UPGTMR gt 300 和 $PRVTMR ge 600</Resync_Trigger_1>

    <Resync_Trigger_2 ua="na"/>

  • 在電話網頁,指定觸發器。

預設值: 空白

使用者可設定的重新同步

允許用戶透過電話螢幕目錄重新同步電話。 當設定為是,使用者可以從電話中輸入設定檔規則,從而重新同步電話組態。 當設定為,該設定檔規則參數未顯示在電話螢幕目錄上。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <User_Configurable_Resync ua="na">是</User_Configurable_Resync>

  • 在電話網頁,選取是以顯示設定檔規則參數(電話功能表)上,或選取無以隱藏此參數。

預設值: 是

在 FNF 上重新同步失敗

如果未從伺服器接收到請求的設定檔,通常會認為重新同步失敗。 此參數會覆蓋此行為。 當設定為無,裝置接受找不到檔案重新同步成功。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Resync_Fails_On_FNF ua="na">是</Resync_Fails_On_FNF>
  • 在電話網頁,選取是採取找不到檔案回應為重新同步失敗,或選取無採取找不到檔案回應為成功的重新同步。

預設值: 是

設定檔驗證類型

指定用於設定檔帳戶驗證的憑證。 可用的選項包括:

  • 已停用: 停用設定檔帳戶功能。 當停用此功能時,設定檔帳戶設定功能表未顯示在電話螢幕。

  • 基本 HTTP 驗證: HTTP 登入認證用於對設定檔帳戶進行驗證。

  • XSI 驗證: XSI 登入憑證或 XSI SIP憑證用於對設定檔帳戶進行驗證。 驗證憑證取決於XSI驗證類型對於電話:

    • 當XSI驗證類型為電話設定為登入認證,使用 XSI 登入認證。

    • 當XSI驗證類型為電話設定為SIP憑證,會使用 XSI SIP憑證。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Profile_Authentication_Type ua="na">基本 Http 驗證</Profile_Authentication_Type>
  • 在電話網頁,從清單中選取電話的選項,以驗證設定檔重新同步。

預設值: 基本 HTTP 驗證

如需相關資訊,請參閱指定設定檔驗證類型下指定用於設定檔重新同步的電話。

設定檔規則

設定檔規則 B

設定檔規則 C

設定檔規則 D

每個設定檔規則都會通知電話您要從中獲取設定檔(組態檔)的來源。 每次重新同步操作期間,電話都會順序套用所有設定檔。

若您對組態檔套用AES-256-CBC 加密,請使用下列字元指定加密金鑰: --鍵關鍵字如下:

[--鍵<encryption key>]

您可以選擇性地用雙引號 (") 括起加密金鑰。

  • 在包含XML的電話組態檔 (cfg.xml) 中,請採用以下格式輸入字串:

    <Profile_Rule ua="na">/$PSN.xml</Profile_Rule>

    <Profile_Rule_B ua="na"/>

    <Profile_Rule_C ua="na"/>

    <Profile_Rule_D ua="na"/>

  • 在電話網頁,指定設定檔規則。

預設值: /$PSN.xml

使用的 DHCP選項

以逗號分隔的DHCP選項,用於擷取韌體和設定檔。

預設值: 66,160,159,150,60,43,125

要使用的 DHCPv6 選項

以逗號分隔的DHCP選項,用於擷取韌體和設定檔。

預設值: 17,160,159

您可以透過Cisco XML函式來佈建電話。

您可以透過SIP通知封包或 HTTP Post 至電話的 CGI 介面,將XML物件傳送至電話: http://PhoneIPAddress/CGI/執行。

CP-xxxx-3PCC 擴展了Cisco XML功能,以支援透過XML物件進行佈建:

 <CP-xxxx-3PCCExecute> <ExecuteItem URL=Resync:[profile-rule]/> </CP-xxxx-3PCCExecute> 

電話收到XML物件後,會從 [profile-rule] 下載佈建檔案。 此規則使用 macros 來簡化XML服務應用程式的開發。

伺服器上具有多個設定檔的子目錄提供了一種方便的方法來管理大量已部署的裝置。 設定檔URL可以包含:

  • 佈建伺服器名稱或明確的IP 位址。 如果設定檔依名稱識別佈建伺服器,則電話會執行DNS查找來解析名稱。

  • 使用標準語法在URL中指定的非標準伺服器通訊埠:埠在伺服器名稱之後。

  • 儲存設定檔的伺服器虛擬根目錄的子目錄,使用標準URL表示法指定,並由巨集展開管理。

例如,以下 Profile_Rule 請求伺服器子目錄中的設定檔 ($PN.cfg) /cisco/config ,從在主機 prov.telco.com 上執行的TFTP伺服器(在連接埠 6900 上偵聽連線):

 <Profile_Rule>tftp://prov.telco.com:6900/cisco/config/$PN.cfg</Profile_Rule> 

可在通用參數中識別每個電話的設定檔,並使用宏擴充在通用設定檔規則中引用其值。

例如,假設 GPP_B 定義為Dj6Lmp23Q

Profile_Rule 具有以下值:

 tftp://prov.telco.com/cisco/$B/$MA.cfg 

當裝置重新同步和 macros 展開時, MAC 位址000e08012345 的電話會透過以下URL請求名稱中包含裝置MAC 位址的設定檔:

 tftp://prov.telco.com/cisco/Dj6Lmp23Q/000e08012345.cfg 

設定檔驗證可讓電話使用者將佈建設定檔重新同步到電話上。 當電話首次嘗試重新同步和下載組態檔並發生 HTTP 或 HTTPS 401 驗證錯誤時需要驗證資訊。 啟用此功能時,設定檔帳戶設定在以下情況下,電話上會顯示 畫面:

  • 如果在電話重新啟動後首次佈建期間發生 HTTP 或 HTTPS 401 驗證錯誤

  • 當設定檔帳戶使用者名稱和密碼為空時

  • 當「設定檔規則」中沒有使用者名稱和密碼時

如果設定檔帳戶設定螢幕遺失或忽略,使用者還可以透過電話螢幕目錄存取設定螢幕,或設定軟鍵,僅在電話上未註冊線路時顯示。

當您停用該功能時,設定檔帳戶設定螢幕未顯示在電話上。

中的使用者名稱和密碼設定檔規則欄位的優先級比設定檔帳戶高。

  • 當URL在設定檔規則欄位上沒有使用者名稱和密碼,電話需要驗證或摘要來重新同步設定檔。 使用正確的設定檔帳戶,驗證就能通過。 設定檔帳戶不正確會導致驗證失敗。

  • 當URL在設定檔規則使用正確的使用者名稱和密碼,電話需要驗證或摘要來重新同步設定檔。 設定檔帳戶不用於電話重新同步。 登入成功。

  • 當URL在設定檔規則使用不正確的使用者名稱和密碼的欄位,電話需要驗證或摘要來重新同步設定檔。 設定檔帳戶不用於電話重新同步。 登入一律失敗。

  • 當URL在設定檔規則欄位,則登入一律失敗。

您還可以使用XML (cfg.xml) 代碼電話組態檔中的參數。

您可以從電話管理網頁指定設定檔驗證類型。

1

存取電話管理網頁。

2

選取語音>佈建

3

在配置設定檔區段中,設定設定檔驗證類型參數以指定用於設定檔帳戶驗證的憑證。

您可以透過輸入以下格式的字串在電話組態XML 檔案(cfg.xml) 中配置此參數:

<Profile_Authentication_Type ua="na">已停用</Profile_Authentication_Type>

選項:

  • 已停用: 停用設定檔帳戶功能。當停用此功能時,設定檔帳戶設定功能表未顯示在電話螢幕。

  • 基本 HTTP 驗證: HTTP 登入認證用於對設定檔帳戶進行驗證。

  • XSI 驗證: XSI 登入憑證或 XSI SIP憑證用於對設定檔帳戶進行驗證。 驗證憑證取決於XSI驗證類型對於電話:

    當XSI驗證類型為電話設定為登入認證,使用 XSI 登入認證。

    當XSI驗證類型為電話設定為SIP憑證,會使用 XSI SIP憑證。

預設值: 基本 HTTP 驗證

4

按一下提交所有變更。

手動將設定檔套用至電話

請完成以下步驟,將組態檔下載至PC上的TFTP伺服器應用程式。

1

將電腦連接到電話的 LAN 連接埠。

2

在電腦上執行TFTP伺服器應用程式,並確保組態檔在TFTP根目錄中可用。

3

在 Web 瀏覽器中,輸入電話 LAN IP 位址、電腦的IP 位址、檔案名以及登入認證。 使用此格式:

http://<WAN_IP_Address> /admin/重新同步?tftp://<PC_IP_Address> /<file_name> &xuser=管理員&x密碼=<password>

範例:

http://192.168.15.1/admin/reSync?tftp://192.168.15.100/my_config.xml&xuser=admin&xpassword=admin

請完成以下步驟,以使用 cURL 將設定下載至電話。 此指令行工具用於透過URL語法傳送資料。 若要下載 cURL,請造訪:

https://curl.haxx.se/download.html

我們建議您不要使用 cURL 將設定公佈至電話,因為使用 cURL 時可能會擷取使用者名稱和密碼。

1

將電腦連接到電話的 LAN 連接埠。

2

輸入以下 cURL 指令,將組態檔下載至電話:

curl –d @my_config.xml 「http://192.168.15.1/admin/config.xml&xuser=admin&xpassword=admin」

配置設定檔

電話接受XML格式的設定。

本節中的範例將配置設定檔與XML語法結合使用。

配置檔案會定義電話的參數值。

配置檔案XML格式使用標準XML創作工具來編譯參數和值。

僅支援 UTF-8 字元集。 如果您在編輯器中修改設定檔,請不要變更編碼格式;否則,電話將無法識別該檔案。

每部電話都有不同的功能集,因此也有不同的參數集。

開啟設定檔格式

開放格式設定檔是一個文字檔案,在元素層次結構中具有類XML語法,具有元素屬性和值。 此格式可讓您使用標準工具來建立組態檔。 在重新重新同步操作期間, XML組態檔可從佈建伺服器傳送至電話,而無需編譯為二進制物件。

電話可以接受標準工具產生的組態格式。 此功能簡化了從現有資料庫產生組態設定檔的後端佈建伺服器軟體的開發。

為了保護配置檔案中的機密資訊,佈建伺服器會透過受TLS保護的通道將XML組態檔傳送至電話。 (可選)可以使用 gzip 緊縮算法 (RFC1951) 壓縮檔案。

可使用下列其中一種加密方法來加密檔案:

  • AES-256-CBC 加密

  • 使用AES-128-GCM 傳送加密基於 RFC-8188 的 HTTP 內容

組態檔可以包含下列元件:

  • 元素標籤

  • 屬性

  • 參數

  • 格式功能

  • XML註釋

範例: 開啟設定檔格式

 <flat-profile><Resync_On_Reset> 是</Resync_On_Reset><Resync_Periodic> 7200</Resync_Periodic><Profile_Rule> tftp://prov.telco.com:6900/cisco/config/CP_xxxx_MPP.cfg</Profile_Rule></flat-profile> 

<flat-profile>element tag 包含電話可識別的所有參數元素。

元素標記屬性

當您建立或更新組態檔時,請記住以下規則。

  • XML佈建格式和網路 UI 允許進行相同設定的配置。 網路 UI 中的XML標記名稱和欄位名稱相似,但由於XML元素名稱限製而不同。 例如, XML組態檔中的下劃線 ( _ ) 取代網路 UI 上的空格。

  • 電話會識別具有正確參數名稱且封裝在特殊字元中的元素。<flat-profile>元素。

  • 元素名稱包含在尖括號中。

  • 大多數元素名稱與電話網路 UI 上的欄位名稱相似,但有以下修改:

    • 元素名稱不能包含空格或特殊字元。 若要從 Web 欄位名稱中派生元素名稱,請用下劃線代替每個空格或特殊字元[ , ] , ( , ) ,或/ 。

      範例: 的<Resync_On_Reset>元素代表重設時重新同步欄位。

    • 每個元素名稱必須唯一。 在電話網路 UI 中,相同的欄位可以出現在多個網頁上,例如「線路」、「使用者」和「分機」頁面。 附加[n]前往元素名稱,以指出顯示在頁面標籤中的數字。

      範例:<Dial_Plan_1_>元素代表撥號計劃線路 1。

  • 每個開始元素標記都必須具有相符的結束元素標記。 譬如:

     <flat-profile><Resync_On_Reset>是</Resync_On_Reset><Resync_Periodic>7200</Resync_Periodic><Profile_Rule> tftp://prov.telco.com: 6900/cisco/config/CP_xxxx_MPP.cfg</Profile_Rule></flat-profile> 
  • 元素標籤會區分大小寫。

  • 允許使用空元素標籤,這些標籤將被解釋為將值設定為空。 輸入不含對應元素標記的開始元素標記,並在右尖括號 (>) 前插入空格和正斜線。 在此範例中,設定檔規則 B 為空:

     <Profile_Rule_B /> 
  • 空元素標記可用於防止在重新重新同步操作期間覆寫任何使用者提供的值。 在以下範例中,使用者快速撥號設定不變:

    <flat-profile> <Speed_Dial_2_Name ua="rw"/> <Speed_Dial_2_Number ua="rw"/> <Speed_Dial_3_Name ua="rw"/> <Speed_Dial_3_Number ua="rw"/> <Speed_Dial_4_Name ua="rw"/> <Speed_Dial_4_Number ua="rw"/> <Speed_Dial_5_Name ua="rw"/> <Speed_Dial_5_Number ua="rw"/> <Speed_Dial_6_Name ua="rw"/> <Speed_Dial_6_Number ua="rw"/> <Speed_Dial_7_Name ua="rw"/> <Speed_Dial_7_Number ua="rw"/> <Speed_Dial_8_Name ua="rw"/> <Speed_Dial_8_Number ua="rw"/> <Speed_Dial_9_Name ua="rw"/> <Speed_Dial_9_Number ua="rw"/> </flat-profile> 
  • 使用空值將對應的參數設定為空字串。 輸入中間不含任何值的開始和結束元素。 在以下範例中,GPP_A 參數設定為空字串。

     <flat-profile> <GPP_A>   </GPP_A> </flat-profile> 
  • 無法識別的元素名稱將被忽略。

參數屬性

這些內容適用於參數:

  • 設定檔未指定的任何參數在電話中將保持不變。

  • 無法識別的參數將被忽略。

  • 如果「開啟格式」設定檔包含多處相同的參數標記,則最後一次出現的此類參數標記會覆蓋任何較舊的參數標記。 為了避免意外覆蓋參數的組態值,我們建議每個設定檔最多指定一個參數的實例。

  • 最後處理的設定檔優先。 若多個設定檔指定相同的組態參數,則後一個設定檔的值優先。

字串格式

這些屬性適用於字串的格式:

  • 允許透過標準XML語法進行註解。

    <!-- My comment is typed here -->
  • 為了便於閱讀,允許前導和尾隨空格,但會從參數值中移除。

  • 值中的新行將轉換為空格。

  • 表格的XML標頭<? ?>被允許,但電話會忽略它。

  • 若要輸入特殊字元,請使用基本的XML字元轉義,如下表所示。

    特殊字元

    XML轉義序列

    & (符號)

    (&)

    <(小於)

    <

    > (大於)

    >

    ' (撇號)

    」(雙引號)

    在以下範例中,輸入了撥號計劃規則所需的大於和小於符號。 此範例定義一個資訊熱線撥號計劃,該計劃設定<Dial_Plan_1_>參數 (管理員登入>進階>語音>分機(n) ) 等於 (S0 <:18005551212>)。

     <flat-profile><Dial_Plan_1_>(S0 <:18005551212>)</Dial_Plan_1_></flat-profile>
  • 數字字元轉義,使用十進制和十六進制值(sa ),已被翻譯。

  • 電話韌體僅支援ASCII字元。

可壓縮 Open 設定檔以減輕佈建伺服器上的網路負載。 設定檔也可以加密以保護機密資訊。 壓縮不是必需的,但必須在加密之前。

開啟設定檔壓縮

支援的壓縮方法是 gzip 緊縮算法 (RFC1951)。 可透過網站取得 gzip 工具程式,以及實施相同算法 (zlib) 的壓縮庫。

為了識別壓縮,電話期望壓縮的檔案包含 gzip 相容的標頭。 在原始的 Open 設定檔上調用 gzip 工具程式會產生標題。 電話會檢查下載的檔案標頭,以確定檔案格式。

譬如,如果設定檔.xml是有效的設定檔,該檔案設定檔.xml.gz也被接受。 下列任一指令均可生成此設定檔類型:

  • >gzip 設定檔.xml

    用壓縮的檔案取代原始檔案。

  • >cat 設定檔.xml | gzip >profile.xml.gz

    保留原始檔案並產生新的壓縮檔案。

公開設定檔加密

對稱金鑰加密可用於加密開啟的設定檔,無論檔案是否已壓縮。 如果套用壓縮,則必須在加密之前套用。

佈建伺服器會使用 HTTPS 在部署後處理電話的初始佈建。 離線預加密組態設定檔允許隨後使用 HTTP 重新同步設定檔。 這樣可減輕大規模部署中 HTTPS 伺服器的負載。

電話支援配置檔案的兩種加密方法:

  • AES-256-CBC 加密

  • 使用AES-128-GCM 傳送加密,進行基於 RFC 8188 的 HTTP 內容加密

必須在更早的時間將密鑰或輸入密鑰材料 (IKM) 預先佈建到單元中。 可使用 HTTPS 安全地完成密鑰的引導。

組態檔名不需要特定格式,而是需要以.cfg擴展名通常表示配置檔案。

AES-256-CBC 加密

電話支援配置檔案的AES-256-CBC 加密。

可從各個網站下載的 OpenSSL 加密工具可以執行加密。 對 256 位元AES加密的支援可能需要重新編譯工具以啟用AES代碼。 韌體已針對 opensl-1.1.1d 版本進行測試。

對於加密的檔案,設定檔期望該檔案具有與以下命令產生的相同的格式:

 # 範例加密金鑰= –輸入設定檔.xml.gz –輸出設定檔.cfg 

小寫字母 -k 在密鑰(可以是任何純文字片語)之前,用於產生隨機的 64 位元加值。 借助 -k 參數指定的密碼,加密工具會派生一個隨機的 128 位元初始向量 和實際的 256 位元加密金鑰。

當在配置檔案使用此形式的加密時,必須通知電話密鑰值才能解密檔案。 此值在設定檔URL中指定為限定符。 語法如下,使用了明確的URL:

 [--密鑰「SecretPhrase1234」] http://prov.telco.com/path/profile.cfg 

此值是使用下列其中一個設定的Profile_Rule參數。

巨集展開

多個佈建參數在評估之前會在內部進行巨集擴充。 此預先評估步驟在控制電話重新同步及升級活動方面提供了更大的靈活性。

這些參數群組在評估前會進行巨集擴充:

  • ReSync_Tiger_*

  • Profile_Rule*

  • Log_xxx_Msg

  • Upgrade_Rule

在特定情況下,部分通用參數 (GPP_*) 也會經歷巨集擴充,如第 2 部分中明確指出的那樣。可選的重新同步參數區段。

在宏展開期間,命名變數的內容將取代 $NAME 和 $(NAME) 形式的表達式。 這些變數包括通用參數、數個產品標識符、某些活動計時器和佈建狀態值。 如需完整清單,請參閱宏擴充變數佈建參數

在以下範例中,表達式 $(MAU) 用於插入MAC 位址000E08012345。

管理員輸入: $(MAU)config.cfg

對於MAC 位址000E08012345 的裝置,產生的巨集擴充為: 000E08012345config.cfg

如果未識別宏名稱,它將保持未展開。 例如,名稱 STRANGE 未識別為有效的巨集名稱,而 MAU 則被識別為有效的巨集名稱。

管理員輸入: $STRANGE$MAU.cfg

對於MAC 位址000E08012345 的裝置,產生的巨集擴充為: $STRANGE000E08012345.cfg

不會以循環方式套用宏擴充。 例如,「$$MAU」擴充為「$MAU」($$ 已展開),並且不會產生MAC 位址。

特殊用途參數(GPP_SA 至 GPP_SD)的內容將被對映至宏表達式 $SA 至 $SD。 這些參數只會被宏擴展為的參數--鍵 --uid ,和--pwd重新同步URL中的選項。

條件表達式

條件表達式可以觸發重新同步事件,並從替代 URL 中進行選擇以進行重新同步和升級操作。

條件表達式包含一個比較清單,以下列字元分隔:算子。 必須滿足所有比較才能使條件為真。

每個比較都可與以下三種文字類型之一相關:

  • 整數值

  • 軟體或硬體版本號碼

  • 重複引用的字串

版本號

Cisco視訊電話 8875 的軟體版本使用此格式(其中BN是內部版本號):

電話yyyy 1-0-1-0001 - BN

在哪裡yyyy指出電話機型或電話系列; 1是主要版本; 0是次要版本; 1-0001是微型版本;和BN是組建編號。

比較字串必須使用相同的格式。 否則,會產生格式解析錯誤。

比較軟體版本時,會順序比較主要版本、次要版本和微型版本,最左邊的數字優先於後面的數字。 當版本號相同時,會比較組建編號。

有效版本號列舉如下

PHONEOS-8875.1-0-1-0001-19

比較

可以比較引用字串的是否相等。 也可以以算術方式比較整數和版本號。 比較運算符可以表示為符號或首字母縮寫。 首字母縮寫方便在 Open 格式設定檔中表達條件。

接線員

替代語法

說明

適用於整數和版本操作數

適用於帶引號的字串操作數

=

當量

等於

!=

不等於

<

lt

小於

<=

小於或等於

>

gt

大於

>=

佇列

大於或等於

請在需要字串常值的地方將宏變數用雙引號引起來,這一點很重要。 不要在期望提供號碼或版本號的地方執行此操作。

當在 Profile_Rule* 和Upgrade_Rule 參數的內容中使用時,條件表達式必須包含在語法「(exr)?」內。如此升級規則範例中。 記住要取代BN包含要升級至的韌體載入的組建編號。

($SWVER 和 PHONEOS-8875.1-0-1-0001-19)? http://ps.tell.com/sw/PHONEOS-8875.1-0-1-0001-BN.loads

請不要使用上述帶有圓括號的語法來配置 ReSync_觸發_* 參數。

URL語法

使用標準URL語法可分別在 Profile_Rule* 和Upgrade_Rule 參數中指定如何擷取組態檔和韌體載入。 語法如下:

[ 方案://  ] [ 伺服器 [:port]] 檔案路徑

地點方案是下列值之一:

  • tftp

  • http

  • https

如果方案省略,則假定使用 tftp。 伺服器可以是DNS識別的主機名稱或數字IP 位址。 埠是目的地UDP或TCP 連接埠號碼。 檔案路徑必須以根目錄 (/) 開頭;它必須是絕對路徑。

如果伺服器缺少,則使用透過DHCP (選項 66)指定的 tftp 伺服器。

對於升級規則,必須指定伺服器。

如果缺少,則使用指定方案的標准通訊埠。 Tftp 使用UDP連接埠 69,http 使用TCP 連接埠80,https 使用TCP 連接埠443。

必須存在檔案路徑。 它不一定指靜態檔案,但可以指出透過 CGI 獲得的動態內容。

宏擴充適用於 URL。 以下是有效 URL 的範例:

 /$MA.cfg /cisco/cfg.xml 192.168.1.130/profiles/init.cfg tftp://prov.call.com/cpe/cisco$MA.cfg http://neptune.speak.net:8080/prov /$D/$E.cfg https://secure.me.com/profile?Linksys 

使用DHCP選項 66 時,升級規則不支援空語法。 它僅適用於設定檔規則*。

基於 RFC 8188 的 HTTP 內容加密

電話支援使用AES-128-GCM 傳送加密,以 RFC 8188 式 HTTP 內容加密為配置設定檔加密。 有了這種加密方法,任何實體都可以讀取 HTTP 訊息標頭。 但是,只有知道輸入金鑰材料 (IKM) 的實體才能讀取有效荷載。 使用 IKM 佈建電話時,電話和佈建伺服器可以安全地交換組態檔,同時允許第三方網路元素使用訊息標題進行分析和監控。

XML組態參數IKM_HTTP_Encrypt_內容容納電話上的 IKM。 基於安全原因,無法在電話管理網頁存取此參數。 它在電話的組態檔中也不可見,您可以從電話的IP 位址或從傳送至佈建伺服器的電話組態報告中存取該組態檔。

如果您要使用基於 RFC 8188 的加密,請確保滿足以下條件:

  • 透過使用XML參數指定 IKM,使用 IKM 佈建電話IKM_HTTP_Encrypt_內容在佈建伺服器傳送至電話的組態檔中。

  • 若此加密適用於從佈建伺服器傳送至電話的組態檔案,請確保內容編碼組態檔中的 HTTP 標頭有 aes128gcm.

    如果缺少此標題,則AES-256-CBC 方法優先。 如果設定檔規則中存在AES -256-CBC 金鑰,則電話會套用AES -256-CBC 解密,而與 IKM 無關。

  • 如果希望電話將此加密套用至其傳送至佈建伺服器的組態報告,請確保報告規則中未指定AES-256-CBC 金鑰。

可選的重新同步參數

可選的參數, uid ,以及密碼,可以放在在 中輸入的 URL 之前Profile_Rule*參數,全部用方括號括起來。

--鍵選項會告知電話其從佈建伺服器接收的組態檔已使用AES-256-CBC 加密進行加密,除非內容編碼檔案中的標頭表示 aes128gcm 加密。 鍵本身被指定為字串後的字串--鍵。 可以選擇性地將鍵括在雙引號 (") 中。 電話會使用該金鑰來解密組態檔。

使用範例
 [--鍵 VerySecretValue] [--鍵「我的密碼」] [--鍵 a37d2fb9055c1d04883a0745eb0917a4] 

方括號內的可選參數會被宏擴展。 特殊用途的參數(GPP_SA 到 GPP_SD)會巨集擴充為巨集變數($SA 到 $SD),但前提是它們被用作鍵選項參數。 請參閱下列範例:

[--鍵 $ SC] [--鍵 "$ SD"] 

在開啟格式設定檔中,參數為--鍵必須與的參數相同-k給予的選項openssl

uid 和 pwd

uid密碼選項可用於指定在請求指定URL時為回應 HTTP 基本和摘要驗證質詢而傳送的使用者 ID 和密碼。 方括號內的可選參數會被宏擴展。 特殊用途的參數(GPP_SA 到 GPP_SD)會巨集擴充為巨集變數($SA 到 $SD),但前提是它們被用作鍵選項參數。 請參閱下列範例:

GPP_SA = 我的使用者 ID GPP_SB = 我的密碼 

[--uid $SA --pwd $SB] https://provisioning_server_url/path_to_您的_config/您的_config.xml

然後將擴展為:

[--uid MyUserID --pwdMySecretPassword] https://provisioning_server_url/path_to_your_config/your_config.xml

這些資料類型與配置檔案參數一起使用:

  • {a,b,c,…} — 在 a、b、c、...中選擇

  • 布林 — 「是」或「否」的布林值。

  • CadScript - 指定訊號的節奏參數的迷你指令檔。 最多 127 個字元。

    語法: 小號1 [;S 2 ],其中:

    • 小號=D(開啟i,1 /關閉i,1 [,在i,2 /關閉i,2 [,在i, 3 /關閉i, 3 [,在i, 4 /關閉i, 4 [,在i, 5 /關閉i, 5 [,在i, 6 /關閉i, 6 ]]]]]) 並且稱為區段。

    • 開啟i,j並關閉i,j是的開啟/關閉持續時間(以秒為單位)區段。 i = 1 或 2,且 j = 1 至 6。

    • D是區段的總持續時間(以秒為單位)。

    所有持續時間最多可以有小數點後三位以提供 1 毫秒解析度。 萬用字元「*」代表無限持續時間。 區段內的區段將按順序播放並重複,直到播放完整個持續時間。

    範例 1:

     60(2/4) 節奏區段數 = 1 節奏區段 1: 區段長度 = 60 秒 區段數 = 1 區段 1: 開啟 = 2 秒,關閉 = 4 秒 總鈴聲長度 = 60 秒 

    範例 2 — 特殊鈴聲(短,短,短,長):

     60(.2/.2,.2/.2,.2/.2,1/4) 節奏區段數 = 1 節奏區段 1: 區段長度 = 60 秒 區段數 = 4 區段 1: 開啟 = 0.2 秒,關閉 = 0.2 秒 區段 2: 開啟 = 0.2 秒,關閉 = 0.2 秒 區段 3: 開啟 = 0.2 秒,關閉 = 0.2 秒 區段 4: 開啟 = 1.0 秒,關閉 = 4.0 秒 總響鈴長度 = 60 秒 
  • DialPlanScript - 用於指定線路 1 和線路 2 撥號計劃的指令檔語法。

  • 浮動<n>- 最多包含 n 位小數的浮點值。

  • FQDN — 完整網域名稱。 最多可以包含 63 個字元。 範例如下:

    • 啜飲。 Cisco.com:5060 或 109.12.14.12:12345

    • 啜飲。 Cisco.com或 109.12.14.12

  • FreqScript — 指定音調的頻率和電平參數的迷你指令。 最多包含 127 個字元。

    語法: F 1 @L 1 [,F 2 @L 2 [,F 3 @L 3 [,F 4 @L 4 [,F 5 @L 5 [,F 6 @L 6 ]]]]],其中:

    • F 1 -F 6是以 Hz 為單位的頻率 (僅限無符號整數)。

    • 大號1 –L 6是以 dBm 為單位的對應水平(最多保留一位小數)。

    逗號前後的空格是允許的,但不建議使用。

    範例 1—插撥鈴聲:

     440@-10 頻率數 = 1 頻率 1 = 440 Hz(在 –10 dBm 時) 

    範例 2—撥號音:

     350@-19,440@-19 頻率數 = 2 頻率 1 = 350 Hz,在 –19 dBm 頻率 2 = 440 Hz,在 –19 dBm 
  • IP— xxxx 格式的有效IPv4位址,其中 x 介於 0 到 255 之間。 範例: 10.1.2.100。

  • 使用者ID — URL中顯示的使用者 ID ;最多 63 個字元。

  • 電話 —電話號碼字串,例如 14081234567、*69、*72、345678;或通用URL,例如 1234@10.10.10.100:5068 或 jsmith@ Cisco.com。 字串最多可以包含 39 個字元。

  • PhTmplt -電話號碼範本。 每個範本可以包含一個或多個以逗號 (,) 分隔的型式。 每個型式開頭的空白將被忽略。 「?」及「*」代表萬用字元。 若要逐字表示,請使用 %xx。 例如,%2a 代表 *。 範本最多可以包含 39 個字元。 範例: 「1408*、1510*」、「1408123????、555?1。」。

  • 連接埠 — TCP/ UDP連接埠號碼 (0-65535)。 能以十進製或十六進制格式指定。

  • ProvisioningRuleSyntax — 用於定義組態重新同步和韌體升級規則的指令檔語法。

  • PwrLevel — 以 dBm 表示的功率水平,保留一位小數,例如 –13.5 或 1.5 (dBm)。

  • RscTmplt — SIP回應狀態代碼的範本,例如「404、5*」、「61?」、「407、408、487、481」。 最多可以包含 39 個字元。

  • SIG<n> — 有符號的 n 位元值。 能以十進製或十六進制格式指定。 「-」符號必須在負值之前。 正值前的 + 符號為可選。

  • 星碼 — 補充服務的啟動碼,例如 *69。 代碼最多可以包含 7 個字元。

  • STR<n> - 最多包含 n 個非保留字元的通用字串。

  • 時間<n>— 持續時間(以秒為單位),最多保留 n 位小數。 額外指定的小數位將被忽略。

  • ToneScript - 一個迷你指令,用於指定通話進行鈴聲的節奏參數。 指令檔最多可以包含 127 個字元。

    語法: FreqScript;Z 1 [;Z 2 ]。

    Z 區段1與 S 相似1在 CadScript 中的區段中,不同的是每個開/關區段都後跟一個頻率元件參數: Z 1 = D 1 (開啟i,1 /關閉i,1 /f i,1 [,在i,2 /關閉i,2 /f i,2 [,在i, 3 /關閉i, 3 /f i, 3 [,在i, 4 /關閉i, 4 /f i, 4 [,在i, 5 /關閉i, 5 /f i, 5 [,在i, 6 /關閉i, 6 /f i, 6 ]]]]]),其中:

    • f i,j = n 1 [+n 2 ]+ 3 [+n 4 [+n 5 [+n 6 ]]]]]。

    • 1 < n k < 6 會指定該區段中使用的 FreqScript 中的頻率元件。

    如果在區段中使用了多個頻率元件,則會將這些元件相加。

    範例 1—撥號音:

     350@-19,440@-19;10(*/0/1+2) 頻率數 = 2 頻率 1 = 350 Hz(在 –19 dBm 頻率下)2 = 440 Hz(在 –19 dBm 下) 節奏區段數 = 1 節奏區段 1 : 區段長度 = 10 秒 區段數 = 1 區段 1: 開啟 = 永遠,其中頻率 1 和 2 總音調長度 = 10 秒 

    範例 2 — 口吃的語氣:

     350@-19,440@-19;2(.1/.1/1+2);10(*/0/1+2) 頻率數 = 2 頻率 1 = 350 Hz(在 –19 dBm 頻率下) 2 = 440 Hz在 –19 dBm 時,節奏區段數 = 2 節奏區段 1: 區段長度 = 2 秒 區段數 = 1 區段 1: 開啟 = 0.1 秒,關閉 = 0.1 秒,其中頻率 1 和 2 節奏區段 2: 區段長度 = 10 秒 區段數 = 1 區段 1: 開啟 = 永遠,其中頻率 1 和 2 總音調長度 = 12 秒 
  • 取消對<n>— 無符號的 n 位元值,其中 n = 8、16 或 32。 可以採用十進製或十六進制格式(例如 12 或 0x18)來指定值,只要值可以放入 n 位元中。

請將這些考慮在內:

  • <Par Name>代表組態參數名稱。 在設定檔中,相應的標記是透過用下劃線「_」取代空格形成的,例如Par_Name
  • 空的預設值欄位意味著空字串 < "" >。
  • 對於給定設定檔中不存在的標籤,電話會繼續使用最後設定的值。
  • 範本會按照給定的順序進行比較。 第一個,不是最近的,符合已選取。 參數名稱必須完全相符。
  • 如果設定檔中給出了多個參數的定義,則檔案中最後一個這樣的定義是在電話中生效的定義。
  • 參數值為空的參數規格會強制將參數恢復為預設值。 若要改為指定空字串,請使用空字串 "" 作為參數值。