Skip to content
Switch Services/
/
Power Cycle Port

Switch Services (0.4.0)

Overview

The Switch Service REST API facilitates the management and configuration of RUCKUS ICX switches via the RUCKUS One platform. This API allows for programmatic control of switch operations, network configurations, security policies, and monitoring across various environments.

What This API Does

  • Manage ICX switch devices and their configurations
  • Configure network settings including VLANs, ports, LAGs, and virtual ethernet interfaces
  • Control security policies with AAA servers, ACLs, and trusted port settings
  • Create and apply switch profiles and templates for consistent configurations
  • Handle firmware upgrades and configuration backups
  • Configure DHCP servers and static routing
  • Import and onboard new switches to the platform
  • Manage CLI templates and web authentication pages

Authentication

All API calls require valid authentication via JWT (JSON Web Token) in Authorization header.

Regional Endpoints

Select the appropriate API endpoint based on your region:

  • North America: https://api.ruckus.cloud
  • Europe: https://api.eu.ruckus.cloud
  • Asia: https://api.asia.ruckus.cloud

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

All endpoints may return these common error responses:

  • 400 Bad Request: Invalid input data or validation errors
  • 401 Unauthorized: Missing or invalid authentication
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Requested resource doesn't exist
  • 422 Unprocessable Entity: Business rule violations
  • 500 Internal Server Error: Unexpected server errors.
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Terms of Service
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.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 switch configuration history records.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX switch settings.

Operations

Import Switch

Import and register new switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Profile

Manage switch profiles and profile configurations.

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 switch configuration backups and restore operations.

Operations

Switch Firmware Upgrade

Manage switch firmware upgrade and scheduling operations.

Operations

Switch Ports

Manage switch port configurations.

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

The set of port identifiers when performing batch operations on multiple ports.

namestring

The descriptive name or label assigned to the port for identification purposes.

ignoreFieldsstring

The comma separated list of field names to ignore during update operations.

revertboolean

The flag indicating whether to revert port configuration to profile defaults.

portSpeedstring

The configured speed setting for the port, such as auto negotiation or specific speed values.

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

The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.

Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeBudgetnumber(float)

The PoE power budget allocated to this port in watts.

poePriorityinteger(int32)

The PoE priority level for power allocation, with lower values indicating higher priority.

poeEnableboolean

The flag indicating whether PoE (Power over Ethernet) is enabled on this port.

poeCapabilityboolean

The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.

portEnableboolean

The flag indicating whether the port is administratively enabled for traffic forwarding.

portProtectedboolean

The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.

dhcpSnoopingTrustboolean

The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.

arpInspectionTrustboolean

The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.

rstpAdminEdgePortboolean

The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).

stpBpduGuardboolean

Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.

stpRootGuardboolean

The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.

ipsgboolean

The flag indicating whether IP source guard is enabled for additional layer 2 security.

lldpEnableboolean

The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.

lldpQosArray of objects(LldpQos_V1_1)unique

The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.

taggedVlansArray of stringsunique

The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.

untaggedVlanstring

The VLAN ID configured as the untagged (native) VLAN for this port.

voiceVlaninteger(int32)

The VLAN ID designated for voice traffic, typically used for VoIP devices.

ingressAclstring

The name of the Access Control List applied to ingress (incoming) traffic on this port.

egressAclstring

The name of the Access Control List applied to egress (outgoing) traffic on this port.

vsixIngressAclstring

The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

vsixEgressAclstring

The name of the VSIX ACL applied to egress traffic for virtual switch integration.

tagsstring

The comma separated list of custom tags assigned to this port for organization and filtering.

flexibleAuthenticationEnabledboolean

The flag indicating whether flexible authentication with multiple methods is enabled on this port.

authenticationCustomizeboolean

The flag indicating whether port specific authentication settings override the profile defaults.

authenticationProfileIdstring

The identifier of the authentication profile applied to this port for access control.

authenticationTypestring

The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.

Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
changeAuthOrderboolean

The flag indicating whether the authentication method order has been modified from defaults.

dot1xPortControlstring

The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.

Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)

The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.

restrictedVlaninteger(int32)

The VLAN ID for users who fail authorization after successful authentication.

criticalVlaninteger(int32)

The VLAN ID for critical users requiring network access during AAA server failure.

guestVlaninteger(int32)

The VLAN ID for guest users who bypass authentication.

authFailActionstring

The action to take when authentication fails: restricted VLAN, drop, or block.

Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring

The action to take when authentication times out: same as auth fail or critical VLAN.

Enum"__NULL""none""failure""success""critical_vlan"
shouldAlertAaaAndRadiusNotApplyboolean

The flag indicating whether to alert users when AAA and RADIUS configurations cannot be applied to the switch.

switchLevelAuthDefaultVlaninteger(int32)

The authentication default VLAN ID configured at the switch level for reference in the UI.

profileAuthDefaultVlaninteger(int32)

The authentication default VLAN ID configured at the profile level for reference in the UI.

enableAuthPortsArray of strings

The list of port identifiers where authentication is enabled, displayed in the UI.

switchMacstring

The MAC address of the switch to which this port belongs, used for UI identification.

profileNamestring

The name of the profile applied to this port, displayed in the UI for reference.

switchPortProfileIdstring

The identifier of the switch port profile configuration applied to this port.

adminPtToPtstring

The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.

Enum"AUTO""DISABLE""ENABLE"
portSecurityboolean

The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.

portSecurityMaxEntriesinteger(int32)

The maximum number of MAC addresses allowed when port security is enabled.

switchMacAclstring

The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.

poeSchedulerobject(Scheduler_V1)

The scheduler configuration for PoE (Power over Ethernet) operations, allowing time-based PoE control.

]
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

The set of port identifiers when performing batch operations on multiple ports.

namestring

The descriptive name or label assigned to the port for identification purposes.

ignoreFieldsstring

The comma separated list of field names to ignore during update operations.

revertboolean

The flag indicating whether to revert port configuration to profile defaults.

portSpeedstring

The configured speed setting for the port, such as auto negotiation or specific speed values.

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

The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.

Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeBudgetnumber(float)

The PoE power budget allocated to this port in watts.

poePriorityinteger(int32)

The PoE priority level for power allocation, with lower values indicating higher priority.

poeEnableboolean

The flag indicating whether PoE (Power over Ethernet) is enabled on this port.

poeCapabilityboolean

The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.

portEnableboolean

The flag indicating whether the port is administratively enabled for traffic forwarding.

portProtectedboolean

The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.

dhcpSnoopingTrustboolean

The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.

arpInspectionTrustboolean

The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.

rstpAdminEdgePortboolean

The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).

adminPtToPtstring

The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.

Enum"AUTO""DISABLE""ENABLE"
stpBpduGuardboolean

Enable STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard to automatically disable the port when BPDU frames are received.

stpRootGuardboolean

The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.

ipsgboolean

The flag indicating whether IP source guard is enabled for additional layer 2 security.

lldpEnableboolean

The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.

lldpQosArray of objects(LldpQos_V1_1)unique

The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.

taggedVlansArray of stringsunique

The set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.

untaggedVlanstring

The VLAN ID configured as the untagged (native) VLAN for this port.

voiceVlaninteger(int32)[ 1 .. 4095 ]

The VLAN ID designated for voice traffic, typically used for VoIP devices.

ingressAclstring

The name of the Access Control List applied to ingress (incoming) traffic on this port.

egressAclstring

The name of the Access Control List applied to egress (outgoing) traffic on this port.

tagsstring

The comma separated list of custom tags assigned to this port for organization and filtering.

flexibleAuthenticationEnabledboolean

The flag indicating whether flexible authentication with multiple methods is enabled on this port.

authenticationTypestring

The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.

Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
authenticationCustomizeboolean

The flag indicating whether port specific authentication settings override the profile defaults.

authenticationProfileIdstring

The identifier of the authentication profile applied to this port for access control.

changeAuthOrderboolean

The flag indicating whether the authentication method order has been modified from defaults.

dot1xPortControlstring

The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.

Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)[ 1 .. 4095 ]

The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.

restrictedVlaninteger(int32)[ 1 .. 4095 ]

The VLAN ID for users who fail authorization after successful authentication.

criticalVlaninteger(int32)[ 1 .. 4095 ]

The VLAN ID for critical users requiring network access during AAA server failure.

guestVlaninteger(int32)[ 1 .. 4095 ]

The VLAN ID for guest users who bypass authentication.

authFailActionstring

The action to take when authentication fails: restricted VLAN, drop, or block.

Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring

The action to take when authentication times out: same as auth fail or critical VLAN.

Enum"__NULL""none""failure""success""critical_vlan"
switchPortProfileIdstring

The identifier of the switch port profile configuration applied to this port.

portSecurityboolean

The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.

portSecurityMaxEntriesinteger(int32)

The maximum number of MAC addresses allowed when port security is enabled.

switchMacAclstring

The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.

poeSchedulerobject(Scheduler_V1)

The scheduler configuration for PoE (Power over Ethernet) operations, allowing time-based PoE control.

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

The unique identifier for tracking this API operation request.

responseobject(Port_V1_1)

The response data containing the result of the operation.

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

The set of port identifiers when performing batch operations on multiple ports.

namestring

The descriptive name or label assigned to the port for identification purposes.

ignoreFieldsstring

The comma separated list of field names to ignore during update operations.

revertboolean

The flag indicating whether to revert port configuration to profile defaults.

portSpeedstring

The configured speed setting for the port, such as auto negotiation or specific speed values.

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

The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.

Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeBudgetnumber(float)

The PoE power budget allocated to this port in watts.

poePriorityinteger(int32)

The PoE priority level for power allocation, with lower values indicating higher priority.

poeEnableboolean

The flag indicating whether PoE (Power over Ethernet) is enabled on this port.

poeCapabilityboolean

The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.

portEnableboolean

The flag indicating whether the port is administratively enabled for traffic forwarding.

portProtectedboolean

The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.

dhcpSnoopingTrustboolean

The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.

arpInspectionTrustboolean

The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.

rstpAdminEdgePortboolean

The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).

stpBpduGuardboolean

Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.

stpRootGuardboolean

The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.

ipsgboolean

The flag indicating whether IP source guard is enabled for additional layer 2 security.

lldpEnableboolean

The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.

lldpQosArray of objects(LldpQos_V1_1)unique

The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.

taggedVlansArray of stringsunique

The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.

untaggedVlanstring

The VLAN ID configured as the untagged (native) VLAN for this port.

voiceVlaninteger(int32)

The VLAN ID designated for voice traffic, typically used for VoIP devices.

ingressAclstring

The name of the Access Control List applied to ingress (incoming) traffic on this port.

egressAclstring

The name of the Access Control List applied to egress (outgoing) traffic on this port.

vsixIngressAclstring

The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

vsixEgressAclstring

The name of the VSIX ACL applied to egress traffic for virtual switch integration.

tagsstring

The comma separated list of custom tags assigned to this port for organization and filtering.

flexibleAuthenticationEnabledboolean

The flag indicating whether flexible authentication with multiple methods is enabled on this port.

authenticationCustomizeboolean

The flag indicating whether port specific authentication settings override the profile defaults.

authenticationProfileIdstring

The identifier of the authentication profile applied to this port for access control.

authenticationTypestring

The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.

Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
changeAuthOrderboolean

The flag indicating whether the authentication method order has been modified from defaults.

dot1xPortControlstring

The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.

Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)

The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.

restrictedVlaninteger(int32)

The VLAN ID for users who fail authorization after successful authentication.

criticalVlaninteger(int32)

The VLAN ID for critical users requiring network access during AAA server failure.

guestVlaninteger(int32)

The VLAN ID for guest users who bypass authentication.

authFailActionstring

The action to take when authentication fails: restricted VLAN, drop, or block.

Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring

The action to take when authentication times out: same as auth fail or critical VLAN.

Enum"__NULL""none""failure""success""critical_vlan"
shouldAlertAaaAndRadiusNotApplyboolean

The flag indicating whether to alert users when AAA and RADIUS configurations cannot be applied to the switch.

switchLevelAuthDefaultVlaninteger(int32)

The authentication default VLAN ID configured at the switch level for reference in the UI.

profileAuthDefaultVlaninteger(int32)

The authentication default VLAN ID configured at the profile level for reference in the UI.

enableAuthPortsArray of strings

The list of port identifiers where authentication is enabled, displayed in the UI.

switchMacstring

The MAC address of the switch to which this port belongs, used for UI identification.

profileNamestring

The name of the profile applied to this port, displayed in the UI for reference.

switchPortProfileIdstring

The identifier of the switch port profile configuration applied to this port.

adminPtToPtstring

The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.

Enum"AUTO""DISABLE""ENABLE"
portSecurityboolean

The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.

portSecurityMaxEntriesinteger(int32)

The maximum number of MAC addresses allowed when port security is enabled.

switchMacAclstring

The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.

poeSchedulerobject(Scheduler_V1)

The scheduler configuration for PoE (Power over Ethernet) operations, allowing time-based PoE control.

]
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

The set of port identifiers when performing batch operations on multiple ports.

namestring

The descriptive name or label assigned to the port for identification purposes.

ignoreFieldsstring

The comma separated list of field names to ignore during update operations.

revertboolean

The flag indicating whether to revert port configuration to profile defaults.

portSpeedstring

The configured speed setting for the port, such as auto negotiation or specific speed values.

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

The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.

Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeBudgetnumber(float)

The PoE power budget allocated to this port in watts.

poePriorityinteger(int32)

The PoE priority level for power allocation, with lower values indicating higher priority.

poeEnableboolean

The flag indicating whether PoE (Power over Ethernet) is enabled on this port.

poeCapabilityboolean

The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.

portEnableboolean

The flag indicating whether the port is administratively enabled for traffic forwarding.

portProtectedboolean

The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.

dhcpSnoopingTrustboolean

The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.

arpInspectionTrustboolean

The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.

rstpAdminEdgePortboolean

The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).

adminPtToPtstring

The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.

Enum"AUTO""DISABLE""ENABLE"
stpBpduGuardboolean

Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.

stpRootGuardboolean

The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.

ipsgboolean

The flag indicating whether IP source guard is enabled for additional layer 2 security.

lldpEnableboolean

The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.

lldpQosArray of objects(LldpQos_V1_1)unique

The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.

taggedVlansArray of stringsunique

The set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.

untaggedVlanstring

The VLAN ID configured as the untagged (native) VLAN for this port.

voiceVlaninteger(int32)[ 1 .. 4095 ]

The VLAN ID designated for voice traffic, typically used for VoIP devices.

ingressAclstring

The name of the Access Control List applied to ingress (incoming) traffic on this port.

egressAclstring

The name of the Access Control List applied to egress (outgoing) traffic on this port.

tagsstring

The comma separated list of custom tags assigned to this port for organization and filtering.

flexibleAuthenticationEnabledboolean

The flag indicating whether flexible authentication with multiple methods is enabled on this port.

authenticationTypestring

The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.

Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
authenticationCustomizeboolean

The flag indicating whether port specific authentication settings override the profile defaults.

authenticationProfileIdstring

The identifier of the authentication profile applied to this port for access control.

changeAuthOrderboolean

The flag indicating whether the authentication method order has been modified from defaults.

dot1xPortControlstring

The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.

Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)[ 1 .. 4095 ]

The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.

restrictedVlaninteger(int32)[ 1 .. 4095 ]

The VLAN ID for users who fail authorization after successful authentication.

criticalVlaninteger(int32)[ 1 .. 4095 ]

The VLAN ID for critical users requiring network access during AAA server failure.

guestVlaninteger(int32)[ 1 .. 4095 ]

The VLAN ID for guest users who bypass authentication.

authFailActionstring

The action to take when authentication fails: restricted VLAN, drop, or block.

Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring

The action to take when authentication times out: same as auth fail or critical VLAN.

Enum"__NULL""none""failure""success""critical_vlan"
switchIdstringrequired

The unique identifier of the switch where this port configuration will be applied.

switchPortProfileIdstring

The identifier of the switch port profile configuration applied to this port.

portSecurityboolean

The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.

portSecurityMaxEntriesinteger(int32)

The maximum number of MAC addresses allowed when port security is enabled.

switchMacAclstring

The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.

poeSchedulerobject(Scheduler_V1)

The scheduler configuration for PoE (Power over Ethernet) operations, allowing time-based PoE control.

]
[
  {
    "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

The unique identifier for tracking this API operation request.

responseobject(Port_V1_1)

The response data containing the result of the operation.

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

Switch identifier (serial number) where the port operations will be performed.

portsArray of stringsunique

Set of port identifiers to be operated on (e.g., ['1/1/1', '1/1/2', '1/1/3']).

]
[
  {
    "switchId": "string",
    "ports": [ … ]
  }
]

Responses

OK

Body
Array [
idstring
portsArray of stringsunique

The set of port identifiers when performing batch operations on multiple ports.

namestring

The descriptive name or label assigned to the port for identification purposes.

ignoreFieldsstring

The comma separated list of field names to ignore during update operations.

revertboolean

The flag indicating whether to revert port configuration to profile defaults.

portSpeedstring

The configured speed setting for the port, such as auto negotiation or specific speed values.

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

The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.

Enum"__NULL""UNSET""ZERO""ONE""TWO""THREE""FOUR""FIVE""SIX""SEVEN"
poeBudgetnumber(float)

The PoE power budget allocated to this port in watts.

poePriorityinteger(int32)

The PoE priority level for power allocation, with lower values indicating higher priority.

poeEnableboolean

The flag indicating whether PoE (Power over Ethernet) is enabled on this port.

poeCapabilityboolean

The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.

portEnableboolean

The flag indicating whether the port is administratively enabled for traffic forwarding.

portProtectedboolean

The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.

dhcpSnoopingTrustboolean

The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.

arpInspectionTrustboolean

The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.

rstpAdminEdgePortboolean

The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).

stpBpduGuardboolean

Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.

stpRootGuardboolean

The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.

ipsgboolean

The flag indicating whether IP source guard is enabled for additional layer 2 security.

lldpEnableboolean

The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.

lldpQosArray of objects(LldpQos_V1_1)unique

The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.

taggedVlansArray of stringsunique

The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.

untaggedVlanstring

The VLAN ID configured as the untagged (native) VLAN for this port.

voiceVlaninteger(int32)

The VLAN ID designated for voice traffic, typically used for VoIP devices.

ingressAclstring

The name of the Access Control List applied to ingress (incoming) traffic on this port.

egressAclstring

The name of the Access Control List applied to egress (outgoing) traffic on this port.

vsixIngressAclstring

The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

vsixEgressAclstring

The name of the VSIX ACL applied to egress traffic for virtual switch integration.

tagsstring

The comma separated list of custom tags assigned to this port for organization and filtering.

flexibleAuthenticationEnabledboolean

The flag indicating whether flexible authentication with multiple methods is enabled on this port.

authenticationCustomizeboolean

The flag indicating whether port specific authentication settings override the profile defaults.

authenticationProfileIdstring

The identifier of the authentication profile applied to this port for access control.

authenticationTypestring

The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.

Enum"__NULL""802.1x""macauth""802.1x_and_macauth"
changeAuthOrderboolean

The flag indicating whether the authentication method order has been modified from defaults.

dot1xPortControlstring

The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.

Enum"__NULL""auto""force_authorized""force_unauthorized"""
authDefaultVlaninteger(int32)

The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.

restrictedVlaninteger(int32)

The VLAN ID for users who fail authorization after successful authentication.

criticalVlaninteger(int32)

The VLAN ID for critical users requiring network access during AAA server failure.

guestVlaninteger(int32)

The VLAN ID for guest users who bypass authentication.

authFailActionstring

The action to take when authentication fails: restricted VLAN, drop, or block.

Enum"__NULL""block""restricted_vlan"
authTimeoutActionstring

The action to take when authentication times out: same as auth fail or critical VLAN.

Enum"__NULL""none""failure""success""critical_vlan"
shouldAlertAaaAndRadiusNotApplyboolean

The flag indicating whether to alert users when AAA and RADIUS configurations cannot be applied to the switch.

switchLevelAuthDefaultVlaninteger(int32)

The authentication default VLAN ID configured at the switch level for reference in the UI.

profileAuthDefaultVlaninteger(int32)

The authentication default VLAN ID configured at the profile level for reference in the UI.

enableAuthPortsArray of strings

The list of port identifiers where authentication is enabled, displayed in the UI.

switchMacstring

The MAC address of the switch to which this port belongs, used for UI identification.

profileNamestring

The name of the profile applied to this port, displayed in the UI for reference.

switchPortProfileIdstring

The identifier of the switch port profile configuration applied to this port.

adminPtToPtstring

The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.

Enum"AUTO""DISABLE""ENABLE"
portSecurityboolean

The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.

portSecurityMaxEntriesinteger(int32)

The maximum number of MAC addresses allowed when port security is enabled.

switchMacAclstring

The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.

poeSchedulerobject(Scheduler_V1)

The scheduler configuration for PoE (Power over Ethernet) operations, allowing time-based PoE control.

]
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

Switch identifier (serial number) where the port operations will be performed.

portsArray of stringsunique

Set of port identifiers to be operated on (e.g., ['1/1/1', '1/1/2', '1/1/3']).

]
[
  {
    "switchId": "string",
    "ports": [ … ]
  }
]

Responses

OK

Body
requestIdstring

The unique identifier for tracking this API operation request.

responseobject(EmptyView)

The response data containing the result of the operation.

Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Switch Static Routes

Manage static route configurations.

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