CN102520941B - 一种生成可执行文档的方法及装置 - Google Patents

Abstract

本发明公开了一种生成可执行文档的方法，用于提高生成可执行文档的效率和准确度。所述方法包括：网元设备获得表格结构的MIB描述文档并进行解析；网元设备依据预定义的执行文档模板，从所述MIB描述文档中获得该执行文档模板需要的管理配置信息；网元设备结合所述执行文档模板和获得的管理配置信息，生成可执行文档。本发明还公开了用于实现所述方法的装置。

Description

一种生成可执行文档的方法及装置

技术领域

本发明涉及计算机及通信领域，特别是涉及生成可执行文档的方法及装置。

背景技术

现在的Internet(互联网)大多采用了基于简单网络管理协议(SNMP)的网络管理体系，主要由管理者(Manager)、代理者(Agent)、管理信息库(ManagementInformation Base，MIB)和SNMP协议等几部分构成。Manager通过SNMP协议向Agent发布操作指令，实施对网络中各种资源的监测和控制。Agent响应Manager的操作请求，通过访问被管信息数据执行对设备的操作维护。MIB是所有管理对象的集合，为了统一管理，它采用了一种层次型、结构化的树形结构，库中的每一个变量就是一个网管对象。

IETF(Internet Engineering Task Force，因特网工程任务组)组织给出了MIB定义的方式，通常是以管理信息结构(SMI)的格式来定义的，它实质上是一套基于文本方式的特殊的语义符号。SMI采用ASN.1(一种程序语言)的一个适配子集，为MIB如何定义管理对象以及协议如何使用管理对象提供了模板。标准协议RFC1212、RFC1155、RFC2856、RFC2580、RFC2579、RFC2578给出了详细定义。如下给出了一个以ASN.1方式描述MIB的实例：

传统的SNMP开发模式由人工手工编写ASN.1文档，代理侧利用MIB编译器形成Agent侧需要的C语言桩文件，管理侧利用MIB加载器装载后，针对特定应用进行图形界面开发，由于采用同一套ASN.1的MIB文档开发，可以相对保证双方的一致性。但是，以文本方式定义描述MIB，犯书写错误时不容易被发现。并且每次维护MIB时，均需要重新编写文本文档，影响文档的生成效率。

发明内容

本发明实施例提供一种生成可执行文档的方法及装置，用于提高生成可执行文档的效率和准确度。

一种生成可执行文档的方法，包括以下步骤：

网元设备获得表格结构的MIB描述文档并进行解析；

网元设备依据预定义的执行文档模板，从所述MIB描述文档中获得该执行文档模板需要的管理配置信息；

网元设备结合所述执行文档模板和获得的管理配置信息，生成可执行文档。

一种网元设备，包括：

接口模块，用于获得表格结构的MIB描述文档并进行解析；

提取模块，用于依据预定义的执行文档模板，从所述MIB描述文档中获得该执行文档模板需要的管理配置信息；

生成模块，用于结合所述执行文档模板和获得的管理配置信息，生成可执行文档。

本发明实施例中MIB描述文档采用表格结构，将管理对象的管理配置信息用二维表格结构体现，相对于一维的文本形式更清晰，不易出错。并且表格中的每一项均可设定数据类型，以检验输入的管理配置信息是否准确。另外，预先针对网元设备配置执行文档模板，从MIB描述文档中取出执行文档模板所需的管理配置信息，并生成可执行文档。当需要维护MIB时，只需修改MIB描述文档中的管理配置信息，不需要修改执行文档模板，可大幅度提高生成可执行文档的效率。

附图说明

图1为本发明实施例中生成可执行文档的方法流程图；

图2为本发明实施例中MIB定义部分的结构示意图；

图3为本发明实施例中CMD定义部分的结构示意图；

图4为本发明实施例中网元设备的结构图。

具体实施方式

本发明实施例中MIB描述文档采用表格结构，将管理对象的管理配置信息用二维表格结构体现，相对于一维的文本形式更清晰，不易出错。并且表格中的每一项均可设定数据类型，以检验输入的管理配置信息是否准确。另外，预先针对网元设备配置执行文档模板，从MIB描述文档中取出执行文档模板所需的管理配置信息，并生成可执行文档。当需要维护MIB时，只需修改MIB描述文档中的管理配置信息，不需要修改执行文档模板，可大幅度提高生成可执行文档的效率。

参见图1，本实施例中生成可执行文档的方法流程如下：

步骤101：网元设备获得表格结构的MIB描述文档并进行解析。较佳的，表格可采用Excel(一种表格工具)表。

步骤102：网元设备依据预定义的执行文档模板，从所述MIB描述文档中获得该执行文档模板需要的管理配置信息。

步骤103：网元设备结合所述执行文档模板和获得的管理配置信息，生成可执行文档。

MIB描述文档包括用于记录网元所支持的所有被管对象及其属性的MIB定义部分和用于记录网元支持的所有命令操作的CMD(命令字)定义部分。

具体的，MIB定义部分包括：每个对象的对象标识符、表格索引项、管理者的最大读写权限、ASN.1数据类型、取值范围、缺省值、单位、中英文注释、对象存储方式、变更需求、热备需求、存盘需求、预配文件权限中的一项或多项，参见图2所示。行表示一个具体的管理对象或者该对象在树形结构所处的节点位置；列表示该管理对象所有的属性，比如管理站最大权限、数据类型及取值范围、缺省值、基本单位等等。

行区域设计：

总体上，表格的行区域采用类似树形结构定义被管对象，每一个对象前面都有自身的对象标识符。对象与节点间的隶属关系表示：如果该对象隶属于上个节点，该对象向右下方错开一个方格定义。对象间的同级关系表示：如果该对象与上个对象共同属于某个节点，是同级的平行关系，直接在该对象下一行定义。表量和标量的区别：表格中第一个变量往往是索引(即表量)，在这个特殊变量上标记一个“*”号，它也就给出了ASN.1中表格变量定义的INDEX(索引)子句。如果父节点下最近的一个变量没有“*”标记，即可表示该变量为标量。利用Excel提供的“数据组合功能”将同一节点下的对象组合起来，就可以清晰看到整个MIB的树形结构框架。

列区域设计：

针对SMI的需求，MIB描述文档中添加了如下几列，填写值为选择项内容：

管理站最大权限：对应ASN.1中MAX-ACCESS(最大接入)子句，选择项如下：

“/”表示为节点(node)；

“na”表示为不可访问(not-accessible)，通常是索引；

“ro”表示为管理站只读(read-only)；

“rw”表示为管理站可读写(read-write)；

“rc”表示为管理站可读且可创建(read-create)；

“an”表示该变量只用做通知(accessible-for-notify)；

ASN.1数据类型：对应ASN.1中SYNTAX(句法)子句的数据类型部分，选择项如下：

“/”表示为节点；

“Integer32”表示为32位有符号整型；

“INTEGER”表示为32位有符号整型，通常为枚举值；

“Unsigned32”表示为32位的无符号整型；

“Counter32”表示为32位的计数器；

“DisplayString”表示为字符串类型；

“TimeTick”表示时钟计数器类型；

“OBJECT IDENTIFIER”表示为OID类型；

其他代表性的文本约定(Textual Convention)有：

“RowStatus”表示为行状态；

“IpAddress”表示为IP(互联网协议)地址类型；

“DateAndTime”表示日期时间显示类型；

“MacAddress”表示MAC(媒体接入控制)地址类型；

如有需要，可以继续扩充，不再详细罗列。

取值范围：结合“ASN.1数据类型”列属性，对应ASN.1中SYNTAX子句的取值范围部分；

缺省初配值：对应ASN.1中DEVAL(缺省值)子句，选择项如下：

“/”表示为节点；

“#”表示该变量需要根据不同的应用场景单独初配；

“×”表示该变量不需要初配；

其余情况，根据需要填写；

单位：对应ASN.1中UnitsPart(单位)子句，选择项如下：

“/”表示为节点；

“×”表示该对象没有单位；

其余字符是文本方式表征的该对象单位；

注释说明：对应ASN.1中DESCRIPTION子句。

以文本方式该对象的使用方式、状态机轮转情况等等。

热备需求：描述该数据是否需要实时热备份，选择项如下：

“/”表示为节点；

“×”表示不需要备份；

“√”表示需要备份；

其它，略。

列属性可以根据网元功能需求自行添加，比如“热备需求”就是根据网元实现的特点自行添加的，类似的还有变更需求、文件预配置权限等等。

CMD定义部分包括：命令名称、命令参数、命令权限分级、执行条件、命令显示分层中的一项或多项，参见图3所示。具体的，命令英文名称：显示给用户的管理站命令的英文名称。命令中文名称：显示给用户的管理站命令的中文名称。命令使用说明：命令的使用方法、限制条件等等。操作命令内容：定义命令包含的参数内容，命令参数来源于MIB定义，并严格匹配。对象树命令路径：便于图形界面上对象树方式下命令集显示，采用“父路径名”+“\”+“1级子路径名”+...+“N级子路径名”格式。权限分级：用于基础的管理权限的分类，可以用中文枚举方式定义。

网元设备包括ASN.1类的网元设备、代理者Agent端和管理者Manager端。

网元设备为ASN.1类的网元设备时，执行文档模板的结构可按照目前协议的规定，采用SYNTAX、ACCESS(访问权限)、STATUS(状态)、DESCRIPTION(描述)等关键字，需要写入全部MIB节点的相关信息。

当网元设备为代理者端时，所述执行文档模板包括：头文件(.h文件)和程序文件(.c文件)。头文件包括文件说明、宏定义、全局变量定义和函数声明中的一项或多项。程序文件包括文件说明、全局变量初始化和函数实现中的一项或多项。.h文件的宏定义部分包括全部父节点的编号定义、各父节点下全部子节点的编号定义、各叶子节点的取值(最大值、最小值、默认值)定义、一些统计值定义(如全部叶子节点的个数、全部实例数、各父节点下的命令个数)等。.h文件的全局变量定义部分，根据约定写入需要的全局变量定义。.h文件的函数申明部分，根据Excel表格中的CMD定义，写入各命令的函数原型。.c文件的全局变量初始化部分，包括全部父节点信息初始化(包括索引个数、叶子节点个数、实例个数等统计信息)、各父节点的叶子节点信息初始化(包括叶子节点名、数据类型、是否需要变更上报、是否需要备份、是否需要写入配置文件、最大取值、最小取值、默认值等信息)。.c文件的函数实现部分，根据统一的函数模版，为CMD表格中的全部命令写出函数实现代码。

当网元设备为管理者端时，所述执行文档模板包括：MIB节点信息数据表和命令数据表。MIB节点信息数据表的数据字段包括节点名、节点OID(对象标识符)、父节点OID、索引信息、数据类型、管理站权限、取值范围、缺省初配值、单位和注释说明中的一项或多项。命令数据表的数据字段包括命令名、命令类型、命令操作的MIB节点和命令说明中的一项或多项。

下面对网元设备的内部结构和功能进行介绍。

参见图4，本实施例中网元设备包括：接口模块401、提取模块402和生成模块403。

接口模块401用于获得表格结构的MIB描述文档并进行解析。

提取模块402用于依据预定义的执行文档模板，从所述MIB描述文档中获得该执行文档模板需要的管理配置信息。

生成模块403用于结合所述执行文档模板和获得的管理配置信息，生成可执行文档。

MIB描述文档包括用于记录网元所支持的所有被管对象及其属性的MIB定义部分和用于记录网元支持的所有命令操作的CMD定义部分。

MIB定义部分包括：每个对象的对象标识符、表格索引项、管理者的最大读写权限、ASN.1数据类型、取值范围、缺省值、单位、中英文注释、对象存储方式、变更需求、热备需求、存盘需求、预配文件权限中的一项或多项。

CMD定义部分包括：命令名称、命令参数、命令权限分级、执行条件、命令显示分层中的一项或多项。

网元设备包括ASN.1类的网元设备、代理者Agent端和管理者Manager端。

当网元设备为代理者端时，所述执行文档模板包括：头文件和程序文件。头文件包括文件说明、宏定义、全局变量定义和函数声明中的一项或多项。程序文件包括文件说明、全局变量初始化和函数实现中的一项或多项。

当网元设备为管理者端时，所述执行文档模板包括：MIB节点信息数据表和命令数据表。MIB节点信息数据表的数据字段包括节点名、节点OID、父节点OID、索引信息、数据类型、管理站权限、取值范围、缺省初配值、单位和注释说明中的一项或多项。命令数据表的数据字段包括命令名、命令类型、命令操作的MIB节点和命令说明中的一项或多项。

本发明实施例中MIB描述文档采用表格结构，将管理对象的管理配置信息用二维表格结构体现，相对于一维的文本形式更清晰，不易出错。并且表格中的每一项均可设定数据类型，以检验输入的管理配置信息是否准确。另外，预先针对网元设备配置执行文档模板，从MIB描述文档中取出执行文档模板所需的管理配置信息，并生成可执行文档。当需要维护MIB时，只需修改MIB描述文档中的管理配置信息，不需要修改执行文档模板，可大幅度提高生成可执行文档的效率。在设备开发阶段，MIB的定义是一个繁复的过程，总在不断地更新变化。本发明实施例借鉴了基于ASN.1文档MIB开发模式的优点，基于设备Agent侧开发的一般需求和命令行等图形显示的要求，提出了一种新的基于表格的MIB文档定义格式，能够详细描述设备能力、数据支持要求、界面呈现要求，并基于此进行了二次开发，能够同时生成Agent侧的大部分代码和管理侧的命令数据库。由于采用格式化规约和机器编译，可以从最大程度上避免了人为错误，保证了文档、程序的实时一致性，从加快MIB的稳定开发。甚至，结合设备实际特点，可以利用框架来实现一些通用的高级需求，比如热备、数据变更、网元预配置文件等。

本领域内的技术人员应明白，本发明的实施例可提供为方法、系统、或计算机程序产品。因此，本发明可采用完全硬件实施例、完全软件实施例、或结合软件和硬件方面的实施例的形式。而且，本发明可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器和光学存储器等)上实施的计算机程序产品的形式。

本发明是参照根据本发明实施例的方法、设备(系统)、和计算机程序产品的流程图和/或方框图来描述的。应理解可由计算机程序指令实现流程图和/或方框图中的每一流程和/或方框、以及流程图和/或方框图中的流程和/或方框的结合。可提供这些计算机程序指令到通用计算机、专用计算机、嵌入式处理机或其他可编程数据处理设备的处理器以产生一个机器，使得通过计算机或其他可编程数据处理设备的处理器执行的指令产生用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的装置。

这些计算机程序指令也可存储在能引导计算机或其他可编程数据处理设备以特定方式工作的计算机可读存储器中，使得存储在该计算机可读存储器中的指令产生包括指令装置的制造品，该指令装置实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能。

这些计算机程序指令也可装载到计算机或其他可编程数据处理设备上，使得在计算机或其他可编程设备上执行一系列操作步骤以产生计算机实现的处理，从而在计算机或其他可编程设备上执行的指令提供用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的步骤。

显然，本领域的技术人员可以对本发明进行各种改动和变型而不脱离本发明的精神和范围。这样，倘若本发明的这些修改和变型属于本发明权利要求及其等同技术的范围之内，则本发明也意图包含这些改动和变型在内。

Claims (10)

1.一种生成可执行文档的方法，其特征在于，包括以下步骤：

网元设备获得表格结构的管理信息库MIB描述文档并进行解析；

网元设备依据预定义的执行文档模板，从所述MIB描述文档中获得该执行文档模板需要的管理配置信息；

网元设备结合所述执行文档模板和获得的管理配置信息，生成可执行文档；

MIB描述文档包括用于记录网元所支持的所有被管对象及其属性的MIB定义部分和用于记录网元支持的所有命令操作的命令字CMD定义部分；

CMD定义部分包括：命令名称、命令参数、命令权限分级、执行条件、命令显示分层中的一项或多项。

2.如权利要求1所述的方法，其特征在于，MIB定义部分包括：每个对象的对象标识符、表格索引项、管理者的最大读写权限、程序语言ASN.1数据类型、取值范围、缺省值、单位、中英文注释、对象存储方式、变更需求、热备需求、存盘需求、预配文件权限中的一项或多项。

3.如权利要求1所述的方法，其特征在于，网元设备包括ASN.1类的网元设备、代理者Agent端和管理者Manager端。

4.如权利要求3所述的方法，其特征在于，当网元设备为代理者端时，所述执行文档模板包括：头文件和程序文件；

头文件包括文件说明、宏定义、全局变量定义和函数声明中的一项或多项；

程序文件包括文件说明、全局变量初始化和函数实现中的一项或多项。

5.如权利要求3所述的方法，其特征在于，当网元设备为管理者端时，所述执行文档模板包括：MIB节点信息数据表和命令数据表；

MIB节点信息数据表的数据字段包括节点名、节点对象标识符OID、父节点OID、索引信息、数据类型、管理站权限、取值范围、缺省初配值、单位和注释说明中的一项或多项；

命令数据表的数据字段包括命令名、命令类型、命令操作的MIB节点和命令说明中的一项或多项。

6.一种网元设备，其特征在于，包括：

接口模块，用于获得表格结构的MIB描述文档并进行解析，其中，MIB描述文档包括用于记录网元所支持的所有被管对象及其属性的MIB定义部分和用于记录网元支持的所有命令操作的CMD定义部分，CMD定义部分包括：命令名称、命令参数、命令权限分级、执行条件、命令显示分层中的一项或多项；

提取模块，用于依据预定义的执行文档模板，从所述MIB描述文档中获得该执行文档模板需要的管理配置信息；

生成模块，用于结合所述执行文档模板和获得的管理配置信息，生成可执行文档。

7.如权利要求6所述的网元设备，其特征在于，MIB定义部分包括：每个对象的对象标识符、表格索引项、管理者的最大读写权限、ASN.1数据类型、取值范围、缺省值、单位、中英文注释、对象存储方式、变更需求、热备需求、存盘需求、预配文件权限中的一项或多项。

8.如权利要求6所述的网元设备，其特征在于，网元设备包括ASN.1类的网元设备、代理者Agent端和管理者Manager端。

9.如权利要求7所述的网元设备，其特征在于，当网元设备为代理者端时，所述执行文档模板包括：头文件和程序文件；

头文件包括文件说明、宏定义、全局变量定义和函数声明中的一项或多项；

程序文件包括文件说明、全局变量初始化和函数实现中的一项或多项。

10.如权利要求7所述的网元设备，其特征在于，当网元设备为管理者端时，所述执行文档模板包括：MIB节点信息数据表和命令数据表；

MIB节点信息数据表的数据字段包括节点名、节点OID、父节点OID、索引信息、数据类型、管理站权限、取值范围、缺省初配值、单位和注释说明中的一项或多项；

命令数据表的数据字段包括命令名、命令类型、命令操作的MIB节点和命令说明中的一项或多项。