Skip to content

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

Get Ports

Request

Get switch's port settings by switch id.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
No request payload

Responses

OK

Body
Array [
idstring
portsArray of stringsunique
namestring
ignoreFieldsstring
revertboolean
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeBudgetnumber(float)
poePriorityinteger(int32)
poeEnableboolean
poeCapabilityboolean
portEnableboolean
portProtectedboolean
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
rstpAdminEdgePortboolean
stpBpduGuardboolean
stpRootGuardboolean
ipsgboolean
lldpEnableboolean
lldpQosArray of objects(LldpQosViewV1001)unique
taggedVlansArray of stringsunique
untaggedVlanstring
voiceVlaninteger(int32)
ingressAclstring
egressAclstring
vsixIngressAclstring
vsixEgressAclstring
tagsstring
flexibleAuthenticationEnabledboolean
authenticationCustomizeboolean
authenticationProfileIdstring
authenticationTypestring
Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
changeAuthOrderboolean
dot1xPortControlstring
Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)
restrictedVlaninteger(int32)
criticalVlaninteger(int32)
guestVlaninteger(int32)
authFailActionstring
Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring
Enum"__NULL""none""failure""success""critical_vlan"
shouldAlertAaaAndRadiusNotApplyboolean
switchLevelAuthDefaultVlaninteger(int32)
profileAuthDefaultVlaninteger(int32)
enableAuthPortsArray of strings
switchMacstring
profileNamestring
switchPortProfileIdstring
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
portSecurityboolean
portSecurityMaxEntriesinteger(int32)
switchMacAclstring
poeSchedulerobject(SchedulerViewV1000)
]
Response
[
  {
    "id": "string",
    "ports": [ … ],
    "name": "string",
    "ignoreFields": "string",
    "revert": true,
    "portSpeed": "__NULL",
    "poeClass": "__NULL",
    "poeBudget": 0.1,
    "poePriority": 0,
    "poeEnable": true,
    "poeCapability": true,
    "portEnable": true,
    "portProtected": true,
    "dhcpSnoopingTrust": true,
    "arpInspectionTrust": true,
    "rstpAdminEdgePort": true,
    "stpBpduGuard": true,
    "stpRootGuard": true,
    "ipsg": true,
    "lldpEnable": true,
    "lldpQos": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "voiceVlan": 0,
    "ingressAcl": "string",
    "egressAcl": "string",
    "vsixIngressAcl": "string",
    "vsixEgressAcl": "string",
    "tags": "string",
    "flexibleAuthenticationEnabled": true,
    "authenticationCustomize": true,
    "authenticationProfileId": "string",
    "authenticationType": "__NULL",
    "changeAuthOrder": true,
    "dot1xPortControl": "__NULL",
    "authDefaultVlan": 0,
    "restrictedVlan": 0,
    "criticalVlan": 0,
    "guestVlan": 0,
    "authFailAction": "__NULL",
    "authTimeoutAction": "__NULL",
    "shouldAlertAaaAndRadiusNotApply": true,
    "switchLevelAuthDefaultVlan": 0,
    "profileAuthDefaultVlan": 0,
    "enableAuthPorts": [ … ],
    "switchMac": "string",
    "profileName": "string",
    "switchPortProfileId": "string",
    "adminPtToPt": "AUTO",
    "portSecurity": true,
    "portSecurityMaxEntries": 0,
    "switchMacAcl": "string",
    "poeScheduler": { … }
  }
]

Update Port

Request

Update switch's port setting. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
switchIdstringrequired
Body
required
idstring
portsArray of stringsunique
namestring
ignoreFieldsstring
revertboolean
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeBudgetnumber(float)
poePriorityinteger(int32)
poeEnableboolean
poeCapabilityboolean
portEnableboolean
portProtectedboolean
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
rstpAdminEdgePortboolean
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
stpBpduGuardboolean
stpRootGuardboolean
ipsgboolean
lldpEnableboolean
lldpQosArray of objects(LldpQosViewV1001)unique
taggedVlansArray of stringsunique
untaggedVlanstring
voiceVlaninteger(int32)[ 1 .. 4095 ]
ingressAclstring
egressAclstring
tagsstring
flexibleAuthenticationEnabledboolean
authenticationTypestring
Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
authenticationCustomizeboolean
authenticationProfileIdstring
changeAuthOrderboolean
dot1xPortControlstring
Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)[ 1 .. 4095 ]
restrictedVlaninteger(int32)[ 1 .. 4095 ]
criticalVlaninteger(int32)[ 1 .. 4095 ]
guestVlaninteger(int32)[ 1 .. 4095 ]
authFailActionstring
Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring
Enum"__NULL""none""failure""success""critical_vlan"
switchPortProfileIdstring
portSecurityboolean
portSecurityMaxEntriesinteger(int32)
switchMacAclstring
poeSchedulerobject(SchedulerViewV1000)
{
  "id": "string",
  "ports": [
    "string"
  ],
  "name": "string",
  "ignoreFields": "string",
  "revert": true,
  "portSpeed": "__NULL",
  "poeClass": "__NULL",
  "poeBudget": 0.1,
  "poePriority": 0,
  "poeEnable": true,
  "poeCapability": true,
  "portEnable": true,
  "portProtected": true,
  "dhcpSnoopingTrust": true,
  "arpInspectionTrust": true,
  "rstpAdminEdgePort": true,
  "adminPtToPt": "AUTO",
  "stpBpduGuard": true,
  "stpRootGuard": true,
  "ipsg": true,
  "lldpEnable": true,
  "lldpQos": [
    { … }
  ],
  "taggedVlans": [
    "string"
  ],
  "untaggedVlan": "string",
  "voiceVlan": 1,
  "ingressAcl": "string",
  "egressAcl": "string",
  "tags": "string",
  "flexibleAuthenticationEnabled": true,
  "authenticationType": "__NULL",
  "authenticationCustomize": true,
  "authenticationProfileId": "string",
  "changeAuthOrder": true,
  "dot1xPortControl": "__NULL",
  "authDefaultVlan": 1,
  "restrictedVlan": 1,
  "criticalVlan": 1,
  "guestVlan": 1,
  "authFailAction": "__NULL",
  "authTimeoutAction": "__NULL",
  "switchPortProfileId": "string",
  "portSecurity": true,
  "portSecurityMaxEntries": 0,
  "switchMacAcl": "string",
  "poeScheduler": {
    "id": "string",
    "type": "NO_SCHEDULE",
    "mon": "string",
    "tue": "string",
    "wed": "string",
    "thu": "string",
    "fri": "string",
    "sat": "string",
    "sun": "string"
  }
}

Responses

OK

Body
requestIdstring
responseobject(PortViewV1001)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "ports": [ … ],
    "name": "string",
    "ignoreFields": "string",
    "revert": true,
    "portSpeed": "__NULL",
    "poeClass": "__NULL",
    "poeBudget": 0.1,
    "poePriority": 0,
    "poeEnable": true,
    "poeCapability": true,
    "portEnable": true,
    "portProtected": true,
    "dhcpSnoopingTrust": true,
    "arpInspectionTrust": true,
    "rstpAdminEdgePort": true,
    "stpBpduGuard": true,
    "stpRootGuard": true,
    "ipsg": true,
    "lldpEnable": true,
    "lldpQos": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "voiceVlan": 0,
    "ingressAcl": "string",
    "egressAcl": "string",
    "vsixIngressAcl": "string",
    "vsixEgressAcl": "string",
    "tags": "string",
    "flexibleAuthenticationEnabled": true,
    "authenticationCustomize": true,
    "authenticationProfileId": "string",
    "authenticationType": "__NULL",
    "changeAuthOrder": true,
    "dot1xPortControl": "__NULL",
    "authDefaultVlan": 0,
    "restrictedVlan": 0,
    "criticalVlan": 0,
    "guestVlan": 0,
    "authFailAction": "__NULL",
    "authTimeoutAction": "__NULL",
    "shouldAlertAaaAndRadiusNotApply": true,
    "switchLevelAuthDefaultVlan": 0,
    "profileAuthDefaultVlan": 0,
    "enableAuthPorts": [ … ],
    "switchMac": "string",
    "profileName": "string",
    "switchPortProfileId": "string",
    "adminPtToPt": "AUTO",
    "portSecurity": true,
    "portSecurityMaxEntries": 0,
    "switchMacAcl": "string",
    "poeScheduler": { … }
  }
}

Get Ports

Request

Get switch's port settings with port ids.

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

Responses

OK

Body
Array [
idstring
portsArray of stringsunique
namestring
ignoreFieldsstring
revertboolean
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeBudgetnumber(float)
poePriorityinteger(int32)
poeEnableboolean
poeCapabilityboolean
portEnableboolean
portProtectedboolean
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
rstpAdminEdgePortboolean
stpBpduGuardboolean
stpRootGuardboolean
ipsgboolean
lldpEnableboolean
lldpQosArray of objects(LldpQosViewV1001)unique
taggedVlansArray of stringsunique
untaggedVlanstring
voiceVlaninteger(int32)
ingressAclstring
egressAclstring
vsixIngressAclstring
vsixEgressAclstring
tagsstring
flexibleAuthenticationEnabledboolean
authenticationCustomizeboolean
authenticationProfileIdstring
authenticationTypestring
Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
changeAuthOrderboolean
dot1xPortControlstring
Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)
restrictedVlaninteger(int32)
criticalVlaninteger(int32)
guestVlaninteger(int32)
authFailActionstring
Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring
Enum"__NULL""none""failure""success""critical_vlan"
shouldAlertAaaAndRadiusNotApplyboolean
switchLevelAuthDefaultVlaninteger(int32)
profileAuthDefaultVlaninteger(int32)
enableAuthPortsArray of strings
switchMacstring
profileNamestring
switchPortProfileIdstring
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
portSecurityboolean
portSecurityMaxEntriesinteger(int32)
switchMacAclstring
poeSchedulerobject(SchedulerViewV1000)
]
Response
[
  {
    "id": "string",
    "ports": [ … ],
    "name": "string",
    "ignoreFields": "string",
    "revert": true,
    "portSpeed": "__NULL",
    "poeClass": "__NULL",
    "poeBudget": 0.1,
    "poePriority": 0,
    "poeEnable": true,
    "poeCapability": true,
    "portEnable": true,
    "portProtected": true,
    "dhcpSnoopingTrust": true,
    "arpInspectionTrust": true,
    "rstpAdminEdgePort": true,
    "stpBpduGuard": true,
    "stpRootGuard": true,
    "ipsg": true,
    "lldpEnable": true,
    "lldpQos": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "voiceVlan": 0,
    "ingressAcl": "string",
    "egressAcl": "string",
    "vsixIngressAcl": "string",
    "vsixEgressAcl": "string",
    "tags": "string",
    "flexibleAuthenticationEnabled": true,
    "authenticationCustomize": true,
    "authenticationProfileId": "string",
    "authenticationType": "__NULL",
    "changeAuthOrder": true,
    "dot1xPortControl": "__NULL",
    "authDefaultVlan": 0,
    "restrictedVlan": 0,
    "criticalVlan": 0,
    "guestVlan": 0,
    "authFailAction": "__NULL",
    "authTimeoutAction": "__NULL",
    "shouldAlertAaaAndRadiusNotApply": true,
    "switchLevelAuthDefaultVlan": 0,
    "profileAuthDefaultVlan": 0,
    "enableAuthPorts": [ … ],
    "switchMac": "string",
    "profileName": "string",
    "switchPortProfileId": "string",
    "adminPtToPt": "AUTO",
    "portSecurity": true,
    "portSecurityMaxEntries": 0,
    "switchMacAcl": "string",
    "poeScheduler": { … }
  }
]

Update Ports

Request

Update ports of different switches. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
Body
requiredArray [
idstring
portsArray of stringsunique
namestring
ignoreFieldsstring
revertboolean
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeBudgetnumber(float)
poePriorityinteger(int32)
poeEnableboolean
poeCapabilityboolean
portEnableboolean
portProtectedboolean
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
rstpAdminEdgePortboolean
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
stpBpduGuardboolean
stpRootGuardboolean
ipsgboolean
lldpEnableboolean
lldpQosArray of objects(LldpQosViewV1001)unique
taggedVlansArray of stringsunique
untaggedVlanstring
voiceVlaninteger(int32)[ 1 .. 4095 ]
ingressAclstring
egressAclstring
tagsstring
flexibleAuthenticationEnabledboolean
authenticationTypestring
Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
authenticationCustomizeboolean
authenticationProfileIdstring
changeAuthOrderboolean
dot1xPortControlstring
Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)[ 1 .. 4095 ]
restrictedVlaninteger(int32)[ 1 .. 4095 ]
criticalVlaninteger(int32)[ 1 .. 4095 ]
guestVlaninteger(int32)[ 1 .. 4095 ]
authFailActionstring
Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring
Enum"__NULL""none""failure""success""critical_vlan"
switchIdstringrequired
switchPortProfileIdstring
portSecurityboolean
portSecurityMaxEntriesinteger(int32)
switchMacAclstring
poeSchedulerobject(SchedulerViewV1000)
]
[
  {
    "id": "string",
    "ports": [ … ],
    "name": "string",
    "ignoreFields": "string",
    "revert": true,
    "portSpeed": "__NULL",
    "poeClass": "__NULL",
    "poeBudget": 0.1,
    "poePriority": 0,
    "poeEnable": true,
    "poeCapability": true,
    "portEnable": true,
    "portProtected": true,
    "dhcpSnoopingTrust": true,
    "arpInspectionTrust": true,
    "rstpAdminEdgePort": true,
    "adminPtToPt": "AUTO",
    "stpBpduGuard": true,
    "stpRootGuard": true,
    "ipsg": true,
    "lldpEnable": true,
    "lldpQos": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "voiceVlan": 1,
    "ingressAcl": "string",
    "egressAcl": "string",
    "tags": "string",
    "flexibleAuthenticationEnabled": true,
    "authenticationType": "__NULL",
    "authenticationCustomize": true,
    "authenticationProfileId": "string",
    "changeAuthOrder": true,
    "dot1xPortControl": "__NULL",
    "authDefaultVlan": 1,
    "restrictedVlan": 1,
    "criticalVlan": 1,
    "guestVlan": 1,
    "authFailAction": "__NULL",
    "authTimeoutAction": "__NULL",
    "switchId": "string",
    "switchPortProfileId": "string",
    "portSecurity": true,
    "portSecurityMaxEntries": 0,
    "switchMacAcl": "string",
    "poeScheduler": { … }
  }
]

Responses

OK

Body
requestIdstring
responseobject(PortViewV1001)
Response
{
  "requestId": "string",
  "response": {
    "id": "string",
    "ports": [ … ],
    "name": "string",
    "ignoreFields": "string",
    "revert": true,
    "portSpeed": "__NULL",
    "poeClass": "__NULL",
    "poeBudget": 0.1,
    "poePriority": 0,
    "poeEnable": true,
    "poeCapability": true,
    "portEnable": true,
    "portProtected": true,
    "dhcpSnoopingTrust": true,
    "arpInspectionTrust": true,
    "rstpAdminEdgePort": true,
    "stpBpduGuard": true,
    "stpRootGuard": true,
    "ipsg": true,
    "lldpEnable": true,
    "lldpQos": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "voiceVlan": 0,
    "ingressAcl": "string",
    "egressAcl": "string",
    "vsixIngressAcl": "string",
    "vsixEgressAcl": "string",
    "tags": "string",
    "flexibleAuthenticationEnabled": true,
    "authenticationCustomize": true,
    "authenticationProfileId": "string",
    "authenticationType": "__NULL",
    "changeAuthOrder": true,
    "dot1xPortControl": "__NULL",
    "authDefaultVlan": 0,
    "restrictedVlan": 0,
    "criticalVlan": 0,
    "guestVlan": 0,
    "authFailAction": "__NULL",
    "authTimeoutAction": "__NULL",
    "shouldAlertAaaAndRadiusNotApply": true,
    "switchLevelAuthDefaultVlan": 0,
    "profileAuthDefaultVlan": 0,
    "enableAuthPorts": [ … ],
    "switchMac": "string",
    "profileName": "string",
    "switchPortProfileId": "string",
    "adminPtToPt": "AUTO",
    "portSecurity": true,
    "portSecurityMaxEntries": 0,
    "switchMacAcl": "string",
    "poeScheduler": { … }
  }
}

Get Ports

Request

Get port settings of different switches.

Security
jwtAuth
Path
venueIdstringrequired
Body
requiredArray [
switchIdstring
portsArray of stringsunique
]
[
  {
    "switchId": "string",
    "ports": [ … ]
  }
]

Responses

OK

Body
Array [
idstring
portsArray of stringsunique
namestring
ignoreFieldsstring
revertboolean
portSpeedstring
Enum"__NULL""UNSET""NONE""AUTO""TEN_M_FULL""TEN_M_HALF""ONE_HUNDRED_M_FULL""ONE_HUNDRED_M_HALF""ONE_G_FULL""ONE_G_FULL_MASTER"
poeClassstring
Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeBudgetnumber(float)
poePriorityinteger(int32)
poeEnableboolean
poeCapabilityboolean
portEnableboolean
portProtectedboolean
dhcpSnoopingTrustboolean
arpInspectionTrustboolean
rstpAdminEdgePortboolean
stpBpduGuardboolean
stpRootGuardboolean
ipsgboolean
lldpEnableboolean
lldpQosArray of objects(LldpQosViewV1001)unique
taggedVlansArray of stringsunique
untaggedVlanstring
voiceVlaninteger(int32)
ingressAclstring
egressAclstring
vsixIngressAclstring
vsixEgressAclstring
tagsstring
flexibleAuthenticationEnabledboolean
authenticationCustomizeboolean
authenticationProfileIdstring
authenticationTypestring
Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
changeAuthOrderboolean
dot1xPortControlstring
Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)
restrictedVlaninteger(int32)
criticalVlaninteger(int32)
guestVlaninteger(int32)
authFailActionstring
Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring
Enum"__NULL""none""failure""success""critical_vlan"
shouldAlertAaaAndRadiusNotApplyboolean
switchLevelAuthDefaultVlaninteger(int32)
profileAuthDefaultVlaninteger(int32)
enableAuthPortsArray of strings
switchMacstring
profileNamestring
switchPortProfileIdstring
adminPtToPtstring
Enum"AUTO""DISABLE""ENABLE"
portSecurityboolean
portSecurityMaxEntriesinteger(int32)
switchMacAclstring
poeSchedulerobject(SchedulerViewV1000)
]
Response
[
  {
    "id": "string",
    "ports": [ … ],
    "name": "string",
    "ignoreFields": "string",
    "revert": true,
    "portSpeed": "__NULL",
    "poeClass": "__NULL",
    "poeBudget": 0.1,
    "poePriority": 0,
    "poeEnable": true,
    "poeCapability": true,
    "portEnable": true,
    "portProtected": true,
    "dhcpSnoopingTrust": true,
    "arpInspectionTrust": true,
    "rstpAdminEdgePort": true,
    "stpBpduGuard": true,
    "stpRootGuard": true,
    "ipsg": true,
    "lldpEnable": true,
    "lldpQos": [ … ],
    "taggedVlans": [ … ],
    "untaggedVlan": "string",
    "voiceVlan": 0,
    "ingressAcl": "string",
    "egressAcl": "string",
    "vsixIngressAcl": "string",
    "vsixEgressAcl": "string",
    "tags": "string",
    "flexibleAuthenticationEnabled": true,
    "authenticationCustomize": true,
    "authenticationProfileId": "string",
    "authenticationType": "__NULL",
    "changeAuthOrder": true,
    "dot1xPortControl": "__NULL",
    "authDefaultVlan": 0,
    "restrictedVlan": 0,
    "criticalVlan": 0,
    "guestVlan": 0,
    "authFailAction": "__NULL",
    "authTimeoutAction": "__NULL",
    "shouldAlertAaaAndRadiusNotApply": true,
    "switchLevelAuthDefaultVlan": 0,
    "profileAuthDefaultVlan": 0,
    "enableAuthPorts": [ … ],
    "switchMac": "string",
    "profileName": "string",
    "switchPortProfileId": "string",
    "adminPtToPt": "AUTO",
    "portSecurity": true,
    "portSecurityMaxEntries": 0,
    "switchMacAcl": "string",
    "poeScheduler": { … }
  }
]

Power Cycle Port

Request

Power cycle switch's port. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
Body
requiredArray [
switchIdstring
portsArray of stringsunique
]
[
  {
    "switchId": "string",
    "ports": [ … ]
  }
]

Responses

OK

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

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

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