Skip to content
/
Retrieve Virtual Ethernet...

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 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

Get Virtual Ethernet Setting

Request

Get a specified virtual ethernet port.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
vePortIdstringrequired
No request payload

Responses

OK

Body
idstring
veIdinteger(int32)
vlanIdinteger(int32)
namestring^(?:(?!").){1,64}$
ospfAreastring
dhcpRelayAgentstring
ipAddressTypestring
Enum"static""dynamic"
ipAddressstring
ipSubnetMaskstring
ingressAclNamestring
egressAclNamestring
connectedVeboolean
switchIdstring
switchNamestring
deviceStatusstring
syncedSwitchConfigboolean
vsixIngressAclNamestring
vsixEgressAclNamestring
Response
{
  "id": "string",
  "veId": 0,
  "vlanId": 0,
  "name": "string",
  "ospfArea": "string",
  "dhcpRelayAgent": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "ipSubnetMask": "string",
  "ingressAclName": "string",
  "egressAclName": "string",
  "connectedVe": true,
  "switchId": "string",
  "switchName": "string",
  "deviceStatus": "string",
  "syncedSwitchConfig": true,
  "vsixIngressAclName": "string",
  "vsixEgressAclName": "string"
}

Update Virtual Ethernet Setting

Request

Update virtual ethernet port.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
vePortIdstringrequired
Body
required
veIdinteger(int32)
vlanIdinteger(int32)
namestring
ospfAreastring
dhcpRelayAgentstring
ipAddressTypestring
Enum"static""dynamic"
ipAddressstring
ipSubnetMaskstring
ingressAclstring
egressAclstring
{
  "veId": 0,
  "vlanId": 0,
  "name": "string",
  "ospfArea": "string",
  "dhcpRelayAgent": "string",
  "ipAddressType": "static",
  "ipAddress": "string",
  "ipSubnetMask": "string",
  "ingressAcl": "string",
  "egressAcl": "string"
}

Responses

OK

Body
requestIdstring
responseobject(VePortViewV1001)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "veId": 0,
    "vlanId": 0,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAclName": "string",
    "egressAclName": "string",
    "connectedVe": true,
    "switchId": "string",
    "switchName": "string",
    "deviceStatus": "string",
    "syncedSwitchConfig": true,
    "vsixIngressAclName": "string",
    "vsixEgressAclName": "string"
  }
}

Delete Virtual Ethernet Setting

Request

Delete virtual ethernet port.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
vePortIdstringrequired
No request payload

Responses

OK

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

Retrieve Virtual Ethernet Settings

Request

Retrieve virtual ethernet ports of venue by query.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
filtersobject
filterTypestringDeprecated
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "filterType": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Body
idstring
dataArray of objects
fieldsArray of strings
pageinteger(int32)
totalCountinteger(int64)
totalPagesinteger(int32)
Response
{
  "id": "string",
  "data": [
    {}
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

Retrieve Virtual Ethernet Settings

Request

Retrieve virtual ethernet ports of the specified switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
No request payload

Responses

OK

Body
Array [
idstring
veIdinteger(int32)
vlanIdinteger(int32)
namestring^(?:(?!").){1,64}$
ospfAreastring
dhcpRelayAgentstring
ipAddressTypestring
Enum"static""dynamic"
ipAddressstring
ipSubnetMaskstring
ingressAclNamestring
egressAclNamestring
connectedVeboolean
switchIdstring
switchNamestring
deviceStatusstring
syncedSwitchConfigboolean
vsixIngressAclNamestring
vsixEgressAclNamestring
]
Response
[
  {
    "id": "string",
    "veId": 0,
    "vlanId": 0,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAclName": "string",
    "egressAclName": "string",
    "connectedVe": true,
    "switchId": "string",
    "switchName": "string",
    "deviceStatus": "string",
    "syncedSwitchConfig": true,
    "vsixIngressAclName": "string",
    "vsixEgressAclName": "string"
  }
]

Add Virtual Ethernet Settings

Request

Add virtual ethernet ports of the switch.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
requiredArray [
veIdinteger(int32)
vlanIdinteger(int32)
namestring
ospfAreastring
dhcpRelayAgentstring
ipAddressTypestring
Enum"static""dynamic"
ipAddressstring
ipSubnetMaskstring
ingressAclstring
egressAclstring
]
[
  {
    "veId": 0,
    "vlanId": 0,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAcl": "string",
    "egressAcl": "string"
  }
]

Responses

Created

Body
requestIdstring
responseobject(VePortViewV1001)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "veId": 0,
    "vlanId": 0,
    "name": "string",
    "ospfArea": "string",
    "dhcpRelayAgent": "string",
    "ipAddressType": "static",
    "ipAddress": "string",
    "ipSubnetMask": "string",
    "ingressAclName": "string",
    "egressAclName": "string",
    "connectedVe": true,
    "switchId": "string",
    "switchName": "string",
    "deviceStatus": "string",
    "syncedSwitchConfig": true,
    "vsixIngressAclName": "string",
    "vsixEgressAclName": "string"
  }
}

Delete Virtual Ethernet Settings

Request

Delete multiple virtual ethernet ports.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
requiredArray [
string
]
[
  "string"
]

Responses

OK

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

Retrieve Virtual Ethernet Settings

Request

Retrieve virtual ethernet ports of switch by query.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
filtersobject
filterTypestringDeprecated
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "filterType": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Body
idstring
dataArray of objects
fieldsArray of strings
pageinteger(int32)
totalCountinteger(int64)
totalPagesinteger(int32)
Response
{
  "id": "string",
  "data": [
    {}
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

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

Venue Template Switch Setting

Manage switch settings of venue template.

Operations

Web Authentication Page Template

Manage web authentication page template.

Operations