网络管理接口说明书.docx
- 文档编号:29859437
- 上传时间:2023-07-27
- 格式:DOCX
- 页数:18
- 大小:19.41KB
网络管理接口说明书.docx
《网络管理接口说明书.docx》由会员分享,可在线阅读,更多相关《网络管理接口说明书.docx(18页珍藏版)》请在冰豆网上搜索。
网络管理接口说明书
网络管理接口说明书
编号:
编制:
舒适日期:
2003-8-6
审核:
日期:
批准:
日期:
文档修订记录
变更
序号
文档版本号
变更内容简述
变更日期
变更人
1.接口说明4
1.1启动拓扑探测接口函数说明4
1.1.1启动拓扑探测函数原型4
1.1.2启动拓扑探测参数说明4
1.1.3与启动拓扑探测接口函数相关联的模块4
1.2拓扑探测回调函数说明5
1.2.1拓扑探测回调函数原型5
1.2.2拓扑探测回调函数参数说明5
1.2.3与拓扑探测回调函数相关联的模块5
1.3接入发现回调函数说明6
1.3.1接入发现回调函数原型6
1.3.2接入发现回调函数参数说明6
1.3.3与接入发现回调函数相关联的模块6
1.4获取交换机基本信息函数说明7
1.4.1获取交换机基本信息函数原型7
1.4.2获取交换机基本信息函数参数说明7
1.4.3与获取交换机基本信息函数相关联的模块7
1.5获取端口统计信息函数说明7
1.5.1获取端口统计信息函数原型7
1.5.2获取端口统计信息函数参数说明7
1.5.3与获取端口统计信息函数相关联的模块7
1.6读取设备端口状态函数说明8
1.6.1读取设备端口状态函数原型8
1.6.2读取设备端口状态函数参数说明8
1.6.3与读取设备端口状态函数相关联的模块8
1.7设置设备端口状态函数说明8
1.7.1设置设备端口状态函数原型8
1.7.2设置设备端口状态函数参数说明8
1.7.3与设置设备端口状态函数相关联的模块8
2.数据结构9
2.1拓扑数据结构9
2.1.1设备类型数据9
2.1.2设备数据9
2.1.3拓扑连接数据9
2.1.4拓扑信息9
2.2交换机信息和端口状态10
2.2.1端口10
2.2.2端口状态10
2.2.3交换机基本信息10
2.2.4端口统计信息10
2.2.5交换机信息和端口状态10
1.接口说明
1.1启动拓扑探测接口函数说明
1.1.1启动拓扑探测函数原型
HANDLETopo(
HWNDhwnd,
UINTuMsg,
TOPO_CALLBACKfTopoCallback,
TRAP_CALLBACKfTrapCallback,
TOPO_INFO*pTopoInfo,
LPVOIDlpParam)
1.1.2启动拓扑探测参数说明
参数:
HWNDhwnd
IN
窗口句柄,用于接收拓扑探测过程中所发送的消息,可以为NULL
UINTuMsg
IN
所发送的消息,可以为NULL
TOPO_CALLBACKfTopoCallback
IN
拓扑探测过程中由用户指定的拓扑回调函数(下文详述)
TRAP_CALLBACKfTrapCallback
IN
拓扑探测过程中由用户指定的TRAP处理回调函数(下文详述)
TOPO_INFO*pTopoInfo
IN/OUT
调用者需要在该结构体中填写探测的起始IP地址和终止IP地址。
LPVOIDlpParam
IN/OUT
用户指定在调用回调函数时的参数指针
返回值:
HANDLE
如果返回NULL则表示失败,否则返回拓扑探测线程的句柄
1.1.3与启动拓扑探测接口函数相关联的模块
由执行平台调度程序调用
1.2拓扑探测回调函数说明
1.2.1拓扑探测回调函数原型
intCALLBACKTOPO_CALLBACK(
HWNDhwnd,
UINTuMsg,
DWORDdwReason,
LPVOIDlpValue,
LPVOIDlpParam)
1.2.2拓扑探测回调函数参数说明
参数:
HWNDhwnd
IN
窗口句柄,用于接收接入发现过程中所发送的消息,可以为NULL
UINTuMsg
IN
所发送的消息,可以为NULL
DWORDdwReason
IN
在拓扑探测中调用回调函数的原因,可为下列值的任何一个
TP_PROGRESS:
拓扑探测进度
TP_SUCCESS:
拓扑探测成功
TP_FAIL拓扑探测失败
LPVOIDlpValue
IN
与dwReason相关连值的指针
TP_PROGRESS:
INT*,指向表示拓扑探测进度的百分点值
TP_SUCCESS:
拓扑数据的指针,TOPO_DATA_BUFFER*
LPVOIDlpParam
IN
用户指定在调用回调函数时的参数指针
返回值:
Int
TP_SUCCESS表示成功
1.2.3与拓扑探测回调函数相关联的模块
由启动拓扑探测接口函数Topo()调用
1.3接入发现回调函数说明
1.3.1接入发现回调函数原型
intCALLBACKTRAP_CALLBACK(
HWNDhwnd,
UINTuMsg,
DWORDdwReason,
LPVOIDlpValue,
LPVOIDlpParam)
1.3.2接入发现回调函数参数说明
参数:
HWNDhwnd
IN
窗口句柄,用于接收接入发现过程中所发送的消息,可以为NULL
UINTuMsg
IN
所发送的消息,可以为NULL
DWORDdwReason
IN
调用回调函数的原因,即处理TRAP的结果,可为下列值的任何一个
TRAP_STARTED:
TRAP线程已在运行中
TRAP_START_FAIL:
TRAP线程初始化失败
TRAP_FINISHED:
TRAP线程正常结束
TRAP_FAILED:
TRAP线程失败
TRAP_SWITCH_DOWN:
交换机断开网络
TRAP_NO_PORT_STATUS:
不能得到端口状态
TRAP_ADMIN_PORT_DOWN:
管理端口DOWN
TRAP_OPRT_PORT_DOWN:
工作端口DOWN
TRAP_NEW_CONNECTION:
新设备接入
TRAP_CONNECTION_DOWN:
设备断开
TRAP_NO_DEVICE_IP:
连接的设备无IP
TRAP_NO_DEVICE_MAC:
连接的设备无MAC
TRAP_CRITICAL_UP:
该端口原接关键性网络设备,现有设备连接入网络。
TRAP_CRITICAL_DOWN:
该端口原接关键性网络设备,现该设备断开网络。
TRAP_TOO_MANY_TRAPS:
该端口收到过于频繁的拔插事件通知。
LPVOIDlpValue
IN
与dwReason关连的接入信息指针
对应以下值,指针为空
TRAP_STARTED:
TRAP线程已在运行中
TRAP_START_FAIL:
TRAP线程初始化失败
TRAP_FINISHED:
TRAP线程正常结束
TRAP_FAILED:
TRAP线程失败
对应以下值,指针为TRAP_REPORT_INFO*
TRAP_SWITCH_DOWN:
交换机地址有效
TRAP_NO_PORT_STATUS:
交换机地址和端口号有效
TRAP_ADMIN_PORT_DOWN:
交换机地址和端口号有效
TRAP_OPRT_PORT_DOWN:
交换机地址和端口号有效
TRAP_NEW_CONNECTION:
交换机地址、端口号、设备信息有效(nDeviceID为-1则设备无效)
TRAP_CONNECTION_DOWN:
交换机地址、端口号、设备信息有效(nDeviceID为-1则设备无效)
TRAP_NO_DEVICE_IP:
交换机地址、端口号、设备ID(ID为-1则除MAC外其他信息无效)和设备MAC有效
TRAP_NO_DEVICE_MAC:
交换机地址和端口号有效
TRAP_CRITICAL_UP:
交换机地址、端口号有效
TRAP_CRITICAL_DOWN:
交换机地址、端口号有效
TRAP_TOO_MANY_TRAPS:
交换机地址、端口号有效
LPVOIDlpParam
IN
用户指定在调用回调函数时的参数指针
返回值:
Int
TP_SUCCESS表示成功
1.3.3与接入发现回调函数相关联的模块
由启动拓扑探测接口函数Topo()调用
1.4获取交换机基本信息函数说明
1.4.1获取交换机基本信息函数原型
intGetSwitchBasicInfo(char*szIP,BASICINFO*pData)
1.4.2获取交换机基本信息函数参数说明
参数:
char*szIP
IN
目标交换机IP地址
BASICINFO*pData
IN/OUT
读取基本信息后写入该结构体
返回值:
Int
TP_SUCCESS表示获取成功
1.4.3与获取交换机基本信息函数相关联的模块
由执行平台调度程序调用
1.5获取端口统计信息函数说明
1.5.1获取端口统计信息函数原型
intGetPortStatInfo(char*szIP,intnPort,STATINFO*pData)
1.5.2获取端口统计信息函数参数说明
参数:
char*szIP
IN
目标交换机IP地址
intnPort
IN
目标端口
STATINFO*pData
IN/OUT
读取统计信息后写入该结构体
返回值:
Int
TP_SUCCESS表示获取成功
1.5.3与获取端口统计信息函数相关联的模块
由执行平台调度程序调用
1.6读取设备端口状态函数说明
1.6.1读取设备端口状态函数原型
intGetPortStatus(
char*szIP,
intnPort,
PORTSTATUS*PortStatus
int*nPortCount)
1.6.2读取设备端口状态函数参数说明
参数:
char*szIP
IN
目标交换机IP地址
intnPort
IN
目标端口
当为-1时表示读取所有端口的状态
PORTSTATUS*PortStatus
IN/OUT
端口状态结构体数组
int*pnPortCount
IN/OUT
端口状态结构体数组元素个数
若调用者只读取单个端口状态,则必须在该参数所指向的整型变量里指定1
若调用者读取所有端口状态,则必须在该参数所指向的整型变量里指定端口数量
若该参数与nPort不一致,则可能会导致TP_INSUFFICIENT_MEMORY错误
若成功返回,则该参数指向的整型变量包含里结构体数组的大小
若返回错误,则包含所需要的数组大小
返回值:
int
TP_SUCCESS表示成功读取,这时PortStatus包含端口状态信息的数组,pnPortCount包含数组大小
TP_GET_PORT_FAIL表示读取失败
TP_INVALID_PORT表示指定的交换机或端口无效
TP_INSUFFICIENT_MEMORY表示提供的结构体数组太小,这时在pnPortCount返回所需要的数组大小
1.6.3与读取设备端口状态函数相关联的模块
由执行平台调度程序调用
1.7设置设备端口状态函数说明
1.7.1设置设备端口状态函数原型
intSetPortStatus(char*szIP,intnPort,PORTSTATUSStatusToSet)
1.7.2设置设备端口状态函数参数说明
参数:
char*szIP
IN
目标交换机IP地址
intnPort
IN
目标端口
PORTSTATUSStatusToSet
IN
待设置的端口新状态
返回值:
int
若成功设置端口状态,则返回TP_SUCCESS
若关闭处于已关闭状态的端口,则返回TP_PORT_CLOSED
若开启处于已开启状态的端口,则返回TP_PORT_OPENED
1.7.3与设置设备端口状态函数相关联的模块
由执行平台调度程序调用
2.数据结构
2.1拓扑数据结构
2.1.1设备类型数据
DEVICE_TYPE
{
intnDeviceTypeID
charszTypeName[50]
}
2.1.2设备数据
NET_DEVICE
{
intnDeviceID
charszDeviceName[100]
charszIP[20]
charszMAC[20]
BYTESysStatus
BYTEAlarmStatus
intnDeviceTypeID
}
2.1.3拓扑连接数据
TOPO_CONNECTION
{
intnFatherID
BYTEDownPort
BYTEDownPortStatus
intnChildID
BYTEUpPort
BYTEUpPortStatus
}
2.1.4拓扑信息
TOPO_INFO
{
SYSTEMTIMEStartTime
SYSTEMTIMEEndTime
DWORDFlag
charszStartIP[20]
charszEndIP[20]
intnDevCount
intnDevTypeCount
intnConnCount
DEVICE_TYPE*pDevTypes
NET_DEVICE*pDevices
TOPO_CONNECTION*pTopoConn
}
2.2交换机信息和端口状态
2.2.1端口
PORT
{
intnPort//端口号
intnIfIndex//接口索引
PORTSTATUSStatus//端口状态
intnChildID//连接的设备ID
STATINFOCurrentStat//当前统计数据
STATINFOStatIncrement//统计数据增量
}
2.2.2端口状态
PORTSTATUS
{
BYTEAdminStatus//管理状态
BYTEOprtStatus//工作状态
}
2.2.3交换机基本信息
BASICINFO
{
charDescription[50]//对交换机的描述
charUpTime[20]//交换机启动到现在已经经过的时间
charContact[50]//联系信息
charName[100]//名字
charLocation[100]//位置
}
2.2.4端口统计信息(该数据结构可能还需要改动)
STATINFO
{
charUpTime[20]//运行时间
ULONGInBytes//输入字节数
ULONGOutBytes//输出字节数
ULONGTotalBytes//总字节数
ULONGUCastPkts//单播包数
ULONGGCastPkts//组播包数
ULONGBCastPkts//广播包数
ULONGTotalPkts//总包数
//当没有组播和广播包数而取得非单播包数时,将GCastPkts设为0xFFFFFFFF
//而BCastPkts里放非单播包数
ULONGInDiscards//入包丢弃数
ULONGInErrors//入包错误数
ULONGOutDiscards//出包丢弃数
ULONGOutErrors//出包错误数
ULONGTotalDiscards//总丢弃数
ULONGTotalErrors//总错误数
ULONGDiscardsAndErrors//总的丢弃和错误数
{
ULONGLessThan64//少于64
ULONGIs64//等于64
ULONGF64T127//64-127
ULONGF128T255//128-255
ULONGF256T511//256-511
ULONGF512T1023//512-1023
ULONGF1024T1518//1024-1518
ULONGOver1518//大于1518
}PktsLen//包长度统计
ULONGCollisions//冲突次数
}
2.2.5交换机信息和端口状态
SWITCHINFO
{
charszIP[20]
intnPortCount//交换机的端口数
BASICINFO*pBasicInfo//交换机的基本信息
PORT*pPort//交换机端口结构体数祖
}
2.2.6接入发现信息
TRAP_REPORT_INFO
{
charszSwitchIP[16];//拓扑连接信息
intnPort;//端口号
DWORDdwReason;//调用回调函数的原因
NET_DEVICEChildDevice;//所连接的设备信息
}
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 网络 管理 接口 说明书