OMC系统北向接口通用技术规范V1.0.0

中国移动通信企业标准QB-XX-XXX-XXXXOMC北向接口通用技术规范Northbound Interface General Technology Specification for OMC版本号 1.0.02016-910-1244发布2016-109-1244实施中国移动通信集团公司发布目录1范围52规范性引用文件53缩略语54接口架构55通用技术约定65.1公共要求65.2FTP通用要求66资源数据接口86.1接口协议86.2接口数据96.3数据格式96.4技术指标127性能数据接口137.1接口协议137.2接口数据137.3数据格式137.4技术指标148告警数据接口148.1接口协议148.2通信过程158.2.1消息方式的实时告警流水158.2.2文件方式的批量告警同步168.3消息数据188.3.1消息格式188.3.2登录与登录响应198.3.3消息方式同步告警请求与响应208.3.4文件方式同步告警请求与响应218.3.5心跳请求与响应228.3.6关闭连接通知228.3.7实时告警上报238.4文件数据238.5技术指标249操作指令接口2410接口日志2511接口可靠性要求2512编制历史25前 言本标准由中国移动通信集团公司网络部提出并归口。本标准起草单位：中国移动通信集团公司网络部。本标准主要起草人：刘立卫、刘云霞、李健、肖捷、陈丹、高建军、张凤桥。本标准解释单位：中国移动通信集团公司网络部。本标准由中国移动通信集团公司XXX号文发布。1 范围本规范给出了中国移动OMC系统北向接口的通用技术要求，适用于无线网、核心网、传输网和IP网四个专业，适用于新建OMC系统以及现网OMC系统改造。本规范适用于中国移动OMC系统北向接口的设计和实现，是中国移动OMC系统提供商必须遵循的指导性文件。本规范是中国移动各级运营单位进行OMC系统的招标采购、工程设计、网络运营、管理、维护、检查和验收等方面的技术依据。2 规范性引用文件下列文件中的条款通过本标准的引用而成为本标准的条款。凡注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。凡不注日期的引用文件，其最新版本适用于本标准。序号文档名称文档来源01OMC系统功能规范中国移动通信集团公司02OMC系统通用技术规范中国移动通信集团公司03OMC系统北向接口数据规范中国移动通信集团公司3 缩略语英文缩写英文全称中文解释OMCOperations &Maintenance Center操作维护中心NMSNetwork Management System网络管理系统NENet Element网元rmUIDResource Management Universal Identifier网络资源对象的全网唯一标识MTBFMean Time Between Failure平均故障间隔时间MTTRMean Time To Repair平均修复时间4 接口架构OMC北向接口是OMC系统与网络管理系统（NMS）间的接口，分为上行接口和下行接口。上行接口指从OMC到NMS的接口，下行接口指从NMS到OMC的接口。接口总体架构如下：接口说明：1、资源数据接口：数据量相对较小，周期性单向传送，数据时延要求较低。2、性能数据接口：数据量相对较大，周期性单向传送，数据时延要求一般。3、告警数据接口：单条信息数据量较小、总体数据量较大，要求数据实时传送。4、操作指令接口：网络设备的操作指令通道接口，为上层网管提供下行指令通道，并反馈操作指令返回结果，数据量相对较小，实时性要求较高。5 通用技术约定5.1 公共要求1、 时间同步OMC北向接口服务器必须采用当地标准时间，中国大陆地区采用UTC+8（北京标准时间）。接口服务器使用OMC系统的时间同步服务器或公共的时间同步服务器。2、 编码方式所有消息和文件的数据编码采用UTF-8（No BOM）编码方式。3、 数据时间格式如无特殊说明，时间类字段数据格式均为：“YYYY-MM-DD HH24:mm:ss”。5.2 FTP通用要求1、 服务端与客户端OMC提供可以获取资源、告警和性能数据的FTP server，NMS为 FTP client。OMC系统将数据文件放到FTP server上，NMS自行采集数据文件。2、 安全性要求通过授权的用户名、密码信息才能够访问FTP服务器。3、 目录规则目录结构：/FTP根目录/省简称/专业简称/厂家编码/OMC名称/数据类别/日期或时间/示例：资源目录：/ftproot/GD/WX/HW/GZ_OMC2/CM/20150611/性能目录：/ftproot/GD/WX/HW/GZ_OMC2/PM/2015061101/告警目录：/ftproot/GD/WX/HW/GZ_OMC2/FM/20150611/1） FTP根目录：OMC厂家自定义的ftp根目录。2） 省份简称、专业简称、厂家编码、数据类别：参见OMC北向接口数据规范-公共数据分册。3） 日期或时间：资源、告警数据按天存放，格式为YYYYMMDD；性能数据按小时存放，格式为YYYYMMDDHH24，小时数为性能数据统计起始时间。4、 文件命名规则1) 文件名字符：英文字母全部大写，不允许有中文字符。2) 文件命名规则：-网元子类-登录用户名-Ri-统计周期 -序列号.3) 网元类型：资源、性能数据为网元类型，如MME、ENB、PTN、PON等；告警数据为“OMC”。4) 网元子类：无线网、核心网的资源、性能数据的网元子类为资源数据、性能数据规范定义的空间粒度名称，如：EutranCellTDD、InventoryUnitRru、EthernetPort等；告警数据无此项。传输网的资源、性能数据的资源对象类名，填写资源对象简称，如：隧道（TNL）、标签交换（LBS）。资源对象简称参见OMC北向接口数据规范-XX资源数据分册或OMC北向接口数据规范-XX性能数据分册。IP网数据无此项，核心网的资源、性能数据该项可选。5) 主机编号：两位，每1位可用0-9、A-Z编码。6) 数据版本：遵循接口数据规范规范版本，允许同一目录下存放不同版本的数据文件。7) 数据时间：采用YYYYMMDDHH24MMSS格式，。资源、告警数据为数据文件开始生成时间，其中资源数据文件开始生成时间指0点或12点，；性能数据为统计周期的起始时间。8) 登录用户名：仅在告警文件同步时使用。用以解决多个NMS同时对同一个OMC发起告警文件同步请求，生成的同步文件名冲突的问题。9) Ri：可选。当接口数据文件内容有误（如数据缺失等）时，OMC重新生成文件提供给NMS进行数据补采，新文件在原文件名后增加”Ri”进行标识，i从1开始，每重新生成一次i加1。10) 统计周期：两位，取值范围为00-99，仅针对性能数据文件，统计周期的分钟数，如05、15、60。资源、告警数据文件无此项。11) 序列号：当文件总量小于100MB(允许上下浮动10%)时，应只形成一个文件；当文件总量大于100MB(允许上下浮动10%)时要求进行文件分割，即分割后的文件大小（除最后一个）均应介于（90MB,110MB）之间。分割后的文件增加序列号标识，序列号为三位，取值为001-999。在文件切分过程中，不能把资源、性能或告警的一条完整的记录切开放到两个文件中。12) 后缀：每个文件都进行压缩，统一采用zip或gzip压缩，压缩文件后缀是zip或gz。13) 文件名样例资源文件：CM-ENB-EUTRANCELLTDD-A1-V1.1.0-20151227000000-001.xml.zip性能文件：PM-ENB-EUTRANCELLTDD-01-V1.1.0-20151227000000-15-001.csv.zip告警文件：FM-OMC-1A-V1.1.0-20150611011603-001.txt.zip对于设备厂家北向接口上报的私有参数文件，在数据版本前增加ALL字样，其他字段要求保持不变。样例：性能文件：PM-ENB-EUTRANCELLTDD-01-ALLV1.1.0-20151227000000-15-001.csv.zip5、 文件生成过程标识文件生成过程中，文件名后缀增加“.tmp”标识，该文件全部生成完成后，去掉“.tmp”标识，以确保NMS获取到的北向数据文件是完整的。对于在数据规范中定义的一个单一接口文件，如果由于文件过大拆分或分布式处理，形成多个文件的，要求在该批次文件全部生成完成后，去掉“.tmp”标识。6 资源数据接口6.1 接口协议接口协议：采用SFTP或者FTP协议。数据周期：无线网、核心网、传输网和IP网四个专业每12小时生成一次，即每天0点和12点启动，基于OMC配置数据库中的数据信息生成一套最新的全量资源文件。智能家庭网关的终端管理平台的资源数据周期为每24小时生成一次，即每天0点启动，基于OMC配置数据库中的数据信息生成一套最新的全量资源文件。6.2 接口数据接口数据含公共信息和业务数据。业务数据字段参见相关数据规范。公共信息如下：No字段名称英文名称数据类型取值或说明1.数据生成时间TimeStamp时间开始生成数据文件的时间戳。2.时区TimeZone字符串时区信息，如：北京时间为“UTC+8”。3.生成这个网络资源模型文件的OMC的设备供应商VendorName字符串字符串，取值长度不大于64个字节，不限制字符类型。通过该属性取值应可明确识别厂商名称4.网元类型ElementType字符串如MME、ENB、PTN、PON5.资源数据版本CmVersion字符串资源数据版本6.网络资源对象的全网唯一标识rmUID字符串网络资源对象的全网唯一标识，具体定义请见OMC系统北向接口数据规范-公共数据分册V1.0.07.网元标识Dn字符串无线、核心网专业该字段必选，传输、IP专业无该字段8.用户友好名UserLabel字符串无线、核心网专业该字段必选，传输、IP专业无该字段9.网络资源类别名称ObjectType字符串该组网络资源模型归属的对象类，具体定义请见OMC北向接口数据规范-XX资源数据分册。如：EutranCellTDD、InventoryUnitRru、EthernetPort等。核心网专业该字段必选。6.3 数据格式资源数据文件采用XML格式。给定一个网元类型，有两种文件组织方式：（1）同一个空间粒度的资源数据在同一数据文件中；（2）对所有的空间粒度，启用一个CM文件存储其资源数据。核心网专业优选文件组织方案（2）。XML文件格式要求如下。1、标签说明标签名称要求说明dataFile必须数据文件fileHeader必须文件头FiledName必须网元对象的参数集合Object必须网元N必须网元对象参数集合中每个参数名称V有条件网元的参数取值，值的个数要与参数的个数相同2、xml标签属性属性名称解释要求类型和取值说明version版本必须字符串，取值为：1.0encoding字符集必须字符串，取值为：UTF-83、fileHeader标签属性属性名称解释要求类型和取值说明TimeStamp数据生成时间必选时间格式，YYYY-MM-DDTHH24:mm:ssTimeZone时区必选时区信息，如：北京时间为“UTC+8”。VendorName生成这个网络资源模型文件的OMC的设备供应商必选字符串，取值长度不大于64个字节，不限制字符类型。通过该属性取值应可明确识别厂商名称ElementType网元类型必选字符串，如MME、ENB、PTN、PONCmVersion资源数据版本必选字符串，资源数据版本4、object标签属性属性名称解释要求类型和取值说明rmUID网络资源对象的全网唯一标识必须字符串DnDistinguished Name，识别名无线、核心网专业该字段必选，传输、IP专业无该字段字符串UserLabel用户友好名无线、核心网专业该字段必选，传输、IP专业无该字段字符串5、v标签属性属性名称解释要求类型和取值说明i属性序列号必须整型，网元参数名和参数值相对应的序列号，从1开始编号对于传输专业（PTN、PON等），rmUID字段不重复写在v标签中（写在object标签中）。6、Xml数据文件Schema定义7、数据样例PTN资源文件样例： 2015-01-12T04:01:06UTC+8huaweiPTNV1.0.0 nativeName vendor equipmemtDomain MAS-U2000-1-P FH PTN MAS-U2000-2-P FH PTN 核心网专业资源文件样例：2016-04-18T05:00:04UTC+8ZTEMMEV1.3.0EthernetPortPortIdUserLabelPortRateAdministrativeStateOperationalStatePortLocationSignTransMediaMacAddressIpAddressList214_65535_12_1214_65535_12_11024000UNLOCKEDENABLED11-2-17-12-1OPTIC00.d0.d0.a1.09.0214_65535_25_1214_65535_25_11024000UNLOCKEDENABLED11-2-25-25-1ELECTIC00.d0.d0.a1.09.06.4 技术指标No指标名称指标含义指标值1.字段完整性接口必选字段个数/OMC系统内必选字段总个数*100%=100%接口B类字段个数/OMC系统内B类字段总个数*100%90%2.记录完整性接口记录数/OMC系统内记录数*100%99%3.数据时延全量资源文件生成时延=文件完成生成的时间-文件开始生成的时间（文件开始生成的时间，这里指0点或12点）1小时4.数据一致性性能数据、告警数据中资源对象的rmUID必须与资源数据的rmUID保持一致。数据一致的记录数量/总记录数量*100%99%5.数据存储时长资源接口数据文件保存时长7天6.并发连接数支持ftp客户端多连接的数量10个7 性能数据接口7.1 接口协议接口协议：采用SFTP或者FTP协议。数据周期：性能测量周期分为5分钟、15分钟、60分钟、24小时等。各专业各类设备性能测量周期的具体要求参见OMC北向接口数据规范-性能数据分册。7.2 接口数据接口数据含公共信息和业务数据。业务数据字段参见相关数据规范。公共信息如下：No字段名称英文名称数据类型要求取值或说明1.数据生成时间TimeStamp时间必选开始生成数据文件的时间戳。XML格式文件中，格式为YYYY-MM-DDTHH24:mm:ss；CSV格式文件中，格式为YYYY-MM-DD HH24:mm:ss2.时区TimeZone字符串必选时区信息，如：北京时间为“UTC+8”。3.统计周期Period数字必选测量统计周期的分钟数，如5、15、60等4.OMC设备供应商名VendorName字符串必选生成这个网络资源模型文件的OMC的设备供应商。必选5.网元类型ElementType字符串必选如MME、ENB、PTN、PON6.性能数据版本PmVersion字符串必选性能数据版本7.网络资源对象的全网唯一标识rmUID字符串必选网络资源对象的全网唯一标识，具体定义请见OMC系统北向接口数据规范-公共数据分册V1.0.08.网元标识Dn字符串必选无线、核心网专业该字段必选，传输、IP专业无该字段9.用户友好名UserLabel字符串必选UserLabel字段的转义要求：用双引号字符封闭UserLabel字段的值，对UserLabel中出现的双引号字符用一对双引号字符表示。例如，UserLabel为 北京|海淀，输出为北京|海淀，或者UserLabel 北京新建，输出为北京新建。无线、核心网专业该字段必选，传输、IP专业无该字段10.统计周期的起始时间startTime时间必选性能数据统计周期的起始时间。XML格式文件中，格式为YYYY-MM-DDTHH24:mm:ss；CSV格式文件中，格式为YYYY-MM-DD HH24:mm:ss11.网络资源类别名称ObjectType字符串条件必选该组网络资源模型归属的对象类，具体定义请见OMC北向接口数据规范-XX资源数据分册。如：EutranCellTDD、InventoryUnitRru、EthernetPort等。核心网专业该字段必选。7.3 数据格式无线、传输、IP专业OMC性能测量文件必须采用CSV格式（竖线分隔）。要求无线专业同一个空间粒度的测量项必须在同一PM文件中。核心网OMC性能测量文件优先采用CSV格式（竖线分隔），可以采用XML格式。给定一个网元类型，有两种文件组织方式：（1）要求同一个空间粒度的测量项在同一数据文件中；（2）对所有的空间粒度的测量项，启用一个PM文件存储其测量结果数据。核心网专业优选文件组织方案（2）。CSV格式（竖线分隔）要求：1、第一行数据是公共信息。2、第二行数据是字段名称信息，每个字段用ASCII字符竖线“|”进行分隔。3、第三行开始是具体数据，每条记录一行，每个数据项用ASCII字符竖线“|”分隔。4、在每行的行尾不加分隔符“|”数据样例（普通测量）：TimeStamp=2015-06-11 05:08:00|TimeZone=UTC+8|Period=15|VendorName=ZTE|ElementType=ENB|PmVersion=V2.6.0rmUID|Dn|UserLabel|startTime|ConnEstabAtt|ConnEstabSucc1301HWWX2CELA12ZA1|ZTE-CMZJ-TZ,SubNetwork=ltetdd18,ManagedElement=ENODEBME747785,EnbFunction=747785,EutranCellTdd=1|589832|2015-06-11 05:00:00|18|171301HWWX2CELA12Z45|ZTE-CMZJ-TZ,SubNetwork=ltetdd18,ManagedElement=ENODEBME747785,EnbFunction=747785,EutranCellTdd=2|589833|2015-06-11 05:00:00|259|258如果业务字段值为空，如VendorName值为空，则VendorName字段及值在CSV文件中为空，即TimeStamp=2015-06-11 05:08:00|TimeZone=UTC+8|Period=15|ElementType=ENB|PmVersion=V2.6.0性能数据指标命名依据OMC北向接口数据规范-性能数据分册，文件划分也参照该规范，具体要求如下;1) 同一个空间粒度的普通测量项存储在一个数据文件中；2) 如果该空间粒度还含有一系列的伪子测量项（在性能数据分册中包含“._”的子测量项，如._Cause），有两种解决方案：方案一：该空间粒度的每类伪子测量单独存储一个文件。文件的命名在文件名规则的“网元子类”部分增加伪子测量的标识，-网元子类_子测量类型-登录用户名-Ri-统计周期-.如PM-ENB-EUTRANCELLTDD_CAUSE-01-V1.1.0-20151227000000-15-001.csv.zip; 该文件列除资源对象标识和时间外，包括伪子测量的标识（._后面的部分）和所有该类型伪子测量指标。具体见样例“数据样例（伪子测量）”。数据样例（伪子测量）：TimeStamp=2015-06-11 05:08:00|TimeZone=UTC+8|Period=15|VendorName=ZTE|ElementType=ENB|PmVersion=V2.6.0rmUID|Dn|UserLabel|startTime|Cause|RRC.AttConnEstab._Cause|RRC.SuccConnEstab._Cause|RRC.SuccConnReestab._Cause1301HWWX2CELA12ZA1|ZTE-CMZJ-TZ,SubNetwork=ltetdd18,ManagedElement=ENODEBME747785,EnbFunction=747785,EutranCellTdd=1|589832|2015-06-11 10:00:00|12345|2|2|2其中Cause就是伪子测量类型标识，后面都是带有._Cause的指标名。因为不同Cause指标的统计对象可能不同，所以可能存在某些指标列为空的情况，比如：1301HWWX2CELA12ZA1|ENODEB1|2015-06-11 10:00:00|12345|1|2方案二：空间粒度的每类伪子测量项和普通测量项在同一个文件中上报。文件命名规则参见5.2章节，样例：PM-ENB-EUTRANCELLTDD-01-V1.1.0-20151227000000-15-001.csv.zip。目前，TD-LTE eNB统计数据规范中有3类伪子测量，测量命名规则及扩展方法分别为： 1）._Qci对应子测量项，命名为“19数字，并可递加扩展，如ENBHB01每QCI平均E-RAB数子项的名称为ERAB.NbrMeanEstab.1ERAB.NbrMeanEstab.9；因此，._Qci对应子测量项可以全部展开成 测量名称.1测量名称.9，数量固定。 2）._Cause对应子测量项，命名为英文字母开头的字符串（仅由大小写字母、数字和“_”组成），例如为3GPP或厂家私有原因英文字符串缩写（不含空格）；._Cause可以全部展开成 测量名称.字符串。但对于不同测量的._Cause，其原因数量是不同的，并且在不同厂家间，数量也是不同的。3）._PRB对应子测量项，命名为英文字母或数字开头的字符串（仅由大小写字母、数字和“_”组成）；._PRB，可以全部展开成 测量名称.0测量名称.99，数量固定。数据样例（伪子测量）：TimeStamp=2016-06-16 10:54:56|TimeZone=UTC+8|Period=15|VendorName=Huawei|ElementType=ENB|PmVersion=V2.6.0rmUID|Dn|UserLabel|startTime|CONTEXT.AttInitalSetup|CONTEXT.AttInitalSetup.Csfb|CONTEXT.AttMod|CONTEXT.