Skip to content
/
Update LAG

Switch Service API & Model Documentation (0.3.4)

Overview

Rate Limit

For the Switch REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 20 calls can be made per second.
  • Each second 10 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Terms of Service

Languages
Servers
Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

North American region

https://api.ruckus.cloud/

AAA Server

Manage AAA (authentication, authorization, and accounting) Servers.

Operations

AAA Setting

Manage AAA (authentication, authorization, and accounting) Settings.

Operations

Command-Line Interface Template

Manage command-line interface templates.

Operations

Configuration History

Retrieve configuration history.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX Switches.

Operations

Import Switch

Import Switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Get LAGDeprecated

Request

Get LAG setting by id.

Security
jwtAuth
Path
lagIdstringrequired
No request payload

Responses

OK

Body
idstring
lagIdinteger(int32)
namestring^(?:(?!").){1,64}$
typestring
Enum"static""dynamic"
portsArray of stringsunique
taggedVlansArray of stringsunique
untaggedVlanstring
switchIdstring
tenantIdstring
addPortsArray of strings
removePortsArray of strings
portVlansArray of objects(LagPortVlanBo)
portAddVlansArray of objects(LagPortVlanBo)
lastNamestring
realRemoveboolean
defaultVlanIdstring
originalUntaggedVlanstring
lagViewListArray of objects(LagView)
Response
{
  "id": "string",
  "lagId": 0,
  "name": "string",
  "type": "static",
  "ports": [
    "string"
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "switchId": "string",
  "tenantId": "string",
  "addPorts": [
    "string"
  ],
  "removePorts": [
    "string"
  ],
  "portVlans": [
    { … }
  ],
  "portAddVlans": [
    { … }
  ],
  "lastName": "string",
  "realRemove": true,
  "defaultVlanId": "string",
  "originalUntaggedVlan": "string",
  "lagViewList": [
    {}
  ]
}

Update LAGDeprecated

Request

Update switch's LAG setting.

Security
jwtAuth
Path
lagIdstringrequired
Body
required
idstring
lagIdinteger(int32)
namestring^(?:(?!").){1,64}$
typestring
Enum"static""dynamic"
portsArray of stringsunique
taggedVlansArray of stringsunique
untaggedVlanstring
switchIdstring
addPortsArray of strings
removePortsArray of strings
portVlansArray of objects(LagPortVlanBo)
portAddVlansArray of objects(LagPortVlanBo)
lastNamestring
defaultVlanIdstring
originalUntaggedVlanstring
forceUpPortstring
dynamicLagboolean
{
  "id": "string",
  "lagId": 0,
  "name": "string",
  "type": "static",
  "ports": [
    "string"
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "switchId": "string",
  "addPorts": [
    "string"
  ],
  "removePorts": [
    "string"
  ],
  "portVlans": [
    { … }
  ],
  "portAddVlans": [
    { … }
  ],
  "lastName": "string",
  "defaultVlanId": "string",
  "originalUntaggedVlan": "string",
  "forceUpPort": "string",
  "dynamicLag": true
}

Responses

OK

Body
idstring
lagIdinteger(int32)
namestring^(?:(?!").){1,64}$
typestring
Enum"static""dynamic"
portsArray of stringsunique
taggedVlansArray of stringsunique
untaggedVlanstring
switchIdstring
tenantIdstring
addPortsArray of strings
removePortsArray of strings
portVlansArray of objects(LagPortVlanBo)
portAddVlansArray of objects(LagPortVlanBo)
lastNamestring
realRemoveboolean
defaultVlanIdstring
originalUntaggedVlanstring
lagViewListArray of objects(LagView)
Response
{
  "id": "string",
  "lagId": 0,
  "name": "string",
  "type": "static",
  "ports": [
    "string"
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "switchId": "string",
  "tenantId": "string",
  "addPorts": [
    "string"
  ],
  "removePorts": [
    "string"
  ],
  "portVlans": [
    { … }
  ],
  "portAddVlans": [
    { … }
  ],
  "lastName": "string",
  "realRemove": true,
  "defaultVlanId": "string",
  "originalUntaggedVlan": "string",
  "lagViewList": [
    {}
  ]
}

Delete LAGDeprecated

Request

Delete switch's LAG setting.

Security
jwtAuth
Path
lagIdstringrequired
No request payload

Responses

OK

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Get LAGsDeprecated

Request

List of switch's LAG settings.

Security
jwtAuth
Path
switchIdstringrequired
No request payload

Responses

OK

Body
idstring
lagIdinteger(int32)
namestring^(?:(?!").){1,64}$
typestring
Enum"static""dynamic"
portsArray of stringsunique
taggedVlansArray of stringsunique
untaggedVlanstring
switchIdstring
tenantIdstring
addPortsArray of strings
removePortsArray of strings
portVlansArray of objects(LagPortVlanBo)
portAddVlansArray of objects(LagPortVlanBo)
lastNamestring
realRemoveboolean
defaultVlanIdstring
originalUntaggedVlanstring
lagViewListArray of objects(LagView)
Response
{
  "id": "string",
  "lagId": 0,
  "name": "string",
  "type": "static",
  "ports": [
    "string"
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "switchId": "string",
  "tenantId": "string",
  "addPorts": [
    "string"
  ],
  "removePorts": [
    "string"
  ],
  "portVlans": [
    { … }
  ],
  "portAddVlans": [
    { … }
  ],
  "lastName": "string",
  "realRemove": true,
  "defaultVlanId": "string",
  "originalUntaggedVlan": "string",
  "lagViewList": [
    {}
  ]
}

Add LAGsDeprecated

Request

Add switch's multiple LAG settings.

Security
jwtAuth
Path
switchIdstringrequired
Body
requiredArray [
idstring
lagIdinteger(int32)
namestring^(?:(?!").){1,64}$
typestring
Enum"static""dynamic"
portsArray of stringsunique
taggedVlansArray of stringsunique
untaggedVlanstring
switchIdstring
addPortsArray of strings
removePortsArray of strings
portVlansArray of objects(LagPortVlanBo)
portAddVlansArray of objects(LagPortVlanBo)
lastNamestring
defaultVlanIdstring
originalUntaggedVlanstring
forceUpPortstring
dynamicLagboolean
]
[
  {
    "id": "string",
    "lagId": 0,
    "name": "string",
    "type": "static",
    "ports": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "switchId": "string",
    "addPorts": [ … ],
    "removePorts": [ … ],
    "portVlans": [ … ],
    "portAddVlans": [ … ],
    "lastName": "string",
    "defaultVlanId": "string",
    "originalUntaggedVlan": "string",
    "forceUpPort": "string",
    "dynamicLag": true
  }
]

Responses

OK

Body
idstring
lagIdinteger(int32)
namestring^(?:(?!").){1,64}$
typestring
Enum"static""dynamic"
portsArray of stringsunique
taggedVlansArray of stringsunique
untaggedVlanstring
switchIdstring
tenantIdstring
addPortsArray of strings
removePortsArray of strings
portVlansArray of objects(LagPortVlanBo)
portAddVlansArray of objects(LagPortVlanBo)
lastNamestring
realRemoveboolean
defaultVlanIdstring
originalUntaggedVlanstring
lagViewListArray of objects(LagView)
Response
{
  "id": "string",
  "lagId": 0,
  "name": "string",
  "type": "static",
  "ports": [
    "string"
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "switchId": "string",
  "tenantId": "string",
  "addPorts": [
    "string"
  ],
  "removePorts": [
    "string"
  ],
  "portVlans": [
    { … }
  ],
  "portAddVlans": [
    { … }
  ],
  "lastName": "string",
  "realRemove": true,
  "defaultVlanId": "string",
  "originalUntaggedVlan": "string",
  "lagViewList": [
    {}
  ]
}

Delete LAGsDeprecated

Request

Delete switch's multiple LAG settings.

Security
jwtAuth
Body
requiredArray [
string
]
[
  "string"
]

Responses

OK

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Profile

Manage switch profiles.

Operations

Profile ACL

Manage ACL (access control list) of switch profile.

Operations

Profile Template

Manage switch profile templates.

Operations

Profile VLAN

Manage VLANs (virtual local area networks) of switch profile.

Operations

Switch Access Control List

Manage ACLs (access control lists).

Operations

Switch Configuration Backup

Manage configuration backups.

Operations

Switch Firmware Upgrade

Manage firmware upgrade.

Operations

Switch Ports

Manage Ports.

Operations

Switch Static Routes

Manage static routes.

Operations

Switch VLAN

Manage VLANs (virtual local area networks).

Operations

Switch Virtual Ethernet

Manage VE (virtual ethernet) port settings.

Operations

Trusted Port

Manage a port's trust settings.

Operations

Venue Switch Setting

Manage a switch's venue-level settings.

Operations

Venue Template AAA Server

Manage Venue Template AAA (authentication, authorization, and accounting) Servers.

Operations

Venue Template AAA Setting

Manage Venue Template AAA (authentication, authorization, and accounting) Settings.

Operations