Skip to content
/
Retrieve VLANs

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

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

Get Profile VLANDeprecated

Request

Get the specified VLAN of the switch profile.

Security
jwtAuth
Path
switchProfileIdstringrequired
vlanIdstringrequired
No request payload

Responses

OK

Body
idstring
vlanIdinteger(int32)
vlanNamestring
rootBridgeFamilyIdstring
Enum"__NULL""ICX7150""ICX7250""ICX7650""ICX7850""ICX7550""ICX8200""ICX8100"
ipv4DhcpSnoopingboolean
ipv4DhcpSnoopingTrustPortstring
arpInspectionboolean
arpInspectionTrustPortstring
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)
spanningTreeProtocolstring
Enum"rstp""stp""none"
spanningTreePriorityinteger(int32)
switchFamilyModelsArray of objects(SwitchFamilyModelView)unique
Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "rootBridgeFamilyId": "__NULL",
  "ipv4DhcpSnooping": true,
  "ipv4DhcpSnoopingTrustPort": "string",
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "spanningTreePriority": 0,
  "switchFamilyModels": [
    { … }
  ]
}

Update VLANDeprecated

Request

Update the VLAN of the switch profile.

Security
jwtAuth
Path
switchProfileIdstringrequired
vlanIdinteger(int32)required
Body
required
idstring
vlanIdinteger(int32)[ 1 .. 4095 ]required
vlanNamestring
rootBridgeFamilyIdstring
Enum"__NULL""ICX7150""ICX7250""ICX7650""ICX7850""ICX7550""ICX8200""ICX8100"
ipv4DhcpSnoopingboolean
ipv4DhcpSnoopingTrustPortstring
ipv4DhcpSnoopingTrustPortListArray of strings
arpInspectionboolean
arpInspectionTrustPortstring
arpInspectionTrustPortListArray of strings
arpTrustPortsListArray of strings
dhcpTrustPortsListArray of strings
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)[ 0 .. 3 ]
spanningTreeProtocolstring
Enum"rstp""stp""none"
spanningTreePriorityinteger(int32)[ 0 .. 65535 ]
switchFamilyModelsArray of objects(SwitchFamilyModelBo)unique
managementVlanboolean
switchVlanPortModelsArray of objects(SwitchVlanPortModelBo)unique
switchIdstring
enableAsDefaultVlanbooleanrequired
deleteVlanEnabledboolean
dummyVlanboolean
switchVlanPortModelobject(SwitchVlanPortModelBo)
rapidSpanningTreeProtocolboolean
taggedPortsListArray of strings
untaggedPortsListArray of strings
notDummyVlanboolean
defaultVlanboolean
igmpSnoopingTypeChangedboolean
{
  "id": "string",
  "vlanId": 1,
  "vlanName": "string",
  "rootBridgeFamilyId": "__NULL",
  "ipv4DhcpSnooping": true,
  "ipv4DhcpSnoopingTrustPort": "string",
  "ipv4DhcpSnoopingTrustPortList": [
    "string"
  ],
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "arpInspectionTrustPortList": [
    "string"
  ],
  "arpTrustPortsList": [
    "string"
  ],
  "dhcpTrustPortsList": [
    "string"
  ],
  "igmpSnooping": "active",
  "multicastVersion": 3,
  "spanningTreeProtocol": "rstp",
  "spanningTreePriority": 65535,
  "switchFamilyModels": [
    { … }
  ],
  "managementVlan": true,
  "switchVlanPortModels": [
    { … }
  ],
  "switchId": "string",
  "enableAsDefaultVlan": true,
  "deleteVlanEnabled": true,
  "dummyVlan": true,
  "switchVlanPortModel": {
    "id": "string",
    "switchModel": "ICX7150-24",
    "taggedPorts": "string",
    "untaggedPorts": "string",
    "voicePorts": "string",
    "taggedPortsList": [ … ],
    "untaggedPortsList": [ … ],
    "voicePortsList": [ … ]
  },
  "rapidSpanningTreeProtocol": true,
  "taggedPortsList": [
    "string"
  ],
  "untaggedPortsList": [
    "string"
  ],
  "notDummyVlan": true,
  "defaultVlan": true,
  "igmpSnoopingTypeChanged": true
}

Responses

OK

Body
idstring
vlanIdinteger(int32)
vlanNamestring
rootBridgeFamilyIdstring
Enum"__NULL""ICX7150""ICX7250""ICX7650""ICX7850""ICX7550""ICX8200""ICX8100"
ipv4DhcpSnoopingboolean
ipv4DhcpSnoopingTrustPortstring
arpInspectionboolean
arpInspectionTrustPortstring
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)
spanningTreeProtocolstring
Enum"rstp""stp""none"
spanningTreePriorityinteger(int32)
switchFamilyModelsArray of objects(SwitchFamilyModelView)unique
Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "rootBridgeFamilyId": "__NULL",
  "ipv4DhcpSnooping": true,
  "ipv4DhcpSnoopingTrustPort": "string",
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "spanningTreePriority": 0,
  "switchFamilyModels": [
    { … }
  ]
}

Delete Profile VLANDeprecated

Request

Delete the specified VLAN of the switch profile.

Security
jwtAuth
Path
switchProfileIdstringrequired
vlanIdstringrequired
No request payload

Responses

OK

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

Get VLANsDeprecated

Request

List all of VLANs in profiles with the specified venue and the specific model.

Security
jwtAuth
Path
venueIdstringrequired
Query
modelstringrequired
No request payload

Responses

OK

Body
idstring
vlanIdinteger(int32)
vlanNamestring
rootBridgeFamilyIdstring
Enum"__NULL""ICX7150""ICX7250""ICX7650""ICX7850""ICX7550""ICX8200""ICX8100"
ipv4DhcpSnoopingboolean
ipv4DhcpSnoopingTrustPortstring
arpInspectionboolean
arpInspectionTrustPortstring
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)
spanningTreeProtocolstring
Enum"rstp""stp""none"
spanningTreePriorityinteger(int32)
switchFamilyModelsArray of objects(SwitchFamilyModelView)unique
Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "rootBridgeFamilyId": "__NULL",
  "ipv4DhcpSnooping": true,
  "ipv4DhcpSnoopingTrustPort": "string",
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "spanningTreePriority": 0,
  "switchFamilyModels": [
    { … }
  ]
}

Retrieve Untagged-VLANsDeprecated

Request

List of venues switch-profile VLANs with specific model and untagged port.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
modelstring
Enum"ICX7150-24""ICX7150-24P""ICX7150-48""ICX7150-48P""ICX7150-48PF""ICX7150-48ZP""ICX7150-C12P""ICX7150-C10ZP""ICX7150-C08P""ICX7150-C08PT"
{
  "model": "ICX7150-24"
}

Responses

OK

Body
idstring
vlanIdinteger(int32)
vlanNamestring
rootBridgeFamilyIdstring
Enum"__NULL""ICX7150""ICX7250""ICX7650""ICX7850""ICX7550""ICX8200""ICX8100"
ipv4DhcpSnoopingboolean
ipv4DhcpSnoopingTrustPortstring
arpInspectionboolean
arpInspectionTrustPortstring
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)
spanningTreeProtocolstring
Enum"rstp""stp""none"
spanningTreePriorityinteger(int32)
switchFamilyModelsArray of objects(SwitchFamilyModelView)unique
Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "rootBridgeFamilyId": "__NULL",
  "ipv4DhcpSnooping": true,
  "ipv4DhcpSnoopingTrustPort": "string",
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "spanningTreePriority": 0,
  "switchFamilyModels": [
    { … }
  ]
}

Retrieve Tagged-VLANsDeprecated

Request

List of venues switch-profile VLANs with specific model and tagged port.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
modelstring
Enum"ICX7150-24""ICX7150-24P""ICX7150-48""ICX7150-48P""ICX7150-48PF""ICX7150-48ZP""ICX7150-C12P""ICX7150-C10ZP""ICX7150-C08P""ICX7150-C08PT"
{
  "model": "ICX7150-24"
}

Responses

OK

Body
idstring
vlanIdinteger(int32)
vlanNamestring
rootBridgeFamilyIdstring
Enum"__NULL""ICX7150""ICX7250""ICX7650""ICX7850""ICX7550""ICX8200""ICX8100"
ipv4DhcpSnoopingboolean
ipv4DhcpSnoopingTrustPortstring
arpInspectionboolean
arpInspectionTrustPortstring
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)
spanningTreeProtocolstring
Enum"rstp""stp""none"
spanningTreePriorityinteger(int32)
switchFamilyModelsArray of objects(SwitchFamilyModelView)unique
Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "rootBridgeFamilyId": "__NULL",
  "ipv4DhcpSnooping": true,
  "ipv4DhcpSnoopingTrustPort": "string",
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "spanningTreePriority": 0,
  "switchFamilyModels": [
    { … }
  ]
}

Get Multiple VLANsDeprecated

Request

Get multiple VLANs of the switch profile.

Security
jwtAuth
Path
switchProfileIdstringrequired
Query
pageinteger(int32)
sizeinteger(int32)
No request payload

Responses

OK

Body
idstring
vlanIdinteger(int32)
vlanNamestring
rootBridgeFamilyIdstring
Enum"__NULL""ICX7150""ICX7250""ICX7650""ICX7850""ICX7550""ICX8200""ICX8100"
ipv4DhcpSnoopingboolean
ipv4DhcpSnoopingTrustPortstring
arpInspectionboolean
arpInspectionTrustPortstring
igmpSnoopingstring
Enum"active""passive""none"
multicastVersioninteger(int32)
spanningTreeProtocolstring
Enum"rstp""stp""none"
spanningTreePriorityinteger(int32)
switchFamilyModelsArray of objects(SwitchFamilyModelView)unique
Response
{
  "id": "string",
  "vlanId": 0,
  "vlanName": "string",
  "rootBridgeFamilyId": "__NULL",
  "ipv4DhcpSnooping": true,
  "ipv4DhcpSnoopingTrustPort": "string",
  "arpInspection": true,
  "arpInspectionTrustPort": "string",
  "igmpSnooping": "active",
  "multicastVersion": 0,
  "spanningTreeProtocol": "rstp",
  "spanningTreePriority": 0,
  "switchFamilyModels": [
    { … }
  ]
}

Delete Multiple VLANsDeprecated

Request

Delete multiple VLANs of the switch profile.

Security
jwtAuth
Path
switchProfileIdstringrequired
Bodyapplication/jsonrequiredArray [
string
]
application/json
[
  "string"
]

Responses

OK

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

Retrieve VLANsDeprecated

Request

List all usable VLANs for multiple ports of the same switch.

Security
jwtAuth
Path
switchIdstringrequired
No request payload

Responses

OK

Body
switchDefaultVlanArray of objects(VlanIntersectContent)
profileVlanArray of objects(VlanIntersectContent)
switchVlanArray of objects(VlanIntersectContent)
Response
{
  "switchDefaultVlan": [
    { … }
  ],
  "profileVlan": [
    { … }
  ],
  "switchVlan": [
    { … }
  ]
}

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