RESTAPI Manual
Layer 2
LAG
11 min
link aggregations(lag or portchannel) urls summary urls summary url get post patch put delete /rest/v1/running/portchannels/{name} y y y n y /rest/v1/running/portchannels/{name}/members/{port} y y n n y /rest/v1/rpc/show link aggregation summary n y n n n examples examples show link aggregation summary show link aggregation summary post https //{switch ip}/rest/v1/rpc/show link aggregation summary get all portchannels get all portchannels get https //{switch ip}/rest/v1/running/portchannels create a portchannel with members create a portchannel with members post https //{switch ip}/rest/v1/running/portchannels/ { "name" "portchannel0004", "mode" "lacp", "lacp" { "lacp key" "auto", "min links" 1, "system priority" 10000, "fallback" "true", "fast rate" "true", "system id" "12 34 56\ ab\ cd\ ef" }, "members" \[ { "port" "ethernet0", }, { "port" "ethernet1", "lacp port priority" 65535 } ] } create a member for portchannel create a member for portchannel post https //{switch ip}/rest/v1/running/portchannels/portchannel8888/members { "port" "ethernet3", "lacp port priority" 65535 } properties descriptions properties descriptions lags lags tree diagrams + rw portchannels + rw portchannel \[name] + rw name + rw mode? + rw commit? + rw lacp \| + rw lacp key? \| + rw min links? \| + rw system priority? \| + rw fallback? \| + rw fast rate? \| + rw graceful down? \| + rw system id? table of properties name required type/range description portchannels m path only node, has no configurable value name m portchannel0000 9999 (sub property of portchannels) the name of the portchannel and portchannel sub interface mode o "lacp" "static" (sub property of portchannels) choose port channel mode lacp for running lacp protocol, static for static load banlancing among members default value "lacp" lacp cm (sub property of portchannels) path only node, has no configurable value only applicable when mode = "lacp" lacp protocol configuration of portchannels lacp key o "auto" 0 65535 (sub property of lacp) lacp key should be either auto or a integer in the range of 0 to 65535 when lacp key is set to "auto" it would be set to be the number on the end of the portchannel name with a prefix of 1 default value "auto" min links o 1 1024 (sub property of lacp) minimum count of up ports for the lag to enter up state system priority o 0 65535 (sub property of lacp) the lacp system priority identifies the master switch ot the lag the system with the lower system priority is preferred default value 65535 fallback o "true" "false" (sub property of lacp) the fallback mode brings up one of the lacp member ports to "up" state before an lacp pdu is received by the lag default value "false" fast rate o "true" "false" (sub property of lacp) fast rate allows the lacp peer to send lacp pdus at a rate of one per second after synchronization the default rate is one per 30 seconds default value "false" graceful down o "true" "false" (sub property of lacp) graceful shutdown lacp system id o a\ b c\ d e\ f (sub property of lacp) change lacp system id default to the system mac lag lag members tree diagrams + rw portchannels + rw portchannel \[name] + rw name + rw members + rw member \[port] + rw port + rw lacp port priority? + rw lacp key? + rw lacp port id? table of properties name required type/range description portchannels m path only node, has no configurable value name m portchannel0000 9999 (sub property of portchannels) the name of the portchannel and portchannel sub interface members m (sub property of portchannels) path only node, has no configurable value port m ethernet name (sub property of members) lacp port priority o 1 65535 (sub property of members) the port priority determines which ports should be put in standby mode when there is a hardware limitation that prevents all compatible ports from aggregating ports with lower port priority are preferred lacp key o 0 65535 (sub property of members) the administrative key defines the ability of a port to aggregate with other ports a port's ability to aggregate with other ports is determined by these factors port physical characteristics, such as the data rate and the duplex capability configuration restrictions that you establish lacp port id o 1 65535 (sub property of members) lacp port identifier default lacp uses the port priority with the port number to form the port identifier show link aggregation summary show link aggregation summary tree diagrams + x show link aggregation summary + ro output + ro result? table of properties name required type/range description show link aggregation summary m path only node, has no configurable value result ro string (sub property of output) a table that shows information of all link aggregation
