RESTAPI Manual
High Availability
MC-LAG
15 min
multi chassis link aggregation group urls summary urls summary url get post patch put delete /rest/v1/running/mclag domains/{domainid} y y y n y /rest/v1/running/mclag domains/{domainid}/members/{name} y y y n y /rest/v1/running/mclag domains/{domainid}/vlans/{vlanid} y y y n y /rest/v1/rpc/show mclag consistency check result n y n n n /rest/v1/rpc/show mclag state n y n n n examples examples show mclag consistency check result show mclag consistency check result post https //{switch ip}/rest/v1/rpc/show mclag consistency check result show mclag state show mclag state post https //{switch ip}/rest/v1/rpc/show mclag state create a mclag domain create a mclag domain post https //{switch ip}/rest/v1/running/mclag domains { "domainid" 2, "peer ip" "35 0 0 2", "source ip" "35 0 0 1" } create a member for mclag domain create a member for mclag domain post https //{switch ip}/rest/v1/running/mclag domains/1/members { "name" "portchannel0111" } create a vlan for mclag domain create a vlan for mclag domain post https //{switch ip}/rest/v1/running/mclag domains/1/vlans { "vlanid" 12, "unique ip" "true", "mode" "same mac" } properties descriptions properties descriptions mc lag domains global mc lag domains global tree diagrams + rw mclag domains + rw mclag domain \[domainid] + rw domainid + rw peer ip? + rw source ip? + rw peer link? + rw keepalive interval? + rw session timeout? + rw vrf? + rw consistency check? + rw backup channel? + rw dad source ip? + rw dad peer ip? + rw detection delay? + rw member recover delay? + rw orphan recover delay? + rw dad vrf? + rw commit? table of properties name required type/range description mclag domains m path only node, has no configurable value domainid m 1 4095 (sub property of mclag domains) mclag domain id peer ip o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of mclag domains) peer ip of the mc lag control link source ip o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of mclag domains) local ip of the mc lag control link peer link o ethernet name portchannel0000 9999 (sub property of mclag domains) the peer link port name, which is used to connect to the remote mc lag keepalive interval o 1 60 (sub property of mclag domains) mc lag keepalive message sending interval in seconds the keepalive message interval value should be less than 1/3 of the session timeout time; the session timeout time should be a multiple of the keepalive message interval default 1 seconds default value 1 session timeout o 3 3600 (sub property of mclag domains) mc lag session timeout in seconds default 15 seconds default value 15 vrf o "default" vrf name (sub property of mclag domains) vrf name, mc lag keepalive session belongs to the vrf that specifies the vrf of the routing port to which the local address belongs consistency check o "default" "graceful" "idle" (sub property of mclag domains) mc lag consistency check action, the default action is the idle mode default mode if the consistency check fails, the master and standby devices admin down the failed member ports at the same time graceful mode if the consistency check fails, only the standby role device admin down the failed member ports, and the active device stays up idle mode, the consistency check only displays the relevant results and does not take any corresponding action default value "idle" backup channel o 1 4094 (sub property of mclag domains) mc lag iccp alternate pathway vlanid dad source ip o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of mclag domains) mc lag dad link local ip dad peer ip o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of mclag domains) mc lag dad link peer ip detection delay o 0 512 (sub property of mclag domains) mc lag dad detection delay in seconds default 15 seconds default value 15 member recover delay o 0 1000 (sub property of mclag domains) mc lag standby side mlag port error down state recovery delay time default 60 seconds default value 60 orphan recover delay o 0 1000 (sub property of mclag domains) mc lag standby side non mlag port error down state recovery delay time default 0 seconds default value 0 dad vrf o "default" vrf name (sub property of mclag domains) vrf name, mc lag dad keepalive session belongs to the vrf that specifies the vrf of the routing port to which the local address belongs mc lag domain members mc lag domain members tree diagrams + rw mclag domains + rw mclag domain \[domainid] + rw domainid + rw members \| + rw member \[name] \| + rw name table of properties name required type/range description mclag domains m path only node, has no configurable value domainid m 1 4095 (sub property of mclag domains) mclag domain id members m (sub property of mclag domains) path only node, has no configurable value name m portchannel0000 9999 (sub property of members) mc lag domain vlans mc lag domain vlans tree diagrams + rw mclag domains + rw mclag domain \[domainid] + rw domainid + rw vlans + rw vlan \[vlanid] + rw vlanid + rw mode? + rw unique ip? table of properties name required type/range description mclag domains m path only node, has no configurable value domainid m 1 4095 (sub property of mclag domains) mclag domain id vlans m (sub property of mclag domains) path only node, has no configurable value vlanid m 1 4094 (sub property of vlans) mode o "diff mac" "same mac" (sub property of vlans) unique vlan mode, the default mode is diff mac mode diff mac the vlan id of the local and remote devices must be different same mac the vlan id of the local and remote devices must be the same default value "diff mac" unique ip o "true" "false" (sub property of vlans) whether to enable the unique ip function default "false" default value "false" show mclag state show mclag state tree diagrams + x show mclag state \| + ro output \| + ro data? table of properties name required type/range description show mclag state m path only node, has no configurable value show mclag state data ro \<anydata> (sub property of output) show mclag consistency check result show mclag consistency check result tree diagrams + x show mclag consistency check result + ro output + ro data? table of properties name required type/range description show mclag consistency check result m path only node, has no configurable value show mclag consistency check result data ro \<anydata> (sub property of output)
