Port Channel

The below API's are used to create groups of tool ports as port-channel and provide traffic load-balancing. By default, symmetric hashing is enabled for IPv4 and IPv6 traffic.

Configure Port-channel

Request URL

/api/config/portchannel/<port-channel-id>

Description

Use this API to add the members from a port-channel

Note: Edit port-channel not supported. Please delete and add the port-channel to change the member ports

Method

POST

Request Body

{

"add_member" :["Ethernet1_1", "Ethernet2_1", "Ethernet3_1"],

"description": "test"

}

Response Body

NA

Status code

  • SERVER_ERROR(500) if there is any error with the server

  • OK(200) if the request completes successfully

Delete Port-channel

Request URL

/api/config/portchannel/<port-channel-id>

Description

Use this API to delete all the members from a port-channel

Method

DELETE

Request Body

NA

Response Body

NA

Status code

  • SERVER_ERROR(500) if there is any error with the server

  • OK(200) if the request completes successfully

Get Port-channel Information

Request URL

/api/info/portchannel/<port-group-id>

Description

Use this API to get the portchannel related information from the system

Method

GET

Request Body

NA

Response Body

{

{

"ports": [ "Ethernet46_1", "Ethernet47_1" ], "comment": "test"

}

Status code

  • SERVER_ERROR(500) if there is any error with the server

  • OK(200) if the request completes successfully

Get all Port-channel Information

Request URL

/api/info/portchannel

Description

Use this API to get all the portchannel related information from the system

Method

GET

Request Body

NA

Response Body

{

"1": {

"ports": [ "Ethernet46_1", "Ethernet47_1" ], "comment": "test"

}

}

Status code

  • SERVER_ERROR(500) if there is any error with the server

  • OK(200) if the request completes successfully