网管接口概要设计

1、FLYINGVOICE文档编号产品版本密级1.00产品名称：共 页网管接口文档V1.01北京飞音时代技术有限公司Flying Voice Technology Limited修订记录日期修订版本描述作者2012-7-301.00初稿完成伊宝峰目录1. 简介42. 接口形态43. 模块基本功能44. 设计要点44.1. 程序接口都为字符串形式44.2. 回调函数44.3. 信号处理54.4. 消息传递55. 接口定义55.1. 函数列表55.2. 函数说明及示例：65.2.1. 回调函数65.2.2. 状态的获取65.2.3. 状态的设置65.2.4. 参数的获取65.2.5. 参数的设置75.

2、2.6. 保存设置的参数的flash75.2.7. 恢复设备为出厂设置75.2.8. 控制设备重启75.2.9. 程序及配置的更新,75.2.10. 记录日志到日志模块中85.2.11. 数图接口说明81. 简介本文档主要描述了飞音时代提供的设备管理模块和SNMP程序的接口定义。2. 接口形态SNMP网管作为一个独立的进程运行，设备管理模块提供一个动态链接库供SNMP进程以及其它网管模块运行时调用，同时提供一个静态链接库供编译使用。SNMP通过设备管理模块提供的接口对设备进行管理。在使用这个网管接口时，可能会用到SIGRTMIN至SIGRTMIN+15之间的信号，用于告警和参数同步等事件通知，

3、除非必要，请不要在模块中使用这些信号3. 模块基本功能系统参数的读写及保存系统状态的获取及报警上送软件和配置文件的下载升级配置文件的上传恢复出厂设置系统重启4. 设计要点4.1. 程序接口都为字符串形式4.2. 回调函数回调函数可以处理以下事件，每个事件可以注册单独的回调函数：网口link状态变化：“phy_link”wan ip变化（包括了interface的变化）：“wan_interface”参数变化（包括恢复出厂设置）：“config”注册状态改变：“register”呼叫状态改变：“call”程序升级结束：“upgrade”重启：“reboot”4.3. 信号处理采用SIGRTMIN

4、之上的信号，共32个可以用，这些信号可以可靠发送，不会丢失。（sigqueue函数可以支持带参数的信号但是uclibc不支持这个函数）4.4. 消息传递因为信号本身就是异步的，程序收到信号后无论是由设备管理库获取相应信息然后通过回调函数传给网管设备，还是直接由网管程序去读取相应信息没有逻辑上的区别，本设计采用第二种方式，回调函数的参数只有注册时指定的事件。5. 接口定义5.1. 函数列表int dev_manager_event_init(char* processname, char* event, dev_manager_callback_t callback);int dev_manag

5、er_status_get(char* name, char* value);int dev_manager_status _set(char* name, char* value);int dev_manager_cfg_get(char* name, char* value);int dev_manager_cfg_set(char* name, char* value);int dev_manager_commit(void);int dev_manager_factory_default(void);int dev_manager_reboot(void);int dev_manage

6、r_start_upgrade_fw (char* url)int dev_manager_start_upgrade_profile (char* url)int dev_manager_start_upload_profile (char* url)int dev_manager_log(int priority, const char *text);所有函数的返回值定义如下0：success1：fail5.2. 函数说明及示例：5.2.1. 回调函数回调函数用于通知网管程序有事件发生，具体消息细节需要在回调函数中主动获取。typedef void (*dev_manager_callba

7、ck_t)( char* event);int dev_manager_event_init(char* event, dev_manager_callback_t callback);void upgrade_call_back(char* event)If(0 = strncmp(event, “upgrade”,7)dev_manager_get(“upgrade_protocol”,protocol);dev_manager_get(“upgrade_result”, result);dev_manager_get(“upgrade_error_code”, code);dev_man

8、ager_event_init(“upgrade”, upgrade_call_back);5.2.2. 状态的获取int dev_manager_status_get(char* name, char* value);char name64;dev_manager_status _get(“vendor”, name);5.2.3. 状态的设置int dev_manager_status _set(char* name, char* value);dev_manager_status _set(“line1_register_describe”, “Registered”);5.2.4. 参

9、数的获取int dev_manager_cfg_get(char* name, char* value);char devid64;dev_manager_cfg _get(“gkSnmpDeviceIdentifier”, devid);5.2.5. 参数的设置int dev_manager_cfg_set(char* name, char* value);dev_manager_cfg_set(“gkSnmpServerIp”, “28”);5.2.6. 保存设置的参数的flashint dev_manager_commit(void);dev_manager_co

10、mmit(); 5.2.7. 恢复设备为出厂设置int dev_manager_factory_default(void);dev_manager_factory_default();5.2.8. 控制设备重启int dev_manager_reboot(void);dev_manager_reboot();5.2.9. 程序及配置的更新,本模块根据url头判断升级协议的类型，共支持四种，本地文件，tftp服务器，http服务器，ftp服务器，默认为本地文件升级软件int dev_manager_start_upgrade_fw (char* url)local: dev_manager_st

11、art_upgrade_fw (“/tmp/mg6001.bin”)tftp:dev_manager_start_upgrade_fw (“t9/mg6001.bin”)http:dev_manager_start_upgrade_fw (“:8080/mg6001/mg6001.bin”);ftp:dev_manager_start_upgrade_fw (“ftp:/id:pw:8080/mg6001.bin”); 升级配置文件int dev_manager_start_upgrade_profile (char* url)tftp:dev_manager_s

12、tart_upgrade_profile(“t9/mg6001.cfg”)上传配置文件int dev_manager_start_upload_profile (char* url)tftp:dev_manager_start_upgrade_fw (“t9/mg6001.cfg”)5.2.10. 记录日志到日志模块中int dev_manager_log(int priority, const char *text);dev_manager_log(INFO, “snmp startup success”);5.2.11. 数图接口说明int dev_manager_digitmap_set(char *digitmap, int line);数图接口说明客户参数飞音参数方法参数范围1DigitMapEnbaleDBID_SIP_DIALMODEdev_manager_cfg_set/get2BriefTimeDBID_SIP_DM_SHORT_TI