LAG
Link-aggregations(LAG or PortChannel).
URLs Summary
URL | GET | POST | PATCH | PUT | DELETE |
|---|---|---|---|---|---|
/rest/v1/running/link-aggregations/{name} | Y | Y | Y | N | Y |
/rest/v1/running/link-aggregations/{name}/members/{port} | Y | Y | N | N | Y |
/rest/v1/rpc/show-link-aggregation-summary | N | Y | N | N | N |
Examples
Show-link-aggregation-summary
POST HTTPS://{switch IP}/rest/v1/rpc/show-link-aggregation-summaryresponse:
{
"link-aggregation": [
{
"index": 200,
"name": "Lag200",
"protocol": "lacp",
"runner-active": "active",
"state": "down",
"description": "N/A",
"member": [
{
"name": "Ethernet53:2",
"status": "deselected",
"synced": "synced"
}
]
}
]
}Get all PortChannels
GET HTTPS://{switch IP}/rest/v1/running/link-aggregationsresponse:
{
"result": [
{
"name": "Lag200",
"mode": "lacp",
"lacp": {
"lacp-key": "auto"
},
"members": [
{
"port": "Ethernet53:2"
}
]
}
]
}Create a PortChannel with members
POST HTTPS://{switch IP}/rest/v1/running/link-aggregations/
{
"name": "Lag4",
"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": "Ethernet1",
},
{
"port": "Ethernet2",
"lacp-port-priority": 65535
}
]
}Create a member for PortChannel
POST HTTPS://{switch IP}/rest/v1/running/link-aggregations/Lag8888/members
{
"port": "Ethernet3",
"lacp-port-priority": 65535
}Properties Descriptions
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 |
|---|---|---|---|
link-aggregations | M | | Path-only node, has no configurable value. |
name | M | Lag1..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 members
Tree Diagrams
+--rw link-aggregations
+--rw link-aggregation* [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 |
|---|---|---|---|
link-aggregations | M | | Path-only node, has no configurable value. |
name | M | Lag1..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
Tree Diagrams
+---x show-link-aggregation-summary
+--ro output
+--ro link-aggregation* [name]
+--ro index?
+--ro name
+--ro protocol?
+--ro runner-active?
+--ro state?
+--ro member* [name]
| +--ro name
| +--ro status?
| +--ro synced?
+--ro description?Table of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
show-link-aggregation-summary | M | | Path-only node, has no configurable value. |
link-aggregation | RO | | (sub-property of output) Path-only node, has no configurable value. |
index | RO | 0..65535 | (sub-property of link-aggregation) |
name | RO | string | (sub-property of link-aggregation) |
protocol | RO | "lacp" "static" "not-available" | (sub-property of link-aggregation) |
runner-active | RO | "active" "inactive" "not-available" | (sub-property of link-aggregation) |
state | RO | "up" "down" "not-available" | (sub-property of link-aggregation) |
member | RO | | (sub-property of link-aggregation) Path-only node, has no configurable value. |
name | RO | string | (sub-property of member) |
status | RO | "selected" "deselected" "up" "down" | (sub-property of member) |
synced | RO | "synced" "not-synced" "not-available" | (sub-property of member) |
description | RO | string | (sub-property of link-aggregation) |