Tr069协议参数模型.docx

Tr069协议参数模型.docx

《Tr069协议参数模型.docx》由会员分享，可在线阅读，更多相关《Tr069协议参数模型.docx（36页珍藏版）》请在冰豆网上搜索。

Tr069协议参数模型

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.TraceRouteDiagnostics

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.2CA卡的相关信息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或HTTPSURL[8].。

HTTPSURL表示终端管理系统支持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

终端管理系统向终端发起连接请求通知时所使用的HTTPURL。

其形式如下：

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.9LAN接口参数　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

DHCPoption表中的入口个数

O

1.9.1DHCP参数配置　Device.LAN.DHCPOption.{i}

Name

Type

Write

Read

Description

Default

Device.LAN.DHCPOption.{i}.

object

R

R

本对象用于DHCPoption的配置。

每个实例都代表DHCP客户端请求中的一个DHCPoption。

.

O

Request

Boolean

R

R

本入口是表示向DHCP服务器的请求，或DHCP客户端发送值。

M

tag

unsignedInt[1:

254]

R

R

RFC2132中定义的DHCPoption标签

M

Value

Base64

R

R

如果请求为false时，用于标识DHCPoption的base64编码的八进制字符串。

M

1.9.2LAN状态参数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.3Ping诊断参数　Device.LAN.IPPingDiagnostics

Name

Type

Write

Read

Description

必选

Device.LAN.IPPingDiagnostic