- 主页
- /
- 文章
电话 9800 和 8877(BroadWorks)的预配置参数
本帮助文章适用于已注册到 Cisco BroadWorks 的 Cisco Desk Phone 9800 系列和 Cisco Video Phone 8875。 此页面上的信息包括设置参数及其语法。
配置参数类型
本节介绍根据功能大致编排的设置参数。
通用参数
当将电话配置为与特定设置服务器解决方案进行交互时,通用参数 GPP_*(
)用作免费字符串寄存器。 GPP_* 参数默认为空。 可将它们配置为包含不同的值,其中包括:-
加密密钥
-
URL
-
多阶段设置状态信息。
-
Post 请求模板
-
参数名称别名映射
-
最终并入完整的参数值的部分字符串值。
GPP_* 参数可在其他设置参数内用于宏扩展。 出于此目的,一个字母的大写宏名称(A through P)足以识别 GPP_A 至 GPP_P 的内容。 另外,当用作以下 URL 选项的参数时,两个字母的大写宏名称 SA 至 SD 将 GPP_SA 至 GPP_SD 标识为特殊情况:
key、uid 和 pwd
这些参数可在设置和升级规则中用作变量。 引用它们时需在变量名称前添加‘$’字符,例如 $GPP_A。
启用参数
Provision_Enable 和 Upgrade_Enable 参数控制着所有配置文件重新同步和固件升级操作。 这些参数彼此独立控制重新同步和升级。 这些参数还控制通过管理 web 服务器发出的重新同步和升级 URL 命令。 这两个参数默认都设置为是。
Resync_From_SIP 参数控制重新同步操作请求。 SIP NOTIFY 事件从服务提供商代理服务器发送到电话。 如果启用,代理可以请求重新同步。 为此,代理会发送 SIP NOTIFY 消息到设备,其中包含 Event: resync 标头。
设备以 401 响应消息质询请求(授权遭拒,因凭证已被使用)。 设备在支持来自代理的重新同步请求之前,预期会出现经过验证的后续请求。 Event: reboot_now 和 Event: restart_now 标头会分别执行冷重启和热重启,也会遭到质询。
其余两个会启用 Resync_On_Reset 和 Resync_After_Upgrade_Attempt。 这些参数确定在开机软件重新启动后以及每次升级尝试后,设备是否执行重新同步操作。
启用 Resync_On_Reset 后,在执行重置之前,设备在启动序列后引入随机延迟。 延迟时间是随机的,上限为 Resync_Random_Delay 指定的值(以秒为单位)。 在同时开机的电话池中,这一延迟将传播到每个设备重新同步请求的开始时间。 在大型住宅部署中,如果发生地区性电力故障,此功能将十分有用。
触发器
电话允许您按特定时间间隔或在特定时间重新同步。
在特定时间间隔重新同步
电话可定期与设置服务器重新同步。 重新同步间隔在 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 and $PRVTMR ge 600
在特定时间重新同步
Resync_At 参数可让电话在特定时间重新同步。 此参数使用 24 小时制 (hhmm) 指定时间。
Resync_At_Random_Delay 参数允许电话在未指定的延迟时间重新同步。 此参数用于正整数格式指定时间。
应避免来自多部电话、设定为在相同时间重新同步的重新同步请求涌向服务器。 为此,电话会在指定时间后最多 10 分钟触发重新同步。
例如,如果您将重新同步时间设置为 1000(上午 10:00),电话会在上午 10:00 与 10:10 之间的任何时间触发重新同步。
默认情况下,此功能处于禁用状态。 如果设置了 Resync_At 参数,Resync_Periodic 参数会被忽略。
可配置的日程表
您可以配置日程表以定期执行重新同步,并且可以使用以下设置参数指定重新同步和升级失败时的重试间隔:
-
Resync_Periodic
-
Resync_Error_Retry_Delay
-
Upgrade_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 分钟、1 小时、2 小时重试升级。 如果升级仍然失败,设备会每隔 4 至 5 小时重试,直至升级成功。
Upgrade_Error_Retry_Delay = 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 选项。 在每个备用值中,所有这些要素都是可选的。 以下是有效的组合,并且必须依此顺序显示(如果有):
[ conditional-expr ] [ assignment-expr ] [[ options ] URL ]
在每个 Profile_Rule* 参数内,除最后一个备用值外,其他所有备用值都必须提供一个条件表达式。 系统会按如下方式评估及处理此表达式:
-
从左到右评估条件,直到找到评估结果为 true 的值(或直至找到一个不含条件表达式的备用值)。
-
评估任何随同的赋值表达式(如果有)。
-
如果 URL 被指定为该备用值的一部分,将尝试下载位于指定 URL 的配置文件。 系统会尝试相应更新内部参数。
如果所有备用值都有条件表达式且没有条件被评估为 true(或者如果整个配置文件规则为空),则会跳过整个 Profile_Rule* 参数。 接下来会评估序列中的下一个配置文件规则参数。
示例 1
本示例将无条件重新同步到指定 URL 上的配置文件,并执行到远程设置服务器的 HTTP GET 请求:
http://remote.server.com/cisco/$MA.cfg
示例 2
在本例中,设备重新同步到两个不同的 URL,具体取决于第 1 行的注册状态。在丢失注册的情况下,设备针对 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
在此示例中,在将 GPP_A 设定为通过第一个 URL 设置的值之前,线路 1 会一直禁用。 然后,它会重新同步到第二个 URL:
(“$A” ne “Provisioned”)? (Line_Enable_1_ = “No”;)! https://p.tel.com/init-prov| https://p.tel.com/configs
示例 5
在此示例中,假设服务器返回的配置文件包含 XML 元素标签。 这些标签必须按照 GPP_B 中存储的别名映射图,重新映射到适当的参数名称:
[--alias 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 选项,但可以使用条件表达式和赋值表达式。 如果使用条件表达式,此参数可填充为多个以 | 字符分隔的备用值。 每个备用值的语法如下:
[ conditional-expr ] [ assignment-expr ] URL
如果采用 Profile_Rule* 参数,Upgrade_Rule 参数将评估每个备用值,直到满足条件表达式或备用值无条件表达式。 评估随同的赋值表达式(如有指定)。 然后,尝试升级到指定的 URL。
如果 Upgrade_Rule 包含无条件表达式的 URL,设备将升级到 URL 指定的固件映像。 宏扩展和规则评估后,设备不会重新尝试升级,直到规则遭修改或方案 + 服务器 + 端口 + 文件路径的有效组合被更改。
要尝试进行固件升级,设备将在程序开始时禁用音频,并在程序结束时重新启动。 仅当所有语音线路当前都处于非活动状态时,设备才会自动开始由 Upgrade_Rule 的内容驱动的升级。
例如,
https://10.73.10.223/firmware/PHONEOS-8875.1-0-1-0001-1.loads
在此示例中,Upgrade_Rule 将固件升级到指定 URL 中存储的映像。
以下为另一个示例:
(“$F” ne “beta-customer”)? http://p.tel.com/firmware/PHONEOS-8875.1-0-1-0001-1.loads| http://p.tel.com/firmware/PHONEOS-8875.1-0-1-0001-1.loads
本例将指示设备根据通用参数 GPP_F 的内容,下载两幅图像中的一幅。
配置参数
您可以在电话网页的设置选项卡上找到配置参数。
配置文件参数
下表定义了设置选项卡配置文件参数部分中每个参数的功能和用途。
参数名称 |
描述和默认值 |
---|---|
启用设置 |
控制独立于固件升级操作的所有重新同步操作。 设置为是将启用远程设置。 默认值为“是”。 |
重置时重新同步 |
除参数更新和固件升级导致的重新启动外,每次重新启动之后都触发重新同步。 默认值为“是”。 |
重新同步随机延迟 |
执行重置之前,启动序列后的随机延迟指定以秒为单位。 在安排要同时接通电源的 IP 电话设备池中,这会在每个设备向设置服务器发送重新同步请求的时间中引入一个时间差。 在大型住宅部署中,如果发生地区性电力故障,此功能将十分有用。 此字段的值必须为介于 0 到 65535 之间的整数。 默认值为 2。 |
重新同步时间 (HHmm) |
设备与设置服务器重新同步的时间 (HHmm)。 此字段的值必须为介于 0000 到 2400 之间的四位数字,以 HHmm 格式表示时间。 例如,0959 年表示 09:59。 默认值为空。 如果值无效,该参数将被忽略。 如果此参数设置为有效值,则“重新同步周期”参数将被忽略。 |
随机延迟重新同步 |
防止设置服务器在大量设备同时接电时过载。 为避免来自多部电话的大量重新同步请求涌向服务器,电话的重新同步范围介于小时和分钟,以及小时、分钟加上随机延迟之间 (hhmm, hhmm+random_delay)。 例如,如果随机延迟 =(随机延迟时重新同步 + 30)/60 分钟,以秒为单位输入的值会转换为分钟,四舍五入计入下一分钟以计算最终的 random_delay 间隔。 有效值介于 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。 |
日志请求消息 |
此参数包含尝试开始重新同步时发送到系统日志服务器的消息。 默认值为 |
日志成功消息 |
成功完成重新同步后发出的系统日志消息。 默认值为 |
日志失败消息 |
尝试重新同步失败后发出的系统日志消息。 默认值为 |
用户可配置重新同步 |
允许用户在 IP 电话屏幕上重新同步电话。 默认值为“是”。 |
固件升级参数
下表定义了设置选项卡固件升级部分中每个参数的功能和用途。
参数名称 |
描述和默认值 |
---|---|
启用升级 |
允许固件升级操作独立于重新同步操作。 默认值为“是”。 使用以下方法之一配置此参数:
|
升级错误重试延迟 |
如果升级失败,应用升级重试间隔(以秒为单位)。 设备有一个固件升级错误计时器,会在固件升级尝试失败后激活。 计时器使用此参数中的值进行初始化。 当此计时器倒计至零时,会再次尝试进行固件升级。 默认值为 3600 秒。 使用以下方法之一配置此参数:
|
升级规则 |
定义升级条件及所关联固件 URL 的固件升级脚本。 它使用相同的语法作为配置文件规则。 使用以下格式输入升级规则:
例如:
若未指定任何协议,系统会假设您指定了 TFTP。 如果未指定服务器名称,则使用请求 URL 的主机作为服务器名称。如果未指定端口,则使用默认端口(TFTP 为 69,HTTP 为 80,HTTPS 为 443)。 默认值为空白。 使用以下方法之一配置此参数:
|
日志升级请求消息 |
固件升级尝试开始时发出的系统日志消息。 默认值: 使用以下方法之一配置此参数:
|
日志升级成功消息 |
成功完成固件升级尝试后发出的系统日志消息。 默认值为 使用以下方法之一配置此参数:
|
日志升级失败消息 |
固件升级尝试失败后发出的系统日志消息。 默认值为 使用以下方法之一配置此参数:
|
对等固件共享 |
启用或禁用对等固件共享(PFS)功能。 选择是或否以启用或禁用该功能。 默认值:Yes 使用以下方法之一配置此参数:
|
对等固件共享日志服务器 |
指示 IP 地址和接收 UDP 消息的端口。 例如:10.98.76.123:514,其中 10.98.76.123 是 IP 地址,514 是端口号。 使用以下方法之一配置此参数:
|
通用参数
下表定义了设置选项卡通用参数部分中每个参数的功能和用途。
参数名称 |
描述和默认值 |
---|---|
GPP A - GPP P |
当将电话配置为与特定设置服务器解决方案进行交互时,通用参数 GPP_* 用作免费字符串寄存器。 可将它们配置为包含不同的值,其中包括:
默认值为空白。 |
宏扩展变量
以下设置参数内识别了特定的宏变量:
-
Profile_Rule
-
Profile_Rule_*
-
Resync_Trigger_*
-
Upgrade_Rule
-
Log_*
-
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 through P |
替换为通用参数 GPP_A 至 GPP_P 的内容。 |
SA through SD |
替换为专用参数 GPP_SA 至 GPP_SD。 这些参数存有在设置过程中使用的密钥或密码。 $SA 至 $SD 被认为是传递给可选重新同步 URL 限定符 — 密钥 — 的参数。 |
MA |
使用小写十六进制数字的 MAC 地址,例如 000e08aabbcc。 |
MAU |
使用大写十六进制数字的 MAC 地址,例如 000E08AABBCC。 |
MAC |
使用小写十六进制数字并用冒号分隔十六进制数字对的 MAC 地址。 例如 00:0e:08:aa:bb:cc。 |
PN |
产品名称。例如,CP-8875、DP-9851、DP-9871。 |
PSN | 产品序列号。 例如 V03。 |
SN |
序列号字符串;例如 88012BA01234。 |
CCERT |
SSL 客户端证书状态:安装或未安装。 |
IP |
电话在其本地子网中的 IP 地址。 例如 192.168.1.100。 |
EXTIP |
电话的外部 IP(在 Internet 上显示的 IP)。 例如 66.43.16.52。 |
SWVER |
软件版本字符串。 例如, 电话作系统.3-1-1-0104-37 |
HWVER |
硬件版本字符串。 例如 2.0.1 |
PRVST |
部署状态(数字字符串): -1 = 显式重新同步请求 0 = 接通电源时重新同步 1 = 定期重新同步 2 = 重新同步失败,重试 |
UPGST |
升级状态(数字字符串): 1 = 第一次升级尝试 2 = 升级失败,重试 |
UPGERR |
上次升级尝试的结果消息(错误);例如,http_get 失败。 |
PRVTMR |
距离上次重新同步尝试的秒数。 |
UPGTMR |
距离上次升级尝试的秒数。 |
REGTMR1 |
线路 1 丢失在 SIP 服务器的注册信息后经历的秒数。 |
REGTMR2 |
线路 2 丢失在 SIP 服务器的注册信息后经历的秒数。 |
UPGCOND |
原来的宏名称。 |
SCHEME |
文件访问方案,TFTP、HTTP 或 HTTPS 之一,在解析重新同步或升级 URL 后获得。 |
SERV |
请求目标服务器主机名,在解析重新同步或升级 URL 后获得。 |
SERVIP |
请求目标服务器 IP 地址,在解析重新同步或升级 URL 后获得,可能在 DNS 查找之后。 |
PORT |
请求目标 UDP/TCP 端口,在解析重新同步或升级 URL 后获得。 |
PATH |
请求目标文件路径,在解析重新同步或升级 URL 后获得。 |
ERR |
重新同步或升级尝试的结果消息。 只有助于生成结果系统日志消息。 尝试升级时,值将保留在 UPGERR 变量中。 |
UIDn |
线路 n UserID 配置参数的内容。 |
EMS |
Extension Mobility 状态 |
MUID |
Extension Mobility 用户 ID |
MPWD |
Extension Mobility 密码 |
内部错误代码
电话定义多个内部错误代码 (X00–X99),以便加强配置,从而在某些错误条件下更好地控制设备行为。
参数名称 |
描述和默认值 |
---|---|
X00 |
发送 SIP 请求时出现传输层(或 ICMP)错误。 |
X20 |
等待响应时,SIP 请求超时。 |
X40 |
一般 SIP 协议错误(例如,200 和 ACK 消息中,SDP 的编解码器不可接受;或等待 ACK 时超时)。 |
X60 |
根据给定拨号方案,被叫号码无效。 |