协议参数模型报告模板.doc

1 参数定义
定义 终端TR-069 参数模型 关键参考两个文档 TR-106 和TR-135 , TR-106 定义了基于TR-069管理设备通用数据模型, TR-135 定义了STB 特定数据模型。
因为现在针对STB 数据管理没有提出具体要求, 所以暂不实现TR-135中定义数据模型。
在数据模型中, 凡参数中有X_STB字样, 都有扩展参数。读写属性值(wrie, Read) ,假如为“R”, 则该参数是可读或可写, 假如为”-“, 则该参数是不可读或不可写。若必选属性值为”M”,则该参数是必需实现, 若为”O”, 则该参数实现是可选。
1.1 数据模型
红色表示暂不实现
Name
Type
Write
Read
Description
必 选
Device. DeviceSummary
string(1024)
-
R
设备描述
M
Device.CA
Object

CA卡相关信息
M
Device. DeviceInfo
object

终端具体信息描述
M
Device.ManagementServer
object

终端管理系统相关参数
M
Device.Config
object

终端一般配置参数。
O
Device.GatewayInfo
object

终端连接网关设备信息
O
Device.Time
object

终端中 NTP 时间用户端相关参数。
M
Device.UserInterface
object

终端用户接口相关参数。
O
Device.LAN
object

终端中基于IP网络连接信息
M
Device.LAN.DHCP
object

O
Device.LAN.Stats
object

O
Device.LAN. IPPingDiagnostics

M
Device.LAN.T raceRouteDiagnostics

O
Device.Services
object

终端中特定服务相关配置
O
Device.X_STB_Config
object

STB特定配置
M
Device.X_STB_Stats
object

终端状态
M
Device.X_STB_Statistic
object

性能统计
M
Device.X_STB_AudienceStats
object

用户收视率采集
M
Device.X_STB_Software
object

软件版本管理
M
Device.X_STB_Alarm
Object

目前告警信息
M

1.2 CA卡相关信息 Device.CA
Name
Type
Write
Read
Description
必选
Device.CA

CA信息查询
M
CAVersion
String(5k)

R
CA版本
M
CAProvider
String(5k)

R
运行商信息
M
CASerialNumber
String(5k)

R
CA序列号
M

1.3 设备具体信息 Device. DeviceInfo

Name
Type
Write
Read
Description
必 选
Device. DeviceInfo.
object
-
-
设备具体信息描述
M
Manufacturer
string(64)
-
R
终端制造商（意义可读字符串）。
M
ManufacturerOUI
string(6)
-
R
设备制造商组织体系唯一标识。表示为六位十六进制数值, 全部采取大写字母并包含任意前导零。
M
ModelName
string(64)
-
R
终端型号名称（意义可读字符串）。
M
Description
string(256)
-
R
终端 设备完全描述（意义可读字符串）。
M
ProductClass
string(64)
-
R
使用序列号产品类别标识。即, 对于指定制造商, 此参数用于标识产品或产品类别, 其中 SerialNumber 参数是唯一。
M
SerialNumber
string(64)
-
R
终端 序列号
M
HardwareVersion
string(64)
-
R
标识特定终端型号和版本字符串。
M
SoftwareVersion
string(64)
-
R
各厂商自定义版本命名方法。
M
EnabledOptions
string(1024)
-
R
采取逗号分隔终端支持Option名称列表
O
AdditionalHardwareVersion
string(64)
-
R
任何附加版本以逗号分隔列表。表示任何供给商期望提供附加硬件版本信息。假如没有能够为空字符串。
O
AdditionalSoftwareVersion
string(64)
-
R
任何附加版本以逗号分隔列表。表示任何供给商期望提供附加软件版本信息。假如没有能够为空字符串。
O
ProvisioningCode
string(64)
-
R
关键服务提供商和其她供给信息标识, 服务器用来确定服务提供商特定定制和供给参数。当发生改变时, 需立刻上报终端管理系统。
M
DeviceStatus
string
-
R
终端目前可选状态: “Up” ”Initializing” “Error” “Disabled
M
UpTime
unsignedInt
-
R
一次重启后时间（以秒计）。
M
FirstUseDate
dateTime
-
R
终端 首次成功建立网络连接日期和时间。
O
DeviceLog
string(32K)
-
R
终端统计日志信息
O
HardwareVersion为终端设备版本/型号
SoftwareVersion为终端上主系统软件版本,在eBox上为”主框架”版本号.
1.4 网管信息参数 Device.ManagementServer
Name
Type
Write
Read
Description
必 选
Device.ManagementServer.
object
-
-
此对象包含与 终端管理系统 相关参数, 此 终端管理系统 与终端关联。
M
URL
string(256)
R
R
终端利用终端
WAN 管理协议连接
终端管理系统
URL。此参数必需为有效 HTTP 或 HTTPS URL [8].。HTTPS URL 表示终端管理系统支持 SSL。终端 使用此 URL “主机”部分, 方便在使用基于认证鉴权时确定 终端管理系统 认证。当发生改变时, 需立刻上报终端管理系统。
M
Username
string(256)
R
R
当使用终端WAN 管理协议建立与 终端管理系统 连接时使用用户名, 此用户名只在基于HTTP认证时使用。默认值为”STBAdmin”, 且大小写敏感。
M
Password
string(256)
R
R
当使用终端WAN 管理协议建立与 终端管理系统 连接时使用鉴权密码。只有当终端不使用用户端基于认证鉴权时, 才会用到此密码。在被读取时, 该参数会忽略实际值而返回一个空字符串。采取统一密码方法, 默认值为”STBAdmin”, 且大小写敏感
M
PeriodicInformEnable
boolean
R
R
终端是否必需利用 Inform 方法调用定时向服务器端发送终端信息。默认为true
M
PeriodicInformInterval
unsignedInt
[1:]
R
R
在PeriodicInformEnable 为真时, 终端 必需尝试连接 终端管理系统 并调用 Inform 方法时间间隔。默认为3600秒
M
PeriodicInformTime
dateTime
R
R
决定终端提议Inform 方法调用时间参考绝对值。 每个 Inform 调用必需在 PeriodicInformInterval 加或减此参考时间整数倍时进行。默认为0001-01-01T00:00:00Z.,即不采取此值做为时间参考。
M
ParameterKey
string(32)
-
R
来自于服务器最新 SetParameterValues
, AddObject 或 DeleteObject 方法调用 ParameterKey 自变量数值。假如没有这类调用, 此数值为空。
M
ConnectionRequestURL
string(256)
-
R
终端管理系统 向终端提议连接请求通知时所使用 HTTP URL。其形式以下: http://host:port/path.URL “主机”部分能够是终端管理接口 IP 地址, 用以替换域名。
M
ConnectionRequestUsername
string(256)
R
R
终端管理系统 向终端提议连接请求时, 鉴权过程使用用户名。默认为 “itms”。
M
ConnectionRequestPassword
string(256)
R
R
终端管理系统 向终端提议连接请求时, 鉴权过程使用密码。在被读取时, 该参数会忽略实际值而返回一个空字符串。默认为 “itms”。
M
UpgradesManaged
boolean
R
R
指示终端管理系统是否控制终端升级。假如为真 (1), 终端应只利用 终端管理系统 寻求可用升级。假如为假 (0), 则终端能够使用其她方法进行升级。
M
KickURL
string(256)
R
R
只有当终端支持Kick方法是使用。
O

DownloadProgressURL
string(256)
R
R
只有当终端支持LAN侧Web页面用于显示下载进度时使用。
O

1.5 设备一般配置参数 Device.Config
Name
Type
Write
Read
Description
必选
Device.Config.
object
－
－
此对象包含一般配置参数。
O
PersistentData
string(256)
R
R
必需贯穿终端重启任意用户数据。
M
ConfigFile
string(32K)
－
R　
终端目前配置转储。此参数启用了备份和存放最终一次终端已知良好状态能力。此参数返回一个定义终端状态供给商特定文档。此文档必需能够在使用 SetParameterValues 将终端状态写回时恢复该状态。
M

1.6 网关信息 Device.GatewayInfo
Name
Type
Write
Read
Description
必选
Device.GatewayInfo.
object
－
－
这个对象包含有已连接网关设备信息
O
ManufacturerOUI
string(6)
－
R
相关网关设备OUI。空字符串标识没有监测到相关网关设备。
M
ProductClass
string(64)
－
R
用于标识相关网关设备产品类型。空字符串标识没有监测到相关网关设备。
M
SerialNumber
string(64)
－
R
用于标识相关网关设备序列号。空字符串标识没有监测到相关网关设备。
M

1.7 时间配置参数 Device.Time
Name
Type
Write
Read
Description
必选
Device.Time.
object
-
-
此对象包含与终端中 NTP 时间用户端相关参数。 是否支持此对象是可选。
M
NTPServer1
string(64)
R
R
第一个 NTP 时间服务器。能够为域名或 IP 地址。当发生改变时, 需立刻上报终端管理系统。
O
NTPServer2
string(64)
R
R
第二个 NTP 时间服务器。能够为域名或 IP 地址。
O
NTPServer3
string(64)
R
R
第三个 NTP 时间服务器。能够为域名或 IP 地址。
O
NTPServer4
string(64)
R
R
第四个 NTP 时间服务器。能够为域名或 IP 地址。
O
NTPServer5
string(64)
R
R
第五个 NTP 时间服务器。能够为域名或 IP 地址。
O
CurrentLocalTime
dateTime
－
R
终端当地时区中目前日期和时间
M
LocalTimeZone
string(256)
R
R
当地时间与 UTC 偏差, 形式以下: "+hh:mm" "－hh:mm"。当发生改变时, 需立刻上报终端管理系统。
M

1.8 用户接口相关参数 Device.UserInterface
Name
Type
Write
Read
Description
必选
Device.UserInterface.
object
－
－
此对象包含与终端用户接口相关参数。 是否支持此对象是可选。
O
PasswordRequired
boolean
R
R
只有当终端提供密码保护 LAN 侧用户接口时, 此参数才适用。指示当地用户接口是否必需要求密码, 方便供用户选择。假如此参数为假, 则由用户来选择是否使用密码。

PasswordUserSelectable
boolean
R
R
只有当终端提供密码保护 LAN 侧用户接口并支持 LAN 侧自动配置时, 此参数才适用。指示用户是否能够直接选择密码以保护终端当地用户接口, 或者必需使用与 LAN 侧自动配置协议相同密码。

UpgradeAvailable
boolean
R
R
指示某个终端升级是可用, 许可终端将此信息显示给用户。

WarrantyDate
dateTime
R
R
指示与终端相关保修期过期日期和时间。

ISPName
string(64)
R
R
用户 ISP 名称。

ISPHelpDesk
string(32)
R
R
ISP 咨询电话号码。

ISPHomePage
string(256)
R
R
ISP 主页 URL。

ISPHelpPage
string(256)
R
R
ISP 在线支持页面URL

ISPLogo
Base64(5460)
R
R
Base64编码Gif或JPEG图像。二进制图像大小限制为4095k以下。

ISPLogoSize
unsignedInt
[0:4095]
R
R
未编码二进制图像大小(K)。假如ISPLogoSize输入值为0, 则ISPLogo被清除。ISPLogoSize也能够用于图片检测图片正确传输与Base64字符串到图片大小转换。

ISPMailServer
string(256)
R
R
ISP 邮件服务器 URL。

ISPNewsServer
string(256)
R
R
ISP 新闻服务器 URL。

TextColor
string(6)
R
R
RGB表示GUI屏幕文字颜色

BackgroundColor
string(6)
R
R
RGB表示GUI屏幕背景颜色

ButtonColor
string(6)
R
R
RGB表示GUI屏幕按钮颜色

ButtonTextColor
string(6)
R
R
RGB表示GUI屏幕按钮文字颜色.

AutoUpdateServer
string(256)
R
R
终端用于检验是否有最新更新并进行直接下载服务器地址。.当Device.-ManagementServer.-UpgradesManaged为true时, 不能使用本参数。

UserUpdateServer
string(256)
R
R
用户经过浏览器检验是否有最新更新并下载到PC上服务器地址。.当Device.Management-Server.Upgrades-Managed为true时, 不能使用本参数。

AvailableLanguages
string(256)
R
R
可选语种

CurrentLanguage
string(6)
R
R
目前语言

1.9 LAN接口参数　Device.LAN
Name
Type
Write
Read
Description
必选
Device.LAN.
object
－
－
终端中基于IP网络连接信息, 此处只有1个LAN信息上报
M
AddressingType
string
R　
R
给网络接口分配地址方法, 枚举类型: “DHCP” “Static”
当发生改变时, 需立刻上报终端管理系统。
M
IPAddress
string
R　
R
目前分配给网络接口IP地址。本参数在AddressingType为”DHCP”时为只读。
M
SubnetMask
string
R　
R
子网掩码
M
DefaultGateway
string
R　
R
默认网关
M
DNSServers
string(256)
R
R
逗号分隔DNS服务器地址。
M
MACAddress
string
R　
R
MAC地址
M
MACAddressOverride
boolean
R　
R
MACAddress参数是否能够被重写。True:可改写; False:不可改写。
O
DHCPOptionNumberOfEntries
unsignedInt
－
R
DHCP option表中入口个数
O
1.9.1 DHCP参数配置　Device.LAN.DHCPOption.{i}
Name
Type
Write
Read
Description
Default
Device.LAN.DHCPOption.{i}.
object
R
R
本对象用于DHCP option配置。每个实例都代表DHCP用户端请求中一个DHCP option。.
O
Request
Boolean
R
R
本入口是表示向DHCP服务器请求, 或DHCP用户端发送值。
M
tag
unsignedInt[1:254]
R
R
RFC 2132中定义DHCP option标签
M
Value
Base64
R
R
假如请求为false时, 用于标识DHCP optionbase64编码八进制字符串。
M

1.9.2 LAN状态参数 Device.LAN.Stats
Name
Type
Write
Read
Description
必选
Device.LAN.Stats.
object
－
－
这个对象包含默认IP接口统计信息。
O
ConnectionUpTime
unsignedInt
－
R
网卡连接网络时间(秒为单位)

TotalBytesSent
unsignedInt
－
R
从上次在DeviceInfo.UpTime中描述重启时间开始, 经过这个接口发送IP负载总字节数

TotalBytesReceived
unsignedInt
－
R
从上次在DeviceInfo.UpTime中描述重启时间开始, 经过这个接口接收IP负载总字节数

TotalPacketsSent
unsignedInt
－
R
从上次在DeviceInfo.UpTime中描述重启时间开始, 经过这个接口发送IP包总数

TotalPacketsReceived
unsignedInt
－
R
从上次在DeviceInfo.UpTime中描述重启时间开始, 经过这个接口接收IP包总数

CurrentDayInterval
unsignedInt
－
R
从开始今日统计开始所经过时间(以秒为单位)。设备能够在每个CurrentDay间隔之前加上采取UTC格式表示日期。

CurrentDayBytesSent
unsignedInt
－
R
从CurrentDayInterval定义今日统计时间开始, 经过这个接口发送IP字节总数

CurrentDayBytesReceived
unsignedInt
－
R
从CurrentDayInterval定义今日统计时间开始, 经过这个接口接收IP字节总数

CurrentDayPacketsSent
unsignedInt
－
R
从CurrentDayInterval定义今日统计时间开始, 经过这个接口发送IP包总数

CurrentDayPacketsReceived
unsignedInt
－
R
从CurrentDayInterval定义今日统计时间开始, 经过这个接口接收IP包总数

QuarterHourInterval
unsignedInt
－
R
从开始QuarterHour统计开始所经过时间(以秒为单位)

QuarterHourBytesSent
unsignedInt
－
R
从QuarterHourInterval定义今日统计时间开始, 经过这个接口发送IP字节总数

QuarterHourBytesReceived
unsignedInt
－
R
从QuarterHourInterval定义今日统计时间开始, 经过这个接口接收IP字节总数

QuarterHourPacketsSent
unsignedInt
－
R
从QuarterHourInterval定义今日统计时间开始, 经过这个接口发送IP包总数

QuarterHourPacketsReceived
unsignedInt
－
R
从QuarterHourInterval定义今日统计时间开始, 经过这个接口发送IP包总数

1.9.3 Ping诊疗参数　Device.LAN.IPPingDiagnostics
Name
Type
Write
Read
Description
必选
Device.LAN.IPPingDiagnostics.
object
－
－
这个对象提供IP层ping诊疗
M
DiagnosticsState
string
R
R
表示诊疗数据情况, 假如终端管理系统要求设置这个值, 则能够是:
"None"
"Requested"
"Complete" "Error_CannotResolveHostName"
"Error_Internal"
"Error_Other"
M
Host
string(256)
R
R
用于ping诊疗主机名或地址。
M
NumberOfRepetitions
unsignedInt
[1:]
R
R
在汇报结果之前, ping诊疗反复次数。
M
Timeout
unsignedInt
[1:]
R
R
用毫秒表示ping诊疗超时时间
M
DataBlockSize
unsignedInt
[1:65535]
R
R
每个ping命令发送数据大小, 以字节为单位, 要求固定大小为32字节
M
DSCP
unsignedInt
[0:64]
R
R
测试包中用于DiffServ码点, 默认值为0
M
SuccessCount
unsignedInt
－
R
在最近ping测试中成功次数。.
M
FailureCount
unsignedInt
－
R
在最近ping测试中失败次数。
M
AverageResponseTime
unsignedInt
－
R
以毫秒为单位最近一次ping测试全部成功响应平均时间。
M
MinimumResponseTime
unsignedInt
－
R
以毫秒为单位最近一次ping测试全部成功响应中最短时间
M
MaximumResponseTime
unsignedInt
－
R
以毫秒为单位最近一次ping测试全部成功响应中最长时间
M

1.9.4 路由主机参数　Device.LAN.TraceRouteDiagnostics
Name
Type
Write
Read
Description
必选
Device.LAN.TraceRouteDiagnostics.
object
-
-
用于路由诊疗对象
O
DiagnosticsState
string
R
R
表示诊疗数据情况, 假如终端管理系统要求设置这个值, 则能够是:
"None"
"Requested"
"Complete" "Error_CannotResolveHostName" "Error_Internal"
"Error_Other"

Host
string(256)
R
R
用于路由诊疗主机名或地址。

Timeout
unsignedInt
[1:]
R
R
用毫秒表示路由诊疗超时时间

DataBlockSize
unsignedInt
[1:65535]
R
R
每个路由诊疗发送数据大小, 以字节为单位, 要求固定大小为32字节

MaxHopCount
unsignedInt
[1:64]
R
R
发送测试数据包最大跳数
(最大TTL数), 默认为30跳

DSCP
unsignedInt
[0:64]
R
R
测试包中用于DiffServ码点, 默认值为0.

ResponseTime
unsignedInt
-
R
以毫秒表示最近一次路由主机测试响应时间, 假如无法决定具体路由, 则默认为0

NumberOfRouteHops
unsignedInt
-
R
用于发觉路由跳数, 假如无法决定路由, 则默认为0.

.LAN.TraceRouteDiagnostics.RouteHops.{i}.
object
-

用于表示被发觉路由对象, 假如路由无法达成, 则这个对象没有实例。

HopHost
String(256)
-
R

1.10 Device.Services（临时不实现）
Name
Type
Write
Read
Description
必选
Device.Service
object

O
STBServiceNumberOfEntries
unsignedInt

STBService.{i}.
Object

1.11 终端配置参数 Device.X_STB_Config
Name
Type
Write
Read
Description
必选
Device.X_STB_Config.
object
-
-
STB 特定配置
M
STBID
String(32)
-
R
终端ID
M
UserID
String(36)
-
R
STB用户编号
M
ServiceIDList
String（256）
-
R
支持服务列表（用半角分号分隔）
M

1.12 终端运行状态参数 Device.X_STB_Stats

Name
Type
Write
Read
Description
必选
Device.X_STB_Stats.
object
-
-
终端状态
M
STBOnlineStatus
String(1)
-
R
0 目前在线, 活跃
1 待机
M
CPULoad
unsignedInt[0:100]
-
R
CPU占用率（1－100）
M
MemLoad
unsignedInt[0:100]
-
R
内存占用比率（1－100）
M
StorageLoad
unsignedInt[0:100]
-
R
存放占用比率
M
ServiceUsing
String(256)
-
R
正在使用业务, 依次包含业务种类和业务内容, 以半角字符分号分割。
M
BuffeRatior
unsignedInt[0:100]
-
R
缓冲利用率
M
BufferOverflow
boolean
-
R
缓冲区是否溢出
M
BufferEmpty
boolean
-
R
缓冲区是否为空
M
Bandwidth
unsignedInt[0:]
-
R
目前媒体流传输带宽
M
1.13 用户收视率采集参数Device. X_STB_ AudienceStats

Name
Type
Write
Read
Description
必选
Device.X_STB_ AudienceStats.
object

用户收视率采集
M
RequestRecord
Boolean
R
R
请求开始/终止统计
M
MaxCollectInterval
unsignedInt
R
R
数据上报间隔
单位: s 默认: 3600（即1小时）
M
MaxPacketSize
unsignedInt
R
R
最大保留数据包大小。默认为5000字节。
M
AudienceData
String(10k)
-
R
目前用户收视率数据
M
RequestRecord=true表示采集工作开始, CPE将采集到数据保留到文件, =false时候, 将文件上传到服务器, 上传完成后, 删除CPE端文件并发送Inform
1.14 软件管理参数 Device. X_STB_SoftwareConfig

Name
Type
Write
Read
Description
必选
Device.X_STB_ SoftwareConfig

软件版本管理
M
CurrentSoftwareList
String(5k)
-
R
目前使用软件版本信息列表
每个软件版本信息包含软件名称和版本, 用半角逗号分隔, 软件版本信息之间用半角分号分隔。
M
UpgradeParameters
String(5k)
R

升级信息 格式:
频点: 符号率: 调制方法: PID
终端收到这个命令后, 将实施升级。

UpdateSoftwareList
String(5k)
R
-
包含了全部需要升级文件信息, 每个文件信息包含 fileUrl, 软件名称, 软件版本, 用半角逗号分隔
每组文件信息之间用半角分号分隔
M
iPanel临时不实现UpdateSoftwareList参数,但eBox需要实现
CurrentSoftwareList表示目前全部模块版本信息,格式为”模块名称:版本号,模块名称:版本号…”
UpdateSoftwareList表示需要更新模块版本信息, 假如为空, 则表示不需要对模块进行升级, 格式为“模块名称:版本号:升级标志:文件全路径,模块名称:版本号:升级标志:文件全路径…”, CPE检测到这个参数有内容后, 确定升级内容（与用户交互）, 然后在后台经过FTP下载升级包, 升级完成Inform上报并修改CurrentSoftwareList, UpdateSoftwareList。其中“升级标志”为1（强制升级）2（按需升级）
UpgradeParameters针对cab方法升级, 这个参数默认为空, 当ACS设置这个参数, CPE进行升级, 升级完成后修改内容。
1.15 告警参数 Device. X_STB_Alarm
保留最近一次告警信息。
Name
Type
Write
Read
Description
必选
Device.X_STB_Alarm.

软件版本管理
M
AlarmCode
unsignedInt
-
R
告警代码。终端为不一样告警定义不一样代码。
M
AlarmDescription
String(256)
-
R
告警描述。能够为空
M
AlarmTime
dateTime
-
R
告警发生时间
M