Tr069协议参数模型.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 数据模型 红色表示暂不实现NameTypeWriteReadDescription必 选Device. DeviceSummarystring(1024)-R设备描述MDevice.CAObjectCA卡的相关信息MDevice. DeviceInfoobject终端的详细信息描述MDevice.ManagementServerobject终端管理系统相关的参数MDevice.Configobject终端普通配置参数。ODevice.GatewayInfoobject终端连接的网关设备信息ODevice.Timeobject终端中 NTP 时间客户端相关的参数。MDevice.UserInterfaceobject终端用户接口相关的参数。ODevice.LANobject终端中基于IP的网络连接信息MDevice.LAN.DHCPobjectODevice.LAN.StatsobjectODevice.LAN. IPPingDiagnosticsMDevice.LAN.T raceRouteDiagnosticsODevice.Servicesobject终端中特定服务相关配置ODevice.X_STB_ConfigobjectSTB特定配置MDevice.X_STB_Statsobject终端状态MDevice.X_STB_Statisticobject性能统计MDevice.X_STB_AudienceStatsobject用户收视率采集MDevice.X_STB_Softwareobject软件版本管理MDevice.X_STB_AlarmObject当前告警信息M 1.2 CA卡的相关信息 Device.CANameTypeWriteReadDescription必选Device.CACA信息查询MCAVersionString(5k)RCA版本MCAProviderString(5k)R运营商信息MCASerialNumberString(5k)RCA序列号M1.3 设备详细信息 Device. DeviceInfoNameTypeWriteReadDescription必 选Device. DeviceInfo.object-设备的详细信息描述MManufacturerstring(64)-R终端制造商（意义可读的字符串）。MManufacturerOUIstring(6)-R设备制造商组织体系唯一标识。表示为六位十六进制数值，全部采用大写字母并包括任意前导零。MModelNamestring(64)-R终端型号名称（意义可读的字符串）。MDescriptionstring(256)-R终端 设备完全描述（意义可读的字符串）。MProductClassstring(64)-R使用序列号的产品类别标识。即，对于指定的制造商，此参数用于标识产品或产品类别，其中 SerialNumber 参数是唯一的。MSerialNumberstring(64)-R终端 序列号MHardwareVersionstring(64)-R标识特定终端型号和版本的字符串。MSoftwareVersionstring(64)-R各厂商自定义版本的命名方式。MEnabledOptionsstring(1024)-R采用逗号分隔的终端支持的Option名称列表 OAdditionalHardwareVersionstring(64)-R任何附加版本以逗号分隔的列表。表示任何供应商希望提供的附加硬件版本信息。如果没有可以为空字符串。OAdditionalSoftwareVersionstring(64)-R任何附加版本以逗号分隔的列表。表示任何供应商希望提供的附加软件版本信息。如果没有可以为空字符串。OProvisioningCodestring(64)-R主要服务提供商和其他供应信息的标识，服务器用来确定服务提供商特定的定制和供应参数。当发生改变时，需立即上报终端管理系统。MDeviceStatusstring-R终端当前可选状态： “Up” ”Initializing” “Error” “DisabledMUpTimeunsignedInt-R一次重启后的时间（以秒计）。MFirstUseDatedateTime-R终端 首次成功建立网络连接的日期和时间。ODeviceLogstring(32K)-R终端记录的日志信息OHardwareVersion为终端设备的版本/型号SoftwareVersion为终端上主系统软件的版本,在eBox上为”主框架”的版本号.1.4 网管信息参数 Device.ManagementServerNameTypeWriteReadDescription必 选Device.ManagementServer.object-此对象包含与 终端管理系统 相关的参数，此 终端管理系统 与终端关联。M URLstring(256)RR终端利用终端WAN 管理协议连接终端管理系统的URL。此参数必须为有效的 HTTP 或 HTTPS URL 8.。HTTPS URL 表示终端管理系统支持 SSL。终端 使用此 URL 的“主机”部分，以便在使用基于认证的鉴权时确认 终端管理系统 认证。当发生改变时，需立即上报终端管理系统。MUsernamestring(256)RR当使用终端WAN 管理协议建立与 终端管理系统 的连接时使用的用户名，此用户名只在基于HTTP的认证时使用。默认值为”STBAdmin”，且大小写敏感。MPasswordstring(256)RR当使用终端WAN 管理协议建立与 终端管理系统 的连接时使用的鉴权密码。只有当终端不使用客户端基于认证的鉴权时，才会用到此密码。在被读取时，该参数会忽略实际值而返回一个空字符串。采用统一密码的方式，默认值为”STBAdmin”，且大小写敏感MPeriodicInformEnablebooleanRR终端是否必须利用 Inform 方法调用定时向服务器端发送终端信息。默认为trueMPeriodicInformIntervalunsignedInt1:RR在PeriodicInformEnable 为真时，终端 必须尝试连接 终端管理系统 并调用 Inform 方法的时间间隔。默认为3600秒MPeriodicInformTimedateTimeRR决定终端发起Inform 方法调用的时间参考绝对值。 每个 Inform 调用必须在 PeriodicInformInterval 加或减此参考时间的整数倍时进行。默认为0001-01-01T00:00:00Z.,即不采用此值做为时间参考。MParameterKeystring(32)-R 来自于服务器的最新的 SetParameterValues，AddObject 或 DeleteObject 方法调用的 ParameterKey 自变量数值。如果没有此类调用，此数值为空。MConnectionRequestURLstring(256)-R终端管理系统 向终端发起连接请求通知时所使用的 HTTP URL。其形式如下：http:/host:port/path.URL 的“主机”部分可以是终端管理接口的 IP 地址，用以替代域名。MConnectionRequestUsernamestring(256)RR终端管理系统 向终端发起连接请求时，鉴权过程使用的用户名。默认为 “itms”。MConnectionRequestPasswordstring(256)RR终端管理系统 向终端发起连接请求时，鉴权过程使用的密码。在被读取时，该参数会忽略实际值而返回一个空字符串。默认为 “itms”。MUpgradesManagedbooleanRR指示终端管理系统是否控制终端的升级。如果为真 (1)，终端应只利用 终端管理系统 寻求可用的升级。如果为假 (0)，则终端可以使用其他方法进行升级。MKickURLstring(256)RR只有当终端支持Kick方法是使用。ODownloadProgressURLstring(256)RR只有当终端支持LAN侧的Web页面用于显示下载进度时使用。O1.5 设备普通配置参数 Device.ConfigNameTypeWriteReadDescription必选Device.Config.object此对象包含普通配置参数。O PersistentDatastring(256)RR必须贯穿终端重启的任意用户数据。MConfigFilestring(32K)R终端当前配置的转储。此参数启用了备份和存储最后一次终端的已知良好状态的能力。此参数返回一个定义终端状态的供应商特定文档。此文档必须能够在使用 SetParameterValues 将终端状态写回时恢复该状态。M1.6 网关信息 Device.GatewayInfoNameTypeWriteReadDescription必选Device.GatewayInfo.object这个对象包含有已连接的网关设备的信息OManufacturerOUIstring(6)R相关网关设备的OUI。空字符串标识没有监测到相关的网关设备。M ProductClassstring(64)R用于标识相关网关设备的产品类型。空字符串标识没有监测到相关网关设备。MSerialNumberstring(64)R用于标识相关网关设备的序列号。空字符串标识没有监测到相关网关设备。M1.7 时间配置参数 Device.TimeNameTypeWriteReadDescription必选Device.Time.object-此对象包含与终端中 NTP 时间客户端相关的参数。 是否支持此对象是可选的。MNTPServer1string(64)RR第一个 NTP 时间服务器。可以为域名或 IP 地址。当发生改变时，需立即上报终端管理系统。ONTPServer2string(64)RR第二个 NTP 时间服务器。可以为域名或 IP 地址。ONTPServer3string(64)R R第三个 NTP 时间服务器。可以为域名或 IP 地址。ONTPServer4string(64)RR第四个 NTP 时间服务器。可以为域名或 IP 地址。ONTPServer5string(64)RR第五个 NTP 时间服务器。可以为域名或 IP 地址。OCurrentLocalTimedateTimeR终端本地时区中的当前日期和时间MLocalTimeZonestring(256)RR本地时间与 UTC 的偏差，形式如下：+hh:mm hh:mm。当发生改变时，需立即上报终端管理系统。M1.8 用户接口相关参数 Device.UserInterfaceNameTypeWriteReadDescription必选Device.UserInterface.object此对象包含与终端用户接口相关的参数。 是否支持此对象是可选的。OPasswordRequiredbooleanRR只有当终端提供密码保护的 LAN 侧用户接口时，此参数才适用。指示本地用户接口是否必须要求密码，以便供用户选择。如果此参数为假，则由用户来选择是否使用密码。PasswordUserSelectablebooleanRR只有当终端提供密码保护的 LAN 侧用户接口并支持 LAN 侧自动配置时，此参数才适用。指示用户是否可以直接选择密码以保护终端的本地用户接口，或者必须使用与 LAN 侧自动配置协议相同的密码。UpgradeAvailablebooleanRR指示某个终端升级是可用的，允许终端将此信息显示给用户。WarrantyDatedateTimeRR指示与终端相关的保修期过期的日期和时间。ISPNamestring(64)RR客户的 ISP 名称。ISPHelpDeskstring(32)RRISP 的咨询电话号码。ISPHomePagestring(256)RRISP 主页的 URL。ISPHelpPagestring(256)RRISP 在线支持页面的URLISPLogoBase64(5460)RRBase64编码的Gif或JPEG图像。二进制图像大小限制为4095k以下。ISPLogoSizeunsignedInt0:4095RR未编码的二进制图像大小(K)。如果ISPLogoSize输入值为0，则ISPLogo被清除。ISPLogoSize也能够用于图片的检测图片的正确传输与Base64字符串到图片大小的转换。ISPMailServerstring(256)RRISP 邮件服务器的 URL。ISPNewsServerstring(256)RRISP 新闻服务器的 URL。TextColorstring(6)RRRGB表示的GUI屏幕文字颜色BackgroundColorstring(6)RRRGB表示的GUI屏幕背景颜色ButtonColorstring(6)RRRGB表示的GUI屏幕按钮颜色ButtonTextColorstring(6)RRRGB表示的GUI屏幕按钮文字颜色.AutoUpdateServerstring(256)RR终端用于检查是否有最新更新并进行直接下载的服务器地址。.当Device.-ManagementServer.-UpgradesManaged为true时，不能使用本参数。UserUpdateServerstring(256)RR用户通过浏览器检查是否有最新的更新并下载到PC上的服务器地址。.当Device.Management-Server.Upgrades-Managed为true时，不能使用本参数。AvailableLanguagesstring(256)RR可选语种CurrentLanguagestring(6)RR当前语言1.9 LAN接口参数Device.LANNameTypeWriteReadDescription必选Device.LAN.object终端中基于IP的网络连接信息，此处只有1个LAN信息上报MAddressingTypestringRR给网络接口分配地址的方法，枚举类型： “DHCP” “Static” 当发生改变时，需立即上报终端管理系统。MIPAddressstringRR当前分配给网络接口的IP地址。本参数在AddressingType为”DHCP”时为只读。MSubnetMaskstringRR子网掩码MDefaultGatewaystringRR默认网关MDNSServersstring(256)RR逗号分隔的DNS服务器地址。MMACAddressstringRRMAC地址MMACAddressOverridebooleanRRMACAddress参数是否能够被重写。True:可改写； False:不可改写。ODHCPOptionNumberOfEntriesunsignedIntRDHCP option表中的入口个数O1.9.1 DHCP参数配置Device.LAN.DHCPOption.iNameTypeWriteReadDescriptionDefaultDevice.LAN.DHCPOption.i.objectR R 本对象用于DHCP option的配置。每个实例都代表DHCP客户端请求中的一个DHCP option。.ORequestBooleanRR本入口是表示向DHCP服务器的请求，或DHCP客户端发送值。MtagunsignedInt1:254RRRFC 2132中定义的DHCP option标签MValueBase64RR如果请求为false时，用于标识DHCP option的base64编码的八进制字符串。M1.9.2 LAN状态参数 Device.LAN.StatsNameTypeWriteReadDescription必选Device.LAN.Stats.object 这个对象包括默认IP接口的统计信息。OConnectionUpTimeunsignedIntR网卡连接网络的时间(秒为单位)TotalBytesSentunsignedIntR从上次在DeviceInfo.UpTime中描述的重启时间开始，通过这个接口发送的IP负载总字节数TotalBytesReceivedunsignedIntR从上次在DeviceInfo.UpTime中描述的重启时间开始，通过这个接口接收的IP负载总字节数TotalPacketsSentunsignedIntR从上次在DeviceInfo.UpTime中描述的重启时间开始，通过这个接口发送的IP包总数TotalPacketsReceivedunsignedIntR从上次在DeviceInfo.UpTime中描述的重启时间开始，通过这个接口接收的IP包总数CurrentDayIntervalunsignedIntR从开始今日统计开始所经过的时间(以秒为单位)。设备可以在每个CurrentDay间隔之前加上采用UTC格式表示的日期。CurrentDayBytesSentunsignedIntR从CurrentDayInterval定义的今日统计时间开始，通过这个接口发送的IP字节总数CurrentDayBytesReceivedunsignedIntR从CurrentDayInterval定义的今日统计时间开始，通过这个接口接收的IP字节总数CurrentDayPacketsSentunsignedIntR从CurrentDayInterval定义的今日统计时间开始，通过这个接口发送的IP包总数CurrentDayPacketsReceivedunsignedIntR从CurrentDayInterval定义的今日统计时间开始，通过这个接口接收的IP包总数QuarterHourIntervalunsignedIntR从开始QuarterHour统计开始所经过的时间(以秒为单位)QuarterHourBytesSentunsignedIntR从QuarterHourInterval定义的今日统计时间开始，通过这个接口发送的IP字节总数QuarterHourBytesReceivedunsignedIntR从QuarterHourInterval定义的今日统计时间开始，通过这个接口接收的IP字节总数QuarterHourPacketsSentunsignedIntR从QuarterHourInterval定义的今日统计时间开始，通过这个接口发送的IP包总数QuarterHourPacketsReceivedunsignedIntR从QuarterHourInterval定义的今日统计时间开始，通过这个接口发送的IP包总数1.9.3 Ping诊断参数Device.LAN.IPPingDiagnosticsNameTypeWriteReadDescription必选Device.LAN.IPPingDiagnostics.object 这个对象提供IP层的ping诊断MDiagnosticsStatestringRR表示诊断数据的情况，如果终端管理系统要求设置这个值，则可以是： None Requested Complete Error_CannotResolveHostName Error_Internal Error_OtherMHoststring(256)RR用于ping诊断的主机名或地址。MNumberOfRepetitionsunsignedInt1:RR在报告结果之前，ping诊断重复的次数。MTimeoutunsignedInt1:RR用毫秒表示的ping诊断超时时间MDataBlockSizeunsignedInt1:65535RR每个ping命令发送的数据大小，以字节为单位，要求固定大小为32字节MDSCPunsignedInt0:64RR测试包中用于DiffServ的码点，默认值为0MSuccessCountunsignedIntR在最近的ping测试中成功的次数。.MFailureCountunsignedIntR在最近的ping测试中失败的次数。MAverageResponseTimeunsignedIntR以毫秒为单位的最近一次ping测试所有成功响应的平均时间。MMinimumResponseTimeunsignedIntR以毫秒为单位的最近一次ping测试所有成功响应中的最短时间MMaximumResponseTimeunsignedIntR以毫秒为单位的最近一次ping测试所有成功响应中的最长时间M1.9.4 路由主机参数Device.LAN.TraceRouteDiagnosticsNameTypeWriteReadDescription必选Device.LAN.TraceRouteDiagnostics.object- 用于路由诊断的对象ODiagnosticsStatestringR R表示诊断数据的情况，如果终端管理系统要求设置这个值，则可以是： None Requested Complete Error_CannotResolveHostName Error_Internal Error_OtherHoststring(256)R R用于路由诊断的主机名或地址。TimeoutunsignedInt1:R R用毫秒表示的路由诊断超时时间DataBlockSizeunsignedInt1:65535R R每个路由诊断发送的数据大小，以字节为单位，要求固定大小为32字节MaxHopCountunsignedInt1:64R R发送的测试数据包的最大跳数(最大TTL数)，默认为30跳DSCPunsignedInt0:64R R测试包中用于DiffServ的码点，默认值为0.ResponseTimeunsignedInt-R以毫秒表示的最近一次路由主机测试的响应时间，如果无法决定具体路由，则默认为0 NumberOfRouteHopsunsignedInt-R用于发现路由的跳数，如果无法决定路由，则默认为0.LAN.TraceRouteDiagnostics.RouteHops.i.object-用于表示被发现的路由对象，如果路由无法达到，则这个对象没有实例。HopHostString(256)-R1.10 Device.Services（暂时不实现）NameTypeWriteReadDescription必选Device.Serviceobject OSTBServiceNumberOfEntriesunsignedIntSTBService.i.Object1.11 终端配置参数 Device.X_STB_ConfigNameTypeWriteReadDescription必选Device.X_STB_Config.object- STB 特定配置MSTBIDString(32)-R终端IDMUserIDString(36)-RSTB用户编号MServiceIDListString（256）-R支持的服务列表（用半角分号分隔）M1.12 终端运行状态参数 Device.X_STB_Stats NameTypeWriteReadDescription必选Device.X_STB_Stats.object- 终端状态MSTBOnlineStatusString(1)-R0 当前在线，活跃1 待机 MCPULoad unsignedInt0:100-RCPU占用率（1100）MMemLoad unsignedInt0:100-R内存占用比率（1100）MStorageLoad unsignedInt0:100-R存储占用比率MServiceUsingString(256)-R正在使用的业务，依次包含业务种类和业务内容，以半角字符分号分割。MBuffeRatiorunsignedInt0:100-R缓冲利用率MBufferOverflowboolean-R缓冲区是否溢出MBufferEmptyboolean-R缓冲区是否为空MBandwidthunsignedInt0:-R当前媒体流传输带宽M1.13 用户收视率采集参数Device. X_STB_ AudienceStats NameTypeWriteReadDescription必选Device.X_STB_ AudienceStats.object用户收视率采集MRequestRecordBoolean RR请求开始/终止记录MMaxCollectIn