智简魔方文档

交换机添加

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

概述

添加交换机

URL

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

请求参数

字段名变量名必填类型描述
交换机名称sname是string交换机名称
交换机标签sname_tag否string交换机内部标签
交换机类型type否int交换机类型(1:自用公网,2:自用 ipmi,3:自用内网,4:租用,5:托管,6:机柜,7:其他),默认为自用公网
设备类型device否string设备类型(switch:交换机,router:路由器,firewall:防火墙,other:其他),默认为交换机
端口数量portnum否int交换机下端口的数量
分配 IPipaddress否int分配的 IP 的 ID,调用(/index.php?m=api&a=getIps,传递 type 参数获取 IP 段,type 允许的值:(public,client,ipmi,intranet,other),返回一个由 ID(IP 段 ID)和 ipsection(IP 段)组成的二维数组,传递 ID 参数(IP 段 ID)到/index.php?m=api&a=getIp,返回一个由 ID(IP 的 ID)和 ipaddress(IP 地址)组成的二维数组)
机柜cabinet否int所属机柜 ID,调用/index.php?m=api&a=getCabinet,获取由 ID(机柜 ID)和 name(机柜名称)组成的二维数组
机柜物理位置position_u否string设备物理位置
设备具体位置position_style否string设备具体位置
位置大小u否int交换机占用位置大小
型号version否string交换机型号
密码pwd否string密码
Telnet 用户名telnetuname否stringTelnet 用户名
Telnet 密码telnetpwd否stringTelnet 密码
VLANvlan否stringVLAN(用,分隔开,例如 12,14,15,16-22)
SNMP 团体名snmp否stringSNMP 团体名
脚本执行文件switch_sh_file否string脚本执行文件,调用/index.php?m=api&a=getShFile,传递参数 conn(Telnet,SSH)获取脚本执行文件数组
连接方式attest否string连接方式(Telnet,SSH)
有无用户名nousername否int交换机有无 Telnet 用户名(0:有,1:无)
功能支持features否string交换机支持的功能,调用/index.php?m=api&a=getShConfig,传递参数 attest(连接方式)以及 switch_sh_file(脚本执行文件)获取,返回一个数组(support:功能支持,用于传递给后台,supportName:支持的功能名称组成的数组,unsupportName:不支持的功能名称组成的数组)
控制支持ipmi_support否string交换机是否支持控制(true:支持,false:不支持)

返回参数

字段名变量名类型描述
状态statusstringsuccess 成功 error 失败
交换机 IDidint添加的交换机 ID
信息msgstring提示信息