DA北向接口软件技术手册V3.10完整版.doc

北向接口北向接口 软件技术手册软件技术手册 UniView DA V1 00 800800 810810 92929292 目目 录录 软件技术手册软件技术手册 1 UNIVIEW DA 1 1 概述概述 1 2 功能说明和使用方法功能说明和使用方法 1 2 1 开发工具 1 2 2 初始化客户端连接 1 2 2 1 注册命名服务 1 2 2 2 注册通知服务 1 2 3 获取命名服务对象 1 2 4 获取 EMSSESSIONFACTORY会话 2 2 5 注册并得到 EMSSESSION会话 2 2 6 获取 EMS 版本信息 2 2 7 获得事件通道 3 2 8 告警管理 3 2 8 1 告警信息定义 3 2 8 2 objectName说明 4 2 8 3 获取EMS上所有当前告警信息 7 2 8 4 获取EMS上指定网元 指定网元的IP地址信息 的所 有当前告警信息 7 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直 接向格林威尔科技发展有限公司查询 1 1 概述概述 为使由 UniView DA 网管平台所管理维护的设备能与上层网管进行交互 通信 我司提供北向接口软件 上层网管开发人员可依据该手册对北向接口 软件进行二次开发 以达到将设备纳入到综合网管平台进行统一管理的目的 该北向接口软件采用可靠 高效 已成为业内流行趋势的CORBA通信协议 并参照814规范 814规范 即为 Multi Technology Network Management Solution Set Document NML EML Interface Version 2 1 TMF 814 2002 以保证接口的通用性 规范性 保证管理系统与被管系统的 互连互通 北向接口软件支持与多个上层网管系统并行交互的能力 下面详细说明北向接口软件支持的功能及使用方法 2 2 功能说明和使用方法功能说明和使用方法 2 12 1 开发工具开发工具 CORBA 客户端开发工具为 JacORB2 2 2 2 22 2 初始化客户端连接初始化客户端连接 2 2 1 注册命名服务 根据EMS名字 IP地址 创建命名上下文 然后将此命名上下文绑定在 所有命名服务器上的命名服务上 实现对其名字的注册 2 2 2 注册通知服务 完成对命名服务的注册 然后创建通道并进行对通知通道的注册 2 32 3 获取命名服务对象获取命名服务对象 该软件中命名上下文定义如下 TMF MTNM GWTT Uniview DA 1 1 属性为UniView DA网管的安装IP地址 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直接向格林威尔科技发展有限公司查询 命名树结构如下图 2 42 4 获取获取 EMSSessionFactoryEMSSessionFactory 会话会话 通过窄化编译 emsSessionFactory idl 得到的 EmsSessionFactory IHelper java 的 narrow 方法得到 EMSSessionFactory 2 52 5 注册并得到注册并得到 EMSSessionEMSSession 会话会话 实现 IDL 中方法为 IDL emsSessionFactory idl Interface emsSessionFactory EmsSessionFactory I 方法 void getEmsSession in string user in string password in nmsSession NmsSession I client out emsSession EmsSession I emsSessionInterface raises globaldefs ProcessingFailureException 2 62 6 获取获取 EMSEMS 版本信息版本信息 实现 IDL 中方法为 IDL emsMgr idl Interface emsMgr EMSMgr I 方法 void getEMS out EMS T emsInfo raises globaldefs ProcessingFailureException 2 72 7 获得事件通道获得事件通道 实现 IDL 中方法为 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直 接向格林威尔科技发展有限公司查询 IDL emsSession idl Interface emsSession EmsSession I 方法 void getEventChannel out CosNotifyChannelAdmin EventChannel eventChannel raises globaldefs ProcessingFailureException 2 82 8 告警管理告警管理 2 8 1 告警信息定义 属性名类型设备是否支持 notificationId string是 objectName globaldefs NamingAttr ibutes T 是 具体定义见下节 nativeEMSName string是 nativeProbableCause string是 objectType notifications ObjectTy pe T 是 emsTime globaldefs Time T是 neTime globaldefs Time T不支持 isClearable boolean是 C120 设备上报 值恒为 true layerRate transmissionParameters LayerRate T 不支持 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直接向格林威尔科技发展有限公司查询 probableCause string支持 此项值同 nativeProbableCause probableCauseQualifi er string不支持 perceivedSeverity notifications Perceived Severity T 支持 C120H 设备不支 持 serviceAffecting notifications ServiceAf fecting T 不支持 affectedTPList globaldefs NamingAttr ibutesList T 不支持 additionalText string支持 告警源名称 additionalInfo globaldefs NVSList T支持 表 2 1 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直 接向格林威尔科技发展有限公司查询 2 8 2 objectName说明 2 8 2 1 1 网元级 NameDiscription EMS EMS 名称 managedElement 值为网元名称或网元 IP 地址 例如 网元 MSTP1 223 注意 C120H 设备的网元名称取值与 UniView SE 界面对象树中的节点名称 一一对应 其组成规则为 根节点 一级子节点 二级 子节点 三级子节点 如 上海电信网管 逸仙 C120H 网 管系统 逸仙东 2 8 2 1 2 板卡级 NameDiscription EMS EMS 名称 managedElement 值为网元名称或网元 IP 地址 例如 网元 MSTP1 223 EquipmentHolder 板卡名称 拼写规则 框号 1 槽位 n 例如 框号 1 槽位 9 2 8 2 1 2 端口级 Name Discription EMS EMS 名称 managedElement 值为网元名称或网元 IP 地址 例如 网元 MSTP1 223 注意 C120H 设备的网元名称取值与 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直接向格林威尔科技发展有限公司查询 UniView SE 界面对象树中的节点名称 一一对应 其组成规则为 根节点 一级子节点 二级 子节点 三级子节点 如 上海电信网管 逸仙 C120H 网 管系统 逸仙东 PTP 端口名称 可定位到唯一的端口 命名规则 框号 1 槽位 n 端口 类型 端口类型名称 端口号 m 例如 框号 1 槽位 3 端口类型 STM 1 物理光端口 端口号 1 端口级告警中 C120H 告警对象只包 括两种 光口和 E1 命名规则如下 光口告警 板卡 n 光口 m 本 对端 例如 板卡 9 光口 1 本端 E1 告警 板卡 n 光口 m E1 k 本 对 端 例如 板卡 9 光口 1 E1 k2 本端 表 2 2 2 8 2 1 2 CTP NameDiscription EMS EMS 名称 managedElement 值为网元名称或网元 IP 地址 例如 网元 MSTP1 223 PTP 端口名称 可定位到唯一的端口 命名规则 框号 1 槽位 n 端口 类型 端口类型名称 端口号 m 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直 接向格林威尔科技发展有限公司查询 例如 框号 1 槽位 3 端口类型 STM 1 物理光端口 端口号 1 CTP 时隙名称 可定位到唯一的时隙 例如 sts3c au4 1 vt2 tu12 k 3 l 3 m 7 表 2 2 注意 C120H 设备无此级别告警 2 8 3 告警级别定义 请参照相应的设备告警级别定义文件 2 8 4 获取 EMS 上所有当前告警信息 实现 IDL 中方法为 IDL emsMgr idl Interface emsMgr EMSMgr I 方法 void getAllEMSAndMEActiveAlarms in notifications ProbableCauseList T excludeProbCauseList in notifications PerceivedSeverityList T excludeSeverityList in unsigned long how many out notifications EventList T eventList out notifications EventIterator I eventIt raises globaldefs ProcessingFailureException 2 8 5 获取 EMS 上指定网元 指定网元的 IP 地址信息 的所有当前告警信息 实现 IDL 中方法为 IDL managedElementManager idl Interface managedElementManager ManagedElementMgr I 方法 void getAllActiveAlarms in globaldefs NamingAttributes T meName in notifications ProbableCauseList T excludeProbCauseList in notifications PerceivedSeverityList T excludeSeverityList in unsigned long how many 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直接向格林威尔科技发展有限公司查询 out notifications EventList T eventList out notifications EventIterator I eventIt raises globaldefs ProcessingFailureException 2 8 6 获取实时告警 实现 IDL 中方法为 IDL CosNotifyComm idl Interface StructuredPushConsumerStructuredPushConsumer NotifyPublish 方法 void push structured eventpush structured event in CosNotification StructuredEvent notification raises CosEventComm Disconnected 2 92 9 设备资源管理设备资源管理 2 9 1 获取所有网元信息 实现 IDL 中方法为 IDL managedElementManager idl Interface managedElementManager ManagedElementMgr I 方法 void getAllManagedElementsgetAllManagedElements in unsigned long how many out managedElement ManagedElementList T meList out managedElement ManagedElementIterator I meIt raises globaldefs ProcessingFailureException 2 9 2 网元信息定义 属性名类型设备是否支持 nameglobaldefs NamingAt tributes T 是 userLabelString 是 nativeEMSNameString 是 OwnerString 否 LocationString 否 VersionString 否 productNameString 是 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直 接向格林威尔科技发展有限公司查询 communicationStateCommunicationState T 否 emsInSyncStateBoolean 否 supportedRatestransmissionParamete rs LayerRateList T 否 additionalInfoglobaldefs NVSList T 否 2 9 3 获取所有端口信息 实现 IDL 中方法为 IDL managedElementManager idl Interface managedElementManager ManagedElementMgr I 方法 void getAllPTPsgetAllPTPs in globaldefs NamingAttributes T managedElementName in transmissionParameters LayerRateList T tpLayerRateList in transmissionParameters LayerRateList T connectionLayerRateList in unsigned long how many out terminationPoint TerminationPointList T tpList out terminationPoint TerminationPointIterator I tpIt raises globaldefs ProcessingFailureException 2 9 4 端口信息定义 属性名类型设备是否支持 nameglobaldefs NamingAt tributes T 是 userLabelString 是 nativeEMSNameString 是 OwnerString 否 ingressTrafficDescriglobaldefs NamingAt 否 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直接向格林威尔科技发展有限公司查询 ptorNametributes T egressTrafficDescrip torName globaldefs NamingAt tributes T 否 TypeTPType T 是 connectionStateTPConnectionState T 否 tpMappingModeTerminationMode T 是 DirectionDirectionality T 是 transmissionParamstransmissionParamete rs LayeredParameter List T 否 tpProtectionAssociat ion TPProtectionAssociat ion T 是 edgePointBoolean 是 additionalInfoglobaldefs NVSList T 是 目前对于 E6300 E6100 设备 additionalInfo 里面用名值对上报端口的屏 蔽 环回状态 具体格式是 第一组数据为端口名称 第二组为屏蔽状态 第三组为环回状态 第四组为类型 环回状态值 不环回 值 0 系统侧环回 值 2 线路侧环回 值 1 环回 值 4 这里值针对的是本端 V35 板卡和远端 V35 板卡 在网 管上显示的为 环回 实际所做的操作是双向侧环回 不使用 值为 238 数据库有本字段 但目前没用 无效 值为 No Data 数据库根本 没有本字段 告警状态值 不使能 值为 2 即告警屏蔽 使能 值为 1 即告警不屏蔽 其它值暂时不做定义 另外有的端口根本没有这些信息 如 E1 离线测试端口 远端电源管理端口等 是因为我们网管本身就没有实现端口告警屏蔽 环回 2 9 5 获取所有拓扑连接信息 实现 IDL 中方法为 IDL emsMgr idl Interface emsMgr EMSMgr I 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直 接向格林威尔科技发展有限公司查询 方法 void getAllTopLevelTopologicalLinksgetAllTopLevelTopologicalLinks in unsigned long how many out topologicalLink TopologicalLinkList T topoList out topologicalLink TopologicalLinkIterator I topoIt raises globaldefs ProcessingFailureException 2 9 6 获取所有槽位 板卡信息 实现 IDL 中方法为 IDL emsMgr idl Interface equipment EquipmentInventoryMgr I 方法 void getAllEquipmentgetAllEquipment in globaldefs NamingAttributes T meOrHolderName in unsigned long how many out EquipmentOrHolderList T eqList out EquipmentOrHolderIterator I eqIt raises globaldefs ProcessingFailureException 2 9 7 板卡信息定义 属性名类型设备是否支持 nameglobaldefs NamingAt tributes T 是 userLabelString 是 nativeEMSNameString 是 OwnerString 否 alarmReportingIndica tor Boolean 是 serviceStateServiceState T 是 expectedEquipmentObj ectType EquipmentObjectType T 是 installedEquipmentObEquipmentObjectType 是 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直接向格林威尔科技发展有限公司查询 jectTypeT installedPartNumberString 否 installedVersionString 否 installedSerialNumbe r String 否 additionalInfoglobaldefs NVSList T 否 2 9 8 槽位信息定义 属性名类型设备是否支持 nameglobaldefs NamingAt tributes T 是 userLabelString 是 nativeEMSNameString 是 OwnerString 否 alarmReportingIndica tor Boolean 是 holderTypeEquipmentHolderType T 是 expectedOrInstalledE quipment globaldefs NamingAt tributes T 否 acceptableEquipmentT ypeList EquipmentObjectTypeL ist T 否 holderStateHolderState T 是 installedVersionString 否 additionalInfoglobaldefs NVSList T 否 2 102 10 性能管理性能管理 2 10 1 获取当前性能数据 目前支持的设备是 E6300 注意 主控盘下的 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直 接向格林威尔科技发展有限公司查询 端口不支持取性能数据 另外有的端口也不支持 包括 E1 端口 laerRate 5 ES SES UAS BBE 这几个性能类型的数据只有 STM 1 物 理光 电端口支持 端口的告警监视状态必须为 使能 实现 IDL 中方法为 IDL performance idl Interface performance PMDataIterator I 方法 void getAllCurrentPMDatagetAllCurrentPMData in PMTPSelectList T pmTPSelectList in PMParameterNameList T pmParameters in unsigned long how many out PMDataList T pmDataList out PMDataIterator I pmIt raises globaldefs ProcessingFailureException 参数说明 pmTPSelectList struct PMTPSelect TPMTPSelect T globaldefs NamingAttributes T name transmissionParameters LayerRateList T layerRateList PMLocationList T pMLocationList GranularityList T granularityList 几个参数都按照标准定义填写 Name 填端口信息 layerRateList 填速率信 息 15 或 11 pMLocationList 随便填 granularityList 填粒度 15min 或 24h pmParameters String pmParameters ES SES UAS BBE OPR OPT 返回值也按照标准上报 不支持 pmLocation unit intervalStatus 其他返 回都支持 另外 OPR OPT 因为设备不支持 所以没有相应数据 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直接向格林威尔科技发展有限公司查询 2 112 11 维护操作管理维护操作管理 2 11 1 告警屏蔽 解屏蔽 端口环回 取消环回 目前支持的设备是 E6300 实现 IDL 中方法为 IDL maintenanceOps idl Interface MaintenanceMgr I common Common I 方法 void performMaintenanceOperation in CurrentMaintenanceOperation T maintenanceOperation in MaintenanceOperationMode T maintenanceOperationMode raises globaldefs ProcessingFailureException 参数说明 maintenanceOperation struct CurrentMaintenanceOperation T globaldefs NamingAttributes T tpName MaintenanceOperation T maintenanceOperation transmissionParameters LayerRate T layerRate globaldefs NVSList T additionalInfo 其中 tpName 目前应该是端口对应的 NamingAttributes T maintenanceOperation 填操作名称 814 标准里定义 的名称不够用 经过了扩展 具体操作名称包括 ALARM MASK 告警屏蔽 FACILITY LOOPBACK 系统侧环回 TERMINAL LOOPBACK 线路侧环回 LOOPBACK CLEAR 取消环回 本操作名称要和 maintenanceOperationMode 结 合使用 确定是进行还是取消操作 下面会有详细的解释 LayerRate T 由 于 E6300 设备我公司有大量私有端口 所以标准定义也被扩展 它对应的就 是资源信息里的端口信息里的 transmissionParams 详细字典值是 5 代表 E1 46 代表电口 47 代表光口 61 代表以太口 这些是标 准里定义的 公司自定义端口说明如下 对于 E6300 设备 从 2007 12 3 起 本属性不能上报 0 如果上报 0 说明下面的字典定义需要更 新 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直 接向格林威尔科技发展有限公司查询 public static final short LR GW E6300 E2OpticalPort 1102 E2 物理光端口 public static final short LR GW E6300 E2 E1Port 1103 E2 物理端口中复用的 E1 public static final short LR GW E6300 RemoteE2OpticalPort 1104 E2 远端物理光端口 public static final short LR GW E6300 RemoteE1Port 1105 E1 远端物理电端口 public static final short LR GW E6300 E1OutLineTestPort 1106 E1 离线测试端口 public static final short LR GW E6300 E3OpticalPort 1107 E3 物理光端口 public static final short LR GW E6300 RemoteE3OpticalPort 1108 E3 远端物理光端口 public static final short LR GW E6300 E3 E1Port 1109 E3 物理端口中复用的 E1 public static final short LR GW E6300 EEOpticalPort 1110 EE 物理光端口 public static final short LR GW E6300 RemoteEEOpticalPort 1111 EE 远端物理光端口 public static final short LR GW E6300 EE E1Port 1112 EE 物理端口中复用的 E1 public static final short LR GW E6300 STM1Port 1201 STM 1 物理光端口 public static final short LR GW E6300 STM4OpticalPort 1202 STM 4 物理光端口 public static final short LR GW E6300 STM1ElectricPort 1203 STM 1 物理电端口 public static final short LR GW E6300 DxcPort 1301 交叉连接矩阵交叉端口 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直接向格林威尔科技发展有限公司查询 public static final short LR GW E6300 TU12OutLineTestModel 1302 TU12 离线测试发 生器 public static final short LR GW E6300 EthernetServicePort 1401 以太网业务电端口 public static final short LR GW E6300 V35Port 1402 V35 数据端口 public static final short LR GW E6300 EthernetServiceOpticalPort 1403 以太网业务 光端口 public static final short LR GW E6300 RemoteEthernetServicePort 1404 远端以太网 业务电端口 public static final short LR GW E6300 RemoteV35Port 1405 远端 V 35 数据端口 public static final short LR GW E6300 RemoteEthernetServiceOpticalPort 1406 远端 以太网业务光端口 public static final short LR GW E6300 EthernetOutLineTestPort 1407 以太网离线测 试端口 public static final short LR GW E6300 RemoteETRMAdapterOpticalPort 1409 远端 ETRM 适配器光端口 public static final short LR GW E6300 ETRMEthernetPort 1410 ETRM 以太网电端口 public static final short LR GW E6300 EthernetPort 1411 以太网电端口 public static final short LR GW E6300 EthernetEEOpticalPort 1412 EE 以太网光端口 本产品及用户手册将随时升级或更新 恕不另行通知 最新信息请登陆格林威尔公司网站或直 接向格林威尔科技发展有限公司查询