智简魔方文档

交换机列表

本文说明智简魔方 DCIM 系统中“交换机列表”相关的接口或函数信息,供开发人员在集成、调用和排查问题时参考。

概述

查询系统下的所有符合条件的交换机。

URL

/index.php?m=api&a=switchListing

请求参数

字段名变量名必填类型描述
搜索内容searchstring对交换机的搜索
分页数量listpagesint每一页显示的数据的数量
排序类型orderbystring用来排序的字段
排序规则sortingstring升序 asc 降序 desc
交换机类型typestring搜索的交换机类型,默认为自用公网,(all:全部,1:自用公网,2:自用 IPMI,3:自用内网,4:租用,5:托管,6:机柜,7:其他)
数据偏移量offsetint返回数据的偏移指针,与分页数量结合使用

返回参数

字段名变量名类型描述
交换机列表listingarray
id 交换机id
sname 交换机名称
sname_tag 交换机标签
type 交换机类型(1:自用公网,2:自用ipmi,3:自用内网,4:租用,5:托管,6:机柜,7:其它)
device 设备类型(switch:交换机,router:路由器,firewall:防火墙,other:其他)
portnum 端口数量
pwd 交换机密码
telnetuname telnet用户名
telnetpwd telnet密码
version 型号
switch_sh_file 执行文件
attest 连接方式(telnet,ssh)
nousername 有无用户名(0:有,1:无)
vlan 交换机VLAN
bind_mac 是否绑定MAC(true,false)
bind_vlan 是否绑定VLAN(true,false)
conn 连接状态(on:正常,off:断开,nonsupport:不支持)
conn_msg 连接错误信息
ipmi_support 支持IPMI控制(true,false)
cid 所属机柜ID
cabinet 所属机柜名称
ipaddress IP地址
根据查询条件查询到的所有交换机数据
交换机总数sumint系统内交换机数据的总数
分页数量listpagesint每一页显示的数据的数量
搜索内容searchstring自定义的搜索内容
排序类型orderbystring用来排序的字段
排序规则sortingstring升序 asc 降序 desc
数据偏移量offsetint返回数据的偏移指针,与分页数量结合使用
状态statusstringsuccess 成功 error 失败