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.
| Document Name | Resources Managed |
| switch-ns-220111.html | ICX switch related resources. This document describes API endpoints related to managing your switches and wired networks. |
| msp-ns-220111.html | MSP & VAR related resources. This document describes API endpoints related to managing your customers and their networks. |
| platform-ns-220111.html | Platform related resources. This document describes API endpoints related to your account including administrators and their notification preferences, venues and your entitlements/licenses. |
| wifi-ns-220111.html | Wi-Fi related resources. This document describes API endpoints related to managing your access points (APs) and wireless networks. |
| Region | Domain |
| Asia | https://asia.ruckus.cloud |
| Europe | https://eu.ruckus.cloud |
| North America | https://ruckus.cloud |
| Format | URL |
| HTML | The complete set of FastIron product guides supporting firmware version 08.0.95 is available on the CommScope Technical Content Portal here: https://docs.commscope.com/bundle?labelkey=fi-08.0.95. |
| PDF bundle | A zip bundle of all FastIron product guides supporting firmware version 08.0.95 is available on the RUCKUS Support Portal here (~50MB): https://support.ruckuswireless.com/documents/3446-fastiron-08-0-95-ga-software-documentation-zip. |
| Individual PDF configuration guides can be downloaded on the RUCKUS Support Portal by navigating to the RUCKUS ICX product area, https://support.ruckuswireless.com/product_families/21-ruckus-icx-switches, selecting an ICX Model you’ve deployed, then selecting the “Documents” tab midway down the page. |
API clients use an API-KEY to access REST endpoints. In order to obtain an API-KEY, an administrator uses the endpoints in the "API Client Authentication" group, available on all cloud hosts. The API-KEY issued will have the same access privileges (aka role) as the administrator who obtained the key. Please see document platform-ns-220111.html for details.
| Security Scheme Type | API Key |
|---|---|
| Header parameter name: | Cookie |
| API Group | New Summary | New Description |
| CliTemplate | Delete Cli Templates | Delete CLI templates. |
| CliTemplate | Get CLI Templates | Get a list of CLI templates. |
| CliTemplate | Add CLI Template | Create a CLI template for switches. |
| CliTemplate | Update CLI Template | Update a CLI template for switches. |
| CliTemplate | Get CLI Template Examples | Get a list of CLI template examples. |
| CliTemplate | Get CLI Templates by Query | Get a list of CLI templates by query. |
| CliTemplate | Delete Cli Template | Delete a CLI template. |
| CliTemplate | Get CLI Template | Get a CLI template. |
List of tenant's ICX switches.
| tenantId required | string Tenant ID |
[- {
- "defaultGateway": "string",
- "description": "string",
- "dhcpClientEnabled": true,
- "dhcpServerEnabled": true,
- "enableStack": true,
- "firmwareVersion": "string",
- "id": "string",
- "igmpSnooping": "active",
- "initialVlanId": 1,
- "ipAddress": "string",
- "ipAddressInterface": "string",
- "ipAddressInterfaceType": "PORT",
- "ipAddressType": "static",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "lastDataSyncTime": 0,
- "lastDataSyncTriggerTime": 0,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "previousMembers": [
- "string"
], - "sendedHostname": true,
- "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "spanningTreePriority": 0,
- "specifiedType": "AUTO",
- "stackConfigTimestamp": "string",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "syncDataEndTime": 0,
- "syncDataId": "string",
- "syncDataStartTime": 0,
- "tags": "string",
- "trustPorts": [
- "string"
], - "venueId": "string"
}
]Update ICX switch.
| tenantId required | string Tenant ID |
viewInput
| defaultGateway | string |
| description | string [ 0 .. 255 ] characters |
| dhcpClientEnabled | boolean The default value is true. The DHCP client is enabled by default at bootup on all Brocade devices. |
| dhcpServerEnabled | boolean The default value is false. |
| enableStack | boolean The default value is false. |
| firmwareVersion | string |
| id required | string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK... |
| igmpSnooping | string Enum: "active" "passive" "none" |
| initialVlanId | integer <int32> [ 1 .. 4095 ] |
| ipAddress | string |
| ipAddressInterface | string |
| ipAddressInterfaceType | string Enum: "PORT" "VE" |
| ipAddressType | string Enum: "static" "dynamic" |
| isPrimaryDeleted | boolean The default value is false. |
| jumboMode | boolean The default value is false. |
| lastDataSyncTime | integer <int64> |
| lastDataSyncTriggerTime | integer <int64> |
| name | string^$|^(?:(?!").){1,255}$ |
object (SwitchPosition) Switch Position object | |
| previousMembers | Array of strings |
| sendedHostname | boolean The default value is false. |
| softDeleted | boolean The default value is false. |
| softDeletedDate | string <date-time> |
| spanningTreePriority | integer <int32> [ 0 .. 65535 ] |
| specifiedType | string Enum: "AUTO" "SWITCH" "ROUTER" default: ImageTypeEnum.AUTO |
| stackConfigTimestamp | string |
Array of objects (StackMembers) | |
| subnetMask | string |
| syncDataEndTime | integer <int64> |
| syncDataId | string |
| syncDataStartTime | integer <int64> |
| tags | string^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$... |
| trustPorts | Array of strings |
| venueId required | string |
{- "defaultGateway": "string",
- "description": "string",
- "dhcpClientEnabled": true,
- "dhcpServerEnabled": true,
- "enableStack": true,
- "firmwareVersion": "string",
- "id": "string",
- "igmpSnooping": "active",
- "initialVlanId": 1,
- "ipAddress": "string",
- "ipAddressInterface": "string",
- "ipAddressInterfaceType": "PORT",
- "ipAddressType": "static",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "lastDataSyncTime": 0,
- "lastDataSyncTriggerTime": 0,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "previousMembers": [
- "string"
], - "sendedHostname": true,
- "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "spanningTreePriority": 0,
- "specifiedType": "AUTO",
- "stackConfigTimestamp": "string",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "syncDataEndTime": 0,
- "syncDataId": "string",
- "syncDataStartTime": 0,
- "tags": "string",
- "trustPorts": [
- "string"
], - "venueId": "string"
}{- "requestId": "string",
- "response": {
- "defaultGateway": "string",
- "description": "string",
- "dhcpClientEnabled": true,
- "dhcpServerEnabled": true,
- "enableStack": true,
- "firmwareVersion": "string",
- "id": "string",
- "igmpSnooping": "active",
- "initialVlanId": 1,
- "ipAddress": "string",
- "ipAddressInterface": "string",
- "ipAddressInterfaceType": "PORT",
- "ipAddressType": "static",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "lastDataSyncTime": 0,
- "lastDataSyncTriggerTime": 0,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "previousMembers": [
- "string"
], - "sendedHostname": true,
- "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "spanningTreePriority": 0,
- "specifiedType": "AUTO",
- "stackConfigTimestamp": "string",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "syncDataEndTime": 0,
- "syncDataId": "string",
- "syncDataStartTime": 0,
- "tags": "string",
- "trustPorts": [
- "string"
], - "venueId": "string"
}
}Add ICX switch.
| tenantId required | string Tenant ID |
viewInput
| defaultGateway | string |
| description | string [ 0 .. 255 ] characters |
| dhcpClientEnabled | boolean The default value is true. The DHCP client is enabled by default at bootup on all Brocade devices. |
| dhcpServerEnabled | boolean The default value is false. |
| enableStack | boolean The default value is false. |
| firmwareVersion | string |
| id required | string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK... |
| igmpSnooping | string Enum: "active" "passive" "none" |
| initialVlanId | integer <int32> [ 1 .. 4095 ] |
| ipAddress | string |
| ipAddressInterface | string |
| ipAddressInterfaceType | string Enum: "PORT" "VE" |
| ipAddressType | string Enum: "static" "dynamic" |
| isPrimaryDeleted | boolean The default value is false. |
| jumboMode | boolean The default value is false. |
| lastDataSyncTime | integer <int64> |
| lastDataSyncTriggerTime | integer <int64> |
| name | string^$|^(?:(?!").){1,255}$ |
object (SwitchPosition) Switch Position object | |
| previousMembers | Array of strings |
| sendedHostname | boolean The default value is false. |
| softDeleted | boolean The default value is false. |
| softDeletedDate | string <date-time> |
| spanningTreePriority | integer <int32> [ 0 .. 65535 ] |
| specifiedType | string Enum: "AUTO" "SWITCH" "ROUTER" default: ImageTypeEnum.AUTO |
| stackConfigTimestamp | string |
Array of objects (StackMembers) | |
| subnetMask | string |
| syncDataEndTime | integer <int64> |
| syncDataId | string |
| syncDataStartTime | integer <int64> |
| tags | string^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$... |
| trustPorts | Array of strings |
| venueId required | string |
{- "defaultGateway": "string",
- "description": "string",
- "dhcpClientEnabled": true,
- "dhcpServerEnabled": true,
- "enableStack": true,
- "firmwareVersion": "string",
- "id": "string",
- "igmpSnooping": "active",
- "initialVlanId": 1,
- "ipAddress": "string",
- "ipAddressInterface": "string",
- "ipAddressInterfaceType": "PORT",
- "ipAddressType": "static",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "lastDataSyncTime": 0,
- "lastDataSyncTriggerTime": 0,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "previousMembers": [
- "string"
], - "sendedHostname": true,
- "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "spanningTreePriority": 0,
- "specifiedType": "AUTO",
- "stackConfigTimestamp": "string",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "syncDataEndTime": 0,
- "syncDataId": "string",
- "syncDataStartTime": 0,
- "tags": "string",
- "trustPorts": [
- "string"
], - "venueId": "string"
}{- "requestId": "string",
- "response": {
- "defaultGateway": "string",
- "description": "string",
- "dhcpClientEnabled": true,
- "dhcpServerEnabled": true,
- "enableStack": true,
- "firmwareVersion": "string",
- "id": "string",
- "igmpSnooping": "active",
- "initialVlanId": 1,
- "ipAddress": "string",
- "ipAddressInterface": "string",
- "ipAddressInterfaceType": "PORT",
- "ipAddressType": "static",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "lastDataSyncTime": 0,
- "lastDataSyncTriggerTime": 0,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "previousMembers": [
- "string"
], - "sendedHostname": true,
- "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "spanningTreePriority": 0,
- "specifiedType": "AUTO",
- "stackConfigTimestamp": "string",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "syncDataEndTime": 0,
- "syncDataId": "string",
- "syncDataStartTime": 0,
- "tags": "string",
- "trustPorts": [
- "string"
], - "venueId": "string"
}
}List of venues' ICX switches.
| tenantId required | string Tenant ID |
| venueId required | string venueId |
[- {
- "defaultGateway": "string",
- "description": "string",
- "dhcpClientEnabled": true,
- "dhcpServerEnabled": true,
- "enableStack": true,
- "firmwareVersion": "string",
- "id": "string",
- "igmpSnooping": "active",
- "initialVlanId": 1,
- "ipAddress": "string",
- "ipAddressInterface": "string",
- "ipAddressInterfaceType": "PORT",
- "ipAddressType": "static",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "lastDataSyncTime": 0,
- "lastDataSyncTriggerTime": 0,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "previousMembers": [
- "string"
], - "sendedHostname": true,
- "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "spanningTreePriority": 0,
- "specifiedType": "AUTO",
- "stackConfigTimestamp": "string",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "syncDataEndTime": 0,
- "syncDataId": "string",
- "syncDataStartTime": 0,
- "tags": "string",
- "trustPorts": [
- "string"
], - "venueId": "string"
}
]Get ICX switch.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
{- "defaultGateway": "string",
- "description": "string",
- "dhcpClientEnabled": true,
- "dhcpServerEnabled": true,
- "enableStack": true,
- "firmwareVersion": "string",
- "id": "string",
- "igmpSnooping": "active",
- "initialVlanId": 1,
- "ipAddress": "string",
- "ipAddressInterface": "string",
- "ipAddressInterfaceType": "PORT",
- "ipAddressType": "static",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "lastDataSyncTime": 0,
- "lastDataSyncTriggerTime": 0,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "previousMembers": [
- "string"
], - "sendedHostname": true,
- "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "spanningTreePriority": 0,
- "specifiedType": "AUTO",
- "stackConfigTimestamp": "string",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "syncDataEndTime": 0,
- "syncDataId": "string",
- "syncDataStartTime": 0,
- "tags": "string",
- "trustPorts": [
- "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"
}
}Update ICX switch position.
| 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"
}
}Update ICX switch firmware.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
viewInput
| firmwareVersion | string |
| scheduledTime | string |
{- "firmwareVersion": "string",
- "scheduledTime": "string"
}{- "requestId": "string"
}Add ICX switches.
| tenantId required | string Tenant ID |
viewInput
| defaultGateway | string |
| description | string [ 0 .. 255 ] characters |
| dhcpClientEnabled | boolean The default value is true. The DHCP client is enabled by default at bootup on all Brocade devices. |
| dhcpServerEnabled | boolean The default value is false. |
| enableStack | boolean The default value is false. |
| firmwareVersion | string |
| id required | string^(FEG|FEM|FEA|FEB|FEH|FEJ|FEE|FEF|FEC|FED|FEK... |
| igmpSnooping | string Enum: "active" "passive" "none" |
| initialVlanId | integer <int32> [ 1 .. 4095 ] |
| ipAddress | string |
| ipAddressInterface | string |
| ipAddressInterfaceType | string Enum: "PORT" "VE" |
| ipAddressType | string Enum: "static" "dynamic" |
| isPrimaryDeleted | boolean The default value is false. |
| jumboMode | boolean The default value is false. |
| lastDataSyncTime | integer <int64> |
| lastDataSyncTriggerTime | integer <int64> |
| name | string^$|^(?:(?!").){1,255}$ |
object (SwitchPosition) Switch Position object | |
| previousMembers | Array of strings |
| sendedHostname | boolean The default value is false. |
| softDeleted | boolean The default value is false. |
| softDeletedDate | string <date-time> |
| spanningTreePriority | integer <int32> [ 0 .. 65535 ] |
| specifiedType | string Enum: "AUTO" "SWITCH" "ROUTER" default: ImageTypeEnum.AUTO |
| stackConfigTimestamp | string |
Array of objects (StackMembers) | |
| subnetMask | string |
| syncDataEndTime | integer <int64> |
| syncDataId | string |
| syncDataStartTime | integer <int64> |
| tags | string^$|^([^,!\-\ ]{2,58})(,[^,!\-\ ]{2,58}){0,4}$... |
| trustPorts | Array of strings |
| venueId required | string |
[- {
- "defaultGateway": "string",
- "description": "string",
- "dhcpClientEnabled": true,
- "dhcpServerEnabled": true,
- "enableStack": true,
- "firmwareVersion": "string",
- "id": "string",
- "igmpSnooping": "active",
- "initialVlanId": 1,
- "ipAddress": "string",
- "ipAddressInterface": "string",
- "ipAddressInterfaceType": "PORT",
- "ipAddressType": "static",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "lastDataSyncTime": 0,
- "lastDataSyncTriggerTime": 0,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "previousMembers": [
- "string"
], - "sendedHostname": true,
- "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "spanningTreePriority": 0,
- "specifiedType": "AUTO",
- "stackConfigTimestamp": "string",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "syncDataEndTime": 0,
- "syncDataId": "string",
- "syncDataStartTime": 0,
- "tags": "string",
- "trustPorts": [
- "string"
], - "venueId": "string"
}
]{- "requestId": "string",
- "response": [
- {
- "defaultGateway": "string",
- "description": "string",
- "dhcpClientEnabled": true,
- "dhcpServerEnabled": true,
- "enableStack": true,
- "firmwareVersion": "string",
- "id": "string",
- "igmpSnooping": "active",
- "initialVlanId": 1,
- "ipAddress": "string",
- "ipAddressInterface": "string",
- "ipAddressInterfaceType": "PORT",
- "ipAddressType": "static",
- "isPrimaryDeleted": true,
- "jumboMode": true,
- "lastDataSyncTime": 0,
- "lastDataSyncTriggerTime": 0,
- "name": "string",
- "position": {
- "floorplanId": "string",
- "xPercent": 0,
- "yPercent": 0
}, - "previousMembers": [
- "string"
], - "sendedHostname": true,
- "softDeleted": true,
- "softDeletedDate": "2019-08-24T14:15:22Z",
- "spanningTreePriority": 0,
- "specifiedType": "AUTO",
- "stackConfigTimestamp": "string",
- "stackMembers": [
- {
- "id": "string"
}
], - "subnetMask": "string",
- "syncDataEndTime": 0,
- "syncDataId": "string",
- "syncDataStartTime": 0,
- "tags": "string",
- "trustPorts": [
- "string"
], - "venueId": "string"
}
]
}Add stack member.
| 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"
}
}Update the regular or CLI profile.
| tenantId required | string Tenant ID |
viewInput
Array of objects (Acl) ACL profile. | |
| description | string |
| id | string |
| name required | string^.{1,64}$ |
| profileType | string Enum: "Regular" "CLI" |
Array of objects (TrustedPort) Manage port's trust settings. | |
object (VenueCliTemplate) Venue CLI Template data object | |
| venues | Array of strings |
Array of objects (Vlan) VLAN profile. |
{- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "profileType": "Regular",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venueCliTemplate": {
- "cli": "string",
- "id": "string",
- "name": "string",
- "overwrite": true,
- "switchModels": "string",
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
]
}, - "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": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "profileType": "Regular",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venueCliTemplate": {
- "cli": "string",
- "id": "string",
- "name": "string",
- "overwrite": true,
- "switchModels": "string",
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
]
}, - "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"
}
]
}
}Add a regular or CLI profile.
| tenantId required | string Tenant ID |
viewInput
Array of objects (Acl) ACL profile. | |
| description | string |
| id | string |
| name required | string^.{1,64}$ |
| profileType | string Enum: "Regular" "CLI" |
Array of objects (TrustedPort) Manage port's trust settings. | |
object (VenueCliTemplate) Venue CLI Template data object | |
| venues | Array of strings |
Array of objects (Vlan) VLAN profile. |
{- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "profileType": "Regular",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venueCliTemplate": {
- "cli": "string",
- "id": "string",
- "name": "string",
- "overwrite": true,
- "switchModels": "string",
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
]
}, - "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": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "profileType": "Regular",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venueCliTemplate": {
- "cli": "string",
- "id": "string",
- "name": "string",
- "overwrite": true,
- "switchModels": "string",
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
]
}, - "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"
}
]
}
}Get tenant's profile.
| profileId required | string profileId |
| tenantId required | string Tenant ID |
{- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "profileType": "Regular",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venueCliTemplate": {
- "cli": "string",
- "id": "string",
- "name": "string",
- "overwrite": true,
- "switchModels": "string",
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
]
}, - "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"
}
]
}List of tenant's profiles.
| tenantId required | string Tenant ID |
[- {
- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "profileType": "Regular",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venueCliTemplate": {
- "cli": "string",
- "id": "string",
- "name": "string",
- "overwrite": true,
- "switchModels": "string",
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
]
}, - "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"
}
]
}
]List of venue's profiles.
| tenantId required | string Tenant ID |
| venueId required | string venueId |
[- {
- "acls": [
- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
], - "description": "string",
- "id": "string",
- "name": "string",
- "profileType": "Regular",
- "trustedPorts": [
- {
- "id": "string",
- "model": "ICX7150-24",
- "slots": [
- {
- "enable": true,
- "option": "string",
- "slotNumber": 0
}
], - "trustPorts": [
- "string"
], - "trustedPortType": "all",
- "vlanDemand": true
}
], - "venueCliTemplate": {
- "cli": "string",
- "id": "string",
- "name": "string",
- "overwrite": true,
- "switchModels": "string",
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
]
}, - "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 switch's venue-level settings.
| tenantId required | string Tenant ID |
viewInput
| cliApplied | boolean The default value is false. |
| dns | Array of strings |
| firmware | string |
| id | string |
| name | string |
| profileId | Array of strings |
| switchLoginPassword | string |
| switchLoginUsername | string |
| syslogEnabled | boolean The default value is 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... |
{- "cliApplied": true,
- "dns": [
- "string"
], - "firmware": "string",
- "id": "string",
- "name": "string",
- "profileId": [
- "string"
], - "switchLoginPassword": "string",
- "switchLoginUsername": "string",
- "syslogEnabled": true,
- "syslogPrimaryServer": "string",
- "syslogSecondaryServer": "string"
}{- "requestId": "string",
- "response": {
- "cliApplied": true,
- "dns": [
- "string"
], - "firmware": "string",
- "id": "string",
- "name": "string",
- "profileId": [
- "string"
], - "switchLoginPassword": "string",
- "switchLoginUsername": "string",
- "syslogEnabled": true,
- "syslogPrimaryServer": "string",
- "syslogSecondaryServer": "string"
}
}Get switch's venue-level settings.
| tenantId required | string Tenant ID |
| venueId required | string venueId |
{- "cliApplied": true,
- "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,
- "lldpQos": [
- {
- "applicationType": "GUEST_VOICE",
- "dscp": 0,
- "id": "string",
- "priority": 0,
- "qosVlanType": "PRIORITY_TAGGED",
- "vlanId": 1
}
], - "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",
- "voiceVlan": 1
}
]Get different switches' port settings.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
viewInput
| deviceId | string |
| dhcpSnoopingTrust | boolean The default value is false. |
| egressAcl | string |
| id | string |
| ignoreFields | string |
| ingressAcl | string |
| ipsg | boolean The default value is false. |
object (Lag) domain object representing LAG Model | |
| lldpEnable | boolean The default value is true. |
Array of objects (LldpQos) | |
| name | string |
| poeBudget | number <float> [ 1000 .. 30000 ] |
| poeCapability | boolean The default value is true. |
| poeClass | string Enum: "UNSET" "ZERO" "ONE" "TWO" "THREE" "FOUR" |
| poeEnable | boolean The default value is true. |
| poePriority | integer <int32> |
| port | string^\d{1,2}/\d{1,2}/\d{1,2}$ |
| portEnable | boolean The default value is true. |
| portProtected | boolean The default value is 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" "OPTIC" |
| ports | Array of strings |
| revert | boolean The default value is false. |
| rstpAdminEdgePort | boolean The default value is false. |
| stpBpduGuard | boolean The default value is false. |
| stpRootGuard | boolean The default value is false. |
| switchSerialNumber | string |
| taggedVlans | Array of strings |
| tags | string |
| untaggedVlan | string |
| voiceVlan | integer <int32> [ 1 .. 4095 ] |
{- "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,
- "lldpQos": [
- {
- "applicationType": "GUEST_VOICE",
- "dscp": 0,
- "id": "string",
- "priority": 0,
- "qosVlanType": "PRIORITY_TAGGED",
- "vlanId": 1
}
], - "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",
- "voiceVlan": 1
}{- "requestId": "string"
}Get a switch's specific port setting.
| 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,
- "lldpQos": [
- {
- "applicationType": "GUEST_VOICE",
- "dscp": 0,
- "id": "string",
- "priority": 0,
- "qosVlanType": "PRIORITY_TAGGED",
- "vlanId": 1
}
], - "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",
- "voiceVlan": 1
}Get switch's port setting.
| 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,
- "lldpQos": [
- {
- "applicationType": "GUEST_VOICE",
- "dscp": 0,
- "id": "string",
- "priority": 0,
- "qosVlanType": "PRIORITY_TAGGED",
- "vlanId": 1
}
], - "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",
- "voiceVlan": 1
}
]
}Update switch's port setting.
| 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,
- "lldpQos": [
- {
- "applicationType": "GUEST_VOICE",
- "dscp": 0,
- "id": "string",
- "priority": 0,
- "qosVlanType": "PRIORITY_TAGGED",
- "vlanId": 1
}
], - "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",
- "voiceVlan": 1
}, - "switchSerialNumber": "string"
}
]{- "requestId": "string"
}Get different switches' port settings.
| 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,
- "lldpQos": [
- {
- "applicationType": "GUEST_VOICE",
- "dscp": 0,
- "id": "string",
- "priority": 0,
- "qosVlanType": "PRIORITY_TAGGED",
- "vlanId": 1
}
], - "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",
- "voiceVlan": 1
}
]
}Retrieve venue's a AAA setting.
| tenantId required | string Tenant ID |
| venueId required | string venueId |
{- "acctCommonsFirstServer": "string",
- "acctCommonsLevel": "string",
- "acctCommonsSecondServer": "string",
- "acctCommonsThirdServer": "string",
- "acctEnabledCommand": true,
- "acctEnabledExec": true,
- "acctExecFirstServer": "string",
- "acctExecSecondServer": "string",
- "acctExecThirdServer": "string",
- "authnEnableTelnet": true,
- "authnEnabledSsh": true,
- "authnFirstPref": "string",
- "authnFourthPref": "string",
- "authnSecondPref": "string",
- "authnThirdPref": "string",
- "authzCommonsFirstServer": "string",
- "authzCommonsLevel": "string",
- "authzCommonsSecondServer": "string",
- "authzCommonsThirdServer": "string",
- "authzEnabledCommand": true,
- "authzEnabledExec": true,
- "authzExecFirstServer": "string",
- "authzExecSecondServer": "string",
- "authzExecThirdServer": "string",
- "id": "string"
}Update switch's a AAA setting.
| tenantId required | string Tenant ID |
| venueId required | string venueId |
viewInput
| acctCommonsFirstServer | string |
| acctCommonsLevel | string |
| acctCommonsSecondServer | string |
| acctCommonsThirdServer | string |
| acctEnabledCommand | boolean default: false |
| acctEnabledExec | boolean default: false |
| acctExecFirstServer | string |
| acctExecSecondServer | string |
| acctExecThirdServer | string |
| authnEnableTelnet | boolean default: true |
| authnEnabledSsh | boolean default: true |
| authnFirstPref | string |
| authnFourthPref | string |
| authnSecondPref | string |
| authnThirdPref | string |
| authzCommonsFirstServer | string |
| authzCommonsLevel | string |
| authzCommonsSecondServer | string |
| authzCommonsThirdServer | string |
| authzEnabledCommand | boolean default: false |
| authzEnabledExec | boolean default: false |
| authzExecFirstServer | string |
| authzExecSecondServer | string |
| authzExecThirdServer | string |
| id | string |
{- "acctCommonsFirstServer": "string",
- "acctCommonsLevel": "string",
- "acctCommonsSecondServer": "string",
- "acctCommonsThirdServer": "string",
- "acctEnabledCommand": true,
- "acctEnabledExec": true,
- "acctExecFirstServer": "string",
- "acctExecSecondServer": "string",
- "acctExecThirdServer": "string",
- "authnEnableTelnet": true,
- "authnEnabledSsh": true,
- "authnFirstPref": "string",
- "authnFourthPref": "string",
- "authnSecondPref": "string",
- "authnThirdPref": "string",
- "authzCommonsFirstServer": "string",
- "authzCommonsLevel": "string",
- "authzCommonsSecondServer": "string",
- "authzCommonsThirdServer": "string",
- "authzEnabledCommand": true,
- "authzEnabledExec": true,
- "authzExecFirstServer": "string",
- "authzExecSecondServer": "string",
- "authzExecThirdServer": "string",
- "id": "string"
}{- "requestId": "string"
}List of venues switch-profile port's trust settings.
| 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
}
]Update switch-profile port's trust setting.
| 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) ICX model's slot setting. | |
| trustPorts | Array of strings |
| trustedPortType | string Enum: "all" "dhcp" "arp" Trusted-port type setting. |
| vlanDemand | boolean The default value is 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
}
}Add switch-profile port's trust setting.
| 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) ICX model's slot setting. | |
| trustPorts | Array of strings |
| trustedPortType | string Enum: "all" "dhcp" "arp" Trusted-port type setting. |
| vlanDemand | boolean The default value is 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 switch-profile port's trust setting.
| 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
}Delete switch-profile port's trust setting.
| profileId required | string profileId |
| tenantId required | string Tenant ID |
| trustedPortId required | string trustedPortId |
{- "requestId": "string"
}Update switch's LAG setting.
| 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"
}
]Add switch's LAG setting.
| 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"
}
}Get switch's LAG setting.
| lagId required | string lagId |
| tenantId required | string Tenant ID |
{- "id": "string",
- "name": "string",
- "ports": [
- "string"
], - "taggedVlans": [
- "string"
], - "type": "static",
- "untaggedVlan": "string"
}Add switch's LAG settings.
| 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 venues switch-profile VLANs.
| 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 venues switch-profile VLANs 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 venues switch-profile VLANs 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 venues switch-profile VLANs 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"
}
]Update switch-profile VLAN.
| profileId required | string profileId |
| tenantId required | string Tenant ID |
viewInput
| arpInspection | boolean The default value is false. |
| arpInspectionTrustPort | string |
| id | string |
| igmpSnooping | string Enum: "active" "passive" "none" |
| ipv4DhcpSnooping | boolean The default value is 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) ICX switch model setting. | |
| vlanId | integer <int32> [ 1 .. 4095 ] |
| 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"
}
}Add switch-profile VLAN.
| profileId required | string profileId |
| tenantId required | string Tenant ID |
viewInput
| arpInspection | boolean The default value is false. |
| arpInspectionTrustPort | string |
| id | string |
| igmpSnooping | string Enum: "active" "passive" "none" |
| ipv4DhcpSnooping | boolean The default value is 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) ICX switch model setting. | |
| vlanId | integer <int32> [ 1 .. 4095 ] |
| 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"
}
}Get switch-profile 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 switch-profile VLANs.
| 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"
}
]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 VLANs 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
}
]
}Get switches' default VLAN.
| tenantId required | string Tenant ID |
viewInput
[- "string"
]{- "requestId": "string",
- "response": [
- {
- "defaultVlanId": 0,
- "serialNumber": "string"
}
]
}Get this switch-level VLAN.
| id required | string id |
| tenantId required | string Tenant ID |
{- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 0,
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchVlanPortModels": [
- {
- "id": "string",
- "switchModel": "ICX7150-24",
- "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}Get this switch's switch-level VLANs.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
[- {
- "arpInspection": true,
- "arpInspectionTrustPort": "string",
- "id": "string",
- "igmpSnooping": "active",
- "ipv4DhcpSnooping": true,
- "ipv4DhcpSnoopingTrustPort": "string",
- "multicastVersion": 0,
- "spanningTreePriority": 0,
- "spanningTreeProtocol": "rstp",
- "switchVlanPortModels": [
- {
- "id": "string",
- "switchModel": "ICX7150-24",
- "taggedPorts": "string",
- "untaggedPorts": "string"
}
], - "vlanId": 1,
- "vlanName": "string"
}
]Query for this switch's switch-level VLANs.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
viewInput
| fields | Array of strings |
| filterType | string |
| page | integer <int32> default: 1 |
| pageSize | integer <int32> default: 25 |
| sortField | string |
| sortOrder | string Enum: "ASC" "DESC" |
{- "fields": [
- "string"
], - "filterType": "string",
- "page": 0,
- "pageSize": 0,
- "sortField": "string",
- "sortOrder": "ASC"
}{- "data": [
- { }
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}Update switch's VE setting.
| tenantId required | string Tenant ID |
viewInput
| defaultVlan | boolean default: false |
| dhcpRelayAgent | string |
| egressAcl | string |
| id | string |
| ingressAcl | string |
| ipAddress | string |
| ipAddressType | string Enum: "static" "dynamic" |
| ipSubnetMask | string |
| name | string |
| ospfArea | string |
| veId | integer <int32> [ 1 .. 4095 ] |
| vlanId | integer <int32> |
{- "defaultVlan": true,
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipAddressType": "static",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 1,
- "vlanId": 0
}{- "requestId": "string",
- "response": {
- "defaultVlan": true,
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipAddressType": "static",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 1,
- "vlanId": 0
}
}List of switch's VE settings.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
[- {
- "defaultVlan": true,
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipAddressType": "static",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 1,
- "vlanId": 0
}
]Add switch's VE setting.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
viewInput
| defaultVlan | boolean default: false |
| dhcpRelayAgent | string |
| egressAcl | string |
| id | string |
| ingressAcl | string |
| ipAddress | string |
| ipAddressType | string Enum: "static" "dynamic" |
| ipSubnetMask | string |
| name | string |
| ospfArea | string |
| veId | integer <int32> [ 1 .. 4095 ] |
| vlanId | integer <int32> |
{- "defaultVlan": true,
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipAddressType": "static",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 1,
- "vlanId": 0
}{- "requestId": "string",
- "response": {
- "defaultVlan": true,
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipAddressType": "static",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 1,
- "vlanId": 0
}
}Get switch's VE setting.
| tenantId required | string Tenant ID |
| vePortId required | string vePortId |
{- "defaultVlan": true,
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipAddressType": "static",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 1,
- "vlanId": 0
}Add switch's VE settings.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
viewInput
| defaultVlan | boolean default: false |
| dhcpRelayAgent | string |
| egressAcl | string |
| id | string |
| ingressAcl | string |
| ipAddress | string |
| ipAddressType | string Enum: "static" "dynamic" |
| ipSubnetMask | string |
| name | string |
| ospfArea | string |
| veId | integer <int32> [ 1 .. 4095 ] |
| vlanId | integer <int32> |
[- {
- "defaultVlan": true,
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipAddressType": "static",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 1,
- "vlanId": 0
}
]{- "requestId": "string",
- "response": [
- {
- "defaultVlan": true,
- "dhcpRelayAgent": "string",
- "egressAcl": "string",
- "id": "string",
- "ingressAcl": "string",
- "ipAddress": "string",
- "ipAddressType": "static",
- "ipSubnetMask": "string",
- "name": "string",
- "ospfArea": "string",
- "veId": 1,
- "vlanId": 0
}
]
}Update switch's static-Route setting.
| 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 static-Route settings.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
[- {
- "adminDistance": 1,
- "destinationIp": "string",
- "id": "string",
- "nextHop": "string"
}
]Add switch's static-Route setting.
| 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"
}
}Get switch's static-Route setting.
| staticRouteId required | string staticRouteId |
| tenantId required | string Tenant ID |
{- "adminDistance": 1,
- "destinationIp": "string",
- "id": "string",
- "nextHop": "string"
}Add switch's static-Route settings.
| 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 venues switch-profile ACLs.
| tenantId required | string Tenant ID |
| venueId required | string venueId |
[- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
]Update switch-profile ACL.
| profileId required | string profileId |
| tenantId required | string Tenant ID |
viewInput
Array of objects (AclRule) Setting the ACL rules. | |
| aclType | string Enum: "standard" "extended" |
| id | string |
| name | string |
{- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}{- "requestId": "string",
- "response": {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
}Add switch-profile ACL.
| profileId required | string profileId |
| tenantId required | string Tenant ID |
viewInput
Array of objects (AclRule) Setting the ACL rules. | |
| aclType | string Enum: "standard" "extended" |
| id | string |
| name | string |
{- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}{- "requestId": "string",
- "response": {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
}Get switch-profile ACL.
| aclId required | string aclId |
| profileId required | string profileId |
| tenantId required | string Tenant ID |
{- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}List of switch-profile ACL.
| profileId required | string profileId |
| tenantId required | string Tenant ID |
| page | string page |
| size | string size |
[- {
- "aclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
], - "aclType": "standard",
- "id": "string",
- "name": "string"
}
]Get this switch-level ACL.
| id required | string id |
| tenantId required | string Tenant ID |
{- "aclType": "standard",
- "id": "string",
- "name": "string",
- "switchAclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
]
}Get this switch's switch-level ACLs.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
[- {
- "aclType": "standard",
- "id": "string",
- "name": "string",
- "switchAclRules": [
- {
- "action": "permit",
- "destination": "string",
- "destinationPort": 0,
- "id": "string",
- "protocol": "ip",
- "sequence": 1,
- "source": "string",
- "sourcePort": 0
}
]
}
]List of venue's AAA servers.
| tenantId required | string Tenant ID |
viewInput
| fields | Array of strings |
| page | integer <int32> default: 1 |
| pageSize | integer <int32> default: 25 |
| searchString | string |
| searchTargetFields | Array of strings |
| serverType | string Enum: "RADIUS" "TACACS_PLUS" "LOCAL" "SERVER_TYPE_NONE" default: AaaServerServerTypeEnum.LOCAL |
| sortField | string |
| sortOrder | string Enum: "ASC" "DESC" |
| venueId | string |
{- "fields": [
- "string"
], - "page": 0,
- "pageSize": 0,
- "searchString": "string",
- "searchTargetFields": [
- "string"
], - "serverType": "RADIUS",
- "sortField": "string",
- "sortOrder": "ASC",
- "venueId": "string"
}{- "data": [
- { }
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}Get a switch's AAA Server setting.
| aaaServerId required | string aaaServerId |
| tenantId required | string Tenant ID |
{- "acctPort": 0,
- "authPort": 0,
- "id": "string",
- "ip": "string",
- "level": "READ_WRITE",
- "name": "string",
- "password": "string",
- "purpose": "DEFAULT",
- "secret": "string",
- "serverType": "RADIUS",
- "username": "string"
}Update switch's a AAA Server setting.
| tenantId required | string Tenant ID |
| venueId required | string venueId |
viewInput
| acctPort | integer <int32> [ 0 .. 65535 ] |
| authPort | integer <int32> [ 0 .. 65535 ] |
| id | string |
| ip | string^([1-9]|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.([0... |
| level | string Enum: "READ_WRITE" "PORT_CONFIG" "READ_ONLY" "LEVEL_NONE" |
| name | string |
| password | string |
| purpose | string Enum: "DEFAULT" "AUTHENTICATION_ONLY" "AUTHORIZATION_ONLY" "ACCOUNTING_ONLY" |
| secret | string |
| serverType | string Enum: "RADIUS" "TACACS_PLUS" "LOCAL" "SERVER_TYPE_NONE" |
| username | string |
{- "acctPort": 0,
- "authPort": 0,
- "id": "string",
- "ip": "string",
- "level": "READ_WRITE",
- "name": "string",
- "password": "string",
- "purpose": "DEFAULT",
- "secret": "string",
- "serverType": "RADIUS",
- "username": "string"
}{- "requestId": "string",
- "response": {
- "acctPort": 0,
- "authPort": 0,
- "id": "string",
- "ip": "string",
- "level": "READ_WRITE",
- "name": "string",
- "password": "string",
- "purpose": "DEFAULT",
- "secret": "string",
- "serverType": "RADIUS",
- "username": "string"
}
}Add switch's AAA server settings.
| tenantId required | string Tenant ID |
| venueId required | string venueId |
viewInput
| acctPort | integer <int32> [ 0 .. 65535 ] |
| authPort | integer <int32> [ 0 .. 65535 ] |
| id | string |
| ip | string^([1-9]|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.([0... |
| level | string Enum: "READ_WRITE" "PORT_CONFIG" "READ_ONLY" "LEVEL_NONE" |
| name | string |
| password | string |
| purpose | string Enum: "DEFAULT" "AUTHENTICATION_ONLY" "AUTHORIZATION_ONLY" "ACCOUNTING_ONLY" |
| secret | string |
| serverType | string Enum: "RADIUS" "TACACS_PLUS" "LOCAL" "SERVER_TYPE_NONE" |
| username | string |
{- "acctPort": 0,
- "authPort": 0,
- "id": "string",
- "ip": "string",
- "level": "READ_WRITE",
- "name": "string",
- "password": "string",
- "purpose": "DEFAULT",
- "secret": "string",
- "serverType": "RADIUS",
- "username": "string"
}{- "requestId": "string",
- "response": {
- "acctPort": 0,
- "authPort": 0,
- "id": "string",
- "ip": "string",
- "level": "READ_WRITE",
- "name": "string",
- "password": "string",
- "purpose": "DEFAULT",
- "secret": "string",
- "serverType": "RADIUS",
- "username": "string"
}
}List of venue's DHCP servers.
| tenantId required | string Tenant ID |
viewInput
| fields | Array of strings |
| page | integer <int32> default: 1 |
| pageSize | integer <int32> default: 25 |
| searchString | string |
| searchTargetFields | Array of strings |
| sortField | string |
| sortOrder | string Enum: "ASC" "DESC" |
| venueId | string |
{- "fields": [
- "string"
], - "page": 0,
- "pageSize": 0,
- "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "ASC",
- "venueId": "string"
}{- "data": [
- { }
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}Get switch's DHCP Server setting.
| dhcpServerId required | string dhcpServerId |
| tenantId required | string Tenant ID |
{- "defaultRouterIp": "string",
- "dhcpOptions": [
- {
- "seq": 0,
- "type": "ASCII",
- "value": "string"
}
], - "excludedEnd": "string",
- "excludedStart": "string",
- "id": "string",
- "leaseDays": 0,
- "leaseHrs": 0,
- "leaseMins": 0,
- "network": "string",
- "poolName": "string",
- "subnetAddress": "string",
- "subnetMask": "string"
}Update switch's DHCP Server setting.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
viewInput
| defaultRouterIp | string |
Array of objects (DhcpOption) | |
| excludedEnd | string |
| excludedStart | string |
| id | string |
| leaseDays | integer <int32> |
| leaseHrs | integer <int32> |
| leaseMins | integer <int32> |
| network | string |
| poolName | string |
| subnetAddress required | string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\... |
| subnetMask required | string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128... |
{- "defaultRouterIp": "string",
- "dhcpOptions": [
- {
- "seq": 0,
- "type": "ASCII",
- "value": "string"
}
], - "excludedEnd": "string",
- "excludedStart": "string",
- "id": "string",
- "leaseDays": 0,
- "leaseHrs": 0,
- "leaseMins": 0,
- "network": "string",
- "poolName": "string",
- "subnetAddress": "string",
- "subnetMask": "string"
}{- "requestId": "string",
- "response": {
- "defaultRouterIp": "string",
- "dhcpOptions": [
- {
- "seq": 0,
- "type": "ASCII",
- "value": "string"
}
], - "excludedEnd": "string",
- "excludedStart": "string",
- "id": "string",
- "leaseDays": 0,
- "leaseHrs": 0,
- "leaseMins": 0,
- "network": "string",
- "poolName": "string",
- "subnetAddress": "string",
- "subnetMask": "string"
}
}Add switch's DHCP server settings.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
viewInput
| defaultRouterIp | string |
Array of objects (DhcpOption) | |
| excludedEnd | string |
| excludedStart | string |
| id | string |
| leaseDays | integer <int32> |
| leaseHrs | integer <int32> |
| leaseMins | integer <int32> |
| network | string |
| poolName | string |
| subnetAddress required | string^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\... |
| subnetMask required | string^(?:(?:(?:255\.){3}(?:252|248|240|224|192|128... |
{- "defaultRouterIp": "string",
- "dhcpOptions": [
- {
- "seq": 0,
- "type": "ASCII",
- "value": "string"
}
], - "excludedEnd": "string",
- "excludedStart": "string",
- "id": "string",
- "leaseDays": 0,
- "leaseHrs": 0,
- "leaseMins": 0,
- "network": "string",
- "poolName": "string",
- "subnetAddress": "string",
- "subnetMask": "string"
}{- "requestId": "string",
- "response": {
- "defaultRouterIp": "string",
- "dhcpOptions": [
- {
- "seq": 0,
- "type": "ASCII",
- "value": "string"
}
], - "excludedEnd": "string",
- "excludedStart": "string",
- "id": "string",
- "leaseDays": 0,
- "leaseHrs": 0,
- "leaseMins": 0,
- "network": "string",
- "poolName": "string",
- "subnetAddress": "string",
- "subnetMask": "string"
}
}List of ICX's DHCP servers.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
viewInput
| fields | Array of strings |
| page | integer <int32> default: 1 |
| pageSize | integer <int32> default: 25 |
| searchString | string |
| searchTargetFields | Array of strings |
| sortField | string |
| sortOrder | string Enum: "ASC" "DESC" |
| venueId | string |
{- "fields": [
- "string"
], - "page": 0,
- "pageSize": 0,
- "searchString": "string",
- "searchTargetFields": [
- "string"
], - "sortField": "string",
- "sortOrder": "ASC",
- "venueId": "string"
}{- "data": [
- { }
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}Delete switch's DHCP Server setting.
| dhcpServerId required | string dhcpServerId |
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
{- "requestId": "string"
}Delete switch's DHCP servers.
| serialNumber required | string serialNumber |
| tenantId required | string Tenant ID |
viewInput
{- "requestId": "string"
}Query for configuration history details on this switch.
| id required | string id |
| tenantId required | string Tenant ID |
viewInput
| filterByConfigType | string |
| filterByStatus | string Enum: "ALL" "SUCCESS" "FAILED" Filter By DispatchStatus In Configuration History |
| limit | integer <int32> default: 8 |
| page | integer <int32> default: 1 |
object (ConfigurationHistoryDetailSortInfo) Configuration History Detail Sort Infomation |
{- "filterByConfigType": "string",
- "filterByStatus": "ALL",
- "limit": 0,
- "page": 0,
- "sortInfo": {
- "dir": "ASC",
- "sortColumn": "startTime"
}
}{- "requestId": "string",
- "response": {
- "list": [
- {
- "clis": "string",
- "configType": "string",
- "dispatchFailedReason": [
- {
- "lineNumber": "string",
- "message": "string",
- "status": "string"
}
], - "dispatchStatus": "string",
- "endTime": "string",
- "numberOfErrors": 0,
- "serialNumber": "string",
- "startTime": "string",
- "switchName": "string",
- "transactionId": "string"
}
], - "totalCount": 0
}
}Get the configuration history details of this transaction on this switch.
| id required | string id |
| tenantId required | string Tenant ID |
| transactionId required | string transactionId |
{- "requestId": "string",
- "response": {
- "clis": "string",
- "configType": "string",
- "dispatchFailedReason": [
- {
- "lineNumber": "string",
- "message": "string",
- "status": "string"
}
], - "dispatchStatus": "string",
- "endTime": "string",
- "numberOfErrors": 0,
- "serialNumber": "string",
- "startTime": "string",
- "switchName": "string",
- "transactionId": "string"
}
}Get the configuration history details for this transaction relative to the switches in this venue.
| id required | string id |
| tenantId required | string Tenant ID |
| transactionId required | string transactionId |
viewInput
| filterByConfigType | string |
| filterByStatus | string Enum: "ALL" "SUCCESS" "FAILED" Filter By DispatchStatus In Configuration History |
| limit | integer <int32> default: 8 |
| page | integer <int32> default: 1 |
object (ConfigurationHistoryDetailSortInfo) Configuration History Detail Sort Infomation |
{- "filterByConfigType": "string",
- "filterByStatus": "ALL",
- "limit": 0,
- "page": 0,
- "sortInfo": {
- "dir": "ASC",
- "sortColumn": "startTime"
}
}{- "requestId": "string",
- "response": {
- "list": [
- {
- "clis": "string",
- "configType": "string",
- "dispatchFailedReason": [
- {
- "lineNumber": "string",
- "message": "string",
- "status": "string"
}
], - "dispatchStatus": "string",
- "endTime": "string",
- "numberOfErrors": 0,
- "serialNumber": "string",
- "startTime": "string",
- "switchName": "string",
- "transactionId": "string"
}
], - "totalCount": 0
}
}Query for configuration history details for switches in this venue.
| id required | string id |
| tenantId required | string Tenant ID |
viewInput
| filterByConfigType | string |
| filterByStatus | string Enum: "ALL" "SUCCESS" "FAILED" Filter By DispatchStatus In Configuration History |
| limit | integer <int32> default: 8 |
| page | integer <int32> default: 1 |
object (ConfigurationHistoryDetailSortInfo) Configuration History Detail Sort Infomation |
{- "filterByConfigType": "string",
- "filterByStatus": "ALL",
- "limit": 0,
- "page": 0,
- "sortInfo": {
- "dir": "ASC",
- "sortColumn": "startTime"
}
}{- "requestId": "string",
- "response": {
- "list": [
- {
- "configType": "string",
- "endTime": "string",
- "numberOfFailed": 0,
- "numberOfSuccess": 0,
- "numberOfSwitches": 0,
- "startTime": "string",
- "transactionId": "string"
}
], - "totalCount": 0
}
}Compare switch's configuration backups.
| 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 configuration backup
| 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"
}
]Create a switch's configuration backup.
| 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"
}
}Get a switch's configuration backup.
| id required | string id |
| 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"
}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).
| tenantId required | string Tenant ID |
payload
| exists | string |
| fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
| multiSortFields | Array of strings |
| mustHaveFields | Array of strings |
| mustNotHaveFields | 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) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "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,
- "switchId": "string",
- "switchMac": "string",
- "switchName": "string",
- "switchPort": "string",
- "venueId": "string",
- "venueName": "string",
- "vlanName": "string"
}
], - "errorMessage": "string",
- "fields": [
- "string"
], - "objectId": "string",
- "page": 0,
- "subsequentQueries": [
- {
- "fields": [
- "string"
], - "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 Switch stack members.
| tenantId required | string Tenant ID |
payload
"string""string"Get a list of parameters for the switch's ports.
| tenantId required | string Tenant ID |
payload
| exists | string |
| fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
| multiSortFields | Array of strings |
| mustHaveFields | Array of strings |
| mustNotHaveFields | 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) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "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": [
- "string"
], - "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 parameters and operational data for a list of switches.
| tenantId required | string Tenant ID |
payload
| exists | string |
| fields | Array of strings |
object | |
Array of objects (MatchFieldDto) | |
| multiSortFields | Array of strings |
| mustHaveFields | Array of strings |
| mustNotHaveFields | 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) |
{- "exists": "string",
- "fields": [
- "string"
], - "filters": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "matchFields": [
- {
- "field": "string",
- "value": "string"
}
], - "multiSortFields": [
- "string"
], - "mustHaveFields": [
- "string"
], - "mustNotHaveFields": [
- "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,
- "cliApplied": true,
- "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",
- "ipFullContentParsed": true,
- "isStack": true,
- "lastUpdTime": "string",
- "lastUpdateTimeInMillis": "string",
- "memory": "string",
- "model": "string",
- "modules": "string",
- "name": "string",
- "numOfPorts": 0,
- "numOfUnits": 0,
- "operationalStackMembers": "string",
- "operationalWarning": true,
- "poeFree": 0,
- "poeTotal": 0,
- "poeUtilization": 0,
- "portStatuses": [
- {
- "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"
}
], - "powerSupplyGroups": "string",
- "provisionName": "string",
- "serialNumber": "string",
- "staticOrDynamic": "string",
- "subnetMask": "string",
- "switchGroupLevelOneId": "string",
- "switchGroupLevelOneName": "string",
- "switchGroupLevelTwoId": "string",
- "switchMac": "string",
- "switchName": "string",
- "switchType": "string",
- "syncDataEndTime": "string",
- "syncDataId": "string",
- "syncDataStartTime": "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": [
- "string"
], - "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 CLI templates.
| tenantId required | string Tenant ID |
[- {
- "applyLater": true,
- "cli": "string",
- "id": "string",
- "name": "string",
- "reload": true,
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
], - "venueSwitches": [
- {
- "switches": [
- "string"
], - "venueId": "string"
}
]
}
]Update a CLI template for switches.
| tenantId required | string Tenant ID |
viewInput
| applyLater | boolean default: false |
| cli | string |
| id | string |
| name required | string^.{1,64}$ |
| reload | boolean default: false |
Array of objects (CliTemplateVariable) | |
Array of objects (VenueSwitch) |
{- "applyLater": true,
- "cli": "string",
- "id": "string",
- "name": "string",
- "reload": true,
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
], - "venueSwitches": [
- {
- "switches": [
- "string"
], - "venueId": "string"
}
]
}{- "requestId": "string",
- "response": {
- "applyLater": true,
- "cli": "string",
- "id": "string",
- "name": "string",
- "reload": true,
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
], - "venueSwitches": [
- {
- "switches": [
- "string"
], - "venueId": "string"
}
]
}
}Create a CLI template for switches.
| tenantId required | string Tenant ID |
viewInput
| applyLater | boolean default: false |
| cli | string |
| id | string |
| name required | string^.{1,64}$ |
| reload | boolean default: false |
Array of objects (CliTemplateVariable) | |
Array of objects (VenueSwitch) |
{- "applyLater": true,
- "cli": "string",
- "id": "string",
- "name": "string",
- "reload": true,
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
], - "venueSwitches": [
- {
- "switches": [
- "string"
], - "venueId": "string"
}
]
}{- "requestId": "string",
- "response": {
- "applyLater": true,
- "cli": "string",
- "id": "string",
- "name": "string",
- "reload": true,
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
], - "venueSwitches": [
- {
- "switches": [
- "string"
], - "venueId": "string"
}
]
}
}Get a list of CLI template examples.
| tenantId required | string Tenant ID |
| category | string category |
[- {
- "cli": "string",
- "id": "string",
- "name": "string",
- "version": "string"
}
]Get a list of CLI templates by query.
| tenantId required | string Tenant ID |
viewInput
| fields | Array of strings |
| filterType | string |
| page | integer <int32> default: 1 |
| pageSize | integer <int32> default: 25 |
| sortField | string |
| sortOrder | string Enum: "ASC" "DESC" |
{- "fields": [
- "string"
], - "filterType": "string",
- "page": 0,
- "pageSize": 0,
- "sortField": "string",
- "sortOrder": "ASC"
}{- "data": [
- { }
], - "fields": [
- "string"
], - "page": 0,
- "totalCount": 0,
- "totalPages": 0
}Get a CLI template.
| templateId required | string templateId |
| tenantId required | string Tenant ID |
{- "applyLater": true,
- "cli": "string",
- "id": "string",
- "name": "string",
- "reload": true,
- "variables": [
- {
- "name": "string",
- "type": "ADDRESS",
- "value": "string"
}
], - "venueSwitches": [
- {
- "switches": [
- "string"
], - "venueId": "string"
}
]
}