修改交换机端口配置
典型场景
提供配置参数的接口,修改交换机以太端口配置。
接口功能
页面功能:站点配置下选择存在交换机设备的站点,在交换机页签下选择接口。
修改交换机以太端口配置,支持同时配置多个端口。
接口约束
1、该接口支持租户视图或msp代维视图下,用户角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。
2、存在交换机设备的站点内使用。
3、对接口速率配置有以下限制:1.autoNegotiationEnable与speed参数为null时不更新接口配置;2.autoNegotiationEnable为false、speed为null时更新接口速率为默认;3.autoNegotiationEnable为false、speed为具体速率如1Gbps时更新接口速率为具体速率;4.autoNegotiationEnable为true、speed为null时更新接口速率为自协商。其他参数组合非法。
调用方法
PUT
URI
/controller/campus/v1/networkservice/networkconfig/net/lswport/devices/{deviceId}/ethernet-ports
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
deviceId |
是 |
uuid |
- |
- |
设备ID。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
请求参数
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
body |
是 |
ARRAY_REFERENCE |
详细请参见表3。 |
交换机以太端口配置参数体,结构体参见LSWEthPortDto。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
status |
否 |
boolean |
|
true |
接口管理状态(true为undo shutdown,false为shutdown)。默认值为true。 |
true |
description |
否 |
string |
0~242个字符。 |
- |
接口描述。 |
"LSW interface" |
linkType |
否 |
string |
- |
trunk |
链路类型,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。取值:access;trunk;hybrid;dot1q。默认值为trunk。 |
"trunk" |
defaultVlan |
否 |
int32 |
[1-4094] |
1 |
access类型下缺省VLAN;或trunk类型下pvid;或hybrid类型下缺省VLAN。若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为1。 |
1 |
allowPassVlan |
否 |
string |
0~13000个字符。 |
1 |
trunk类型下允许通过VLAN,接口为trunk类型时必填。allowPassVlan的取值要求:1到4094范围内的数字、段或all,如:1,3-10。默认值为1。 |
"1,3-10" |
untaggedVlan |
否 |
string |
0~100个字符。 |
1 |
hybrid类型下Untagged VLAN。untaggedVlan的取值要求:1到4094范围内的数字或段,如:11,12-16。不能配置和taggedVlan相同的数值。默认值为1。 |
"11,12-16" |
taggedVlan |
否 |
string |
0~100个字符。 |
- |
hybrid类型下Tagged VLAN。taggedVlan的取值要求:1到4094范围内的数字或段,如:1,3-10。不能配置和untaggedVlan相同的数值。 |
"1,3-10" |
arpSnoopingEnable |
否 |
boolean |
|
false |
ARP Snooping使能,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
dhcpSnooping |
否 |
boolean |
|
false |
DHCP Snooping使能,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
dhcpSnoopingTrusted |
否 |
boolean |
|
false |
配置接口为DHCP Snooping信任状态,默认为非信任状态。默认值为false。 |
false |
ndSnooping |
否 |
boolean |
|
false |
ND Snooping使能,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
ndSnoopingTrusted |
否 |
boolean |
|
false |
配置接口为ND Snooping信任状态,默认为非信任状态。默认值为false。 |
false |
portIsolation |
否 |
boolean |
|
false |
端口隔离使能,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
stp |
否 |
boolean |
|
true |
STP功能状态,取值:true(使能);false(未使能)。当STP为false时,stpEdgedport自动赋值为normal,传入其他参数无效。默认值为true。 |
true |
stpEdgedport |
否 |
string |
- |
normal |
STP边缘端口状态,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。取值:enable(使能);normal(遵从全局状态);disable(未使能)。默认值为normal。 |
"normal" |
bpduFilter |
否 |
string |
0~10个字符。 |
normal |
配置当前端口是否为BPDU filter端口。。取值:enable(使能);normal(遵从全局状态);disable(未使能)。 |
"normal" |
enableRelay |
否 |
boolean |
|
false |
堆叠多主检测场景下,设为检测代理设备。默认值为false。 |
false |
enableMadDetection |
否 |
boolean |
|
false |
堆叠多主检测场景下,代理模式双主检测开关。默认值为false。 |
false |
domainId |
否 |
int32 |
[0-255] |
- |
堆叠多主检测场景下,堆叠域编号,两个堆叠互相检测时,堆叠域编号需不同。 |
16 |
naMsgCheck |
否 |
boolean |
|
false |
NA报文检测,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
nsMsgCheck |
否 |
boolean |
|
false |
NS报文检测,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
rsMsgCheck |
否 |
boolean |
|
false |
RS报文检测,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
ipsgCheck |
否 |
boolean |
|
false |
IPSG检测使能开关。默认值为false。 |
false |
daiCheck |
否 |
boolean |
|
false |
DAI检测使能开关。默认值为false。 |
false |
collectDynamicMac |
否 |
boolean |
|
false |
动态MAC采集关闭使能开关。开关打开:动态MAC采集关闭;开关关闭:动态MAC采集使能。默认值为false。 |
false |
restoreIpSubnetVlanDefault |
否 |
boolean |
|
false |
IP子网划分Vlan开关是否恢复默认值。该属性为true时,ipSubnetVlanEnable属性不生效;该属性为false时,ipSubnetVlanEnable属性生效。默认值为false。 |
false |
ipSubnetVlanEnable |
否 |
boolean |
|
false |
IP子网划分Vlan开关。restoreIpSubnetVlanDefault为true时,该属性不生效;restoreIpSubnetVlanDefault为false时,该属性生效。默认值为false。 |
false |
linkUpDownTrapEnable |
否 |
boolean |
|
true |
SNMP TRAP使能开关。默认值为true。 |
true |
mdnsSnoopingEnable |
否 |
boolean |
|
false |
mdns Snooping使能开关。默认值为false。 |
false |
dnsSnoopingEnable |
否 |
boolean |
|
false |
DNS snooping开关。默认值为false。 |
false |
loopbackDetectEnabled |
否 |
boolean |
|
false |
环路检测使能开关。默认值为false。 |
false |
loopbackDetectAction |
否 |
string |
- |
shutdown |
环路检测处理动作。非V600版本设备取值范围:shutdown,alarm,block,nolearn,quitvlan。V600版本设备取值范围:alarm,block,errordown。 |
"shutdown" |
loopbackDetectVlans |
否 |
string |
- |
环路检测Vlan。1-4094范围内的数字或段,最多支持30个vlan,默认值为空。 |
"1,3-8" |
|
loopbackDetectRecoveryTime |
否 |
int32 |
[1-1000] |
- |
环路检测惩罚动作恢复时间,单位s。非V600版本设备取值范围:1-1000。V600版本设备取值范围:5-1000。 |
16 |
trust |
否 |
string |
- |
- |
trust字段是用来指定对报文按照某类优先级进行映射。可选值为dscp、8021p |
"dscp" |
loadBalance |
否 |
string |
0~15个字符。 |
- |
负载均衡模式。可选值为dst-ip | src-ip | src-dst-ip | dst-mac | src-mac | src-dst-mac | round-robin |
"src-dst-ip" |
lacpPriorityValue |
否 |
int32 |
[0-65535] |
32768 |
lacp优先级,该参数是为了区别同一设备不同接口的优先级,接口优先级高的将被选做活动接口。当Eth-Trunk的ethTrunkMode为lacp时,成员口该值生效。默认值为32768。 |
32768 |
portSecurityEnable |
否 |
boolean |
|
false |
port security 使能, 支持普通口和eth-Truck口, 不支持成员口。默认值为false。 |
false |
portSecurityMaxinum |
否 |
int32 |
[1-4096] |
1 |
port security 使能后, 交换机学习的mac地址数量上限,范围:1~4096。默认值为1。 |
1 |
stickyEnable |
否 |
boolean |
|
false |
sticky mac使能, 支持普通口和eth-Truck口, 不支持成员口。默认值为false。 |
false |
manualUpStream |
否 |
boolean |
|
false |
是否手动指定的上行口,默认值为false |
true |
outboundTrafficPolicy |
否 |
string |
- |
- |
出方向流量策略名称 |
"aaa" |
inboundTrafficPolicy |
否 |
string |
- |
- |
入方向流量策略名称 |
"bbb" |
voiceVlanEnable |
否 |
boolean |
|
- |
Voice VLAN使能 |
false |
voiceVlanId |
否 |
int32 |
[2-4094] |
- |
voiceVlanEnable使能后生效且必填,范围:2~4094。该VLAN必须在当前接口上放通,否则Voice VLAN功能将无法生效。当链路类型为Hybrid时,”Voice VLAN ID”必须与本接口的”Untagged VLAN”相同。 |
2 |
voiceVlanMode |
否 |
string |
- |
- |
voiceVlanEnable使能后生效且必填,提升语音报文优先级方式,取值范围:tag、untag,其中tag为VLAN方式,untag为MAC方式。 |
"tag" |
isolate |
否 |
boolean |
|
- |
远端模块端口隔离配置使能,若当前接口为上行口,堆叠口,eth-trunk成员口不能配置此参数。 |
false |
arpExpireTime |
否 |
int32 |
[30-62640] |
- |
ARP表项老化时间(秒)。 |
1200 |
portSecurityAction |
否 |
string |
0~16个字符。 |
- |
端口安全保护,取值:protect(丢弃),restrict(丢弃并告警),shutdown(关闭并告警)。 |
"protect" |
portSecurityAgingTime |
否 |
int32 |
[1-1440] |
- |
MAC老化时间(分钟)。 |
1440 |
portSecurityAgingType |
否 |
string |
0~16个字符。 |
- |
MAC老化类型,取值:absolute(绝对),inactivity(相对)。 |
"absolute" |
name |
是 |
string |
1~32个字符。 |
- |
接口名称。 |
"GigabitEthernet0/0/1" |
autoNegotiationEnable |
否 |
boolean |
|
- |
接口自协商状态,根据款型确定默认值;端口支持自协商时必填。 |
false |
speed |
否 |
string |
- |
- |
接口速率。可选值:1Gbps,100Mbps,10Mbps,根据款型确定默认值;自协商关闭时必填。 |
"1Gbps" |
duplex |
否 |
string |
- |
- |
双工模式, 根据款型确定默认值,自协商关闭时必填。取值:half(半双工);full(全双工)。 |
"full" |
stormControl |
否 |
boolean |
|
false |
风暴控制使能。默认值为false。 |
false |
stormControlModel |
否 |
string |
0~7个字符。 |
- |
风暴控制模式。取值:packet(包模式),cir(字节模式), percent(百分比模式)。当stormControl字段值为true时,该字段必填。 |
"packet" |
stormControlMaxRate |
否 |
int32 |
[1-59524000] |
- |
风暴控制包模式最大阈值,单位pps。当stormControl字段值为true时,该字段必填。 |
3000 |
stormControlMinRate |
否 |
int32 |
[1-59524000] |
- |
风暴控制包模式最小阈值,单位pps。当stormControl字段值为true时,该字段必填。 |
1 |
stormControlInterval |
否 |
int32 |
[1-180] |
5 |
风暴控制检测时间间隔,单位s。当stormControl字段值为true时,该字段必填。默认值为5。 |
5 |
stormControlAction |
否 |
string |
0~10个字符。 |
block |
风暴控制动作。取值:block(阻塞报文),suppress(抑制报文),error-down(关闭接口),默认值block。 |
"block" |
stormControlLog |
否 |
boolean |
|
false |
风暴控制使能记录日志。默认值为false。 |
false |
stormControlTrap |
否 |
boolean |
|
false |
风暴控制使能上报告警。默认值为false。 |
false |
poe |
否 |
boolean |
|
true |
端口POE使能,支持poe的端口默认值为true;不支持的端口,不能传参。 |
true |
timeTemplateId |
否 |
string |
0~36个字符。 |
- |
PoE上电时间模板ID。UUID格式。当poe为true时,timeTemplateId生效。时间模板ID可以通过第三方开放接口/controller/campus/v3/networkconfig/timetemplate得到。 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
transApPower |
否 |
boolean |
|
false |
端口传递POE功率到AP使能,支持poe的端口默认值为false;不支持的端口,不能传参。 |
true |
poweronLegacyLevel |
否 |
string |
- |
normal |
POE工作模式,poe打开时使用此参数。取值:normal(普通供电);legacy(非标PD供电);force(强制PD供电)。 |
"normal" |
poweronDelayTime |
否 |
int32 |
[0-10] |
- |
POE接口供电延迟时间,单位秒。poe打开时使用此参数,该字段非必填。 |
5 |
lldp |
否 |
boolean |
|
true |
端口LLDP使能,默认值为true。若使用CDP发现协议的设备需要使用LLDP功能,需要将LLDP置为true,同时CDP为true。 |
true |
appDpiEnable |
否 |
boolean |
|
- |
应用识别开关 |
false |
appTrafficStatisticsEnable |
否 |
boolean |
|
- |
应用流量统计开关 |
false |
cdp |
否 |
boolean |
|
false |
端口CDP使能,默认值为false。 |
false |
congestionMgrEnable |
否 |
boolean |
|
false |
接口拥塞管理使能,默认值为false,开启时,congestionMgrList字段不能为空。 |
true |
pnpStartSwitchEnable |
否 |
boolean |
|
- |
管理VLAN自协商。 |
false |
opticalPortLldpEnable |
否 |
boolean |
|
- |
光口LLDP代理使能,仅S5732-H48XUM2CC生效。 |
false |
electricalPortName |
否 |
string |
- |
- |
电口名称,仅S5732-H48XUM2CC生效。 |
"MultiGE0/0/6" |
congestionMgrList |
否 |
ARRAY_REFERENCE |
0-8个列表项,详细请参见表4。 |
拥塞管理队列,配置时需使能拥塞管理开关,结构体参见CongestionMgrInfo。 |
- |
|
trafficShapingEnable |
否 |
boolean |
|
false |
接口流量整形使能,默认值为false,开启时,queueShapingList字段和interfaceShapingList字段不能同时为空。 |
true |
queueShapingList |
否 |
ARRAY_REFERENCE |
0-8个列表项,详细请参见表5。 |
队列整形,配置时需使能接口流量整形开关,结构体参见QueueShapingInfo。 |
- |
|
interfaceShapingList |
否 |
ARRAY_REFERENCE |
0-2个列表项,详细请参见表6。 |
接口整形,配置时需使能接口流量整形开关,结构体参见InterfaceShapingInfo。 |
- |
|
portEnableDelayTime |
否 |
int32 |
[0-3600] |
- |
接口UP延迟时间(秒),非V600版本设备必须是10的倍数。非V600版本设备范围0-1800,V600版本设备0-3600。 |
1800 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
id |
是 |
int32 |
[0-7] |
- |
队列索引,范围为0-7,且不能重复。 |
0 |
scheduleMode |
是 |
string |
- |
- |
拥塞管理调度模式:PQ,WRR,WDRR。设备上的拥塞管理技术分为PQ、WDRR、WRR、PQ+WDRR和PQ+WRR,即WDRR和WRR不能同时存在队列列表中。 |
"PQ" |
weight |
否 |
int32 |
[0-100] |
- |
队列权重。当调度模式为PQ时,权值不配置。当调度模式为WRR或WDRR时,该字段必填。权重大者优先调度。 |
100 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
id |
是 |
int32 |
[0-7] |
- |
队列索引,范围为0-7,且不能重复。 |
0 |
cir |
是 |
int64 |
[0-100000000] |
- |
队列整形的承诺信息速率,整数形式,单位为kbit/s。不同类型的接口取值范围如下: Ethernet:0~100000 MultiGE:0~2500000 GigabitEthernet:0~1000000 XGigabitEthernet:0~10000000 25GE:0~25000000 40GigabitEthernet:0~40000000 100GigabitEthernet:0~100000000。 |
100 |
pir |
否 |
int64 |
[64-100000000] |
- |
队列整形的峰值信息速率,整数形式,单位为kbit/s,不同的接口类型取值范围不同,取值范围如下: Ethernet:64~100000 MultiGE:64~2500000 GigabitEthernet:64~1000000 XGigabitEthernet:64~10000000 25GE:128~25000000 40GigabitEthernet:64~40000000 100GigabitEthernet:64~100000000。 必须大于等于cir,缺省等于cir。 |
100 |
cbs |
否 |
int64 |
[4000-4294967295] |
- |
队列整形的承诺突发尺寸,整数形式,单位是byte,取值范围是4000~4294967295。 |
4000 |
pbs |
否 |
int64 |
[4000-4294967295] |
- |
指定峰值突发尺寸(Peak Burst Size),即瞬间能够通过的峰值突发流量,整数形式,单位是byte,取值范围是4000~4294967295。 |
8000 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
direction |
是 |
string |
- |
- |
对接口指定方向上的报文进行限速。枚举类型,取值为inbound/outbound,表示方向。 |
"inbound" |
cir |
是 |
int64 |
[64-100000000] |
- |
承诺信息速率,整数形式,单位是kbit/s。不同类型的接口取值范围如下: Ethernet:64~100000 MultiGE:64~2500000 GigabitEthernet:64~1000000 XGigabitEthernet:64~10000000 25GE:64-25000000 40GigabitEthernet:64~40000000 100GigabitEthernet:64~100000000 端口组:64~10000000。 |
100 |
cbs |
否 |
int64 |
[4000-4294967295] |
- |
承诺突发尺寸。非V600版本设备取值范围是4000~4294967295,V600版本设备取值范围10000~33554432,单位是字节,若不指定该节点,cbs缺省为cir的125倍。 |
4000 |
请求示例
PUT /controller/campus/v1/networkservice/networkconfig/net/lswport/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/ethernet-ports HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy [ { "status" : true, "description" : "LSW interface", "linkType" : "trunk", "defaultVlan" : 1, "allowPassVlan" : "1,3-10", "untaggedVlan" : "11,12-16", "taggedVlan" : "1,3-10", "arpSnoopingEnable" : false, "dhcpSnooping" : false, "dhcpSnoopingTrusted" : false, "ndSnooping" : false, "ndSnoopingTrusted" : false, "portIsolation" : false, "stp" : true, "stpEdgedport" : "normal", "bpduFilter" : "normal", "enableRelay" : false, "enableMadDetection" : false, "domainId" : 16, "naMsgCheck" : false, "nsMsgCheck" : false, "rsMsgCheck" : false, "ipsgCheck" : false, "daiCheck" : false, "collectDynamicMac" : false, "restoreIpSubnetVlanDefault" : false, "ipSubnetVlanEnable" : false, "linkUpDownTrapEnable" : true, "mdnsSnoopingEnable" : false, "dnsSnoopingEnable" : false, "loopbackDetectEnabled" : false, "loopbackDetectAction" : "shutdown", "loopbackDetectVlans" : "1,3-8", "loopbackDetectRecoveryTime" : 16, "trust" : "dscp", "loadBalance" : "src-dst-ip", "lacpPriorityValue" : 32768, "portSecurityEnable" : false, "portSecurityMaxinum" : 1, "stickyEnable" : false, "manualUpStream" : true, "outboundTrafficPolicy" : "aaa", "inboundTrafficPolicy" : "bbb", "voiceVlanEnable" : false, "voiceVlanId" : 2, "voiceVlanMode" : "tag", "isolate" : false, "arpExpireTime" : 1200, "portSecurityAction" : "protect", "portSecurityAgingTime" : 1440, "portSecurityAgingType" : "absolute", "name" : "GigabitEthernet0/0/1", "autoNegotiationEnable" : false, "speed" : "1Gbps", "duplex" : "full", "stormControl" : false, "stormControlModel" : "packet", "stormControlMaxRate" : 3000, "stormControlMinRate" : 1, "stormControlInterval" : 5, "stormControlAction" : "block", "stormControlLog" : false, "stormControlTrap" : false, "poe" : true, "timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4", "transApPower" : true, "poweronLegacyLevel" : "normal", "poweronDelayTime" : 5, "lldp" : true, "appDpiEnable" : false, "appTrafficStatisticsEnable" : false, "cdp" : false, "congestionMgrEnable" : true, "pnpStartSwitchEnable" : false, "opticalPortLldpEnable" : false, "electricalPortName" : "MultiGE0/0/6", "congestionMgrList" : [ { "id" : 0, "scheduleMode" : "PQ", "weight" : 100 } ], "trafficShapingEnable" : true, "queueShapingList" : [ { "id" : 0, "cir" : 100, "pir" : 100, "cbs" : 4000, "pbs" : 8000 } ], "interfaceShapingList" : [ { "direction" : "inbound", "cir" : 100, "cbs" : 4000 } ], "portEnableDelayTime" : 1800 } ]
响应参数
返回状态码为200:修改成功,返回配置后的端口配置信息,结构体参见PutResponseDto。
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
0~64个字符。 |
- |
错误码。 |
"0" |
errmsg |
string |
0~256个字符。 |
- |
错误信息。 |
"" |
success |
ARRAY_REFERENCE |
详细请参见表8。 |
交换机端口配置数据,结构体参见LSWEthPortDto。 |
- |
|
fail |
ARRAY_REFERENCE |
详细请参见表9。 |
交换机端口配置数据,结构体参见PutResponseFailDto。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
status |
boolean |
|
true |
接口管理状态(true为undo shutdown,false为shutdown)。默认值为true。 |
true |
description |
string |
0~242个字符。 |
- |
接口描述。 |
"LSW interface" |
linkType |
string |
- |
trunk |
链路类型,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。取值:access;trunk;hybrid;dot1q。默认值为trunk。 |
"trunk" |
defaultVlan |
int32 |
[1-4094] |
1 |
access类型下缺省VLAN;或trunk类型下pvid;或hybrid类型下缺省VLAN。若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为1。 |
1 |
allowPassVlan |
string |
0~13000个字符。 |
1 |
trunk类型下允许通过VLAN,接口为trunk类型时必填。allowPassVlan的取值要求:1到4094范围内的数字、段或all,如:1,3-10。默认值为1。 |
"1,3-10" |
untaggedVlan |
string |
0~100个字符。 |
1 |
hybrid类型下Untagged VLAN。untaggedVlan的取值要求:1到4094范围内的数字或段,如:11,12-16。不能配置和taggedVlan相同的数值。默认值为1。 |
"11,12-16" |
taggedVlan |
string |
0~100个字符。 |
- |
hybrid类型下Tagged VLAN。taggedVlan的取值要求:1到4094范围内的数字或段,如:1,3-10。不能配置和untaggedVlan相同的数值。 |
"1,3-10" |
arpSnoopingEnable |
boolean |
|
false |
ARP Snooping使能,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
dhcpSnooping |
boolean |
|
false |
DHCP Snooping使能,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
dhcpSnoopingTrusted |
boolean |
|
false |
配置接口为DHCP Snooping信任状态,默认为非信任状态。默认值为false。 |
false |
ndSnooping |
boolean |
|
false |
ND Snooping使能,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
ndSnoopingTrusted |
boolean |
|
false |
配置接口为ND Snooping信任状态,默认为非信任状态。默认值为false。 |
false |
portIsolation |
boolean |
|
false |
端口隔离使能,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
stp |
boolean |
|
true |
STP功能状态,取值:true(使能);false(未使能)。当STP为false时,stpEdgedport自动赋值为normal,传入其他参数无效。默认值为true。 |
true |
stpEdgedport |
string |
- |
normal |
STP边缘端口状态,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。取值:enable(使能);normal(遵从全局状态);disable(未使能)。默认值为normal。 |
"normal" |
bpduFilter |
string |
0~10个字符。 |
normal |
配置当前端口是否为BPDU filter端口。。取值:enable(使能);normal(遵从全局状态);disable(未使能)。 |
"normal" |
enableRelay |
boolean |
|
false |
堆叠多主检测场景下,设为检测代理设备。默认值为false。 |
false |
enableMadDetection |
boolean |
|
false |
堆叠多主检测场景下,代理模式双主检测开关。默认值为false。 |
false |
domainId |
int32 |
[0-255] |
- |
堆叠多主检测场景下,堆叠域编号,两个堆叠互相检测时,堆叠域编号需不同。 |
16 |
naMsgCheck |
boolean |
|
false |
NA报文检测,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
nsMsgCheck |
boolean |
|
false |
NS报文检测,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
rsMsgCheck |
boolean |
|
false |
RS报文检测,若当前是以太接口,其加入Eth-Trunk后不能配置此参数。默认值为false。 |
false |
ipsgCheck |
boolean |
|
false |
IPSG检测使能开关。默认值为false。 |
false |
daiCheck |
boolean |
|
false |
DAI检测使能开关。默认值为false。 |
false |
collectDynamicMac |
boolean |
|
false |
动态MAC采集关闭使能开关。开关打开:动态MAC采集关闭;开关关闭:动态MAC采集使能。默认值为false。 |
false |
restoreIpSubnetVlanDefault |
boolean |
|
false |
IP子网划分Vlan开关是否恢复默认值。该属性为true时,ipSubnetVlanEnable属性不生效;该属性为false时,ipSubnetVlanEnable属性生效。默认值为false。 |
false |
ipSubnetVlanEnable |
boolean |
|
false |
IP子网划分Vlan开关。restoreIpSubnetVlanDefault为true时,该属性不生效;restoreIpSubnetVlanDefault为false时,该属性生效。默认值为false。 |
false |
linkUpDownTrapEnable |
boolean |
|
true |
SNMP TRAP使能开关。默认值为true。 |
true |
mdnsSnoopingEnable |
boolean |
|
false |
mdns Snooping使能开关。默认值为false。 |
false |
dnsSnoopingEnable |
boolean |
|
false |
DNS snooping开关。默认值为false。 |
false |
loopbackDetectEnabled |
boolean |
|
false |
环路检测使能开关。默认值为false。 |
false |
loopbackDetectAction |
string |
- |
shutdown |
环路检测处理动作。非V600版本设备取值范围:shutdown,alarm,block,nolearn,quitvlan。V600版本设备取值范围:alarm,block,errordown。 |
"shutdown" |
loopbackDetectVlans |
string |
- |
环路检测Vlan。1-4094范围内的数字或段,最多支持30个vlan,默认值为空。 |
"1,3-8" |
|
loopbackDetectRecoveryTime |
int32 |
[1-1000] |
- |
环路检测惩罚动作恢复时间,单位s。非V600版本设备取值范围:1-1000。V600版本设备取值范围:5-1000。 |
16 |
trust |
string |
- |
- |
trust字段是用来指定对报文按照某类优先级进行映射。可选值为dscp、8021p |
"dscp" |
loadBalance |
string |
0~15个字符。 |
- |
负载均衡模式。可选值为dst-ip | src-ip | src-dst-ip | dst-mac | src-mac | src-dst-mac | round-robin |
"src-dst-ip" |
lacpPriorityValue |
int32 |
[0-65535] |
32768 |
lacp优先级,该参数是为了区别同一设备不同接口的优先级,接口优先级高的将被选做活动接口。当Eth-Trunk的ethTrunkMode为lacp时,成员口该值生效。默认值为32768。 |
32768 |
portSecurityEnable |
boolean |
|
false |
port security 使能, 支持普通口和eth-Truck口, 不支持成员口。默认值为false。 |
false |
portSecurityMaxinum |
int32 |
[1-4096] |
1 |
port security 使能后, 交换机学习的mac地址数量上限,范围:1~4096。默认值为1。 |
1 |
stickyEnable |
boolean |
|
false |
sticky mac使能, 支持普通口和eth-Truck口, 不支持成员口。默认值为false。 |
false |
manualUpStream |
boolean |
|
false |
是否手动指定的上行口,默认值为false |
true |
outboundTrafficPolicy |
string |
- |
- |
出方向流量策略名称 |
"aaa" |
inboundTrafficPolicy |
string |
- |
- |
入方向流量策略名称 |
"bbb" |
voiceVlanEnable |
boolean |
|
- |
Voice VLAN使能 |
false |
voiceVlanId |
int32 |
[2-4094] |
- |
voiceVlanEnable使能后生效且必填,范围:2~4094。该VLAN必须在当前接口上放通,否则Voice VLAN功能将无法生效。当链路类型为Hybrid时,”Voice VLAN ID”必须与本接口的”Untagged VLAN”相同。 |
2 |
voiceVlanMode |
string |
- |
- |
voiceVlanEnable使能后生效且必填,提升语音报文优先级方式,取值范围:tag、untag,其中tag为VLAN方式,untag为MAC方式。 |
"tag" |
isolate |
boolean |
|
- |
远端模块端口隔离配置使能,若当前接口为上行口,堆叠口,eth-trunk成员口不能配置此参数。 |
false |
arpExpireTime |
int32 |
[30-62640] |
- |
ARP表项老化时间(秒)。 |
1200 |
portSecurityAction |
string |
0~16个字符。 |
- |
端口安全保护,取值:protect(丢弃),restrict(丢弃并告警),shutdown(关闭并告警)。 |
"protect" |
portSecurityAgingTime |
int32 |
[1-1440] |
- |
MAC老化时间(分钟)。 |
1440 |
portSecurityAgingType |
string |
0~16个字符。 |
- |
MAC老化类型,取值:absolute(绝对),inactivity(相对)。 |
"absolute" |
name |
string |
1~32个字符。 |
- |
接口名称。 |
"GigabitEthernet0/0/1" |
autoNegotiationEnable |
boolean |
|
- |
接口自协商状态,根据款型确定默认值;端口支持自协商时必填。 |
false |
speed |
string |
- |
- |
接口速率。可选值:1Gbps,100Mbps,10Mbps,根据款型确定默认值;自协商关闭时必填。 |
"1Gbps" |
duplex |
string |
- |
- |
双工模式, 根据款型确定默认值,自协商关闭时必填。取值:half(半双工);full(全双工)。 |
"full" |
stormControl |
boolean |
|
false |
风暴控制使能。默认值为false。 |
false |
stormControlModel |
string |
0~7个字符。 |
- |
风暴控制模式。取值:packet(包模式),cir(字节模式), percent(百分比模式)。当stormControl字段值为true时,该字段必填。 |
"packet" |
stormControlMaxRate |
int32 |
[1-59524000] |
- |
风暴控制包模式最大阈值,单位pps。当stormControl字段值为true时,该字段必填。 |
3000 |
stormControlMinRate |
int32 |
[1-59524000] |
- |
风暴控制包模式最小阈值,单位pps。当stormControl字段值为true时,该字段必填。 |
1 |
stormControlInterval |
int32 |
[1-180] |
5 |
风暴控制检测时间间隔,单位s。当stormControl字段值为true时,该字段必填。默认值为5。 |
5 |
stormControlAction |
string |
0~10个字符。 |
block |
风暴控制动作。取值:block(阻塞报文),suppress(抑制报文),error-down(关闭接口),默认值block。 |
"block" |
stormControlLog |
boolean |
|
false |
风暴控制使能记录日志。默认值为false。 |
false |
stormControlTrap |
boolean |
|
false |
风暴控制使能上报告警。默认值为false。 |
false |
poe |
boolean |
|
true |
端口POE使能,支持poe的端口默认值为true;不支持的端口,不能传参。 |
true |
timeTemplateId |
string |
0~36个字符。 |
- |
PoE上电时间模板ID。UUID格式。当poe为true时,timeTemplateId生效。时间模板ID可以通过第三方开放接口/controller/campus/v3/networkconfig/timetemplate得到。 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
transApPower |
boolean |
|
false |
端口传递POE功率到AP使能,支持poe的端口默认值为false;不支持的端口,不能传参。 |
true |
poweronLegacyLevel |
string |
- |
normal |
POE工作模式,poe打开时使用此参数。取值:normal(普通供电);legacy(非标PD供电);force(强制PD供电)。 |
"normal" |
poweronDelayTime |
int32 |
[0-10] |
- |
POE接口供电延迟时间,单位秒。poe打开时使用此参数,该字段非必填。 |
5 |
lldp |
boolean |
|
true |
端口LLDP使能,默认值为true。若使用CDP发现协议的设备需要使用LLDP功能,需要将LLDP置为true,同时CDP为true。 |
true |
appDpiEnable |
boolean |
|
- |
应用识别开关 |
false |
appTrafficStatisticsEnable |
boolean |
|
- |
应用流量统计开关 |
false |
cdp |
boolean |
|
false |
端口CDP使能,默认值为false。 |
false |
congestionMgrEnable |
boolean |
|
false |
接口拥塞管理使能,默认值为false,开启时,congestionMgrList字段不能为空。 |
true |
pnpStartSwitchEnable |
boolean |
|
- |
管理VLAN自协商。 |
false |
opticalPortLldpEnable |
boolean |
|
- |
光口LLDP代理使能,仅S5732-H48XUM2CC生效。 |
false |
electricalPortName |
string |
- |
- |
电口名称,仅S5732-H48XUM2CC生效。 |
"MultiGE0/0/6" |
congestionMgrList |
ARRAY_REFERENCE |
0-8个列表项,详细请参见表5。 |
拥塞管理队列,配置时需使能拥塞管理开关,结构体参见CongestionMgrInfo。 |
- |
|
trafficShapingEnable |
boolean |
|
false |
接口流量整形使能,默认值为false,开启时,queueShapingList字段和interfaceShapingList字段不能同时为空。 |
true |
queueShapingList |
ARRAY_REFERENCE |
0-8个列表项,详细请参见表6。 |
队列整形,配置时需使能接口流量整形开关,结构体参见QueueShapingInfo。 |
- |
|
interfaceShapingList |
ARRAY_REFERENCE |
0-2个列表项,详细请参见表7。 |
接口整形,配置时需使能接口流量整形开关,结构体参见InterfaceShapingInfo。 |
- |
|
portEnableDelayTime |
int32 |
[0-3600] |
- |
接口UP延迟时间(秒),非V600版本设备必须是10的倍数。非V600版本设备范围0-1800,V600版本设备0-3600。 |
1800 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
0~64个字符。 |
- |
错误码。 |
"0" |
errmsg |
string |
0~256个字符。 |
- |
错误信息。 |
"" |
data |
REFERENCE |
详细请参见表8。 |
交换机以太端口配置数据,结构体参见LSWEthPortDto。 |
- |
响应示例
返回状态码为200:修改成功,返回配置后的端口配置信息,结构体参见PutResponseDto。
HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ { "status" : true, "description" : "LSW interface", "linkType" : "trunk", "defaultVlan" : 1, "allowPassVlan" : "1,3-10", "untaggedVlan" : "11,12-16", "taggedVlan" : "1,3-10", "arpSnoopingEnable" : false, "dhcpSnooping" : false, "dhcpSnoopingTrusted" : false, "ndSnooping" : false, "ndSnoopingTrusted" : false, "portIsolation" : false, "stp" : true, "stpEdgedport" : "normal", "bpduFilter" : "normal", "enableRelay" : false, "enableMadDetection" : false, "domainId" : 16, "naMsgCheck" : false, "nsMsgCheck" : false, "rsMsgCheck" : false, "ipsgCheck" : false, "daiCheck" : false, "collectDynamicMac" : false, "restoreIpSubnetVlanDefault" : false, "ipSubnetVlanEnable" : false, "linkUpDownTrapEnable" : true, "mdnsSnoopingEnable" : false, "dnsSnoopingEnable" : false, "loopbackDetectEnabled" : false, "loopbackDetectAction" : "shutdown", "loopbackDetectVlans" : "1,3-8", "loopbackDetectRecoveryTime" : 16, "trust" : "dscp", "loadBalance" : "src-dst-ip", "lacpPriorityValue" : 32768, "portSecurityEnable" : false, "portSecurityMaxinum" : 1, "stickyEnable" : false, "manualUpStream" : true, "outboundTrafficPolicy" : "aaa", "inboundTrafficPolicy" : "bbb", "voiceVlanEnable" : false, "voiceVlanId" : 2, "voiceVlanMode" : "tag", "isolate" : false, "arpExpireTime" : 1200, "portSecurityAction" : "protect", "portSecurityAgingTime" : 1440, "portSecurityAgingType" : "absolute", "name" : "GigabitEthernet0/0/1", "autoNegotiationEnable" : false, "speed" : "1Gbps", "duplex" : "full", "stormControl" : false, "stormControlModel" : "packet", "stormControlMaxRate" : 3000, "stormControlMinRate" : 1, "stormControlInterval" : 5, "stormControlAction" : "block", "stormControlLog" : false, "stormControlTrap" : false, "poe" : true, "timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4", "transApPower" : true, "poweronLegacyLevel" : "normal", "poweronDelayTime" : 5, "lldp" : true, "appDpiEnable" : false, "appTrafficStatisticsEnable" : false, "cdp" : false, "congestionMgrEnable" : true, "pnpStartSwitchEnable" : false, "opticalPortLldpEnable" : false, "electricalPortName" : "MultiGE0/0/6", "congestionMgrList" : [ { "id" : 0, "scheduleMode" : "PQ", "weight" : 100 } ], "trafficShapingEnable" : true, "queueShapingList" : [ { "id" : 0, "cir" : 100, "pir" : 100, "cbs" : 4000, "pbs" : 8000 } ], "interfaceShapingList" : [ { "direction" : "inbound", "cir" : 100, "cbs" : 4000 } ], "portEnableDelayTime" : 1800 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "status" : true, "description" : "LSW interface", "linkType" : "trunk", "defaultVlan" : 1, "allowPassVlan" : "1,3-10", "untaggedVlan" : "11,12-16", "taggedVlan" : "1,3-10", "arpSnoopingEnable" : false, "dhcpSnooping" : false, "dhcpSnoopingTrusted" : false, "ndSnooping" : false, "ndSnoopingTrusted" : false, "portIsolation" : false, "stp" : true, "stpEdgedport" : "normal", "bpduFilter" : "normal", "enableRelay" : false, "enableMadDetection" : false, "domainId" : 16, "naMsgCheck" : false, "nsMsgCheck" : false, "rsMsgCheck" : false, "ipsgCheck" : false, "daiCheck" : false, "collectDynamicMac" : false, "restoreIpSubnetVlanDefault" : false, "ipSubnetVlanEnable" : false, "linkUpDownTrapEnable" : true, "mdnsSnoopingEnable" : false, "dnsSnoopingEnable" : false, "loopbackDetectEnabled" : false, "loopbackDetectAction" : "shutdown", "loopbackDetectVlans" : "1,3-8", "loopbackDetectRecoveryTime" : 16, "trust" : "dscp", "loadBalance" : "src-dst-ip", "lacpPriorityValue" : 32768, "portSecurityEnable" : false, "portSecurityMaxinum" : 1, "stickyEnable" : false, "manualUpStream" : true, "outboundTrafficPolicy" : "aaa", "inboundTrafficPolicy" : "bbb", "voiceVlanEnable" : false, "voiceVlanId" : 2, "voiceVlanMode" : "tag", "isolate" : false, "arpExpireTime" : 1200, "portSecurityAction" : "protect", "portSecurityAgingTime" : 1440, "portSecurityAgingType" : "absolute", "name" : "GigabitEthernet0/0/1", "autoNegotiationEnable" : false, "speed" : "1Gbps", "duplex" : "full", "stormControl" : false, "stormControlModel" : "packet", "stormControlMaxRate" : 3000, "stormControlMinRate" : 1, "stormControlInterval" : 5, "stormControlAction" : "block", "stormControlLog" : false, "stormControlTrap" : false, "poe" : true, "timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4", "transApPower" : true, "poweronLegacyLevel" : "normal", "poweronDelayTime" : 5, "lldp" : true, "appDpiEnable" : false, "appTrafficStatisticsEnable" : false, "cdp" : false, "congestionMgrEnable" : true, "pnpStartSwitchEnable" : false, "opticalPortLldpEnable" : false, "electricalPortName" : "MultiGE0/0/6", "congestionMgrList" : [ { "id" : 0, "scheduleMode" : "PQ", "weight" : 100 } ], "trafficShapingEnable" : true, "queueShapingList" : [ { "id" : 0, "cir" : 100, "pir" : 100, "cbs" : 4000, "pbs" : 8000 } ], "interfaceShapingList" : [ { "direction" : "inbound", "cir" : 100, "cbs" : 4000 } ], "portEnableDelayTime" : 1800 } } ] }