APIs published in this document are subject to strict change control by Ruckus. As far as possible, when new versions of the Public API are published, all documented API endpoints will maintain backward compatibility. When not possible, an API endpoint will be deprecated and a replacement API or some other workaround will be provided. Support for deprecated API endpoints will continue for at least six months prior to removal in order to provide API client developers sufficient time to adopt the replacement. This document will indicate when API endpoints are deprecated along with the schedule for their removal. API client developers may discover other experimental API endpoints provided by the Ruckus Cloud, not included in this API document. Ruckus reserves the right to change these experimental APIs without notice to API client developers.
Cloud hosts: North American region: "https://ruckus.cloud", European region: "https://eu.ruckus.cloud", Asian region: "https://asia.ruckus.cloud".
[- {
- "defaultGateway": "string",
- "description": "string",
- "enableStack": true,
- "id": "string",
- "igmpSnooping": "active",
- "ipAddress": "string",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "tags": "string",
- "venueId": "string"
}
]
tenantId required | string Tenant ID |
viewInput
defaultGateway | string |
description | string [ 0 .. 255 ] characters |
enableStack | boolean default: false |
id required | string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK... |
igmpSnooping | string Enum: "active" "passive" "none" |
ipAddress | string |
isPrimaryDeleted | boolean default: false |
jumboMode | boolean default: false |
name | string^(?:(?!").){1,255}$ |
object (SwitchPosition) Switch Position object | |
softDeleted | boolean default: false |
softDeletedDate | string <date-time> |
Array of objects (StackMembers) | |
subnetMask | string |
tags | string^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$... |
venueId required | string |
{- "defaultGateway": "string",
- "description": "string",
- "enableStack": true,
- "id": "string",
- "igmpSnooping": "active",
- "ipAddress": "string",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "tags": "string",
- "venueId": "string"
}
{- "requestId": "string",
- "response": {
- "defaultGateway": "string",
- "description": "string",
- "enableStack": true,
- "id": "string",
- "igmpSnooping": "active",
- "ipAddress": "string",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "tags": "string",
- "venueId": "string"
}
}
tenantId required | string Tenant ID |
viewInput
defaultGateway | string |
description | string [ 0 .. 255 ] characters |
enableStack | boolean default: false |
id required | string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK... |
igmpSnooping | string Enum: "active" "passive" "none" |
ipAddress | string |
isPrimaryDeleted | boolean default: false |
jumboMode | boolean default: false |
name | string^(?:(?!").){1,255}$ |
object (SwitchPosition) Switch Position object | |
softDeleted | boolean default: false |
softDeletedDate | string <date-time> |
Array of objects (StackMembers) | |
subnetMask | string |
tags | string^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$... |
venueId required | string |
{- "defaultGateway": "string",
- "description": "string",
- "enableStack": true,
- "id": "string",
- "igmpSnooping": "active",
- "ipAddress": "string",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "tags": "string",
- "venueId": "string"
}
{- "requestId": "string",
- "response": {
- "defaultGateway": "string",
- "description": "string",
- "enableStack": true,
- "id": "string",
- "igmpSnooping": "active",
- "ipAddress": "string",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "tags": "string",
- "venueId": "string"
}
}
List of Switches under a venue
tenantId required | string Tenant ID |
venueId required | string venueId |
[- {
- "defaultGateway": "string",
- "description": "string",
- "enableStack": true,
- "id": "string",
- "igmpSnooping": "active",
- "ipAddress": "string",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "tags": "string",
- "venueId": "string"
}
]
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
{- "defaultGateway": "string",
- "description": "string",
- "enableStack": true,
- "id": "string",
- "igmpSnooping": "active",
- "ipAddress": "string",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "tags": "string",
- "venueId": "string"
}
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
add | Array of strings |
remove | Array of strings |
{- "add": [
- "string"
], - "remove": [
- "string"
]
}
{- "requestId": "string",
- "response": {
- "defaultGateway": "string",
- "description": "string",
- "enableStack": true,
- "id": "string",
- "igmpSnooping": "active",
- "ipAddress": "string",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "tags": "string",
- "venueId": "string"
}
}
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
targetHost required | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
{- "targetHost": "string"
}
{- "requestId": "string",
- "response": {
- "response": "string"
}
}
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
floorplanId | string |
xPercent | number <float> [ 0 .. 100 ] |
yPercent | number <float> [ 0 .. 100 ] |
{- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
{- "requestId": "string",
- "response": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}
}
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
maxTtl | integer <int32> [ 0 .. 255 ] default: 30 |
targetHost required | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
{- "maxTtl": 0,
- "targetHost": "string"
}
{- "requestId": "string",
- "response": {
- "response": "string"
}
}
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
firmwareVersion | string |
scheduledTime | string |
{- "firmwareVersion": "string",
- "scheduledTime": "string"
}
{- "requestId": "string"
}
tenantId required | string Tenant ID |
viewInput
defaultGateway | string |
description | string [ 0 .. 255 ] characters |
enableStack | boolean default: false |
id required | string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK... |
igmpSnooping | string Enum: "active" "passive" "none" |
ipAddress | string |
isPrimaryDeleted | boolean default: false |
jumboMode | boolean default: false |
name | string^(?:(?!").){1,255}$ |
object (SwitchPosition) Switch Position object | |
softDeleted | boolean default: false |
softDeletedDate | string <date-time> |
Array of objects (StackMembers) | |
subnetMask | string |
tags | string^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$... |
venueId required | string |
[- {
- "defaultGateway": "string",
- "description": "string",
- "enableStack": true,
- "id": "string",
- "igmpSnooping": "active",
- "ipAddress": "string",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "tags": "string",
- "venueId": "string"
}
]
{- "requestId": "string",
- "response": [
- {
- "defaultGateway": "string",
- "description": "string",
- "enableStack": true,
- "id": "string",
- "igmpSnooping": "active",
- "ipAddress": "string",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "tags": "string",
- "venueId": "string"
}
]
}
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
id required | string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK... |
{- "id": "string"
}
{- "requestId": "string",
- "response": {
- "id": "string"
}
}
Add Profile
tenantId required | string Tenant ID |
viewInput
Array of objects (Acl) default: new HashSet | |
description | string |
id | string |
name required | string(?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$ |
Array of objects (TrustedPort) default: new HashSet | |
venues | Array of strings |
Array of objects (Vlan) default: new HashSet |
{- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venues": [
- "string"
], - "vlans": [
- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
}
{- "requestId": "string",
- "response": {
- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venues": [
- "string"
], - "vlans": [
- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
}
}
Update Profile
tenantId required | string Tenant ID |
viewInput
Array of objects (Acl) default: new HashSet | |
description | string |
id | string |
name required | string(?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$ |
Array of objects (TrustedPort) default: new HashSet | |
venues | Array of strings |
Array of objects (Vlan) default: new HashSet |
{- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venues": [
- "string"
], - "vlans": [
- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
}
{- "requestId": "string",
- "response": {
- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venues": [
- "string"
], - "vlans": [
- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
}
}
Profile
profileId required | string profileId |
tenantId required | string Tenant ID |
{- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venues": [
- "string"
], - "vlans": [
- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
}
[- {
- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venues": [
- "string"
], - "vlans": [
- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
}
]
Delete Profile
tenantId required | string Tenant ID |
viewInput
[- "string"
]
{- "requestId": "string"
}
List of tenant's profiles by Venue Id
tenantId required | string Tenant ID |
venueId required | string venueId |
[- {
- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venues": [
- "string"
], - "vlans": [
- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
}
]
tenantId required | string Tenant ID |
viewInput
dns | Array of strings |
firmware | string |
id | string |
name | string |
profileId | string |
switchLoginPassword | string |
switchLoginUsername | string |
syslogEnabled | boolean default: false |
syslogPrimaryServer | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
syslogSecondaryServer | string(^((22[0-3]|2[0-1][0-9]|1[0-9][0-9]|[1-9][0-9... |
{- "dns": [
- "string"
], - "firmware": "string",
- "id": "string",
- "name": "string",
- "profileId": "string",
- "switchLoginPassword": "string",
- "switchLoginUsername": "string",
- "syslogEnabled": true,
- "syslogPrimaryServer": "string",
- "syslogSecondaryServer": "string"
}
{- "requestId": "string",
- "response": {
- "dns": [
- "string"
], - "firmware": "string",
- "id": "string",
- "name": "string",
- "profileId": "string",
- "switchLoginPassword": "string",
- "switchLoginUsername": "string",
- "syslogEnabled": true,
- "syslogPrimaryServer": "string",
- "syslogSecondaryServer": "string"
}
}
tenantId required | string Tenant ID |
venueId required | string venueId |
{- "dns": [
- "string"
], - "firmware": "string",
- "id": "string",
- "name": "string",
- "profileId": "string",
- "switchLoginPassword": "string",
- "switchLoginUsername": "string",
- "syslogEnabled": true,
- "syslogPrimaryServer": "string",
- "syslogSecondaryServer": "string"
}
List of Switch's port settings
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
[- {
- "deviceId": "string",
- "dhcpSnoopingTrust": true,
- "egressAcl": "string",
- "id": "string",
- "ignoreFields": "string",
- "ingressAcl": "string",
- "ipsg": true,
- "lag": {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}, - "lldpEnable": true,
- "name": "string",
- "poeBudget": 1000,
- "poeCapability": true,
- "poeClass": "UNSET",
- "poeEnable": true,
- "poePriority": 0,
- "port": "string",
- "portEnable": true,
- "portProtected": true,
- "portSpeed": "UNSET",
- "ports": [
- "string"
], - "revert": true,
- "rstpAdminEdgePort": true,
- "stpBpduGuard": true,
- "stpRootGuard": true,
- "switchSerialNumber": "string",
- "taggedVlans": [
- "string"
], - "tags": "string",
- "untaggedVlan": "string"
}
]
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
deviceId | string |
dhcpSnoopingTrust | boolean default: false |
egressAcl | string |
id | string |
ignoreFields | string |
ingressAcl | string |
ipsg | boolean default: false |
object (Lag) domain object representing LAG Model | |
lldpEnable | boolean default: true |
name | string |
poeBudget | number <float> [ 1000 .. 30000 ] |
poeCapability | boolean default: true |
poeClass | string Enum: "UNSET" "ZERO" "ONE" "TWO" "THREE" "FOUR" |
poeEnable | boolean default: true |
poePriority | integer <int32> |
port | string^\d{1,2}/\d{1,2}/\d{1,2}$ |
portEnable | boolean default: true |
portProtected | boolean default: false |
portSpeed | string Enum: "UNSET" "NONE" "AUTO" "TEN_M_FULL" "TEN_M_HALF" "ONE_HUNDRED_M_FULL" "ONE_HUNDRED_M_HALF" "ONE_G_FULL" "ONE_G_FULL_MASTER" "ONE_G_FULL_SLAVE" "TWO_POINT_FIVE_G_FULL" "TWO_POINT_FIVE_G_FULL_MASTER" "TWO_POINT_FIVE_G_FULL_SLAVE" "FIVE_G_FULL" "FIVE_G_FULL_MASTER" "FIVE_G_FULL_SLAVE" "TEN_G_FULL" "TEN_G_FULL_MASTER" "TEN_G_FULL_SLAVE" "TWENTY_FIVE_G_FULL" "FORTY_G_FULL" "ONE_HUNDRED_G_FULL" |
ports | Array of strings |
revert | boolean default: false |
rstpAdminEdgePort | boolean default: false |
stpBpduGuard | boolean default: false |
stpRootGuard | boolean default: false |
switchSerialNumber | string |
taggedVlans | Array of strings |
tags | string |
untaggedVlan | string |
{- "deviceId": "string",
- "dhcpSnoopingTrust": true,
- "egressAcl": "string",
- "id": "string",
- "ignoreFields": "string",
- "ingressAcl": "string",
- "ipsg": true,
- "lag": {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}, - "lldpEnable": true,
- "name": "string",
- "poeBudget": 1000,
- "poeCapability": true,
- "poeClass": "UNSET",
- "poeEnable": true,
- "poePriority": 0,
- "port": "string",
- "portEnable": true,
- "portProtected": true,
- "portSpeed": "UNSET",
- "ports": [
- "string"
], - "revert": true,
- "rstpAdminEdgePort": true,
- "stpBpduGuard": true,
- "stpRootGuard": true,
- "switchSerialNumber": "string",
- "taggedVlans": [
- "string"
], - "tags": "string",
- "untaggedVlan": "string"
}
{- "requestId": "string"
}
portNum required | integer <int32> portNum |
serialNumber required | string serialNumber |
slotNum required | integer <int32> slotNum |
tenantId required | string Tenant ID |
unitNum required | integer <int32> unitNum |
{- "deviceId": "string",
- "dhcpSnoopingTrust": true,
- "egressAcl": "string",
- "id": "string",
- "ignoreFields": "string",
- "ingressAcl": "string",
- "ipsg": true,
- "lag": {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}, - "lldpEnable": true,
- "name": "string",
- "poeBudget": 1000,
- "poeCapability": true,
- "poeClass": "UNSET",
- "poeEnable": true,
- "poePriority": 0,
- "port": "string",
- "portEnable": true,
- "portProtected": true,
- "portSpeed": "UNSET",
- "ports": [
- "string"
], - "revert": true,
- "rstpAdminEdgePort": true,
- "stpBpduGuard": true,
- "stpRootGuard": true,
- "switchSerialNumber": "string",
- "taggedVlans": [
- "string"
], - "tags": "string",
- "untaggedVlan": "string"
}
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
[- "string"
]
{- "requestId": "string",
- "response": [
- {
- "deviceId": "string",
- "dhcpSnoopingTrust": true,
- "egressAcl": "string",
- "id": "string",
- "ignoreFields": "string",
- "ingressAcl": "string",
- "ipsg": true,
- "lag": {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}, - "lldpEnable": true,
- "name": "string",
- "poeBudget": 1000,
- "poeCapability": true,
- "poeClass": "UNSET",
- "poeEnable": true,
- "poePriority": 0,
- "port": "string",
- "portEnable": true,
- "portProtected": true,
- "portSpeed": "UNSET",
- "ports": [
- "string"
], - "revert": true,
- "rstpAdminEdgePort": true,
- "stpBpduGuard": true,
- "stpRootGuard": true,
- "switchSerialNumber": "string",
- "taggedVlans": [
- "string"
], - "tags": "string",
- "untaggedVlan": "string"
}
]
}
tenantId required | string Tenant ID |
viewInput
object (Port) domain object representing Port Model | |
switchSerialNumber | string |
[- {
- "ports": {
- "deviceId": "string",
- "dhcpSnoopingTrust": true,
- "egressAcl": "string",
- "id": "string",
- "ignoreFields": "string",
- "ingressAcl": "string",
- "ipsg": true,
- "lag": {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}, - "lldpEnable": true,
- "name": "string",
- "poeBudget": 1000,
- "poeCapability": true,
- "poeClass": "UNSET",
- "poeEnable": true,
- "poePriority": 0,
- "port": "string",
- "portEnable": true,
- "portProtected": true,
- "portSpeed": "UNSET",
- "ports": [
- "string"
], - "revert": true,
- "rstpAdminEdgePort": true,
- "stpBpduGuard": true,
- "stpRootGuard": true,
- "switchSerialNumber": "string",
- "taggedVlans": [
- "string"
], - "tags": "string",
- "untaggedVlan": "string"
}, - "switchSerialNumber": "string"
}
]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
viewInput
ports | Array of strings |
switchSerialNumber | string |
[- {
- "ports": [
- "string"
], - "switchSerialNumber": "string"
}
]
{- "requestId": "string",
- "response": [
- {
- "deviceId": "string",
- "dhcpSnoopingTrust": true,
- "egressAcl": "string",
- "id": "string",
- "ignoreFields": "string",
- "ingressAcl": "string",
- "ipsg": true,
- "lag": {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}, - "lldpEnable": true,
- "name": "string",
- "poeBudget": 1000,
- "poeCapability": true,
- "poeClass": "UNSET",
- "poeEnable": true,
- "poePriority": 0,
- "port": "string",
- "portEnable": true,
- "portProtected": true,
- "portSpeed": "UNSET",
- "ports": [
- "string"
], - "revert": true,
- "rstpAdminEdgePort": true,
- "stpBpduGuard": true,
- "stpRootGuard": true,
- "switchSerialNumber": "string",
- "taggedVlans": [
- "string"
], - "tags": "string",
- "untaggedVlan": "string"
}
]
}
List of TrustedPort under a venue
tenantId required | string Tenant ID |
venueId required | string venueId |
[- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
]
Add TrustedPort
profileId required | string profileId |
tenantId required | string Tenant ID |
viewInput
id | string |
model | string Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" |
Array of objects (FamilyModelSlot) default: new HashSet | |
trustPorts | Array of strings |
trustedPortType | string Enum: "all" "dhcp" "arp" default: TrustedPortTypeEnum.all |
vlanDemand | boolean default: false |
{- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
{- "requestId": "string",
- "response": {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
}
Update TrustedPort
profileId required | string profileId |
tenantId required | string Tenant ID |
viewInput
id | string |
model | string Enum: "ICX7150-24" "ICX7150-24P" "ICX7150-48" "ICX7150-48P" "ICX7150-48PF" "ICX7150-48ZP" "ICX7150-C12P" "ICX7150-C10ZP" "ICX7150-C08P" "ICX7150-C08PT" "ICX7150-24F" "ICX7250-48" "ICX7650-48ZP" "ICX7650-48P" "ICX7650-48F" "ICX7850-32Q" "ICX7850-48FS" "ICX7850-48F" "ICX7850-48C" "ICX7550-24" "ICX7550-48" "ICX7550-24P" "ICX7550-48P" "ICX7550-24ZP" "ICX7550-48ZP" "ICX7550-24F" "ICX7550-48F" |
Array of objects (FamilyModelSlot) default: new HashSet | |
trustPorts | Array of strings |
trustedPortType | string Enum: "all" "dhcp" "arp" default: TrustedPortTypeEnum.all |
vlanDemand | boolean default: false |
{- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
{- "requestId": "string",
- "response": {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
}
Get TrustedPort
profileId required | string profileId |
tenantId required | string Tenant ID |
trustedPortId required | string trustedPortId |
{- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
tenantId required | string Tenant ID |
viewInput
id | string |
name | string^(?:(?!").){1,64}$ |
ports | Array of strings |
taggedVlans | Array of strings |
type | string Enum: "static" "dynamic" |
untaggedVlan | string |
{- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}
{- "requestId": "string",
- "response": {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}
}
List of Switch's LAG settings
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
[- {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}
]
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
id | string |
name | string^(?:(?!").){1,64}$ |
ports | Array of strings |
taggedVlans | Array of strings |
type | string Enum: "static" "dynamic" |
untaggedVlan | string |
{- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}
{- "requestId": "string",
- "response": {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}
}
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
id | string |
name | string^(?:(?!").){1,64}$ |
ports | Array of strings |
taggedVlans | Array of strings |
type | string Enum: "static" "dynamic" |
untaggedVlan | string |
[- {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}
]
{- "requestId": "string",
- "response": [
- {
- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}
]
}
List of VLAN under a venue
tenantId required | string Tenant ID |
venueId required | string venueId |
[- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
List of VLAN under a venue with specific model
model required | string model |
tenantId required | string Tenant ID |
venueId required | string venueId |
[- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
List of VLAN under a venue with specific model and tagged port
model required | string model |
slotId required | integer <int32> slotId |
taggedPortId required | integer <int32> taggedPortId |
tenantId required | string Tenant ID |
unitId required | integer <int32> unitId |
venueId required | string venueId |
[- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
List of VLAN under a venue with specific model and untagged port
model required | string model |
slotId required | integer <int32> slotId |
tenantId required | string Tenant ID |
unitId required | integer <int32> unitId |
untaggedPortId required | integer <int32> untaggedPortId |
venueId required | string venueId |
[- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
Add VLAN
profileId required | string profileId |
tenantId required | string Tenant ID |
viewInput
arpInspection | boolean default: false |
arpInspectionTrustPort | string |
id | string |
igmpSnooping | string Enum: "active" "passive" "none" |
ipv4DhcpSnooping | boolean default: false |
ipv4DhcpSnoopingTrustPort | string |
multicastVersion | integer <int32> [ 2 .. 3 ] |
rootBridgeFamilyId | string Enum: "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" |
spanningTreePriority | integer <int32> [ 0 .. 65535 ] |
spanningTreeProtocol | string Enum: "rstp" "stp" "none" |
Array of objects (SwitchFamilyModel) default: new HashSet | |
vlanId | integer <int32> [ 1 .. 4094 ] |
vlanName | string [ 0 .. 32 ] characters |
{- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
{- "requestId": "string",
- "response": {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
}
Update VLAN
profileId required | string profileId |
tenantId required | string Tenant ID |
viewInput
arpInspection | boolean default: false |
arpInspectionTrustPort | string |
id | string |
igmpSnooping | string Enum: "active" "passive" "none" |
ipv4DhcpSnooping | boolean default: false |
ipv4DhcpSnoopingTrustPort | string |
multicastVersion | integer <int32> [ 2 .. 3 ] |
rootBridgeFamilyId | string Enum: "ICX7150" "ICX7250" "ICX7650" "ICX7850" "ICX7550" |
spanningTreePriority | integer <int32> [ 0 .. 65535 ] |
spanningTreeProtocol | string Enum: "rstp" "stp" "none" |
Array of objects (SwitchFamilyModel) default: new HashSet | |
vlanId | integer <int32> [ 1 .. 4094 ] |
vlanName | string [ 0 .. 32 ] characters |
{- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
{- "requestId": "string",
- "response": {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
}
Vlan
profileId required | string profileId |
tenantId required | string Tenant ID |
vlanUuid required | string vlanUuid |
{- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
List of VLAN under a profile
profileId required | string profileId |
tenantId required | string Tenant ID |
page | string page |
size | string size |
[- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 2,
- "rootBridgeFamilyId": "ICX7150",
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchFamilyModels": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]
Delete VLANs
profileId required | string profileId |
tenantId required | string Tenant ID |
viewInput
[- "string"
]
{- "requestId": "string"
}
Get Switch's default VLAN Id
tenantId required | string Tenant ID |
viewInput
[- "string"
]
{- "requestId": "string",
- "response": [
- {
- "defaultVlanId": 0,
- "serialNumber": "string"
}
]
}
Get All VLAN Intersection of Switch
tenantId required | string Tenant ID |
viewInput
[- "string"
]
{- "requestId": "string",
- "response": {
- "profileVlan": [
- {
- "defaultVlan": true,
- "profileLevel": true,
- "serialNumber": "string",
- "vlanConfigName": "string",
- "vlanId": 0
}
], - "switchDefaultVlan": [
- {
- "defaultVlan": true,
- "profileLevel": true,
- "serialNumber": "string",
- "vlanConfigName": "string",
- "vlanId": 0
}
], - "switchVlan": [
- {
- "defaultVlan": true,
- "profileLevel": true,
- "serialNumber": "string",
- "vlanConfigName": "string",
- "vlanId": 0
}
]
}
}
Get All VLAN Union of Switch
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
{- "profileVlan": [
- {
- "defaultVlan": true,
- "profileLevel": true,
- "serialNumber": "string",
- "vlanConfigName": "string",
- "vlanId": 0
}
], - "switchDefaultVlan": [
- {
- "defaultVlan": true,
- "profileLevel": true,
- "serialNumber": "string",
- "vlanConfigName": "string",
- "vlanId": 0
}
], - "switchVlan": [
- {
- "defaultVlan": true,
- "profileLevel": true,
- "serialNumber": "string",
- "vlanConfigName": "string",
- "vlanId": 0
}
]
}
tenantId required | string Tenant ID |
viewInput
dhcpRelayAgent | string |
egressAcl | string |
id | string |
ingressAcl | string |
ipAddress | string |
ipSubnetMask | string |
name | string |
ospfArea | string |
veId | integer <int32> |
vlanId | integer <int32> |
{- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 0,
- "vlanId": 0
}
{- "requestId": "string",
- "response": {
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 0,
- "vlanId": 0
}
}
List of Switch's VePort settings
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
[- {
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 0,
- "vlanId": 0
}
]
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
dhcpRelayAgent | string |
egressAcl | string |
id | string |
ingressAcl | string |
ipAddress | string |
ipSubnetMask | string |
name | string |
ospfArea | string |
veId | integer <int32> |
vlanId | integer <int32> |
{- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 0,
- "vlanId": 0
}
{- "requestId": "string",
- "response": {
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 0,
- "vlanId": 0
}
}
tenantId required | string Tenant ID |
vePortId required | string vePortId |
{- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 0,
- "vlanId": 0
}
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
dhcpRelayAgent | string |
egressAcl | string |
id | string |
ingressAcl | string |
ipAddress | string |
ipSubnetMask | string |
name | string |
ospfArea | string |
veId | integer <int32> |
vlanId | integer <int32> |
[- {
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 0,
- "vlanId": 0
}
]
{- "requestId": "string",
- "response": [
- {
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 0,
- "vlanId": 0
}
]
}
tenantId required | string Tenant ID |
viewInput
adminDistance | integer <int32> [ 1 .. 255 ] |
destinationIp | string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2... |
id | string |
nextHop | string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2... |
{- "adminDistance": 1,
- "destinationIp": "string",
- "id": "string",
- "nextHop": "string"
}
{- "requestId": "string",
- "response": {
- "adminDistance": 1,
- "destinationIp": "string",
- "id": "string",
- "nextHop": "string"
}
}
List of Switch's StaticRoute settings
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
[- {
- "adminDistance": 1,
- "destinationIp": "string",
- "id": "string",
- "nextHop": "string"
}
]
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
adminDistance | integer <int32> [ 1 .. 255 ] |
destinationIp | string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2... |
id | string |
nextHop | string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2... |
{- "adminDistance": 1,
- "destinationIp": "string",
- "id": "string",
- "nextHop": "string"
}
{- "requestId": "string",
- "response": {
- "adminDistance": 1,
- "destinationIp": "string",
- "id": "string",
- "nextHop": "string"
}
}
tenantId required | string Tenant ID |
viewInput
[- "string"
]
{- "requestId": "string"
}
serialNumber required | string serialNumber |
tenantId required | string Tenant ID |
viewInput
adminDistance | integer <int32> [ 1 .. 255 ] |
destinationIp | string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2... |
id | string |
nextHop | string^(\b([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|2... |
[- {
- "adminDistance": 1,
- "destinationIp": "string",
- "id": "string",
- "nextHop": "string"
}
]
{- "requestId": "string",
- "response": [
- {
- "adminDistance": 1,
- "destinationIp": "string",
- "id": "string",
- "nextHop": "string"
}
]
}
List of ACL under a venue
tenantId required | string Tenant ID |
venueId required | string venueId |
[- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
]
Add Acl
profileId required | string profileId |
tenantId required | string Tenant ID |
viewInput
Array of objects (AclRule) default: new HashSet | |
aclType | string Enum: "standard" "extended" |
id | string |
name | string |
{- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
{- "requestId": "string",
- "response": {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
}
Update Acl
profileId required | string profileId |
tenantId required | string Tenant ID |
viewInput
Array of objects (AclRule) default: new HashSet | |
aclType | string Enum: "standard" "extended" |
id | string |
name | string |
{- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
{- "requestId": "string",
- "response": {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
}
Acl
aclId required | string aclId |
profileId required | string profileId |
tenantId required | string Tenant ID |
{- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
List of Acl under a profile
profileId required | string profileId |
tenantId required | string Tenant ID |
page | string page |
size | string size |
[- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 1,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 1
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
]
Delete Acls
profileId required | string profileId |
tenantId required | string Tenant ID |
viewInput
[- "string"
]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
viewInput
[- "string"
]
{- "requestId": "string"
}
tenantId required | string Tenant ID |
viewInput
backupId1 required | string |
backupId2 required | string |
{- "backupId1": "string",
- "backupId2": "string"
}
{- "requestId": "string",
- "response": {
- "configBackup1": {
- "config": "string",
- "id": "string"
}, - "configBackup2": {
- "config": "string",
- "id": "string"
}
}
}
List of Switch's Backup Configurations
switchId required | string switchId |
tenantId required | string Tenant ID |
[- {
- "backupType": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "failureReason": "string",
- "id": "string",
- "name": "string",
- "restoreStatus": "string",
- "restoreTimestamp": "string",
- "status": "string"
}
]
switchId required | string switchId |
tenantId required | string Tenant ID |
viewInput
name | string^(?:(?!").){1,64}$ |
{- "name": "string"
}
{- "requestId": "string",
- "response": {
- "backupType": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "failureReason": "string",
- "id": "string",
- "name": "string",
- "restoreStatus": "string",
- "restoreTimestamp": "string",
- "status": "string"
}
}
{- "backupType": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "failureReason": "string",
- "id": "string",
- "name": "string",
- "restoreStatus": "string",
- "restoreTimestamp": "string",
- "status": "string"
}
View Switch information. Note: this set of endpoints is used to view operational data. They don't provide the means to manage configuration.
Get a list of Switch clients (i.e., end-user devices).
tenant_id required | string Tenant ID |
payload
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "clientDesc": "string",
- "clientIpv4Addr": "string",
- "clientIpv6Addr": "string",
- "clientMac": "string",
- "clientName": "string",
- "clientType": "string",
- "clientVlan": "string",
- "id": "string",
- "isRuckusAP": true,
- "ruckusAP": true,
- "switchId": "string",
- "switchMac": "string",
- "switchName": "string",
- "switchPort": "string",
- "venueId": "string",
- "venueName": "string",
- "vlanName": "string"
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": { },
- "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}
Get a list of parameters for the Switch's ports.
tenant_id required | string Tenant ID |
payload
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "adminStatus": "string",
- "broadcastIn": "string",
- "broadcastOut": "string",
- "cloudPort": true,
- "crcErr": "string",
- "deviceStatus": "string",
- "egressAclName": "string",
- "id": "string",
- "inDiscard": "string",
- "inErr": "string",
- "ingressAclName": "string",
- "lagId": "string",
- "lagName": "string",
- "lagStatus": "string",
- "multicastIn": "string",
- "multicastOut": "string",
- "name": "string",
- "neighborName": "string",
- "opticsType": "string",
- "outErr": "string",
- "poeEnabled": true,
- "poeTotal": 0,
- "poeType": "string",
- "poeUsed": 0,
- "port": "string",
- "portId": "string",
- "portIdentifier": "string",
- "portIdentifierFormatted": "string",
- "portMac": "string",
- "portSpeed": "string",
- "portSpeedCapacity": "string",
- "rx": "string",
- "signalIn": 0,
- "signalOut": 0,
- "stack": true,
- "status": "string",
- "switchMac": "string",
- "switchModel": "string",
- "switchName": "string",
- "switchSerial": "string",
- "switchUnitId": "string",
- "syncedSwitchConfig": true,
- "tag": "string",
- "tenantId": "string",
- "tx": "string",
- "unTaggedVlan": "string",
- "unitState": "string",
- "unitStatus": "string",
- "usedInFormingStack": true,
- "venueId": "string",
- "vlanIds": "string"
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": { },
- "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}
Get a list of Switches.
tenant_id required | string Tenant ID |
payload
fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
multiSortFields | Array of strings |
Array of objects (MustNotMatchFieldDto) | |
page | integer <int32> |
object (EntryOfstringAndstring) | |
pageSize | integer <int32> |
object (RangeFilterDto) | |
searchString | string |
searchTargetFields | Array of strings |
sortField | string |
sortOrder | string |
object (TermFieldDto) |
{- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustNotMatchField": [
- {
- "field": "string",
- "value": "string"
}
], - "page": 0,
- "pageByDate": {
- "key": "string",
- "value": "string"
}, - "pageSize": 0,
- "rangeFilter": {
- "field": "string",
- "gte": 0,
- "lte": 0
}, - "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "string",
- "termField": {
- "field": "string",
- "value": "string"
}
}
{- "data": [
- {
- "activeSerial": "string",
- "alerts": 0,
- "clientCount": 0,
- "cloudPort": "string",
- "configReady": true,
- "cpu": "string",
- "crtTime": "string",
- "defaultGateway": "string",
- "deviceStatus": "string",
- "deviceType": "string",
- "dns": "string",
- "domainId": "string",
- "domainName": "string",
- "family": "string",
- "fanGroups": "string",
- "firmware": "string",
- "floorplanId": "string",
- "id": "string",
- "ipAddress": "string",
- "isStack": true,
- "lastUpdTime": "string",
- "lastUpdateTimeInMillis": "string",
- "memory": "string",
- "model": "string",
- "modules": "string",
- "name": "string",
- "numOfPorts": 0,
- "numOfUnits": 0,
- "poeFree": 0,
- "poeTotal": 0,
- "poeUtilization": 0,
- "portModuleIds": "string",
- "powerSupplyGroups": "string",
- "provisionName": "string",
- "serialNumber": "string",
- "staticOrDynamic": "string",
- "subnetMask": "string",
- "switchGroupLevelOneId": "string",
- "switchGroupLevelOneName": "string",
- "switchGroupLevelTwoId": "string",
- "switchMac": "string",
- "switchName": "string",
- "syncedSwitchConfig": true,
- "tags": "string",
- "tenantId": "string",
- "type": "string",
- "unitSerialNumbers": "string",
- "uptime": "string",
- "venueId": "string",
- "venueName": "string",
- "xPercent": 0,
- "yPercent": 0
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": { },
- "httpMethod": "GET",
- "payload": { },
- "url": {
- "absolute": true,
- "authority": "string",
- "fragment": "string",
- "host": "string",
- "opaque": true,
- "path": "string",
- "port": 0,
- "query": "string",
- "rawAuthority": "string",
- "rawFragment": "string",
- "rawPath": "string",
- "rawQuery": "string",
- "rawSchemeSpecificPart": "string",
- "rawUserInfo": "string",
- "scheme": "string",
- "schemeSpecificPart": "string",
- "userInfo": "string"
}
}
], - "totalCount": 0
}