软件需求规格说明书.docx

1、软件需求规格说明书【xxxxxxxx】软件需求规格说明书文档修订记录版本号修订日期修订人修订说明修订状态审核日期审核人批准人V0.1V1.0V1.1修订状态：A-增加，M-修改，D-删除日期格式：YYYY-MM-DD1. 前言 11.1. 目的 11.2. 背景 11.3. 术语与缩写解释 11.4. 预期读者与阅读建议 11.5. 参考资料 11.6. 需求描述约定 12. 项目概貌 22.1. 系统范围 22.2. 系统功能 22.3. 用户的特点 32.4. 运行环境要求 32.5. 设计和实现上的限制 33. 非功能需求 43.1. 系统性能要求 43.2. 系统界面要求 43.3.

2、系统安全及保密要求 43.4. 系统备份与恢复要求 43.5. 系统日志 54. 外部接口说明 55. 其他需求 66. 功能需求的详述 66.1. IDC管理 66.2. BAS地址池下发 66.3. BAS运行状态监控 66.3.1 需求详细描述 66.3.2 内部接口 86.4. BAS应急预案 86.4.1 需求详细描述 86.4.2 内部接口 96.5. 配置下发优化 96.5.1 需求详细描述 96.5.2 内部接口 106.6. 机历卡优化 106.6.1 需求详细描述 106.6.2 内部接口 116.7. 告警转发改进 116.7.1 需求详细描述 116.7.2 内部接口

3、136.8. 设备一键诊断 136.8.1 需求详细描述 136.8.2 内部接口 156.9. 开通工单告警 156.9.1 需求详细描述 156.9.2 内部接口 156.10. 工程信息导入 156.10.1 需求详细描述 156.10.2 内部接口 166.11. 巡检资源组管理 166.11.1 需求详细描述 166.11.2 内部接口 176.12. 巡检配置 176.12.1 需求详细描述 176.12.2 内部接口 186.13. 网络流量优化报表 186.13.1 需求详细描述 186.13.2 内部接口 196.14. 故障统计优化 196.14.1 需求详细描述 196.

4、14.2 内部接口 207. 附件：bas监控指标采集办法 207.1. 设备上行口运行情况监控 207.2. 检查bgp状态 217.3. 检查radius状态 227.4. 和上一周期对比用户数 247.5. ip地址池利用率情况检查 251. 前言1.1. 目的通过本文档定义的需求，以求在项目组员与相关干系人之间达成一致的需求描述。1.2. 背景xxxxxx系统已能实现对IP城域网中骨干设备及接入层设备的控制和管理。但是，随着xxx网的发展以及中国电信集团对网管建设要求的变化，仍有许多功能需要完善和扩展，因此xxxx的扩容势在必行。本项目为之前五期工程的延续，针对xxxx用户运维工作的最

5、新需求，完善xxxxxx系统xxxxx软件的功能。本期工程的任务提出者为中国xxxxx的网络运维部门，系统开发者为xxxx公司；本期软件系统的管理范围将扩展对IDC机房资源的支持，同时系统用户也将增加IDC机房有关管理和维护人员；本期项目新增对IDC设备的管理接口，同时需要获取CRM中IDC大客户基本信息和SLA协议的接口能力；对所有星级IDC机房的客户信息、资源信息和业务信息进行同步；对于区级IDC业务网管系统检测到的重大故障，要求在向综合告警系统申告的同时，需同步向集团级IDC综合网管系统进行告警1.3. 术语与缩写解释缩写、术语解 释?IDC?互联网数据中心?BAS?宽带接入服务器1.4

6、. 预期读者与阅读建议预期读者阅读建议项目经理仔细阅读全部内容。参加需求评审的人员仔细阅读全部内容。系统设计人员仔细阅读全部内容。系统测试人员仔细阅读文档约定，系统功能介绍和维度指标说明。 1.5. 参考资料xxxxxxxx-需求开发-用户需求规格说明书1.6. 需求描述约定）本系统的需求标识方法：进度跟踪系统自动生成的流水号。）本系统的需求跟踪粒度：跟踪到第二层功能需求。）本文档的需求级别定义： 本文档统一规定对需求层次为二级以上（功能模块、主功能点）的定义优先级，三层需求依据二层需求的优先级执行。 本文档的优先级别分为：高、中、低）功能描述方法：本文档从以下几个方面对功能需求进行描述：a.

7、 业务定义/描述。b. 适用的用户类型c. 业务规则/业务要素。d. 输入：提供所有与本功能有关的输入描述，包括：输入数据类型、媒体、格式、数值范围、精度、单位等。e. 输出：提供与本功能有关所有输出的描述，包括：输出数据类型、方式、格式、精度、单位等，以及图形或显示报告的描述。f. 业务操作流程g. 描述正常业务流程，列举异常情况和处理流程。建议使用UML图示，并配合必要的文字说明h. 约束条件/特殊考虑）界面描述规则界面描述可使用VISIO的界面模型进行描述。2. 项目概貌2.1. 系统范围 本系统要开发的主要功能包括：1. xxxxx2. xxxx管理功能优化具体功能下文详述。2.2.

8、系统功能本期项目功能重点为xxxxxx网管理优化，具体功能分类见下表：需求编号功能分类功能说明优先级13023-01IDC网管根据xxxxx系统规范）xxxx将建设集中的IDC综合网管平台对各地IDC进行统一、集中的网络管理以及支撑高13023-02BAS地址池下发在网管系统内统一维护BRAS地址池资源，具备地址池导入、现网已分配地址池的发现，实现对地址池使用情况的监控，动态生成配置工单，经维护人员确认后，通过网管系统自动进行配置下发，完成地址池的自动可控配置，简化配置操作，避免因地址紧张造成用户故障高13023-03BAS运行状态监控按指定地区对BRAS设备的认证相关情况进行分析和统计，统计

9、结果以矩阵形式显示高13023-04BAS应急预案能够选择某节点下的所有bas批量下发事先编写好的配置脚本，每台设备的脚本都可能不一样，由用户提供中13023-05配置下发优化对于下发失败的设备配置，可以在页面上直接选择再次下发低13023-06机历卡优化机历卡需要能够录入设备发生过的故障及处理情况；对于硬件、IOS变化情况可以编辑备注，录入变更原因等；能够批量修改IOS升级原因，能否利用批量导出修改后导入低13023-07告警转发改进能够灵活配置设备转发标签，粒度到具体设备高13023-08设备一键诊断对于汇聚层以上设备（CR、BAS、SR），在网管上增加一键采集并显示最近24小时运行情况和

10、指标的功能；在设备诊断功能中提供“设备历史档案查看”的功能链接，便于维护人员检查设备硬件、软件版本的变更历史中13023-09开通工单告警根据日常工程问题的积累，对于卡单情况的监控，能结合以下几种单子的数量进行告警：1、待部署工单数量（接口侧问题）2、错误类型为“引擎调用失败”（引擎侧问题）3、错误类型为“操作超时，系统直接设置为失败”（引擎侧问题）中13023-10工程信息导入在新增工程信息页面，按照所选的工程类型，提供excel导入工程操作资源功能，不同工程类型导入模板应该是不一样的，比如选“设备割接”，要导入的是设备信息；选择“板卡割接”时，要导入的是板卡信息；选择“端口割接”时，到导入

11、的是端口割接等等低13023-11巡检资源组管理定义巡检计划时，选中的资源组可以排列顺序，并保存。巡检结果呈现时，需按此排序显示下拉框和巡检结果。包括：资源状态监视矩阵页面的下拉框和结果列表；历史巡检矩阵的下拉框和结果列表；巡检计划执行情况页面的下拉框中13023-12巡检配置1 检查任务配置页面增加一列信息，该列信息为配置内容的标准信息。 2 检查结果查询页面，查询结果显示第1点增加的列信息， 3.按照用户提供的样例页面修改有关字段的显示名称中13023-13网络优化报表改进按指定地区对BRAS设备的认证相关情况进行分析和统计，统计结果以矩阵形式显示高13023-14故障统计优化按照用户要求

12、提供增强的告警统计功能，帮助用户实现有关考核功能中2.3. 用户的特点系统管理员：具备全部系统功能，负责创建一般使用者的账号并对其进行授权。一般使用者：具备授权给自己的系统功能。2.4. 运行环境要求硬件：DELL PC Server操作系统：Redhat Linux数据库：Oracle Java应用服务器软件：Resin3.02.5. 设计和实现上的限制无。3. 非功能需求3.1. 系统性能要求并发用户:系统支持至少200个并发用户登录系统。页面、报表性能:配置数据查询页面（并发条件下），时延小于5s，时序数据查询（并发条件下）：1000万条记录，返回50条数据，时延小于10s。系统可靠性除

13、主机故障、系统升级外，可7x24小时稳定、持续运行。3.2. 系统界面要求屏幕格式、报表格式、菜单格式、界面布局等符合研发开发规范，保证界面友好、易用、用户视觉效果良好。 3.3. 系统安全及保密要求设备的访问口令在系统主机及数据库不能以明文存放。系统的登录口令，设备口令等要进行加密存储。3.4. 系统备份与恢复要求系统沿用前期项目的备份及恢复方案，本期不做修改。3.5. 系统日志系统应能提供完备的日志管理功能，包括登录日志等的查询、统计和维护功能，查询到的日志能够输出到文件中进行保存。4. 外部接口说明 设备性能采集接口Bas设备运行状态监控的所有指标通过snmp或CLI方式进行采集，所需的

14、设备mib和参考命令手册已经提供。接口为定时同步调用，采集周期最少5分钟；设备一键诊断功能，需要通过snnmp或CLI方式采集诊断需要的各种性能指标，接口需支持即时同步调用方式； 告警转发接口对方系统为综合告警系统，接口类型目前采用syslog方式，前期工程已将完成此接口，主要是按照配置将指定设备的指定类型告警以约定syslog格式转发给对方系统。本系统接受网络设备的syslog告警，并将符合转发条件的告警转发至综合告警系统。系统接口通过专用接口实现通信，安全性很高。本期工程只是修改转发告警条件的配置方法，并不影响告警转发接口的功能和格式。此接口为即时同步调用接口 设备配置下发接口开通及配置下

15、发类需求，需要被管理设备提供登录设备执行配置命令的接口，即CLI管理模式，目前系统已经具备，个别型号设备需要校验此接口为即时同步调用接口5. 其他需求无。6. 功能需求的详述6.1. xxxx管理复用，参照xxxxx版本中的IDC管理模块6.2. BAS地址池下发复用，参照xxxxx版本中的地址池管理模块6.3. BAS运行状态监控6.3.1 需求详细描述该需求的用例图如下：由单独菜单触发，“BAS运行状态监视”：监控页面能够定时刷新，暂定3分钟，包括三个tab页面： BAS设备运行状态（默认）地市设备名称设备IP上行口状态上行口零流量上行口利用率超90%BGP邻居非Established状态

16、Radius状态用户数对比xxaa1234状态异常的端口数，点击看详细上行口流量为0的端口数上行口利用率超90%的端口数非Established状态的邻居数状态为down的数量与上一周期相比用户数下降高于1000的设备则用红色显示下降用户数ddxxccee上行端口状态异常指物理down；与上一周期用户数对比需要分别显示pppoe和nat-pppoe域的； BAS地址池监控地市设备名称设备IPPPPoE地址池利用率（监控pppoe的域名）NAT-PPPoE地址池利用率（监控nat-pppoe的域名）ITMS地址池利用率（监控itms的域名）空闲在用总量利用率峰值峰值利用率空闲在用总量利用率峰值峰

17、值利用率空闲在用总量利用率峰值峰值利用率南宁aadd桂林ccee地市设备名称设备IP数字校园地址池利用率（监控campus开头的认证域的域名）认证域名字空闲在用总量利用率峰值峰值利用率xxaa111domain1domain2ddxxccee监控pppoe、nat-pppoe、itms和campus地址池占用情况，峰值取过去24小时的最大值；系统可以按指定地区对BRAS设备运行情况进行监控，监控结果以矩阵形式显示，详细内容可以参照上表结构； 系统支持Telnet或SNMP采集方式获取监控指标；采集频度可以修改。支持以地市为粒度，分别显示该地市所属BRAS设备及管理IP地址；对于多值指标，按“最

18、小/最大”方式显示；超阀值的用红色显示监控指标的采集办法见7.附件6.3.2 内部接口监控页面与后台性能采集与分析通过数据库共享BAS性能指标数据。6.4. BAS应急预案6.4.1 需求详细描述该需求的用例图如下：由单独菜单触发，“BAS应急脚本下发”：节点根据用户节点权限选择；设备名称和地址支持模糊匹配；操作类型：可选开启或关闭AAA应急配置；页面可以显示选中节点上所有bas设备最近一次操作情况，包括操作类型、时间、结果。页面不翻页，所有设备在一页显示；支持全选操作；下发按钮：点击后，弹出页面让用户选择操作类型，随后弹出工单部署页面，用户可以选择马上部署或定时部署；页面点击右侧的超链“编辑

19、模板”，弹出如下页面：设备名称、地址带入；操作类型可选，与上一页面相同，必选；配置脚本的多行文本框中，根据设备ID获得该设备对应操作类型的配置内容，如果对应设备脚本不存在，则显示如上示例脚本；保存按钮：保存脚本内容，提示用户确认后操作；关闭按钮，不保存关闭页面，提示用户确认后操作；6.4.2 内部接口预案管理与预案下发通过数据库共享数据，前者完成有关下发内容的配置和存储，后者读取配置内容通过外部接口下发设备。6.5. 配置下发优化6.5.1 需求详细描述该需求的用例图如下：对于下发失败的设备配置，可以在页面上直接选择再次下发：6.5.2 内部接口配置管理与配置下发通过数据库共享数据，前者完成有

20、关下发内容的配置和存储，后者读取配置内容通过外部接口下发设备。6.6. 机历卡优化6.6.1 需求详细描述该需求的用例图如下：机历卡需要能够录入设备发生过的故障及处理情况；对于硬件、IOS变化情况可以编辑备注，录入变更原因等；能够批量修改IOS升级原因，能否利用批量导出修改后导入：原页面增加批量修改，如下图：选中若干条记录，点击批量修改按钮后，校验必须选中至少一条变更记录。新增批量导入：说明： 导入时需校验升级日期不可为空；设备名称不可为空；启动方式、接入方式若非空，则必须为“人工”或“自动”；是否中断业务若非空，则必须为“是”或“否” 按照导入样表各列名称进行解析，显示列表中全部数据； 点击

21、确定后，根据升级日期+设备名称对应的DEVICEID查询到的DHCID更新DHCIOSchange?表。只更新表中非空字段，包括：升级日期，升级时间，升级时长，原OS版本，新OS版本，处理者，类别，级别，启动方式，装入方式，升级原因，处理结果，备注，是否中断业务。是否中断业务需转成Y/N入库6.6.2 内部接口所有导入信息按照设定的excel模板格式完成导入，同步即时调用excel导入接口。6.7. 告警转发改进6.7.1 需求详细描述该需求的用例图如下：系统能够灵活适应运维需求，在转发告警时，只转发指定设备的告警，目前按照设备类型或设备属性来控制告警转发范围已经无法满足运维现状，综合告警系统

22、中的无意义告警数量较大，该告警派单带来困难，本期工程实现告警转发的精细化控制。具体配置方法为1. 登录网管，通过菜单“告警转发标签配置”进入配置页面：2. 选择节点和资源类型，查询设备：根据资源是设备/电路/主机分别查询得到结果列表；直接在查询结果页面进行单个修改或者批量修改。3. 配置结束后保存配置，退出页面：6.7.2 内部接口标签配置与告警转发程序通过数据库共享数据，前者完成有关转发内容的配置和存储，后者定时读取配置内容，通过外部syslog接口完成转发告警。6.8. 设备一键诊断6.8.1 需求详细描述该需求的用例图如下：本期只实现汇聚层以上设备（CR、BAS、SR）；功能由设备维护页

23、面上点击设备右键菜单“一键诊断”触发，页面如下：历史档案查看按钮可以链接打开目前的设备历史档案页面；全部刷新按钮：相当于同时点击下面的所有刷新按钮，对各部分内容重新采集并显示；刷新按钮：仅采集更新对应部分内容；每一区块可以展开或收起；设备网络性能部分，“发生误码电路数”：过去24小时本设备终结的电路中发生过误码的数量；点击应能查看电路列表“发生翻转电路数”：过去24小时本设备终结的电路中发生过up/down转台翻转的数量；点击应能查看电路列表BGP和ISIS状态检查可以采用巡检的方法；LDP和BFD的状态检查方法需用户提供，分设备型号。BAS/PDSN专有信息部分，仅有此类设备类型显示。6.8

24、.2 内部接口采集、诊断和展现部分通过数据库共享数据，包括设备配置、性能和日志等。6.9. 开通工单告警6.9.1 需求详细描述该需求的用例图如下：根据日常工程问题的积累，对于卡单情况的监控，能结合以下几种单子的数量进行告警：1、待部署工单数量（接口侧问题）2、错误类型为“引擎调用失败”（引擎侧问题）3、错误类型为“操作超时，系统直接设置为失败”（引擎侧问题）6.9.2 内部接口检测到的工单告警信息通过内部syslog转发的方式发送到故障管理模块，实现存储和展现，转发格式为标准格式。6.10. 工程信息导入6.10.1 需求详细描述该需求的用例图如下：在新增工程信息页面，按照所选的工程类型，提

25、供excel导入工程操作资源功能，不同工程类型导入模板应该是不一样的，比如选“设备割接”，要导入的是设备信息；选择“板卡割接”时，要导入的是板卡信息；选择“端口割接”时，到导入的是端口信息：点击“批量导入”按钮，导出工程操作资源信息。参考页面如下：6.10.2 内部接口所有导入信息按照设定的excel模板格式完成导入，同步即时调用excel导入接口。6.11. 巡检资源组管理6.11.1 需求详细描述该需求的用例图如下：定义巡检计划时，选中的资源组可以排列顺序，并保存。巡检结果呈现时，需按此排序显示下拉框和巡检结果。包括：资源状态监视矩阵页面的下拉框和结果列表；历史巡检矩阵的下拉框和结果列表；

26、巡检计划执行情况页面的下拉框：记录资源组顺序，并按顺序显示；通过右侧按钮调整资源组顺序，并加以保存；从上到下递增，顺序编号；6.11.2 内部接口资源组配置与显示功能通过数据库共享数据，前者完成有关下发内容的配置和存储，后者读取配置内容并应用到数据展现页面。6.12. 巡检配置6.12.1 需求详细描述该需求的用例图如下：1. 检查任务配置页面增加一列信息，该列信息为配置内容的标准信息。 2. 检查结果查询页面，查询结果显示第1点增加的列信息， 3. 按照用户提供的样例页面修改有关字段的显示名称页面原有的“配置规范”字段改名为“正则表达式”；新增“配置规范字段”6.12.2 内部接口巡检配置与巡检结果显示功能通过数据库共享数据，前者完成有关下发内容的配置和存储，后者读取配置内容并应用到数据展现页面。6.13. 网络流量优化报表6.13.1 需求详细描述该需求的用例图如下：增加网优分析，使用原有的电路统计组报表树，增加拥塞和预警电路数统计。一周内电路流量利用率峰值超过90%且次数大于等于20次或者有一天大