Switch Manager
Overview
This reference guide describes the public APIs supported by the Switch Manager. All API URIs in this guide could use the below all common prefix, where {host} is the IP address of the management interface of the controller.
| Prefix Pattern |
|---|
| https://{host}:8443/switchm/api |
Version Matrix
The API version would follow the SmartZone support versions, please refer to the following matrix.
| SZ Version | API Version |
|---|---|
5.2.1 |
v8_0 v8_1 v8_2 v9_0 v9_1 |
Common Request URI Parameters
The following parameters are required in the Request URI Parameters of all API requests (except for the logon API).
| Parameter | Value |
|---|---|
| serviceTicket | {serviceTicket} |
serviceTicket is returned as the following parameter in the response payload of the Service Ticket Logon API of the Smart Zone.
OpenAPI documents
OpenAPI documents is based on OAS 2.0, Please try it for free.
Installed Smart Zone Software Release and link to https://{host}:8443/switchm/api/openapi for the detail.
You can get the usage at https://swagger.io/, use the Swagger tools to meet your needs.
Not Support URIs
Due to the feature has been changed the design. There below URIs are no longer support in all API version as below.
-
Switch AAA Servers
Remove Substitution POST aaaServers/adminPOST group/{groupId}/aaaServersPOST aaaServers/admin/queryPOST group/{groupId}/aaaServers/queryGET aaaServers/adminGET group/{groupId}/aaaServersGET aaaServers/admin/{aaaServerUUID}GET group/{groupId}/aaaServers/{aaaServerUUID}DELETE aaaServers/adminDELETE group/{groupId}/aaaServersDELETE aaaServers/admin/{aaaServerUUID}DELETE group/{groupId}/aaaServers/{aaaServerUUID}PATCH aaaServers/admin/{aaaServerUUID}PATCH group/{groupId}/aaaServers/{aaaServerUUID} -
Switch AAA Settings
Remove Substitution GET aaaSettingsGET group/{groupId}/aaaSettingsPUT aaaSettingsPUT group/{groupId}/aaaSettings
Switch Configuration ¶
Retrieve Configuration Backup Content ¶
GET/v9_1/switchconfig/{configId}
Use this API command to retrieve configuration backup content.
Response
200Download Configuration Backup Content ¶
GET/v9_1/switchconfig/download/{configId}
Use this API command to download configuration backup content as plain text.
Response
200Get Config Backup List ¶
POST/v9_1/switchconfig
Use this API command to retrieve configuration backup list with specified filters.
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 2,
"hasMore": false,
"firstIndex": 8,
"list": [
{
"id": "844db453-2112-42ad-b6eb-6bf5a0fd987b",
"name": "60:9C:9F:DA:63:80-1528934400165",
"type": "SCHEDULED",
"switchName": "ICX7750-1",
"status": "SUCCESS",
"timestamp": 1528934400165,
"restoreStatus": null,
"restoreTimestamp": null,
"failureReason": ""
},
{
"id": "69acdc88-ab7c-4007-9301-91df234bb185",
"name": "60:9C:9F:DA:63:80-1528761600156",
"type": "SCHEDULED",
"switchName": "ICX7750-1",
"status": "SUCCESS",
"timestamp": 1528761600156,
"restoreStatus": null,
"restoreTimestamp": null,
"failureReason": ""
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "ConfigBackup count",
"type": "integer"
},
"totalCount": {
"description": "Total ConfigBackup count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more ConfigBackup after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first ConfigBackup returned out of the complete ConfigBackup list",
"type": "integer"
},
"extra": {
"description": "Extra information for ConfigBackup list",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
},
"properties": {}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the config backup",
"type": "string"
},
"name": {
"description": "the name of the config backup",
"type": "string"
},
"type": {
"description": "Scheduled or Manual",
"type": "string"
},
"switchName": {
"description": "Switch Name of the config backup",
"type": "string"
},
"status": {
"description": "the status of the config backup",
"type": "string"
},
"timestamp": {
"description": "the timestamp of the config backup",
"type": "integer",
"format": "int64"
},
"restoreStatus": {
"description": "Status of config restore",
"type": "string"
},
"restoreTimestamp": {
"description": "the timestamp of the config restore",
"type": "integer",
"format": "int64"
},
"failureReason": {
"description": "Failure reason of the config backup and config restore",
"type": "string"
}
}
}
}
}
}Backup Configuration for Switches ¶
POST/v9_1/switchconfig/backup
Use this API command to backup configuration for a list of switches.
Request
Body
[
"CC:4E:24:8B:5C:30",
"CC:4E:24:8B:19:D8"
]Schema
{
"type": "array",
"items": {
"description": "Switch id",
"type": "string"
}
}Response
201Body
{
"rawDataTotalCount": 0,
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"switchId": "CC:4E:24:8B:5C:30",
"configBackupId": "b3921397-d6e9-4877-befc-2bcbf65158e7",
"errorMessage": ""
},
{
"switchId": "CC:4E:24:8B:19:D8",
"configBackupId": "",
"errorMessage": "provision doesn't finished yet"
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total ConfigBackupInfo count",
"type": "integer"
},
"totalCount": {
"description": "Current ConfigBackupInfo count",
"type": "integer"
},
"hasMore": {
"description": "Has more data or not",
"type": "boolean"
},
"firstIndex": {
"description": "Index of first index in current page",
"type": "integer"
},
"extra": {
"description": "Extra information for config backup policy",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
},
"properties": {}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"configBackupId": {
"description": "Identifier of config backup",
"type": "string"
},
"switchId": {
"description": "Identifier of switch",
"type": "string"
},
"errorMessage": {
"description": "Error message",
"type": "string"
}
}
}
}
}
}Diff between two Config Backup Files ¶
POST/v9_1/switchconfig/backup/diff
Use this API command to diff between two config back up files for a switch.
Request
Body
{
"configBackupId1": "844db453-2112-42ad-b6eb-6bf5a0fd987b",
"configBackupId2": "69acdc88-ab7c-4007-9301-91df234bb185"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"configBackupId1": {
"description": "The first config backup id of diff input",
"type": "string"
},
"configBackupId2": {
"description": "The second config backup id of diff input",
"type": "string"
}
}
}Response
200Body
{
"configBackup1": {
"id": "844db453-2112-42ad-b6eb-6bf5a0fd987b",
"name": "60:9C:9F:DA:63:80-1528934400165",
"config": "ver 08.0.80b254T201\n!\nstack unit 1\n module 1 icx7750-48-xgc-port-management-module\n module 2 icx7750-qsfp-6port-qsfp-240g-module\n!\n\n!\n!\n!\n!\n!\nvlan 1 name DEFAULT-VLAN by port\n!\nvlan 192 by port\n tagged ethe 1/1/1 \n!\n!\n!\n!\n!\n!\n!\n!\n!\n!\n!\n!\nboot sys fl pri\nhostname ICX7750-1\nip address 192.168.240.31 255.255.0.0\nip default-gateway 192.168.253.253\n!\n!\n!\nsnmp-server community 2 $U2kyXj1k ro\n!\n!\n!\n!\nntp\n server 192.168.253.254\n!\n!\n!\nsz active-list 192.168.240.204\n!\n!\n!\n!\nlldp run\n!\n!\n!\n!\n!\nend\n"
},
"configBackup2": {
"id": "69acdc88-ab7c-4007-9301-91df234bb185",
"name": "60:9C:9F:DA:63:80-1528761600156",
"config": "ver 08.0.80b207T201\n!\nstack unit 1\n module 1 icx7750-48-xgc-port-management-module\n module 2 icx7750-qsfp-6port-qsfp-240g-module\n!\n\n!\n!\n!\n!\n!\nvlan 1 name DEFAULT-VLAN by port\n!\nvlan 192 by port\n tagged ethe 1/1/1 \n!\n!\n!\n!\n!\n!\n!\n!\n!\n!\n!\n!\nboot sys fl pri\nhostname ICX7750-1\nip address 192.168.240.31 255.255.0.0\n!\n!\n!\nsnmp-server community 2 $U2kyXj1k ro\n!\n!\n!\n!\nntp\n server 192.168.253.254\n!\n!\nsz active 192.168.240.204\n!\n!\n!\nlldp run\n!\n!\n!\n!\n!\nend\n"
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"configBackup1": {
"description": "The first config backup content of diff input",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the ConfigBackup Content",
"type": "string"
},
"name": {
"description": "Name of the ConfigBackup Content",
"type": "string"
},
"config": {
"description": "Content of the ConfigBackup",
"type": "string"
}
}
},
"configBackup2": {
"description": "The second config backup content of diff input",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "the identifier of the ConfigBackup Content",
"type": "string"
},
"name": {
"description": "Name of the ConfigBackup Content",
"type": "string"
},
"config": {
"description": "Content of the ConfigBackup",
"type": "string"
}
}
}
}
}Backup Configurations for a Group ¶
PUT/v9_1/switchconfig/{groupType}/{groupId}/backup
Use this API command to backup configurations for all switches under a group.
Response
204Restore Configuration ¶
PUT/v9_1/switchconfig/backup/{backupId}/restore
Restore a configuration backup to the switch.
Response
200Backup Configuration ¶
PUT/v8_0/switchconfig/backup
Use this API command to backup configuration for a list of switches.
Deprecated : this URI will be deprecated after Version: v8_0, and no longer be supported.
Request
Body
[
"CC:4E:24:8B:5C:30",
"CC:4E:24:8B:19:D8"
]Schema
{
"type": "array",
"items": {
"description": "Switch id",
"type": "string"
}
}Response
204Delete Config Backup ¶
DELETE/v9_1/switchconfig/{configId}
Use this API command to delete the configuration backup.
Response
204Delete Config Backups ¶
DELETE/v9_1/switchconfig
Use this API command to delete config backups by a list of config backup id.
Request
Body
[
"844db453-2112-42ad-b6eb-6bf5a0fd987b",
"69acdc88-ab7c-4007-9301-91df234bb185"
]Schema
{
"type": "array",
"items": {
"description": "Config backup id",
"type": "string"
}
}Response
204Switch Firmware ¶
List Firmwares ¶
GET/v9_1/firmware
Use this API command to retrieve list of switch firmwares uploaded to SmartZone.
Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"version": "B254",
"switchModels": [
{
"name": "ICX7750",
"imageFileNames": [
"SWS08080b254ufi.bin",
"SWR08080b254ufi.bin"
]
}
]
},
{
"version": "B207",
"switchModels": [
{
"name": "ICX7750",
"imageFileNames": [
"SWS08080b207ufi.bin",
"SWR08080b207ufi.bin"
]
}
]
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Firmware list count",
"type": "integer"
},
"totalCount": {
"description": "Total Firmware list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Firmwares after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first firmware list returned out of the complete Firmware list",
"type": "integer"
},
"extra": {
"description": "Extra information for Firmware list",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"version": {
"description": "Firmware version of the Switch",
"type": "string"
},
"switchModels": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Switch Model",
"type": "string"
},
"imageFileNames": {
"description": "Name of the Switch Image File",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
}Upload Firmware Image ¶
POST/v9_1/firmware/upload
Use this API command to upload a firmware image zip file to SmartZone.
Request
Headers
Content-Type: multipart/form-dataResponse
200List Firmwares ¶
POST/v9_1/firmware
Use this API command to retrieve list of switch firmwares uploaded to SmartZone.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"value": "60:9C:9F:DA:63:80",
"type": "SWITCH"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"version": "B254",
"switchModels": [
{
"name": "ICX7750",
"imageFileNames": [
"SWS08080b254ufi.bin",
"SWR08080b254ufi.bin"
]
}
]
},
{
"version": "B207",
"switchModels": [
{
"name": "ICX7750",
"imageFileNames": [
"SWS08080b207ufi.bin",
"SWR08080b207ufi.bin"
]
}
]
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Firmware list count",
"type": "integer"
},
"totalCount": {
"description": "Total Firmware list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Firmwares after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first firmware list returned out of the complete Firmware list",
"type": "integer"
},
"extra": {
"description": "Extra information for Firmware list",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"version": {
"description": "Firmware version of the Switch",
"type": "string"
},
"switchModels": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the Switch Model",
"type": "string"
},
"imageFileNames": {
"description": "Name of the Switch Image File",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
}Apply Firmware Update ¶
PATCH/v9_1/firmware/{version}
Use this API command to update the given firmware version on switches matching criteria.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "",
"dir": "ASC"
},
"page": 1,
"limit": 8
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
"firmware-update-ONE_TIME-1524822740577"
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Firmware list count",
"type": "integer"
},
"totalCount": {
"description": "Total Schedule Ids count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Schedule Ids after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Schedule Ids returned out of the complete ConfigBackup list",
"type": "integer"
},
"extra": {
"description": "Extra information for Schedule Ids list",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Switch Health ¶
Switch Unit Hardware Status ¶
POST/v9_1/health/status/{serialNumber}
Use this API command to retrieve fan, temperature and power supply status for the switch unit managed by SmartZone.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1547012879222,
"end": 1547016479222,
"interval": 300000
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"onlineCount": {
"description": "Online status count",
"type": "integer"
},
"flaggedCount": {
"description": "Flagged status count",
"type": "integer"
},
"offlineCount": {
"description": "Offline status count",
"type": "integer"
},
"powerSupply": {
"description": "Powersupply",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Power supply slot number",
"type": "integer"
},
"type": {
"description": "Power supply type",
"type": "string"
},
"status": {
"description": "Power supply status",
"type": "string"
}
}
}
},
"temperature": {
"description": "Temperature",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"slotNumber": {
"description": "Solt number",
"type": "integer"
},
"temperatureValue": {
"description": "Slot temperature",
"type": "number"
},
"serialNumber": {
"type": "string"
}
}
}
},
"fan": {
"description": "Fan",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Fan slot number",
"type": "integer"
},
"type": {
"description": "Fan type",
"type": "string"
},
"status": {
"description": "Fan status",
"type": "string"
}
}
}
},
"powerHealthStatus": {
"description": "Health status for ICX/Stack that contains power supply, temperature and fan",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"fan": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Fan slot number",
"type": "integer"
},
"type": {
"description": "Fan type",
"type": "string"
},
"status": {
"description": "Fan status",
"type": "string"
}
}
}
},
"temperature": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"slotNumber": {
"description": "Solt number",
"type": "integer"
},
"temperatureValue": {
"description": "Slot temperature",
"type": "number"
},
"serialNumber": {
"type": "string"
}
}
}
},
"powerSupply": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Power supply slot number",
"type": "integer"
},
"type": {
"description": "Power supply type",
"type": "string"
},
"status": {
"description": "Power supply status",
"type": "string"
}
}
}
}
}
}
}
}
}CPU Trend ¶
POST/v9_1/health/cpu/line
Use this API command to retrieve CPU trend data based on the time duration.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1547012879222,
"end": 1547016479222,
"interval": 300000
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 6,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"timestamp": "2018-06-15 07:33:50",
"max": 30,
"avg": 30,
"min": 30
},
{
"timestamp": "2018-06-15 07:38:50",
"max": 1,
"avg": 1,
"min": 1
},
{
"timestamp": "2018-06-15 07:43:50",
"max": 1,
"avg": 1,
"min": 1
},
{
"timestamp": "2018-06-15 07:48:50",
"max": 1,
"avg": 1,
"min": 1
},
{
"timestamp": "2018-06-15 07:53:50",
"max": 1,
"avg": 1,
"min": 1
},
{
"timestamp": "2018-06-15 07:58:50",
"max": 1,
"avg": 1,
"min": 1
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "ICX Metrics count",
"type": "integer"
},
"totalCount": {
"description": "Total of ICX Metrics count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more ICX Metrics after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first ICX Metrics returned out of the complete ICX Metrics list",
"type": "integer"
},
"extra": {
"description": "Extra information for ICX Metrics",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"timestamp": {
"description": "Timestamp",
"type": "string"
},
"max": {
"description": "Max metrics",
"type": "number"
},
"min": {
"description": "Min metrics",
"type": "number"
},
"avg": {
"description": "Average metrics",
"type": "number"
}
}
}
}
}
}Memory Trend ¶
POST/v9_1/health/mem/line
Use this API command to retrieve switch memory trend data based on the time duration.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1547012879222,
"end": 1547016479222,
"interval": 300000
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 6,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"timestamp": "2018-06-15 07:33:50",
"max": 30,
"avg": 30,
"min": 30
},
{
"timestamp": "2018-06-15 07:38:50",
"max": 1,
"avg": 1,
"min": 1
},
{
"timestamp": "2018-06-15 07:43:50",
"max": 1,
"avg": 1,
"min": 1
},
{
"timestamp": "2018-06-15 07:48:50",
"max": 1,
"avg": 1,
"min": 1
},
{
"timestamp": "2018-06-15 07:53:50",
"max": 1,
"avg": 1,
"min": 1
},
{
"timestamp": "2018-06-15 07:58:50",
"max": 1,
"avg": 1,
"min": 1
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "ICX Metrics count",
"type": "integer"
},
"totalCount": {
"description": "Total of ICX Metrics count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more ICX Metrics after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first ICX Metrics returned out of the complete ICX Metrics list",
"type": "integer"
},
"extra": {
"description": "Extra information for ICX Metrics",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"timestamp": {
"description": "Timestamp",
"type": "string"
},
"max": {
"description": "Max metrics",
"type": "number"
},
"min": {
"description": "Min metrics",
"type": "number"
},
"avg": {
"description": "Average metrics",
"type": "number"
}
}
}
}
}
}CPU Aggregated ¶
POST/v9_1/health/cpu/agg
Use this API command to retrieve aggregated CPU (min, max, avg, curr) data based on the time duration.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1547012879222,
"end": 1547016479222,
"interval": 300000
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 4,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": null,
"key": "MAX",
"value": 30
},
{
"id": null,
"key": "AVG",
"value": 5.142857142857143
},
{
"id": null,
"key": "MIN",
"value": 1
},
{
"id": null,
"key": "ICX7750-1",
"value": 1
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Aggregation Metrics count",
"type": "integer"
},
"totalCount": {
"description": "Total of Aggregation Metrics count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more Aggregation Metrics after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Aggregation Metrics returned out of the complete ICX Metrics list",
"type": "integer"
},
"extra": {
"description": "Extra information for Aggregation Metrics",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the aggregation value",
"type": "string"
},
"key": {
"description": "Key of the aggregation value",
"type": "string"
},
"value": {
"description": "Metrics of the aggregation value",
"type": "number"
}
}
}
}
}
}Memory Aggregated ¶
POST/v9_1/health/mem/agg
Use this API command to retrieve aggregated CPU (min, max, avg, curr) data based on the time duration.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1547012879222,
"end": 1547016479222,
"interval": 300000
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 4,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": null,
"key": "MAX",
"value": 30
},
{
"id": null,
"key": "AVG",
"value": 5.142857142857143
},
{
"id": null,
"key": "MIN",
"value": 1
},
{
"id": null,
"key": "ICX7750-1",
"value": 1
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Aggregation Metrics count",
"type": "integer"
},
"totalCount": {
"description": "Total of Aggregation Metrics count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more Aggregation Metrics after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Aggregation Metrics returned out of the complete ICX Metrics list",
"type": "integer"
},
"extra": {
"description": "Extra information for Aggregation Metrics",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the aggregation value",
"type": "string"
},
"key": {
"description": "Key of the aggregation value",
"type": "string"
},
"value": {
"description": "Metrics of the aggregation value",
"type": "number"
}
}
}
}
}
}Switch Health Status ¶
POST/v9_1/health/status
Use this API command to retrieve switch health status.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1547012879222,
"end": 1547016479222,
"interval": 300000
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"onlineCount": {
"description": "Online status count",
"type": "integer"
},
"flaggedCount": {
"description": "Flagged status count",
"type": "integer"
},
"offlineCount": {
"description": "Offline status count",
"type": "integer"
},
"powerSupply": {
"description": "Powersupply",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Power supply slot number",
"type": "integer"
},
"type": {
"description": "Power supply type",
"type": "string"
},
"status": {
"description": "Power supply status",
"type": "string"
}
}
}
},
"temperature": {
"description": "Temperature",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"slotNumber": {
"description": "Solt number",
"type": "integer"
},
"temperatureValue": {
"description": "Slot temperature",
"type": "number"
},
"serialNumber": {
"type": "string"
}
}
}
},
"fan": {
"description": "Fan",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Fan slot number",
"type": "integer"
},
"type": {
"description": "Fan type",
"type": "string"
},
"status": {
"description": "Fan status",
"type": "string"
}
}
}
},
"powerHealthStatus": {
"description": "Health status for ICX/Stack that contains power supply, temperature and fan",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"fan": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Fan slot number",
"type": "integer"
},
"type": {
"description": "Fan type",
"type": "string"
},
"status": {
"description": "Fan status",
"type": "string"
}
}
}
},
"temperature": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"slotNumber": {
"description": "Solt number",
"type": "integer"
},
"temperatureValue": {
"description": "Slot temperature",
"type": "number"
},
"serialNumber": {
"type": "string"
}
}
}
},
"powerSupply": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Power supply slot number",
"type": "integer"
},
"type": {
"description": "Power supply type",
"type": "string"
},
"status": {
"description": "Power supply status",
"type": "string"
}
}
}
}
}
}
}
}
}Hardware Status ¶
POST/v9_1/health/status/all
Use this API command to retrieve fan, temperature and power supply status for the switch managed by SmartZone.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1547012879222,
"end": 1547016479222,
"interval": 300000
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"onlineCount": {
"description": "Online status count",
"type": "integer"
},
"flaggedCount": {
"description": "Flagged status count",
"type": "integer"
},
"offlineCount": {
"description": "Offline status count",
"type": "integer"
},
"powerSupply": {
"description": "Powersupply",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Power supply slot number",
"type": "integer"
},
"type": {
"description": "Power supply type",
"type": "string"
},
"status": {
"description": "Power supply status",
"type": "string"
}
}
}
},
"temperature": {
"description": "Temperature",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"slotNumber": {
"description": "Solt number",
"type": "integer"
},
"temperatureValue": {
"description": "Slot temperature",
"type": "number"
},
"serialNumber": {
"type": "string"
}
}
}
},
"fan": {
"description": "Fan",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Fan slot number",
"type": "integer"
},
"type": {
"description": "Fan type",
"type": "string"
},
"status": {
"description": "Fan status",
"type": "string"
}
}
}
},
"powerHealthStatus": {
"description": "Health status for ICX/Stack that contains power supply, temperature and fan",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"fan": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Fan slot number",
"type": "integer"
},
"type": {
"description": "Fan type",
"type": "string"
},
"status": {
"description": "Fan status",
"type": "string"
}
}
}
},
"temperature": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"slotNumber": {
"description": "Solt number",
"type": "integer"
},
"temperatureValue": {
"description": "Slot temperature",
"type": "number"
},
"serialNumber": {
"type": "string"
}
}
}
},
"powerSupply": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"type": "string"
},
"slotNumber": {
"description": "Power supply slot number",
"type": "integer"
},
"type": {
"description": "Power supply type",
"type": "string"
},
"status": {
"description": "Power supply status",
"type": "string"
}
}
}
}
}
}
}
}
}Switch Stack ¶
Get Stack Members ¶
GET/v9_1/stack/member/{switchId}
Use this API command to retrieve the member of switches in a stack.
Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Stack count",
"type": "integer"
},
"totalCount": {
"description": "Total Stack count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more stack after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first stack returned out of the complete stack list",
"type": "integer"
},
"list": {
"description": "List of stack",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"switchName": {
"description": "Switch name of stack",
"type": "string"
},
"model": {
"description": "Switch model of stack",
"type": "string"
},
"ports": {
"description": "Port count of stack",
"type": "integer"
},
"portStatus": {
"description": "Port status Information",
"type": "object",
"additionalProperties": false,
"properties": {
"speed": {
"description": "Port speed of stack",
"type": "string"
},
"up": {
"description": "Count for port status is up of stack",
"type": "integer"
},
"warning": {
"description": "Count for port status is warring of stack",
"type": "integer"
},
"down": {
"description": "Count for port status is down of stack",
"type": "integer"
},
"total": {
"description": "Total port count of stack",
"type": "integer"
},
"adminDown": {
"description": "Count for port status is admin down of stack",
"type": "integer"
}
}
},
"serialNumber": {
"description": "Serial number of stack",
"type": "string"
},
"activeMode": {
"description": "Role of stack",
"type": "string"
},
"switchUnit": {
"description": "Switch unit of stack",
"type": "string"
},
"switchUnitState": {
"description": "Switch unit state of stack",
"type": "string"
},
"switchModule": {
"description": "Switch module of stack",
"type": "string"
},
"poe": {
"description": "Information of PoE",
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"description": "Total power capacity of a switch unit in stack",
"type": "integer"
},
"free": {
"description": "Free power capacity of a switch unit in stack",
"type": "integer"
},
"percent": {
"description": "Percentage of power usage for a switch unit in stack",
"type": "number"
}
}
},
"switchPorts": {
"description": "Switch port information of stack",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of switch port",
"type": "string"
},
"sampledInstant": {
"description": "Sampled instant of switch port",
"type": "string"
},
"name": {
"description": "Name of switch port",
"type": "string"
},
"switchName": {
"description": "Switch name of stack",
"type": "string"
},
"switchGroup": {
"description": "Switch group of switch port",
"type": "string"
},
"mac": {
"description": "Mac address of switch port",
"type": "string"
},
"type": {
"description": "Type of switch port",
"type": "string"
},
"status": {
"description": "Status of switch port",
"type": "string"
},
"adminStatus": {
"description": "Admin Status of switch port",
"type": "string"
},
"vlans": {
"description": "Switch port include vlans",
"type": "string"
},
"poe": {
"description": "PoE information of switch port",
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"description": "Total power capacity of switch port",
"type": "integer"
},
"free": {
"description": "Free power capacity of switch port",
"type": "integer"
},
"percent": {
"description": "Power used percentage of switch port",
"type": "number"
}
}
},
"neighborName": {
"description": "Neighbor name of switch port",
"type": "string"
},
"portSpeed": {
"description": "Port speed of switch port",
"type": "string"
},
"stpState": {
"description": "STP state of switch port",
"type": "integer"
},
"inUtilization": {
"description": "In utilization of switch port",
"type": "number"
},
"outUtilization": {
"description": "Out utilization of switch port",
"type": "number"
},
"opticsType": {
"description": "Optics type of switch port",
"type": "string"
},
"connectedDevice": {
"description": "Connected device information",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of switch port connected device",
"type": "string"
},
"localPortMac": {
"description": "Local port mac address of connected device",
"type": "string"
},
"remotePortMac": {
"description": "Remote port mac address of connected device",
"type": "string"
},
"remoteDeviceName": {
"description": "Remote device name of connected device",
"type": "string"
},
"remotePortType": {
"description": "Remote port type of connected device",
"type": "string"
},
"remotePortDesc": {
"description": "Remote port description of connected device",
"type": "string"
},
"localPort": {
"description": "Local port description of connected device",
"type": "string"
},
"remotePort": {
"description": "Remote port number of connected device",
"type": "string"
},
"isRuckusAP": {
"description": "Connected devices is RuckusAP,True or False",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the connected device belong",
"type": "string"
},
"tenantId": {
"description": "Tenant Id of stack",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Switch group level one Id",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Switch group level two Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"unitId": {
"description": "Unit Id",
"type": "string"
},
"localPortIfaceName": {
"description": "Local port interface name",
"type": "string"
},
"switchName": {
"description": "Switch name",
"type": "string"
},
"switchGroup": {
"description": "Switch group",
"type": "string"
}
}
},
"trafficUsage": {
"description": "Traffic usage information",
"type": "object",
"additionalProperties": false,
"properties": {
"tx": {
"description": "Tx traffic usage of switch port",
"type": "integer"
},
"rx": {
"description": "Rx traffic usage of switch port",
"type": "integer"
}
}
},
"poeEnabled": {
"description": "PoE Enabled, True or False",
"type": "boolean"
},
"usedInFormingStack": {
"description": "Used in forming stack, True or False",
"type": "boolean"
},
"lagName": {
"description": "LAG name of switch port",
"type": "string"
},
"unTaggedVlan": {
"description": "Untagged vlan of switch port",
"type": "string"
},
"portIdentifier": {
"description": "Port Identifier of switch port",
"type": "string"
}
}
}
}
}
}
}
}
}Get Stack Configuration ¶
GET/v9_1/stack/{switchId}
Use this API command to retrieve a stack configuration configured via SZ.
Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"switchId": {
"description": "Switch Id",
"type": "string"
},
"activeSwitchId": {
"description": "Switch Id of Active Unit",
"type": "string"
},
"isActiveRole": {
"description": "Switch role is Active, True (Active) or False (Standby or Member)",
"type": "boolean"
},
"suggestedId": {
"description": "Suggested switch unit Id in stack, 1 ~ 12",
"type": "integer"
}
}
}Create Stack Configuration ¶
POST/v9_1/stack
Use this API command to create a stack configuration.
Request
Body
[
{
"switchId": "18:A0:12:32:00:00",
"isActiveRole": true
},
{
"switchId": "18:A0:12:32:00:01",
"isActiveRole": false,
"suggestedId": 3
}
]Schema
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"switchId": {
"description": "Switch Id",
"type": "string"
},
"activeSwitchId": {
"description": "Switch Id of Active Unit",
"type": "string"
},
"isActiveRole": {
"description": "Switch role is Active, True (Active) or False (Standby or Member)",
"type": "boolean"
},
"suggestedId": {
"description": "Suggested switch unit Id in stack, 1 ~ 12",
"type": "integer"
}
}
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Audit Id",
"type": "string"
},
"name": {
"description": "Audit name",
"type": "string"
}
}
}
}
}
}Switch ¶
Get Switch ¶
GET/v9_1/switch/{id}
Use this API command to retrieve a switch status.
Response
200Body
{
"id": "60:9C:9F:DA:63:80",
"switchName": "ICX7750-1",
"macAddress": "60:9C:9F:DA:63:80",
"model": "ICX7750-48XGC",
"ipAddress": "192.168.240.31",
"registrationStatus": "APPROVED",
"ports": 54,
"portStatus": null,
"numOfUnits": 1,
"alarm": 0,
"upTime": "1:54:34.00",
"firmwareVersion": "SWS08080b254",
"modules": "switch",
"serialNumber": "CRJ3333N00K",
"ipAddressType": null,
"defaultGateway": "192.168.253.253",
"groupName": "21ed3a40-34a7-4d13-844c-783c66074d7a",
"groupId": "21ed3a40-34a7-4d13-844c-783c66074d7a",
"groupFirmware": "FI08090",
"parentGroupId": null,
"stackId": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"status": "ONLINE",
"lastBackupTime": 1529337901991,
"lastRestoreTime": null,
"lastBackupStatus": "SUCCESS",
"lastRestoreStatus": null,
"firmwareUpdate": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of switch",
"type": "string"
},
"switchName": {
"description": "Switch name",
"type": "string"
},
"macAddress": {
"description": "Switch mac address",
"type": "string"
},
"model": {
"description": "Switch model",
"type": "string"
},
"family": {
"description": "Switch Model Family",
"type": "string"
},
"ipAddress": {
"description": "switch IP address",
"type": "string"
},
"registrationStatus": {
"description": "Status for switch registater to ICX-M",
"type": "string"
},
"ports": {
"description": "Total port count",
"type": "integer"
},
"portStatus": {
"description": "Information of port status",
"type": "object",
"additionalProperties": false,
"properties": {
"speed": {
"description": "Port speed of switch",
"type": "string"
},
"up": {
"description": "Count for port status is up of switch",
"type": "integer"
},
"warning": {
"description": "Count for port status is warring of switch",
"type": "integer"
},
"down": {
"description": "Count for port status is down of switch",
"type": "integer"
},
"total": {
"description": "Total count for port status of switch",
"type": "integer"
},
"adminDown": {
"description": "Count for port status is admin down of switch",
"type": "integer"
},
"speedInt": {
"description": "Switch port fully speed",
"type": "integer"
}
}
},
"numOfUnits": {
"description": "Count of switch unit",
"type": "integer"
},
"poe": {
"description": "Information of PoE",
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"description": "Total power capacity of a switch",
"type": "integer"
},
"free": {
"description": "Free power capacity of a switch",
"type": "integer"
},
"percent": {
"description": "Percentage of power usage for a switch",
"type": "number"
}
}
},
"alarm": {
"description": "Count of switch alarm",
"type": "integer"
},
"upTime": {
"description": "SWitch uptime",
"type": "string"
},
"firmwareVersion": {
"description": "Switch firmware version",
"type": "string"
},
"modules": {
"description": "Stack or Switch",
"type": "string"
},
"serialNumber": {
"description": "SWitch serial number",
"type": "string"
},
"ipAddressType": {
"description": "IP address type",
"type": "string"
},
"defaultGateway": {
"description": "Default gateway of switch",
"type": "string"
},
"groupName": {
"description": "Name of switch group",
"type": "string"
},
"groupId": {
"description": "Identifier of switch group",
"type": "string"
},
"groupFirmware": {
"description": "Firmware of switch group",
"type": "string"
},
"parentGroupId": {
"description": "Identifier of parent switch group",
"type": "string"
},
"stackId": {
"description": "Stack Id",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the switch belong",
"type": "string"
},
"status": {
"description": "Status of switch, Ex: ONLINE, OFFLINE",
"type": "string"
},
"lastBackupTime": {
"description": "Last config backup time of switch",
"type": "integer",
"format": "int64"
},
"lastRestoreTime": {
"description": "Last config restore time of switch",
"type": "integer",
"format": "int64"
},
"lastBackupStatus": {
"description": "Last config backup status of switch",
"type": "string",
"enum": [
"STARTED",
"SUCCESS",
"FAILED"
]
},
"lastRestoreStatus": {
"description": "Last config restore status of switch",
"type": "string",
"enum": [
"STARTED",
"SUCCESS",
"FAILED"
]
},
"firmwareUpdate": {
"description": "Information of firmware update",
"type": "object",
"additionalProperties": false,
"properties": {
"scheduleId": {
"description": "Schedule Id of firmware update",
"type": "string"
},
"scheduledTime": {
"description": "Scheduled time of firmware update",
"type": "string"
},
"modifiedTime": {
"description": "Modified time of the firmware update scheduled",
"type": "string"
},
"status": {
"description": "Status of firmware update",
"type": "string"
},
"toVersion": {
"description": "Update to which firmware version",
"type": "string"
}
}
},
"supportedCsl": {
"type": "integer",
"format": "int32"
}
}
}Get Switch Firmware Update History ¶
GET/v9_1/switch/{switchId}/firmware
Use this API command to get a list of firmware update history.
Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Firmware history list count",
"type": "integer"
},
"totalCount": {
"description": "Total firmware history list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more firmware history after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first firmware history returned out of the complete query list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"timestamp": {
"description": "Timestamp of fireware update",
"type": "number"
},
"fromVersion": {
"description": "Original fireware version before firmware update",
"type": "string"
},
"toVersion": {
"description": "Firmware version after firmware update",
"type": "string"
}
}
}
}
}
}Retrieve Switch Model List ¶
GET/v9_1/switchModel/list
Use this API command to Retrieve Switch Model List.
Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 8,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"model": "ICX7150-C08P"
},
{
"model": "ICX7150-C10ZP"
},
{
"model": "ICX7150-C12P"
},
{
"model": "ICX7150-24"
},
{
"model": "ICX7150-48"
},
{
"model": "ICX7250-24"
},
{
"model": "ICX7450-24"
},
{
"model": "ICX7650-48ZP"
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total Data Count",
"type": "integer"
},
"totalCount": {
"description": "Total Data Count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of remaining data",
"type": "boolean"
},
"firstIndex": {
"description": "The first data index for current reulst",
"type": "integer"
},
"extra": {
"description": "Extra field",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"model": {
"description": "Switch Model",
"type": "string"
}
}
}
}
}
}List SNMP Synced Switches ¶
POST/v9_1/switch/snmpSyncedSwitch
Use this API command to retrieve all the switches currently managed by SmartZone and SNMP synced.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "serialNumber",
"dir": "ASC"
},
"page": 1,
"limit": 8
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 3,
"hasMore": false,
"firstIndex": 8,
"list": [
{
"id": "18:A0:12:32:00:00",
"switchName": "icx_jemery0",
"macAddress": "18:A0:12:32:00:00",
"model": "ICX7450-48P",
"family": "ICX7450",
"ipAddress": "192.168.239.150",
"registrationStatus": "APPROVED",
"ports": 24,
"portStatus": {
"speed": null,
"up": 13,
"warning": 24,
"down": 0,
"total": null,
"adminDown": null,
"speedInt": 0
},
"numOfUnits": 1,
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"alarm": 13,
"upTime": "0:00:09.37",
"firmwareVersion": "1.0.0",
"modules": "switch",
"serialNumber": "567866JE0",
"ipAddressType": null,
"defaultGateway": "10.1.200.254",
"groupName": "MyGroup1",
"groupId": "a7058e17-0ce9-41db-b59f-d6222148c43b",
"groupFirmware": "FI08090",
"parentGroupId": "e299823b-dc14-4c1f-985e-f5002bfccb0f",
"stackId": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"status": "OFFLINE",
"lastBackupTime": 1531290000325,
"lastRestoreTime": null,
"lastBackupStatus": "FAILED",
"lastRestoreStatus": null,
"firmwareUpdate": null
},
{
"id": "60:9C:9F:DA:63:80",
"switchName": "ICX7750-1",
"macAddress": "60:9C:9F:DA:63:80",
"model": "ICX7750-48XGC",
"ipAddress": "192.168.240.31",
"registrationStatus": "APPROVED",
"ports": 54,
"portStatus": {
"speed": null,
"up": 1,
"warning": 0,
"down": 53,
"total": null,
"adminDown": null,
"speedInt": 0
},
"numOfUnits": 1,
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"alarm": 2,
"upTime": "6 days, 1:12:22.00",
"firmwareVersion": "SWS08080b254",
"modules": "switch",
"serialNumber": "CRJ3333N00K",
"ipAddressType": null,
"defaultGateway": "192.168.253.253",
"groupName": "RealSwitchGroup1",
"groupId": "e299823b-dc14-4c1f-985e-f5002bfccb0f",
"groupFirmware": "FI08090",
"parentGroupId": null,
"stackId": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"status": "ONLINE",
"lastBackupTime": 1531353601306,
"lastRestoreTime": 1530521401053,
"lastBackupStatus": "SUCCESS",
"lastRestoreStatus": "SUCCESS",
"firmwareUpdate": {
"scheduleId": "firmware-update-ONE_TIME-1530510555674",
"scheduledTime": "",
"modifiedTime": "1530511156376",
"status": "succeeded",
"toVersion": "SWS08080b254"
}
},
{
"id": "60:9C:9F:E5:C7:00",
"switchName": "ICX7150-1",
"macAddress": "60:9C:9F:E5:C7:00",
"model": "ICX7150-24P",
"ipAddress": "192.168.240.1",
"registrationStatus": "APPROVED",
"ports": 90,
"portStatus": {
"speed": null,
"up": 11,
"warning": 1,
"down": 78,
"total": null,
"adminDown": null,
"speedInt": 0
},
"numOfUnits": 3,
"poe": {
"total": 1110000,
"free": 1079200,
"percent": 0
},
"alarm": 2,
"upTime": "6 days, 1:14:45.00",
"firmwareVersion": "SPS08080b207",
"modules": "stack",
"serialNumber": "FEA3234N0B0",
"ipAddressType": null,
"defaultGateway": "192.168.253.253",
"groupName": "RealSwitchGroup1",
"groupId": "e299823b-dc14-4c1f-985e-f5002bfccb0f",
"parentGroupId": null,
"stackId": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"status": "ONLINE",
"lastBackupTime": 1531353601865,
"lastRestoreTime": null,
"lastBackupStatus": "SUCCESS",
"lastRestoreStatus": null,
"firmwareUpdate": null
}
],
"extra": {
"rbacMetadata": [
{
"ICX_CATEGORY": "FULL_ACCESS"
},
{
"ICX_CATEGORY": "FULL_ACCESS"
},
{
"ICX_CATEGORY": "FULL_ACCESS"
}
]
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Switch query result list count",
"type": "integer"
},
"totalCount": {
"description": "Total switch query result list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first registration rule returned out of the complete registration rule list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
},
"properties": {}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of switch",
"type": "string"
},
"switchName": {
"description": "Switch name",
"type": "string"
},
"macAddress": {
"description": "Switch mac address",
"type": "string"
},
"model": {
"description": "Switch model",
"type": "string"
},
"family": {
"description": "Switch Model Family",
"type": "string"
},
"ipAddress": {
"description": "switch IP address",
"type": "string"
},
"registrationStatus": {
"description": "Status for switch registater to ICX-M",
"type": "string"
},
"ports": {
"description": "Total port count",
"type": "integer"
},
"portStatus": {
"description": "Information of port status",
"type": "object",
"additionalProperties": false,
"properties": {
"speed": {
"description": "Port speed of switch",
"type": "string"
},
"up": {
"description": "Count for port status is up of switch",
"type": "integer"
},
"warning": {
"description": "Count for port status is warring of switch",
"type": "integer"
},
"down": {
"description": "Count for port status is down of switch",
"type": "integer"
},
"total": {
"description": "Total count for port status of switch",
"type": "integer"
},
"adminDown": {
"description": "Count for port status is admin down of switch",
"type": "integer"
},
"speedInt": {
"description": "Switch port fully speed",
"type": "integer"
}
}
},
"numOfUnits": {
"description": "Count of switch unit",
"type": "integer"
},
"poe": {
"description": "Information of PoE",
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"description": "Total power capacity of a switch",
"type": "integer"
},
"free": {
"description": "Free power capacity of a switch",
"type": "integer"
},
"percent": {
"description": "Percentage of power usage for a switch",
"type": "number"
}
}
},
"alarm": {
"description": "Count of switch alarm",
"type": "integer"
},
"upTime": {
"description": "SWitch uptime",
"type": "string"
},
"firmwareVersion": {
"description": "Switch firmware version",
"type": "string"
},
"modules": {
"description": "Stack or Switch",
"type": "string"
},
"serialNumber": {
"description": "SWitch serial number",
"type": "string"
},
"ipAddressType": {
"description": "IP address type",
"type": "string"
},
"defaultGateway": {
"description": "Default gateway of switch",
"type": "string"
},
"groupName": {
"description": "Name of switch group",
"type": "string"
},
"groupId": {
"description": "Identifier of switch group",
"type": "string"
},
"groupFirmware": {
"description": "Firmware of switch group",
"type": "string"
},
"parentGroupId": {
"description": "Identifier of parent switch group",
"type": "string"
},
"stackId": {
"description": "Stack Id",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the switch belong",
"type": "string"
},
"status": {
"description": "Status of switch, Ex: ONLINE, OFFLINE",
"type": "string"
},
"lastBackupTime": {
"description": "Last config backup time of switch",
"type": "integer",
"format": "int64"
},
"lastRestoreTime": {
"description": "Last config restore time of switch",
"type": "integer",
"format": "int64"
},
"lastBackupStatus": {
"description": "Last config backup status of switch",
"type": "string",
"enum": [
"STARTED",
"SUCCESS",
"FAILED"
]
},
"lastRestoreStatus": {
"description": "Last config restore status of switch",
"type": "string",
"enum": [
"STARTED",
"SUCCESS",
"FAILED"
]
},
"firmwareUpdate": {
"description": "Information of firmware update",
"type": "object",
"additionalProperties": false,
"properties": {
"scheduleId": {
"description": "Schedule Id of firmware update",
"type": "string"
},
"scheduledTime": {
"description": "Scheduled time of firmware update",
"type": "string"
},
"modifiedTime": {
"description": "Modified time of the firmware update scheduled",
"type": "string"
},
"status": {
"description": "Status of firmware update",
"type": "string"
},
"toVersion": {
"description": "Update to which firmware version",
"type": "string"
}
}
},
"supportedCsl": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}Retrieve Switch & Port Details ¶
POST/v9_1/switch/view/details
Use this API command to retrieve switch and port details for the selected Switch/SwitchGroup/Domain.
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total stack member count",
"type": "integer"
},
"totalCount": {
"description": "Current stack member count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more stack member after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first stack member returned out of the complete stack member list",
"type": "integer"
},
"extra": {
"description": "Extra information for stack member list",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"switchName": {
"description": "Switch name of stack",
"type": "string"
},
"model": {
"description": "Switch model of stack",
"type": "string"
},
"ports": {
"description": "Port count of stack",
"type": "integer"
},
"portStatus": {
"description": "$",
"type": "object",
"additionalProperties": false,
"properties": {
"speed": {
"description": "Switch port speed",
"type": "string"
},
"up": {
"description": "Up port count",
"type": "integer"
},
"warning": {
"description": "Warring port count",
"type": "integer"
},
"down": {
"description": "Down port count",
"type": "integer"
},
"total": {
"description": "Total port count",
"type": "integer"
},
"adminDown": {
"description": "Admin down port count",
"type": "integer"
},
"speedInt": {
"description": "Switch port fully speed",
"type": "integer"
}
}
},
"serialNumber": {
"description": "Serial number of stack",
"type": "string"
},
"activeMode": {
"description": "Role of stack",
"type": "string"
},
"switchUnit": {
"description": "Switch unit of stack",
"type": "string"
},
"switchModule": {
"description": "Switch module of stack",
"type": "string"
},
"switchPorts": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of switch port",
"type": "string"
},
"sampledInstant": {
"description": "Sampled instant of switch port",
"type": "string"
},
"name": {
"description": "Name of switch port",
"type": "string"
},
"switchId": {
"type": "string"
},
"switchFamily": {
"type": "string"
},
"switchModel": {
"type": "string"
},
"switchName": {
"description": "Switch Name of switch port",
"type": "string"
},
"switchGroup": {
"description": "Switch group of switch port",
"type": "string"
},
"mac": {
"description": "Mac address of switch port",
"type": "string"
},
"type": {
"description": "Type of switch port",
"type": "string"
},
"status": {
"description": "Status of switch port, UP or DOWN",
"type": "string"
},
"adminStatus": {
"description": "Admin status of switch port, UP or DOWN",
"type": "string"
},
"vlans": {
"description": "Switch port include vlans",
"type": "string"
},
"poe": {
"description": "PoE information of switch port",
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"description": "Total power capacity of switch port",
"type": "integer"
},
"free": {
"description": "Free power capacity of switch port",
"type": "integer"
},
"percent": {
"description": "Power used percentage of switch port",
"type": "number"
}
}
},
"portError": {
"description": "Port error Information",
"type": "object",
"additionalProperties": false,
"properties": {
"inError": {
"description": "Switch port traffic in error count",
"type": "integer"
},
"outError": {
"description": "Switch port traffic out error count",
"type": "integer"
},
"crcError": {
"description": "Switch port CRC error count",
"type": "integer"
},
"inDiscard": {
"description": "Switch port traffic in discard count",
"type": "integer"
}
}
},
"packets": {
"description": "Port packet transmit information",
"type": "object",
"additionalProperties": false,
"properties": {
"broadcastIn": {
"description": "Switch port broadcast in packet count",
"type": "integer"
},
"broadcastOut": {
"description": "Switch port broadcast out packet count",
"type": "integer"
},
"multicastIn": {
"description": "Switch port multicast in packet count",
"type": "integer"
},
"multicastOut": {
"description": "Switch port multicast out packet count",
"type": "integer"
}
}
},
"neighborName": {
"description": "Switch port connected neighbor name",
"type": "string"
},
"portSpeed": {
"description": "Switch port speed",
"type": "string"
},
"stpState": {
"description": "Switch port STP state",
"type": "integer"
},
"inUtilization": {
"description": "Switch port traffic in utilization",
"type": "number"
},
"outUtilization": {
"description": "Switch port traffic out utilization",
"type": "number"
},
"opticsType": {
"description": "Switch port optics type",
"type": "string"
},
"connectedDevice": {
"description": "Connected device information",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of connected device",
"type": "string"
},
"localPortMac": {
"description": "Local port mac address to connected device",
"type": "string"
},
"remotePortMac": {
"description": "Remote port mac address of local device",
"type": "string"
},
"remoteDeviceName": {
"description": "Remote connected device name",
"type": "string"
},
"remoteDeviceMac": {
"type": "string"
},
"remotePortType": {
"description": "Remote port type of connected device",
"type": "string"
},
"remotePortDesc": {
"description": "Remote port description of connected device",
"type": "string"
},
"localPort": {
"description": "Local port description to connected device",
"type": "string"
},
"remotePort": {
"description": "Remote port number of connected device",
"type": "string"
},
"isRuckusAP": {
"description": "Connected devices is RuckusAP,True or False",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the connected device belong",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Switch group level one Id",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Switch group level two Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"unitId": {
"description": "Unit Id",
"type": "string"
},
"localPortIfaceName": {
"description": "Local port interface name",
"type": "string"
},
"switchName": {
"description": "Switch name",
"type": "string"
},
"switchGroup": {
"description": "Switch group",
"type": "string"
}
}
},
"trafficUsage": {
"description": "Traffic usage information",
"type": "object",
"additionalProperties": false,
"properties": {
"tx": {
"description": "Tx traffic usage of switch port",
"type": "integer"
},
"rx": {
"description": "Rx traffic usage of switch port",
"type": "integer"
}
}
},
"poeEnabled": {
"description": "PoE Enabled, True or False",
"type": "boolean"
},
"poeType": {
"description": "PoE type",
"type": "string"
},
"usedInFormingStack": {
"description": "Used in forming stack, True or False",
"type": "boolean"
},
"lagName": {
"description": "LAG name of switch port",
"type": "string"
},
"unTaggedVlan": {
"description": "Untagged vlan of switch port",
"type": "string"
},
"portIdentifier": {
"description": "Port Identifier of switch port",
"type": "string"
}
}
}
}
}
}
}
}List Switches ¶
POST/v9_1/switch
Use this API command to retrieve all the switches currently managed by SmartZone.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "serialNumber",
"dir": "ASC"
},
"page": 1,
"limit": 8
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 3,
"hasMore": false,
"firstIndex": 8,
"list": [
{
"id": "18:A0:12:32:00:00",
"switchName": "icx_jemery0",
"macAddress": "18:A0:12:32:00:00",
"model": "ICX7450-48P",
"family": "ICX7450",
"ipAddress": "192.168.239.150",
"registrationStatus": "APPROVED",
"ports": 24,
"portStatus": {
"speed": null,
"up": 13,
"warning": 24,
"down": 0,
"total": null,
"adminDown": null,
"speedInt": 0
},
"numOfUnits": 1,
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"alarm": 13,
"upTime": "0:00:09.37",
"firmwareVersion": "1.0.0",
"modules": "switch",
"serialNumber": "567866JE0",
"ipAddressType": null,
"defaultGateway": "10.1.200.254",
"groupName": "MyGroup1",
"groupId": "a7058e17-0ce9-41db-b59f-d6222148c43b",
"groupFirmware": "FI08090",
"parentGroupId": "e299823b-dc14-4c1f-985e-f5002bfccb0f",
"stackId": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"status": "OFFLINE",
"lastBackupTime": 1531290000325,
"lastRestoreTime": null,
"lastBackupStatus": "FAILED",
"lastRestoreStatus": null,
"firmwareUpdate": null
},
{
"id": "60:9C:9F:DA:63:80",
"switchName": "ICX7750-1",
"macAddress": "60:9C:9F:DA:63:80",
"model": "ICX7750-48XGC",
"ipAddress": "192.168.240.31",
"registrationStatus": "APPROVED",
"ports": 54,
"portStatus": {
"speed": null,
"up": 1,
"warning": 0,
"down": 53,
"total": null,
"adminDown": null,
"speedInt": 0
},
"numOfUnits": 1,
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"alarm": 2,
"upTime": "6 days, 1:12:22.00",
"firmwareVersion": "SWS08080b254",
"modules": "switch",
"serialNumber": "CRJ3333N00K",
"ipAddressType": null,
"defaultGateway": "192.168.253.253",
"groupName": "RealSwitchGroup1",
"groupId": "e299823b-dc14-4c1f-985e-f5002bfccb0f",
"groupFirmware": "FI08090",
"parentGroupId": null,
"stackId": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"status": "ONLINE",
"lastBackupTime": 1531353601306,
"lastRestoreTime": 1530521401053,
"lastBackupStatus": "SUCCESS",
"lastRestoreStatus": "SUCCESS",
"firmwareUpdate": {
"scheduleId": "firmware-update-ONE_TIME-1530510555674",
"scheduledTime": "",
"modifiedTime": "1530511156376",
"status": "succeeded",
"toVersion": "SWS08080b254"
}
},
{
"id": "60:9C:9F:E5:C7:00",
"switchName": "ICX7150-1",
"macAddress": "60:9C:9F:E5:C7:00",
"model": "ICX7150-24P",
"ipAddress": "192.168.240.1",
"registrationStatus": "APPROVED",
"ports": 90,
"portStatus": {
"speed": null,
"up": 11,
"warning": 1,
"down": 78,
"total": null,
"adminDown": null,
"speedInt": 0
},
"numOfUnits": 3,
"poe": {
"total": 1110000,
"free": 1079200,
"percent": 0
},
"alarm": 2,
"upTime": "6 days, 1:14:45.00",
"firmwareVersion": "SPS08080b207",
"modules": "stack",
"serialNumber": "FEA3234N0B0",
"ipAddressType": null,
"defaultGateway": "192.168.253.253",
"groupName": "RealSwitchGroup1",
"groupId": "e299823b-dc14-4c1f-985e-f5002bfccb0f",
"parentGroupId": null,
"stackId": null,
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"status": "ONLINE",
"lastBackupTime": 1531353601865,
"lastRestoreTime": null,
"lastBackupStatus": "SUCCESS",
"lastRestoreStatus": null,
"firmwareUpdate": null
}
],
"extra": {
"rbacMetadata": [
{
"ICX_CATEGORY": "FULL_ACCESS"
},
{
"ICX_CATEGORY": "FULL_ACCESS"
},
{
"ICX_CATEGORY": "FULL_ACCESS"
}
]
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Switch query result list count",
"type": "integer"
},
"totalCount": {
"description": "Total switch query result list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first registration rule returned out of the complete registration rule list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object",
"properties": {
"rbacMetadata": {
"type": "array",
"items": {
"additionalProperties": {
"type": "string"
},
"properties": {}
}
}
}
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of switch",
"type": "string"
},
"switchName": {
"description": "Switch name",
"type": "string"
},
"macAddress": {
"description": "Switch mac address",
"type": "string"
},
"model": {
"description": "Switch model",
"type": "string"
},
"family": {
"description": "Switch Model Family",
"type": "string"
},
"ipAddress": {
"description": "switch IP address",
"type": "string"
},
"registrationStatus": {
"description": "Status for switch registater to ICX-M",
"type": "string"
},
"ports": {
"description": "Total port count",
"type": "integer"
},
"portStatus": {
"description": "Information of port status",
"type": "object",
"additionalProperties": false,
"properties": {
"speed": {
"description": "Port speed of switch",
"type": "string"
},
"up": {
"description": "Count for port status is up of switch",
"type": "integer"
},
"warning": {
"description": "Count for port status is warring of switch",
"type": "integer"
},
"down": {
"description": "Count for port status is down of switch",
"type": "integer"
},
"total": {
"description": "Total count for port status of switch",
"type": "integer"
},
"adminDown": {
"description": "Count for port status is admin down of switch",
"type": "integer"
},
"speedInt": {
"description": "Switch port fully speed",
"type": "integer"
}
}
},
"numOfUnits": {
"description": "Count of switch unit",
"type": "integer"
},
"poe": {
"description": "Information of PoE",
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"description": "Total power capacity of a switch",
"type": "integer"
},
"free": {
"description": "Free power capacity of a switch",
"type": "integer"
},
"percent": {
"description": "Percentage of power usage for a switch",
"type": "number"
}
}
},
"alarm": {
"description": "Count of switch alarm",
"type": "integer"
},
"upTime": {
"description": "SWitch uptime",
"type": "string"
},
"firmwareVersion": {
"description": "Switch firmware version",
"type": "string"
},
"modules": {
"description": "Stack or Switch",
"type": "string"
},
"serialNumber": {
"description": "SWitch serial number",
"type": "string"
},
"ipAddressType": {
"description": "IP address type",
"type": "string"
},
"defaultGateway": {
"description": "Default gateway of switch",
"type": "string"
},
"groupName": {
"description": "Name of switch group",
"type": "string"
},
"groupId": {
"description": "Identifier of switch group",
"type": "string"
},
"groupFirmware": {
"description": "Firmware of switch group",
"type": "string"
},
"parentGroupId": {
"description": "Identifier of parent switch group",
"type": "string"
},
"stackId": {
"description": "Stack Id",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the switch belong",
"type": "string"
},
"status": {
"description": "Status of switch, Ex: ONLINE, OFFLINE",
"type": "string"
},
"lastBackupTime": {
"description": "Last config backup time of switch",
"type": "integer",
"format": "int64"
},
"lastRestoreTime": {
"description": "Last config restore time of switch",
"type": "integer",
"format": "int64"
},
"lastBackupStatus": {
"description": "Last config backup status of switch",
"type": "string",
"enum": [
"STARTED",
"SUCCESS",
"FAILED"
]
},
"lastRestoreStatus": {
"description": "Last config restore status of switch",
"type": "string",
"enum": [
"STARTED",
"SUCCESS",
"FAILED"
]
},
"firmwareUpdate": {
"description": "Information of firmware update",
"type": "object",
"additionalProperties": false,
"properties": {
"scheduleId": {
"description": "Schedule Id of firmware update",
"type": "string"
},
"scheduledTime": {
"description": "Scheduled time of firmware update",
"type": "string"
},
"modifiedTime": {
"description": "Modified time of the firmware update scheduled",
"type": "string"
},
"status": {
"description": "Status of firmware update",
"type": "string"
},
"toVersion": {
"description": "Update to which firmware version",
"type": "string"
}
}
},
"supportedCsl": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}Move to Switch Group ¶
PUT/v9_1/switch/move/{destinationSwitchGroupId}
Use this API command to move a list of switches to a switch group.
Request
Body
[
"18:A0:12:32:00:01",
"18:A0:12:32:00:00"
]Schema
{
"description": "$",
"type": "array",
"items": {
"type": "string"
}
}Response
200Delete Switch ¶
DELETE/v9_1/switch/{id}
Use this API command to delete a switch managed by SmartZone.
Response
200Body
{
"id": "19:23:12:11:00:00",
"name": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Audit Id",
"type": "string"
},
"name": {
"description": "Audit name",
"type": "string"
}
}
}Delete Multiple Switches ¶
DELETE/v9_1/switch
Use this API command to delete multiple switches managed by SmartZone
Request
Body
[
"18:A0:12:32:00:01",
"18:A0:12:32:00:00"
]Schema
{
"description": "$",
"type": "array",
"items": {
"type": "string"
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Delete switches list count",
"type": "integer"
},
"totalCount": {
"description": "Total delete switches list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more delete switches after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first delete switches returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Audit Id",
"type": "string"
},
"name": {
"description": "Audit name",
"type": "string"
}
}
}
}
}
}Switch Group ¶
Get Switch Group ¶
GET/v9_1/group/{switchGroupId}
Use this API command to retrieve switch group detail.
Request
Headers
Content-Type: text/plain,*/*Response
200Body
{
"name": "SwitchGroup3",
"description": "Switch Group 3 Description",
"firmware": "Switch Group 3 Firmware Version",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the switch group",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the switch group belong",
"type": "string"
},
"creatorId": {
"description": "Creator Id of the switch group",
"type": "string"
},
"tenantId": {
"description": "Tenant Id of the switch group",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Level one Id of the switch group",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Level two Id of the switch group",
"type": "string"
},
"createDatetime": {
"description": "Create datetime of the switch group",
"type": "integer",
"format": "int64"
},
"name": {
"description": "Name of the switch group",
"type": "string"
},
"description": {
"description": "Description of the switch group",
"type": "string"
},
"firmware": {
"description": "Firmware of the switch group",
"type": "string"
},
"sampledInstant": {
"description": "Sampled instant of the switch group",
"type": "object"
},
"levelOne": {
"description": "Level one of the switch group",
"type": "boolean"
},
"levelTwo": {
"description": "Level two of the switch group",
"type": "boolean"
},
"enableTwoFactor": {
"description": "Enable two factor authentication. Only support FIPS mode",
"type": "boolean"
}
}
}Retrieve Switch Groups ¶
GET/v9_1/group/ids/byDomain/{domainId}
Use this API command to retrieve the switch groups by domain ID.
URI Parameters
- showStagingGroup
string(optional)
Request
Headers
Content-Type: text/plain,*/*Response
200Body
{
"success": true,
"error": null,
"data": {
"rawDataTotalCount": 0,
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "21ed3a40-34a7-4d13-844c-783c66074d7a",
"label": "RealSwitchGroup1",
"extraValues": {},
"type": "Ruckus"
},
{
"id": "8a098bb7-d80f-4604-a0ff-692ed56dcfd3",
"label": "MyGroup1",
"extraValues": {},
"type": "Ruckus"
},
{
"id": "d8050f24-7cfa-498f-b4fc-971eafe4c766",
"label": "MyGroup2",
"extraValues": {},
"type": "Ruckus"
}
],
"extra": null
},
"extra": {},
"metaData": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Query result success or not",
"type": "boolean"
},
"error": {
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"type": "string"
},
"msgKey": {
"type": "string"
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"data": {
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Query result count",
"type": "integer"
},
"totalCount": {
"description": "Total query result count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more query result after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first query result returned out of the complete query result list",
"type": "integer"
},
"extra": {
"description": "Extra information for query result list",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the client",
"type": "string"
},
"label": {
"description": "Label of the client",
"type": "string"
},
"extraValues": {
"description": "Extra values of the client",
"type": "object"
},
"type": {
"description": "Type of the client",
"type": "string"
}
}
}
}
}
},
"extra": {
"description": "Any additional response",
"type": "object"
},
"metaData": {
"description": "Metadata of query result list",
"type": "object"
}
}
}Create Switch Group ¶
POST/v9_1/group
Use this API command to create a new switch group under an existing domain or switch group.
Request
Headers
Content-Type: text/plain,*/*Body
{
"name": "SwitchGroup3",
"description": "Switch Group 3 Description",
"firmware": "Switch Group 3 Firmware Version",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the switch group",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the switch group belong",
"type": "string"
},
"creatorId": {
"description": "Creator Id of the switch group",
"type": "string"
},
"tenantId": {
"description": "Tenant Id of the switch group",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Level one Id of the switch group",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Level two Id of the switch group",
"type": "string"
},
"createDatetime": {
"description": "Create datetime of the switch group",
"type": "integer",
"format": "int64"
},
"name": {
"description": "Name of the switch group",
"type": "string"
},
"description": {
"description": "Description of the switch group",
"type": "string"
},
"firmware": {
"description": "Firmware of the switch group",
"type": "string"
},
"sampledInstant": {
"description": "Sampled instant of the switch group",
"type": "object"
},
"levelOne": {
"description": "Level one of the switch group",
"type": "boolean"
},
"levelTwo": {
"description": "Level two of the switch group",
"type": "boolean"
},
"enableTwoFactor": {
"description": "Enable two factor authentication. Only support FIPS mode",
"type": "boolean"
}
}
}Response
201Body
{
"id": "0e4ac34b-9472-44bd-9d3b-9ea621adee4b",
"name": "SwitchGroup3"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Audit Id",
"type": "string"
},
"name": {
"description": "Audit name",
"type": "string"
}
}
}Retrieve Switch Client list. ¶
POST/v9_1/switchClientVisibility/query
Use this API command to Retrieve the switch client list.
Request
Headers
Content-Type: text/plain,*/*,application/x-www-form-urlencodedBody
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"page": 1,
"limit": 8
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Headers
Content-Type: application/octet-streamBody
{
"rawDataTotalCount": 0,
"totalCount": 0,
"hasMore": false,
"firstIndex": 8,
"list": []
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"switchName": {
"type": "string"
},
"switchPort": {
"type": "integer"
},
"clientIpv4Addr": {
"type": "string"
},
"clientIpv6Addr": {
"type": "string"
},
"clientVlan": {
"type": "string"
},
"clientMac": {
"type": "string"
},
"clientAuthType": {
"type": "string"
},
"clientUserName": {
"type": "string"
},
"clientStatus": {
"type": "string"
},
"clientType": {
"type": "string"
},
"pastAuthHistory": {
"type": "string"
},
"clientDesc": {
"type": "string"
},
"updatedTime": {
"type": "string"
}
}
}
}
}
}Update Switch Group ¶
PUT/v9_1/group/{switchGroupId}
Use this API command to update an existing switch group name, description.
Request
Headers
Content-Type: text/plain,*/*Body
{
"name": "SwitchGroup3",
"description": "Switch Group 3 Description",
"firmware": "Switch Group 3 Firmware Version",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"switchGroupLevelOneId": "",
"switchGroupLevelTwoId": "",
"enableTwoFactor": true,
"levelTwo": false,
"levelOne": true
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the switch group belong",
"type": "string"
},
"creatorId": {
"description": "Creator Id of the switch group",
"type": "string"
},
"tenantId": {
"description": "Tenant Id of the switch group",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Level one Id of the switch group",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Level two Id of the switch group",
"type": "string"
},
"createDatetime": {
"description": "Create datetime of the switch group",
"type": "integer",
"format": "int64"
},
"name": {
"description": "Name of the switch group",
"type": "string"
},
"description": {
"description": "Description of the switch group",
"type": "string"
},
"firmware": {
"description": "Firmware of the switch group",
"type": "string"
},
"sampledInstant": {
"description": "Sampled instant of the switch group",
"type": "object"
},
"levelOne": {
"description": "Level one of the switch group",
"type": "boolean"
},
"levelTwo": {
"description": "Level two of the switch group",
"type": "boolean"
},
"enableTwoFactor": {
"description": "Enable two factor authentication. Only support FIPS mode",
"type": "boolean"
}
}
}Response
200Body
{
"id": "0e4ac34b-9472-44bd-9d3b-9ea621adee4b",
"name": "SwitchGroup3"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Audit Id",
"type": "string"
},
"name": {
"description": "Audit name",
"type": "string"
}
}
}Update Groups Firmware by Domain ¶
PUT/v9_1/group/firmware/byDomain
Use this API command to update default firmware of groups under a specific domain
Request
Headers
Content-Type: text/plain,*/*Body
{
"firmware": "FI08090",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"domainId": {
"description": "Domain Id",
"type": "string"
},
"firmware": {
"description": "Firmware Version",
"type": "string"
}
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Audit Id",
"type": "string"
},
"name": {
"description": "Audit name",
"type": "string"
}
}
}
}
}
}Update Switch Group ¶
PATCH/v9_1/group/{switchGroupId}
Use this API command to update an existing switch group name or description.
Request
Headers
Content-Type: text/plain,*/*Body
{
"name": "SwitchGroup3",
"description": "Switch Group 3 Description",
"firmware": "Switch Group 3 Firmware Version",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the switch group",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the switch group belong",
"type": "string"
},
"creatorId": {
"description": "Creator Id of the switch group",
"type": "string"
},
"tenantId": {
"description": "Tenant Id of the switch group",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Level one Id of the switch group",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Level two Id of the switch group",
"type": "string"
},
"createDatetime": {
"description": "Create datetime of the switch group",
"type": "integer",
"format": "int64"
},
"name": {
"description": "Name of the switch group",
"type": "string"
},
"description": {
"description": "Description of the switch group",
"type": "string"
},
"firmware": {
"description": "Firmware of the switch group",
"type": "string"
},
"sampledInstant": {
"description": "Sampled instant of the switch group",
"type": "object"
},
"levelOne": {
"description": "Level one of the switch group",
"type": "boolean"
},
"levelTwo": {
"description": "Level two of the switch group",
"type": "boolean"
},
"enableTwoFactor": {
"description": "Enable two factor authentication. Only support FIPS mode",
"type": "boolean"
}
}
}Response
200Body
{
"id": "0e4ac34b-9472-44bd-9d3b-9ea621adee4b",
"name": "SwitchGroup3"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Audit Id",
"type": "string"
},
"name": {
"description": "Audit name",
"type": "string"
}
}
}Delete Switch Group ¶
DELETE/v9_1/group/{switchGroupId}
Use this API command to delete a switch group.
Request
Headers
Content-Type: text/plain,*/*Response
200Body
{
"id": "0e4ac34b-9472-44bd-9d3b-9ea621adee4b",
"name": "SwitchGroup3"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Audit Id",
"type": "string"
},
"name": {
"description": "Audit name",
"type": "string"
}
}
}Switch Ports ¶
List Ports ¶
POST/v9_1/switch/ports/details
Use this API command to retrieve all the switch ports and its details currently managed by SmartZone.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "name",
"dir": "ASC"
},
"page": 1,
"limit": 50
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 126,
"hasMore": true,
"firstIndex": 50,
"list": [
{
"id": "00:00:02:01:01:01",
"sampledInstant": null,
"name": "(INTERFACE1/1/1) GigabitEthernet1/1/1",
"switchId": "00:00:02:01:01:01",
"switchFamily": "ICX7450",
"switchModel": "ICX7450-24P",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:01",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 526.63,
"outUtilization": 438.6,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/1"
},
{
"id": "00:00:01:01:01:01",
"sampledInstant": null,
"name": "(INTERFACE1/1/1) GigabitEthernet1/1/1",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:01",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 1942911377,
"free": -197808220,
"percent": -0.34813996562438165
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 642.76,
"outUtilization": 101.43,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/1"
},
{
"id": "00:00:00:01:01:01",
"sampledInstant": null,
"name": "(INTERFACE1/1/1) GigabitEthernet1/1/1",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:01",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 435.25,
"outUtilization": 308.98,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/1"
},
{
"id": "00:00:00:01:01:0A",
"sampledInstant": null,
"name": "(INTERFACE1/1/10) GigabitEthernet1/1/10",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:0A",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 257.77,
"outUtilization": 143.68,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/10"
},
{
"id": "00:00:01:01:01:0A",
"sampledInstant": null,
"name": "(INTERFACE1/1/10) GigabitEthernet1/1/10",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:0A",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 319.23,
"outUtilization": 193.82,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/10"
},
{
"id": "00:00:02:01:01:0A",
"sampledInstant": null,
"name": "(INTERFACE1/1/10) GigabitEthernet1/1/10",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:0A",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 476.7,
"outUtilization": 175.23,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/10"
},
{
"id": "00:00:02:01:01:0B",
"sampledInstant": null,
"name": "(INTERFACE1/1/11) GigabitEthernet1/1/11",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:0B",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 587.03,
"outUtilization": 224.97,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/11"
},
{
"id": "00:00:00:01:01:0B",
"sampledInstant": null,
"name": "(INTERFACE1/1/11) GigabitEthernet1/1/11",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:0B",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 533.21,
"outUtilization": 276.47,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/11"
},
{
"id": "00:00:01:01:01:0B",
"sampledInstant": null,
"name": "(INTERFACE1/1/11) GigabitEthernet1/1/11",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:0B",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 427.37,
"outUtilization": 1.1400000000000001,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/11"
},
{
"id": "00:00:02:01:01:0C",
"sampledInstant": null,
"name": "(INTERFACE1/1/12) GigabitEthernet1/1/12",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:0C",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 341.49,
"outUtilization": 372.58,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/12"
},
{
"id": "00:00:00:01:01:0C",
"sampledInstant": null,
"name": "(INTERFACE1/1/12) GigabitEthernet1/1/12",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:0C",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 449.21000000000004,
"outUtilization": 545.49,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/12"
},
{
"id": "00:00:01:01:01:0C",
"sampledInstant": null,
"name": "(INTERFACE1/1/12) GigabitEthernet1/1/12",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:0C",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 201.55,
"outUtilization": 82.3,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/12"
},
{
"id": "00:00:00:01:01:0D",
"sampledInstant": null,
"name": "(INTERFACE1/1/13) GigabitEthernet1/1/13",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:0D",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 492.54,
"outUtilization": 17.78,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/13"
},
{
"id": "00:00:02:01:01:0D",
"sampledInstant": null,
"name": "(INTERFACE1/1/13) GigabitEthernet1/1/13",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:0D",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 76.21000000000001,
"outUtilization": 129.47,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/13"
},
{
"id": "00:00:01:01:01:0D",
"sampledInstant": null,
"name": "(INTERFACE1/1/13) GigabitEthernet1/1/13",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:0D",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 362.55,
"outUtilization": 207.68,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/13"
},
{
"id": "00:00:01:01:01:0E",
"sampledInstant": null,
"name": "(INTERFACE1/1/14) GigabitEthernet1/1/14",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:0E",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 71.34,
"outUtilization": 168.32,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/14"
},
{
"id": "00:00:00:01:01:0E",
"sampledInstant": null,
"name": "(INTERFACE1/1/14) GigabitEthernet1/1/14",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:0E",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 650.13,
"outUtilization": 467.06,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/14"
},
{
"id": "00:00:02:01:01:0E",
"sampledInstant": null,
"name": "(INTERFACE1/1/14) GigabitEthernet1/1/14",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:0E",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 272565656,
"free": -1014356485,
"percent": -0.5752917748375459
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 479.16,
"outUtilization": 615.62,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/14"
},
{
"id": "00:00:00:01:01:0F",
"sampledInstant": null,
"name": "(INTERFACE1/1/15) GigabitEthernet1/1/15",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:0F",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 254.38,
"outUtilization": 127.24000000000001,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/15"
},
{
"id": "00:00:02:01:01:0F",
"sampledInstant": null,
"name": "(INTERFACE1/1/15) GigabitEthernet1/1/15",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:0F",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 184473004,
"free": -1829118167,
"percent": -2.73398167246195
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 51.980000000000004,
"outUtilization": 181.29,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/15"
},
{
"id": "00:00:01:01:01:0F",
"sampledInstant": null,
"name": "(INTERFACE1/1/15) GigabitEthernet1/1/15",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:0F",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 1315370709,
"free": -384995813,
"percent": -1.3395764615585644
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 121.15,
"outUtilization": 15.51,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/15"
},
{
"id": "00:00:01:01:01:10",
"sampledInstant": null,
"name": "(INTERFACE1/1/16) GigabitEthernet1/1/16",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:10",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 269.87,
"outUtilization": 73.31,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/16"
},
{
"id": "00:00:00:01:01:10",
"sampledInstant": null,
"name": "(INTERFACE1/1/16) GigabitEthernet1/1/16",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:10",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 142.1,
"outUtilization": 90.9,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/16"
},
{
"id": "00:00:02:01:01:10",
"sampledInstant": null,
"name": "(INTERFACE1/1/16) GigabitEthernet1/1/16",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:10",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 619282421,
"free": -713000308,
"percent": 0.13610385365677932
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 597.52,
"outUtilization": 442.75,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/16"
},
{
"id": "00:00:00:01:01:11",
"sampledInstant": null,
"name": "(INTERFACE1/1/17) GigabitEthernet1/1/17",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:11",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 523.41,
"outUtilization": 544.15,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/17"
},
{
"id": "00:00:02:01:01:11",
"sampledInstant": null,
"name": "(INTERFACE1/1/17) GigabitEthernet1/1/17",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:11",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 15.88,
"outUtilization": 179.75,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/17"
},
{
"id": "00:00:01:01:01:11",
"sampledInstant": null,
"name": "(INTERFACE1/1/17) GigabitEthernet1/1/17",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:11",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 266.93,
"outUtilization": 600.61,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/17"
},
{
"id": "00:00:01:01:01:12",
"sampledInstant": null,
"name": "(INTERFACE1/1/18) GigabitEthernet1/1/18",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:12",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 596.49,
"outUtilization": 485.47,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/18"
},
{
"id": "00:00:00:01:01:12",
"sampledInstant": null,
"name": "(INTERFACE1/1/18) GigabitEthernet1/1/18",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:12",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 355.48,
"outUtilization": 88.82000000000001,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/18"
},
{
"id": "00:00:02:01:01:12",
"sampledInstant": null,
"name": "(INTERFACE1/1/18) GigabitEthernet1/1/18",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:12",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 235101258,
"free": -948142611,
"percent": -8.229208998958228
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 446.18,
"outUtilization": 445.23,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/18"
},
{
"id": "00:00:01:01:01:13",
"sampledInstant": null,
"name": "(INTERFACE1/1/19) GigabitEthernet1/1/19",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:13",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 349.07,
"outUtilization": 401.32,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/19"
},
{
"id": "00:00:02:01:01:13",
"sampledInstant": null,
"name": "(INTERFACE1/1/19) GigabitEthernet1/1/19",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:13",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 82.45,
"outUtilization": 465.6,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/19"
},
{
"id": "00:00:00:01:01:13",
"sampledInstant": null,
"name": "(INTERFACE1/1/19) GigabitEthernet1/1/19",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:13",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 284656138,
"free": -1212587432,
"percent": -2.106044029867362
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 76.15,
"outUtilization": 236.94,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/19"
},
{
"id": "00:00:01:01:01:02",
"sampledInstant": null,
"name": "(INTERFACE1/1/2) GigabitEthernet1/1/2",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:02",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 21.32,
"outUtilization": 5.03,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/2"
},
{
"id": "00:00:00:01:01:02",
"sampledInstant": null,
"name": "(INTERFACE1/1/2) GigabitEthernet1/1/2",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:02",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 175.32,
"outUtilization": 376.75,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/2"
},
{
"id": "00:00:02:01:01:02",
"sampledInstant": null,
"name": "(INTERFACE1/1/2) GigabitEthernet1/1/2",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:02",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 500.7,
"outUtilization": 600.44,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/2"
},
{
"id": "00:00:00:01:01:14",
"sampledInstant": null,
"name": "(INTERFACE1/1/20) GigabitEthernet1/1/20",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:14",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 88.34,
"outUtilization": 288.48,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": true,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/20"
},
{
"id": "00:00:01:01:01:14",
"sampledInstant": null,
"name": "(INTERFACE1/1/20) GigabitEthernet1/1/20",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:14",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 11.8,
"outUtilization": 459.48,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/20"
},
{
"id": "00:00:02:01:01:14",
"sampledInstant": null,
"name": "(INTERFACE1/1/20) GigabitEthernet1/1/20",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:14",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 474.55,
"outUtilization": 100.54,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/20"
},
{
"id": "00:00:00:01:01:15",
"sampledInstant": null,
"name": "(INTERFACE1/1/21) GigabitEthernet1/1/21",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:15",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 1021732123,
"free": 162067381,
"percent": 0.06570046931958896
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 504.02000000000004,
"outUtilization": 114.12,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/21"
},
{
"id": "00:00:01:01:01:15",
"sampledInstant": null,
"name": "(INTERFACE1/1/21) GigabitEthernet1/1/21",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:15",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 195.08,
"outUtilization": 468.25,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/21"
},
{
"id": "00:00:02:01:01:15",
"sampledInstant": null,
"name": "(INTERFACE1/1/21) GigabitEthernet1/1/21",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:15",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 813510013,
"free": -1201728564,
"percent": -0.41745670805898244
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 596.79,
"outUtilization": 402.43,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/21"
},
{
"id": "00:00:02:01:01:16",
"sampledInstant": null,
"name": "(INTERFACE1/1/22) GigabitEthernet1/1/22",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:16",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 53.730000000000004,
"outUtilization": 120.60000000000001,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/22"
},
{
"id": "00:00:00:01:01:16",
"sampledInstant": null,
"name": "(INTERFACE1/1/22) GigabitEthernet1/1/22",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:16",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 113.79,
"outUtilization": 417.59000000000003,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/22"
},
{
"id": "00:00:01:01:01:16",
"sampledInstant": null,
"name": "(INTERFACE1/1/22) GigabitEthernet1/1/22",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:16",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 489.38,
"outUtilization": 2.52,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/22"
},
{
"id": "00:00:01:01:01:17",
"sampledInstant": null,
"name": "(INTERFACE1/1/23) GigabitEthernet1/1/23",
"switchName": "icx_jemery1",
"switchGroup": "MyGroup1",
"mac": "00:00:01:01:01:17",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 497.83,
"outUtilization": 374.41,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/23"
},
{
"id": "00:00:02:01:01:17",
"sampledInstant": null,
"name": "(INTERFACE1/1/23) GigabitEthernet1/1/23",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:17",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 392.83,
"outUtilization": 88.77,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/23"
},
{
"id": "00:00:00:01:01:17",
"sampledInstant": null,
"name": "(INTERFACE1/1/23) GigabitEthernet1/1/23",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:17",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 1964635312,
"free": -127902777,
"percent": -0.610590981783188
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 429.82,
"outUtilization": 373.36,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/23"
},
{
"id": "00:00:00:01:01:18",
"sampledInstant": null,
"name": "(INTERFACE1/1/24) GigabitEthernet1/1/24",
"switchName": "icx_jemery0",
"switchGroup": "MyGroup1",
"mac": "00:00:00:01:01:18",
"type": "",
"status": "Down",
"adminStatus": "Down",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gb/sec",
"stpState": null,
"inUtilization": 460.5,
"outUtilization": 181.83,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/24"
},
{
"id": "00:00:02:01:01:18",
"sampledInstant": null,
"name": "(INTERFACE1/1/24) GigabitEthernet1/1/24",
"switchName": "icx_jemery2",
"switchGroup": "MyGroup1",
"mac": "00:00:02:01:01:18",
"type": "",
"status": "Up",
"adminStatus": "Up",
"vlans": "",
"poe": {
"total": 0,
"free": 0,
"percent": 0
},
"neighborName": "",
"portSpeed": "1 Gbits per second",
"stpState": null,
"inUtilization": 38.81,
"outUtilization": 150.97,
"opticsType": "1 Gbits per second fiber.",
"connectedDevice": null,
"trafficUsage": null,
"poeEnabled": false,
"usedInFormingStack": false,
"lagName": "",
"unTaggedVlan": "",
"portIdentifier": "1/1/24"
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Switch port detail list count",
"type": "integer"
},
"totalCount": {
"description": "Total switch port detail list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more switch port detail after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first switch port detail returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of switch port",
"type": "string"
},
"sampledInstant": {
"description": "Sampled instant of switch port",
"type": "string"
},
"name": {
"description": "Name of switch port",
"type": "string"
},
"switchId": {
"type": "string"
},
"switchFamily": {
"type": "string"
},
"switchModel": {
"type": "string"
},
"switchName": {
"description": "Switch Name of switch port",
"type": "string"
},
"switchGroup": {
"description": "Switch group of switch port",
"type": "string"
},
"mac": {
"description": "Mac address of switch port",
"type": "string"
},
"type": {
"description": "Type of switch port",
"type": "string"
},
"status": {
"description": "Status of switch port, UP or DOWN",
"type": "string"
},
"adminStatus": {
"description": "Admin status of switch port, UP or DOWN",
"type": "string"
},
"vlans": {
"description": "Switch port include vlans",
"type": "string"
},
"poe": {
"description": "PoE information of switch port",
"type": "object",
"additionalProperties": false,
"properties": {
"total": {
"description": "Total power capacity of switch port",
"type": "integer"
},
"free": {
"description": "Free power capacity of switch port",
"type": "integer"
},
"percent": {
"description": "Power used percentage of switch port",
"type": "number"
}
}
},
"portError": {
"description": "Port error Information",
"type": "object",
"additionalProperties": false,
"properties": {
"inError": {
"description": "Switch port traffic in error count",
"type": "integer"
},
"outError": {
"description": "Switch port traffic out error count",
"type": "integer"
},
"crcError": {
"description": "Switch port CRC error count",
"type": "integer"
},
"inDiscard": {
"description": "Switch port traffic in discard count",
"type": "integer"
}
}
},
"packets": {
"description": "Port packet transmit information",
"type": "object",
"additionalProperties": false,
"properties": {
"broadcastIn": {
"description": "Switch port broadcast in packet count",
"type": "integer"
},
"broadcastOut": {
"description": "Switch port broadcast out packet count",
"type": "integer"
},
"multicastIn": {
"description": "Switch port multicast in packet count",
"type": "integer"
},
"multicastOut": {
"description": "Switch port multicast out packet count",
"type": "integer"
}
}
},
"neighborName": {
"description": "Switch port connected neighbor name",
"type": "string"
},
"portSpeed": {
"description": "Switch port speed",
"type": "string"
},
"stpState": {
"description": "Switch port STP state",
"type": "integer"
},
"inUtilization": {
"description": "Switch port traffic in utilization",
"type": "number"
},
"outUtilization": {
"description": "Switch port traffic out utilization",
"type": "number"
},
"opticsType": {
"description": "Switch port optics type",
"type": "string"
},
"connectedDevice": {
"description": "Connected device information",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of connected device",
"type": "string"
},
"localPortMac": {
"description": "Local port mac address to connected device",
"type": "string"
},
"remotePortMac": {
"description": "Remote port mac address of local device",
"type": "string"
},
"remoteDeviceName": {
"description": "Remote connected device name",
"type": "string"
},
"remoteDeviceMac": {
"type": "string"
},
"remotePortType": {
"description": "Remote port type of connected device",
"type": "string"
},
"remotePortDesc": {
"description": "Remote port description of connected device",
"type": "string"
},
"localPort": {
"description": "Local port description to connected device",
"type": "string"
},
"remotePort": {
"description": "Remote port number of connected device",
"type": "string"
},
"isRuckusAP": {
"description": "Connected devices is RuckusAP,True or False",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the connected device belong",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Switch group level one Id",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Switch group level two Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"unitId": {
"description": "Unit Id",
"type": "string"
},
"localPortIfaceName": {
"description": "Local port interface name",
"type": "string"
},
"switchName": {
"description": "Switch name",
"type": "string"
},
"switchGroup": {
"description": "Switch group",
"type": "string"
}
}
},
"trafficUsage": {
"description": "Traffic usage information",
"type": "object",
"additionalProperties": false,
"properties": {
"tx": {
"description": "Tx traffic usage of switch port",
"type": "integer"
},
"rx": {
"description": "Rx traffic usage of switch port",
"type": "integer"
}
}
},
"poeEnabled": {
"description": "PoE Enabled, True or False",
"type": "boolean"
},
"poeType": {
"description": "PoE type",
"type": "string"
},
"usedInFormingStack": {
"description": "Used in forming stack, True or False",
"type": "boolean"
},
"lagName": {
"description": "LAG name of switch port",
"type": "string"
},
"unTaggedVlan": {
"description": "Untagged vlan of switch port",
"type": "string"
},
"portIdentifier": {
"description": "Port Identifier of switch port",
"type": "string"
}
}
}
}
}
}Port Summary ¶
POST/v9_1/switch/ports/summary
Use this API command to retrieve ports summary based on status, speed of a switch, currently managed by SmartZone.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "OR",
"value": ""
},
"attributes": [
"*"
],
"page": 1,
"limit": 8,
"extraFilters": [
{
"value": "60:9C:9F:1D:DD:B0",
"type": "SWITCH"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 7,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"speed": null,
"up": null,
"warning": null,
"down": null,
"total": null,
"adminDown": null,
"speedInt": 0
},
{
"speed": "All Ports",
"up": 0,
"warning": 0,
"down": 0,
"total": 0,
"adminDown": 0,
"speedInt": 0
},
{
"speed": "100G",
"up": 0,
"warning": 0,
"down": 0,
"total": 0,
"adminDown": 0,
"speedInt": 100
},
{
"speed": "40G",
"up": 0,
"warning": 0,
"down": 0,
"total": 0,
"adminDown": 0,
"speedInt": 40
},
{
"speed": "10G",
"up": 0,
"warning": 0,
"down": 0,
"total": 0,
"adminDown": 0,
"speedInt": 10
},
{
"speed": "2.5G",
"up": 0,
"warning": 0,
"down": 0,
"total": 0,
"adminDown": 0,
"speedInt": 25
},
{
"speed": "1G",
"up": 0,
"warning": 0,
"down": 0,
"total": 0,
"adminDown": 0,
"speedInt": 1
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Switch ports summary list count",
"type": "integer"
},
"totalCount": {
"description": "Total switch ports summary list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more switch ports summary after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first switch ports summary returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"description": "$",
"type": "object",
"additionalProperties": false,
"properties": {
"speed": {
"description": "Switch port speed",
"type": "string"
},
"up": {
"description": "Up port count",
"type": "integer"
},
"warning": {
"description": "Warring port count",
"type": "integer"
},
"down": {
"description": "Down port count",
"type": "integer"
},
"total": {
"description": "Total port count",
"type": "integer"
},
"adminDown": {
"description": "Admin down port count",
"type": "integer"
},
"speedInt": {
"description": "Switch port fully speed",
"type": "integer"
}
}
}
}
}
}Switch Wired Clients ¶
List Clients ¶
POST/v9_1/switch/clients
Use this API command to retrieve all the wired clients connected to switch, currently managed by SmartZone.
Request
Body
{
"filters": [
{
"type": "SWITCH_GROUP",
"value": "21ed3a40-34a7-4d13-844c-783c66074d7a"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "remoteDeviceName",
"dir": "ASC"
},
"page": 1,
"limit": 8
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 1,
"hasMore": false,
"firstIndex": 8,
"list": [
{
"id": "40:b9:3c:52:21:2160:9c:9f:da:63:80_1",
"localPortMac": "60:9c:9f:da:63:80",
"remotePortMac": "40:b9:3c:52:21:21",
"remoteDeviceName": "RA_App6_10.100.253.102",
"remoteDeviceMac": "55:b9:3c:52:21:21",
"remotePortType": "Bridge, Router",
"remotePortDesc": "1920-24G Switch Software Version 5.20.99, Release 1116\r\nCopyright(c)2010-2017 Hewlett Packard Enterprise Development LP",
"localPort": "10GigabitEthernet1/1/1",
"remotePort": "GigabitEthernet1/0/10 Interface",
"isRuckusAP": "false",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"tenantId": "",
"switchGroupLevelOneId": "21ed3a40-34a7-4d13-844c-783c66074d7a",
"switchGroupLevelTwoId": "",
"switchId": "60:9C:9F:DA:63:80",
"unitId": "",
"localPortIfaceName": null,
"switchName": "ICX7750-1",
"switchGroup": "RealSwitchGroup1",
"sampledInstant": null
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Connected devices list count",
"type": "integer"
},
"totalCount": {
"description": "Total connected devices list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more switch connected devices after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first switch connected devices returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of connected device",
"type": "string"
},
"localPortMac": {
"description": "Local port mac address",
"type": "string"
},
"remotePortMac": {
"description": "Remote connected device port mac address",
"type": "string"
},
"remoteDeviceName": {
"description": "Remote connected device name",
"type": "string"
},
"remoteDeviceMac": {
"type": "string"
},
"remotePortType": {
"description": "Remote connected device port type",
"type": "string"
},
"remotePortDesc": {
"description": "Remote connected device port description",
"type": "string"
},
"localPort": {
"description": "Local port which connect to remote device",
"type": "string"
},
"remotePort": {
"description": "Remote device port which connected to local device",
"type": "string"
},
"isRuckusAP": {
"description": "Remote connected device is Ruckus AP, True or False.",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the connected device belong",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Switch group level one Id",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Switch group level two Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"unitId": {
"description": "Unit Id",
"type": "string"
},
"localPortIfaceName": {
"description": "Local port interface name",
"type": "string"
},
"switchName": {
"description": "Switch name",
"type": "string"
},
"switchGroup": {
"description": "Switch group",
"type": "string"
},
"sampledInstant": {
"description": "Sampled instant",
"type": "object"
}
}
}
}
}
}List Ruckus Clients ¶
POST/v9_1/switch/clients/ap
Use this API command to retrieve all the Ruckus APs connected to switch, currently managed by SmartZone.
Request
Body
{
"filters": [
{
"type": "SWITCH_GROUP",
"value": "f7b3850d-daad-40b5-aad8-5f847436cf8d"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
],
"sortInfo": {
"sortColumn": "remoteDeviceName",
"dir": "ASC"
},
"page": 1,
"limit": 8
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 3,
"hasMore": false,
"firstIndex": 8,
"list": [
{
"id": "d8:38:fc:38:4f:3060:9c:9f:e5:07:41_8",
"localPortMac": "60:9c:9f:e5:07:41",
"remotePortMac": "d8:38:fc:38:4f:30",
"remoteDeviceName": "RuckusAP",
"remotePortType": "Bridge, WlanAccessPoint, Router",
"remotePortDesc": "Ruckus R610 Multimedia Hotzone Wireless AP/SW Version: 5.0.0.99.522",
"localPort": "GigabitEthernet10/1/2",
"remotePort": "eth0",
"isRuckusAP": "true",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"tenantId": "",
"switchGroupLevelOneId": "fce89259-e0b3-4599-8890-6a6cdd93d9bf",
"switchGroupLevelTwoId": "",
"switchId": "60:9C:9F:FE:0B:B8",
"unitId": "",
"localPortIfaceName": null,
"switchName": "N/A",
"switchGroup": "N/A",
"sampledInstant": null
},
{
"id": "d8:38:fc:38:4f:3060:9c:9f:e5:07:41_100",
"localPortMac": "60:9c:9f:e5:07:41",
"remotePortMac": "d8:38:fc:38:4f:30",
"remoteDeviceName": "RuckusAP",
"remotePortType": "Bridge, WlanAccessPoint, Router",
"remotePortDesc": "Ruckus R610 Multimedia Hotzone Wireless AP/SW Version: 5.0.0.0.636",
"localPort": "GigabitEthernet10/1/2",
"remotePort": "eth0",
"isRuckusAP": "true",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"tenantId": "",
"switchGroupLevelOneId": "c2498b0f-c89d-4513-ac8c-242dacf83ce2",
"switchGroupLevelTwoId": "",
"switchId": "60:9C:9F:FE:15:EA",
"unitId": "",
"localPortIfaceName": null,
"switchName": "ABCD",
"switchGroup": "BRCD",
"sampledInstant": null
},
{
"id": "d8:38:fc:1e:b1:3060:9c:9f:e5:26:60_99",
"localPortMac": "60:9c:9f:e5:26:60",
"remotePortMac": "d8:38:fc:1e:b1:30",
"remoteDeviceName": "RuckusAP",
"remotePortType": "Bridge, WlanAccessPoint, Router",
"remotePortDesc": "Ruckus R610 Multimedia Hotzone Wireless AP/SW Version: 5.0.0.0.636",
"localPort": "GigabitEthernet3/1/1",
"remotePort": "eth0",
"isRuckusAP": "true",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"tenantId": "",
"switchGroupLevelOneId": "c2498b0f-c89d-4513-ac8c-242dacf83ce2",
"switchGroupLevelTwoId": "",
"switchId": "60:9C:9F:FE:15:EA",
"unitId": "",
"localPortIfaceName": null,
"switchName": "ABCD",
"switchGroup": "BRCD",
"sampledInstant": null
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Connected AP list count",
"type": "integer"
},
"totalCount": {
"description": "Total connected AP list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more switch connected AP after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first switch connected AP returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of connected device",
"type": "string"
},
"localPortMac": {
"description": "Local port mac address",
"type": "string"
},
"remotePortMac": {
"description": "Remote connected device port mac address",
"type": "string"
},
"remoteDeviceName": {
"description": "Remote connected device name",
"type": "string"
},
"remoteDeviceMac": {
"type": "string"
},
"remotePortType": {
"description": "Remote connected device port type",
"type": "string"
},
"remotePortDesc": {
"description": "Remote connected device port description",
"type": "string"
},
"localPort": {
"description": "Local port which connect to remote device",
"type": "string"
},
"remotePort": {
"description": "Remote device port which connected to local device",
"type": "string"
},
"isRuckusAP": {
"description": "Remote connected device is Ruckus AP, True or False.",
"type": "string"
},
"domainId": {
"description": "Identifier of the management domain to which the connected device belong",
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Switch group level one Id",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Switch group level two Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"unitId": {
"description": "Unit Id",
"type": "string"
},
"localPortIfaceName": {
"description": "Local port interface name",
"type": "string"
},
"switchName": {
"description": "Switch name",
"type": "string"
},
"switchGroup": {
"description": "Switch group",
"type": "string"
},
"sampledInstant": {
"description": "Sampled instant",
"type": "object"
}
}
}
}
}
}Switch Event ¶
Retrieve Switch Custom Event Config List ¶
GET/v9_1/customEvent
Use this API command to retrieve switch event config list
Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 6,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "0",
"name": "Warning CPU Usage",
"type": "CPU",
"severity": "Warning",
"criteria": 20,
"description": "Switch CPU usage is over Warning threshold, 20%",
"timeWindow": 0,
"textPattern": null
},
{
"id": "1",
"name": "Major CPU Usage",
"type": "CPU",
"severity": "Major",
"criteria": 30,
"description": "Switch CPU usage is over Major threshold, 30%",
"timeWindow": 0,
"textPattern": null
},
{
"id": "2",
"name": "Critical CPU Usage",
"type": "CPU",
"severity": "Critical",
"criteria": 60,
"description": "Switch CPU usage is over Critical threshold, 60%",
"timeWindow": 0,
"textPattern": null
},
{
"id": "10",
"name": "Warning Memory Usage",
"type": "Memory",
"severity": "Warning",
"criteria": 60,
"description": "Switch Memory usage is over Warning threshold, 60%",
"timeWindow": 0,
"textPattern": null
},
{
"id": "11",
"name": "Major Memory Usage",
"type": "Memory",
"severity": "Major",
"criteria": 85,
"description": "Switch Memory usage is over Major threshold, 85%",
"timeWindow": 0,
"textPattern": null
},
{
"id": "12",
"name": "Critical Memory Usage",
"type": "Memory",
"severity": "Critical",
"criteria": 90,
"description": "Switch Memory usage is over Critical threshold, 90%",
"timeWindow": 0,
"textPattern": null
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "List of responsed Switch custom event config",
"type": "integer"
},
"totalCount": {
"description": "Count of responsed Switch custom event config",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Switch event config",
"type": "boolean"
},
"firstIndex": {
"description": "First index of responsed Switch custom event config list",
"type": "integer"
},
"extra": {
"description": "Extra information of responsed Switch custom event config list",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of event config",
"type": "integer"
},
"name": {
"description": "Name of each Switch custom event config",
"type": "string"
},
"type": {
"description": "Type of each Switch custom event config",
"type": "string",
"enum": [
"CPU",
"Memory",
"TextPattern"
]
},
"severity": {
"description": "Severity of each Switch custom event config",
"type": "string",
"enum": [
"Warning",
"Major",
"Critical"
]
},
"criteria": {
"description": "Threshold of each Switch custom event config",
"type": "integer"
},
"description": {
"description": "Description of each Switch custom event config",
"type": "string"
},
"textPattern": {
"description": "User defined text pattern of each Switch custom event config",
"type": "string"
},
"timeWindow": {
"description": "Detection time woindow of each Switch custom event config",
"type": "integer",
"enum": [
60,
120,
240,
480,
720,
1440,
2880
]
}
}
}
}
}
}Retrieve One Switch Custom Event Config ¶
GET/v9_1/customEvent/{id}
Use this API command to retrieve one switch event config
Response
200Body
{
"id": 104,
"name": "test4",
"description": "test4",
"type": "TextPattern",
"textPattern": "test4",
"criteria": 20,
"timeWindow": 480,
"severity": "Major"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of event config",
"type": "integer"
},
"name": {
"description": "Name of each Switch custom event config",
"type": "string"
},
"type": {
"description": "Type of each Switch custom event config",
"type": "string",
"enum": [
"CPU",
"Memory",
"TextPattern"
]
},
"severity": {
"description": "Severity of each Switch custom event config",
"type": "string",
"enum": [
"Warning",
"Major",
"Critical"
]
},
"criteria": {
"description": "Threshold of each Switch custom event config",
"type": "integer"
},
"description": {
"description": "Description of each Switch custom event config",
"type": "string"
},
"textPattern": {
"description": "User defined text pattern of each Switch custom event config",
"type": "string"
},
"timeWindow": {
"description": "Detection time woindow of each Switch custom event config",
"type": "integer",
"enum": [
60,
120,
240,
480,
720,
1440,
2880
]
}
}
}Create A New Text Pattern Event Config ¶
POST/v9_1/customEvent
Use this API command to create a new text pattern event config
Request
Body
{
"id": 104,
"name": "test4",
"description": "test4",
"type": "TextPattern",
"textPattern": "test4",
"criteria": 20,
"timeWindow": 480,
"severity": "Major"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of event config",
"type": "integer"
},
"name": {
"description": "Name of each Switch custom event config",
"type": "string"
},
"type": {
"description": "Type of each Switch custom event config",
"type": "string",
"enum": [
"CPU",
"Memory",
"TextPattern"
]
},
"severity": {
"description": "Severity of each Switch custom event config",
"type": "string",
"enum": [
"Warning",
"Major",
"Critical"
]
},
"criteria": {
"description": "Threshold of each Switch custom event config",
"type": "integer"
},
"description": {
"description": "Description of each Switch custom event config",
"type": "string"
},
"textPattern": {
"description": "User defined text pattern of each Switch custom event config",
"type": "string"
},
"timeWindow": {
"description": "Detection time woindow of each Switch custom event config",
"type": "integer",
"enum": [
60,
120,
240,
480,
720,
1440,
2880
]
}
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Response success message of Public API",
"type": "boolean"
},
"error": {
"description": "Response error message of Public API",
"type": "object"
},
"data": {
"description": "Response data message of Public API",
"type": "object"
},
"extra": {
"description": "Extra information of Public API response",
"type": "object"
},
"metaData": {
"description": "Meta-data of Public API response",
"type": "object"
}
}
}Modify A Switch Custom Event Config ¶
PUT/v9_1/customEvent/{id}
Use this API command to modify a switch custom event config. The patch variable {id} is same as id attribute in the request payload. For CPU/Memory, only key, type, criteria, and severity attributes are required.
Request
Body
{
"id": 104,
"name": "test4",
"description": "test4",
"type": "TextPattern",
"textPattern": "test4",
"criteria": 20,
"timeWindow": 480,
"severity": "Major"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of event config",
"type": "integer"
},
"name": {
"description": "Name of each Switch custom event config",
"type": "string"
},
"type": {
"description": "Type of each Switch custom event config",
"type": "string",
"enum": [
"CPU",
"Memory",
"TextPattern"
]
},
"severity": {
"description": "Severity of each Switch custom event config",
"type": "string",
"enum": [
"Warning",
"Major",
"Critical"
]
},
"criteria": {
"description": "Threshold of each Switch custom event config",
"type": "integer"
},
"description": {
"description": "Description of each Switch custom event config",
"type": "string"
},
"textPattern": {
"description": "User defined text pattern of each Switch custom event config",
"type": "string"
},
"timeWindow": {
"description": "Detection time woindow of each Switch custom event config",
"type": "integer",
"enum": [
60,
120,
240,
480,
720,
1440,
2880
]
}
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Response success message of Public API",
"type": "boolean"
},
"error": {
"description": "Response error message of Public API",
"type": "object"
},
"data": {
"description": "Response data message of Public API",
"type": "object"
},
"extra": {
"description": "Extra information of Public API response",
"type": "object"
},
"metaData": {
"description": "Meta-data of Public API response",
"type": "object"
}
}
}Delete A Text Pattern Event Config ¶
DELETE/v9_1/customEvent/{id}
Use this API command to delete a text pattern event config
Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Response success message of Public API",
"type": "boolean"
},
"error": {
"description": "Response error message of Public API",
"type": "object"
},
"data": {
"description": "Response data message of Public API",
"type": "object"
},
"extra": {
"description": "Extra information of Public API response",
"type": "object"
},
"metaData": {
"description": "Meta-data of Public API response",
"type": "object"
}
}
}Top Reports ¶
Top Switches by Firmware ¶
POST/v9_1/switch/top/byFirmware
Use this API command to retrieves top N switch count based on firmware version.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"options": {},
"limit": 10,
"page": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": null,
"key": "1.0.0",
"value": 3
},
{
"id": null,
"key": "SWS08080b254",
"value": 1
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Top switches by firmware list count",
"type": "integer"
},
"totalCount": {
"description": "Total top switches by firmware list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more top switches by firmware after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first top switches by firmware returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the barchart",
"type": "string"
},
"key": {
"description": "Key of the barchart",
"type": "string"
},
"value": {
"description": "Metrics of the barchart",
"type": "number"
}
}
}
}
}
}Top Switches by Model ¶
POST/v9_1/switch/top/byModel
Use this API command to retrieve top N switch count based on switch model.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"options": {},
"limit": 10,
"page": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": null,
"key": "ICX7450",
"value": 3
},
{
"id": null,
"key": "ICX7750-48XGC",
"value": 1
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Top switches by model list count",
"type": "integer"
},
"totalCount": {
"description": "Total top switches by model list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are top switches by model after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first top switches by model returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the barchart",
"type": "string"
},
"key": {
"description": "Key of the barchart",
"type": "string"
},
"value": {
"description": "Metrics of the barchart",
"type": "number"
}
}
}
}
}
}Job and Schedule ¶
Get Job ¶
GET/v9_1/job/{jobId}
Use this API command to retrieve a given job.
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"id": "60:9C:9F:DA:63:80-firmware-update-1528772188495",
"switchId": "60:9C:9F:DA:63:80",
"action": "update",
"type": "firmware",
"status": "succeeded",
"createdTimestamp": 1528772188495,
"modifiedTimestamp": 1528772818068,
"domainId": "",
"tenantId": "",
"switchGroupLevelOneId": "",
"switchGroupLevelTwoId": "",
"failureReason": "",
"stickyNodeId": "",
"scheduleId": "firmware-update-ONE_TIME-1528772152959"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the job",
"type": "string"
},
"switchId": {
"description": "Switch Id of the job",
"type": "string"
},
"action": {
"description": "Action of the job",
"type": "string"
},
"type": {
"description": "Type of the job",
"type": "string"
},
"status": {
"description": "Status of the job",
"type": "string"
},
"createdTimestamp": {
"description": "Created timestamp of the job",
"type": "integer",
"format": "int64"
},
"modifiedTimestamp": {
"description": "Modified timestamp of the job",
"type": "integer",
"format": "int64"
},
"domainId": {
"description": "Identifier of the management domain to which the job belong",
"type": "string"
},
"tenantId": {
"description": "Tenant Id of the job",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Switch group level one Id of the job",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Switch group level two Id of the job",
"type": "string"
},
"failureReason": {
"description": "Failure reason of the job",
"type": "string"
},
"stickyNodeId": {
"description": "Sticky node Id of the job",
"type": "string"
},
"scheduleId": {
"description": "Schedule Id of the job",
"type": "string"
},
"csvDataMap": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"properties": {}
}
}
}Get Schedule ¶
GET/v9_1/job/schedule/{scheduleId}
Use this API command to retrieve a given schedule.
Response
200Body
{
"success": true,
"error": null,
"data": {
"createdTimestamp": 1528774418843,
"triggerValue": "",
"jobId": [
"60:9C:9F:DA:63:80-firmware-update-1528774468472"
]
},
"extra": {},
"metaData": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Success response of job schedule",
"type": "boolean"
},
"error": {
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"type": "string"
},
"msgKey": {
"type": "string"
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"data": {
"type": "object",
"additionalProperties": false,
"properties": {
"createdTimestamp": {
"description": "Created timestamp of job schedule",
"type": "integer"
},
"triggerValue": {
"description": "Trigger value of job schedule",
"type": "string"
},
"jobId": {
"description": "Job Id of job schedule",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"extra": {
"description": "Extra response of job schedule",
"type": "object"
},
"metaData": {
"description": "metaData of job schedule",
"type": "object"
}
}
}List Jobs ¶
POST/v9_1/job
Use this API command to retrieve a list of jobs.
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "60:9C:9F:DA:63:80-firmware-update-1528772188495",
"switchId": "60:9C:9F:DA:63:80",
"action": "update",
"type": "firmware",
"status": "succeeded",
"createdTimestamp": 1528772188495,
"modifiedTimestamp": 1528772818068,
"domainId": "",
"tenantId": "",
"switchGroupLevelOneId": "",
"switchGroupLevelTwoId": "",
"failureReason": "",
"stickyNodeId": "",
"scheduleId": "firmware-update-ONE_TIME-1528772152959"
},
{
"id": "60:9C:9F:DA:63:80-firmware-update-1528774468472",
"switchId": "60:9C:9F:DA:63:80",
"action": "update",
"type": "firmware",
"status": "succeeded",
"createdTimestamp": 1528774468472,
"modifiedTimestamp": 1528775051513,
"domainId": "",
"tenantId": "",
"switchGroupLevelOneId": "",
"switchGroupLevelTwoId": "",
"failureReason": "",
"stickyNodeId": "",
"scheduleId": "firmware-update-ONE_TIME-1528774418843"
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "List count",
"type": "integer"
},
"totalCount": {
"description": "Total list count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more jobs after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first job returned out of the complete job list",
"type": "integer"
},
"extra": {
"description": "Extra information for job list",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the job",
"type": "string"
},
"switchId": {
"description": "Switch Id of the job",
"type": "string"
},
"action": {
"description": "Action of the job",
"type": "string"
},
"type": {
"description": "Type of the job",
"type": "string"
},
"status": {
"description": "Status of the job",
"type": "string"
},
"createdTimestamp": {
"description": "Created timestamp of the job",
"type": "integer",
"format": "int64"
},
"modifiedTimestamp": {
"description": "Modified timestamp of the job",
"type": "integer",
"format": "int64"
},
"domainId": {
"description": "Identifier of the management domain to which the job belong",
"type": "string"
},
"tenantId": {
"description": "Tenant Id of the job",
"type": "string"
},
"switchGroupLevelOneId": {
"description": "Switch group level one Id of the job",
"type": "string"
},
"switchGroupLevelTwoId": {
"description": "Switch group level two Id of the job",
"type": "string"
},
"failureReason": {
"description": "Failure reason of the job",
"type": "string"
},
"stickyNodeId": {
"description": "Sticky node Id of the job",
"type": "string"
},
"scheduleId": {
"description": "Schedule Id of the job",
"type": "string"
},
"csvDataMap": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"properties": {}
}
}
}
}
}
}Switch Registration Rules ¶
List Rules ¶
GET/v9_1/registrationRules
Use this API command to retrieves all the registration rules configured in SmartZone.
Response
200Body
{
"success": true,
"error": null,
"data": {
"rawDataTotalCount": 0,
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "733c6d35-e89b-4793-9591-9c05e2d9af75",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"creatorName": "admin",
"switchGroupId": "e299823b-dc14-4c1f-985e-f5002bfccb0f",
"type": "IP_RANGE",
"ipFrom": "192.168.240.1",
"ipTo": "192.168.240.255",
"network": "",
"subnetMask": "",
"modelNumber": "",
"rank": 2,
"createDatetime": 1528260217948,
"groupName": "RealSwitchGroup1",
"description": "",
"ipRange": "192.168.240.1,192.168.240.255",
"label": "IP From: 192.168.240.1, IP To :192.168.240.255"
},
{
"id": "691310a6-5912-4c67-b72d-cd20d87ffce3",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"creatorName": "admin",
"switchGroupId": "a7058e17-0ce9-41db-b59f-d6222148c43b",
"type": "IP_RANGE",
"ipFrom": "192.168.239.1",
"ipTo": "192.168.239.255",
"network": "",
"subnetMask": "",
"modelNumber": "",
"rank": 1,
"createDatetime": 1526623284828,
"groupName": "MyGroup1",
"description": "",
"ipRange": "192.168.239.1,192.168.239.255",
"label": "IP From: 192.168.239.1, IP To :192.168.239.255"
}
],
"extra": null
},
"extra": {},
"metaData": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Rule query result success or not",
"type": "boolean"
},
"error": {
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"type": "string"
},
"msgKey": {
"type": "string"
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"data": {
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Registration rule list count",
"type": "integer"
},
"totalCount": {
"description": "Total Registration rule list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more registration rule after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first registration rule returned out of the complete registration rule list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the registration rule",
"type": "string"
},
"creatorId": {
"description": "Creator Id of the registration rule",
"type": "string"
},
"creatorName": {
"description": "Creator name of the registration rule",
"type": "string"
},
"switchGroupId": {
"description": "Switch group Id of the registration rule",
"type": "string"
},
"type": {
"description": "Type of the registration rule",
"type": "string",
"enum": [
"IP_RANGE",
"SUBNET",
"MODEL_NUMBER"
]
},
"ipFrom": {
"description": "Start IP range of the registration rule",
"type": "string"
},
"ipTo": {
"description": "End IP range of the registration rule",
"type": "string"
},
"network": {
"description": "Network of the registration rule",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask of the registration rule",
"type": "string"
},
"modelNumber": {
"description": "Switch Model number of the registration rule",
"type": "string"
},
"rank": {
"description": "Rank of the registration rule",
"type": "integer"
},
"createDatetime": {
"description": "Create datetime of the registration rule",
"type": "integer",
"format": "int64"
},
"groupName": {
"description": "Switch group name of the registration rule",
"type": "string"
},
"description": {
"description": "Description of the registration rule",
"type": "string"
},
"label": {
"description": "Lable of the registration rule",
"type": "string"
},
"ipRange": {
"description": "IP range of the registration rule",
"type": "string"
}
}
}
}
}
},
"extra": {
"description": "Any additional response",
"type": "object"
},
"metaData": {
"description": "Matadata of Rule query result",
"type": "object"
}
}
}Create Rule ¶
POST/v9_1/registrationRules
Use this API command to create new switch registration rule.
Request
Body
{
"id": "422c50f8-038a-43b5-ba31-64b4d1aecb22",
"creatorId": "",
"creatorName": "NA",
"switchGroupId": "8a098bb7-d80f-4604-a0ff-692ed56dcfd3",
"type": "IP_RANGE",
"ipFrom": "1.1.1.1",
"ipTo": "2.2.2.2",
"network": "",
"subnetMask": "",
"modelNumber": "",
"rank": 2,
"groupName": "MyGroup1",
"description": "",
"ipRange": "1.1.1.1,2.2.2.2",
"label": "IP From: 1.1.1.1, IP To :2.2.2.2"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the registration rule",
"type": "string"
},
"creatorId": {
"description": "Creator Id of the registration rule",
"type": "string"
},
"creatorName": {
"description": "Creator name of the registration rule",
"type": "string"
},
"switchGroupId": {
"description": "Switch group Id of the registration rule",
"type": "string"
},
"type": {
"description": "Type of the registration rule",
"type": "string",
"enum": [
"IP_RANGE",
"SUBNET",
"MODEL_NUMBER"
]
},
"ipFrom": {
"description": "Start IP range of the registration rule",
"type": "string"
},
"ipTo": {
"description": "End IP range of the registration rule",
"type": "string"
},
"network": {
"description": "Network of the registration rule",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask of the registration rule",
"type": "string"
},
"modelNumber": {
"description": "Switch Model number of the registration rule",
"type": "string"
},
"rank": {
"description": "Rank of the registration rule",
"type": "integer"
},
"createDatetime": {
"description": "Create datetime of the registration rule",
"type": "integer",
"format": "int64"
},
"groupName": {
"description": "Switch group name of the registration rule",
"type": "string"
},
"description": {
"description": "Description of the registration rule",
"type": "string"
},
"label": {
"description": "Lable of the registration rule",
"type": "string"
},
"ipRange": {
"description": "IP range of the registration rule",
"type": "string"
}
}
}Response
201Body
{
"success": true,
"error": null,
"data": {
"id": "0169bf51-e083-4844-8292-6e684909d562",
"label": "IP From: 192.168.188.1, IP To :192.168.188.255",
"extraValues": {},
"type": null
},
"extra": {},
"metaData": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Create result success or not",
"type": "boolean"
},
"error": {
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"type": "string"
},
"msgKey": {
"type": "string"
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"data": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the client",
"type": "string"
},
"label": {
"description": "Label of the client",
"type": "string"
},
"extraValues": {
"description": "Extra values of the client",
"type": "object"
},
"type": {
"description": "Type of the client",
"type": "string"
}
}
},
"extra": {
"description": "Any additional response",
"type": "object"
},
"metaData": {
"description": "Matadata of Rule create result",
"type": "object"
}
}
}Update Rule ¶
PUT/v9_1/registrationRules/{id}
Use this API command to modify the registration rule.
Request
Body
{
"id": "422c50f8-038a-43b5-ba31-64b4d1aecb22",
"creatorId": "",
"creatorName": "NA",
"switchGroupId": "8a098bb7-d80f-4604-a0ff-692ed56dcfd3",
"type": "IP_RANGE",
"ipFrom": "1.1.1.1",
"ipTo": "2.2.2.2",
"network": "",
"subnetMask": "",
"modelNumber": "",
"rank": 2,
"groupName": "MyGroup1",
"description": "",
"ipRange": "1.1.1.1,2.2.2.2",
"label": "IP From: 1.1.1.1, IP To :2.2.2.2"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the registration rule",
"type": "string"
},
"creatorId": {
"description": "Creator Id of the registration rule",
"type": "string"
},
"creatorName": {
"description": "Creator name of the registration rule",
"type": "string"
},
"switchGroupId": {
"description": "Switch group Id of the registration rule",
"type": "string"
},
"type": {
"description": "Type of the registration rule",
"type": "string",
"enum": [
"IP_RANGE",
"SUBNET",
"MODEL_NUMBER"
]
},
"ipFrom": {
"description": "Start IP range of the registration rule",
"type": "string"
},
"ipTo": {
"description": "End IP range of the registration rule",
"type": "string"
},
"network": {
"description": "Network of the registration rule",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask of the registration rule",
"type": "string"
},
"modelNumber": {
"description": "Switch Model number of the registration rule",
"type": "string"
},
"rank": {
"description": "Rank of the registration rule",
"type": "integer"
},
"createDatetime": {
"description": "Create datetime of the registration rule",
"type": "integer",
"format": "int64"
},
"groupName": {
"description": "Switch group name of the registration rule",
"type": "string"
},
"description": {
"description": "Description of the registration rule",
"type": "string"
},
"label": {
"description": "Lable of the registration rule",
"type": "string"
},
"ipRange": {
"description": "IP range of the registration rule",
"type": "string"
}
}
}Response
200Body
{
"success": true,
"error": null,
"data": {
"id": "422c50f8-038a-43b5-ba31-64b4d1aecb22",
"label": "IP From: 1.1.1.1, IP To :2.2.2.2",
"extraValues": {},
"type": null
},
"extra": {},
"metaData": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Modify result success or not",
"type": "boolean"
},
"error": {
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"type": "string"
},
"msgKey": {
"type": "string"
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"data": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the client",
"type": "string"
},
"label": {
"description": "Label of the client",
"type": "string"
},
"extraValues": {
"description": "Extra values of the client",
"type": "object"
},
"type": {
"description": "Type of the client",
"type": "string"
}
}
},
"extra": {
"description": "Any additional response",
"type": "object"
},
"metaData": {
"description": "Matadata of rule modify result",
"type": "object"
}
}
}Delete Rule ¶
DELETE/v9_1/registrationRules/{id}
Use this API command to delete a switch registration rule.
Response
200Body
{
"success": true,
"error": null,
"data": {
"id": "48364416-14a1-453a-b2d2-82a7fab2c729",
"label": "IP From: 192.168.199.1, IP To :192.168.199.255",
"extraValues": {},
"type": null
},
"extra": {},
"metaData": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Delete result success or not",
"type": "boolean"
},
"error": {
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"type": "string"
},
"msgKey": {
"type": "string"
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"data": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the client",
"type": "string"
},
"label": {
"description": "Label of the client",
"type": "string"
},
"extraValues": {
"description": "Extra values of the client",
"type": "object"
},
"type": {
"description": "Type of the client",
"type": "string"
}
}
},
"extra": {
"description": "Any additional response",
"type": "object"
},
"metaData": {
"description": "Matadata of Rule delete result",
"type": "object"
}
}
}Delete Multiple Rules ¶
DELETE/v9_1/registrationRules
Use this API command to delete multiple switch registration rules.
Request
Body
[
"8c2d7d4a-2c06-42d5-874b-9537d58a0887",
"4c846bec-07aa-4cf9-ad10-f35f565154df"
]Schema
{
"type": "array",
"items": {
"description": "registration rule UUID id",
"type": "string"
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Delete multiple result success or not",
"type": "boolean"
},
"error": {
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"type": "string"
},
"msgKey": {
"type": "string"
},
"list": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"data": {
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Registration rule list count",
"type": "integer"
},
"totalCount": {
"description": "Total Registration rule list count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more registration rule after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first registration rule returned out of the complete registration rule list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the registration rule",
"type": "string"
},
"creatorId": {
"description": "Creator Id of the registration rule",
"type": "string"
},
"creatorName": {
"description": "Creator name of the registration rule",
"type": "string"
},
"switchGroupId": {
"description": "Switch group Id of the registration rule",
"type": "string"
},
"type": {
"description": "Type of the registration rule",
"type": "string",
"enum": [
"IP_RANGE",
"SUBNET",
"MODEL_NUMBER"
]
},
"ipFrom": {
"description": "Start IP range of the registration rule",
"type": "string"
},
"ipTo": {
"description": "End IP range of the registration rule",
"type": "string"
},
"network": {
"description": "Network of the registration rule",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask of the registration rule",
"type": "string"
},
"modelNumber": {
"description": "Switch Model number of the registration rule",
"type": "string"
},
"rank": {
"description": "Rank of the registration rule",
"type": "integer"
},
"createDatetime": {
"description": "Create datetime of the registration rule",
"type": "integer",
"format": "int64"
},
"groupName": {
"description": "Switch group name of the registration rule",
"type": "string"
},
"description": {
"description": "Description of the registration rule",
"type": "string"
},
"label": {
"description": "Lable of the registration rule",
"type": "string"
},
"ipRange": {
"description": "IP range of the registration rule",
"type": "string"
}
}
}
}
}
},
"extra": {
"description": "Any additional response",
"type": "object"
},
"metaData": {
"description": "Matadata of delete multiple rules result",
"type": "object"
}
}
}Switch Traffic ¶
Top Port Error Switch ¶
POST/v9_1/traffic/top/porterror
Use this API command to get the top 10 switches by the porterror.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"attributes": [
"Port_Name"
],
"extraTimeRange": {
"start": 1529136949883,
"end": 1529140549883,
"interval": 300000
},
"options": {},
"limit": 10,
"page": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 4,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "icx0",
"key": "icx0",
"value": 126
},
{
"id": "icx3",
"key": "icx3",
"value": 42
},
{
"id": "icx2",
"key": "icx2",
"value": 42
},
{
"id": "icx1",
"key": "icx1",
"value": 0
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Top port error count",
"type": "integer"
},
"totalCount": {
"description": "Total of top port error count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more top port error after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first top port error returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Extra information for top port error",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Traffic Usage",
"type": "string"
},
"key": {
"description": "Interface of the Traffic Usage",
"type": "string"
},
"value": {
"description": "Total Tx and Rx of Traffic Usage",
"type": "number"
}
}
}
}
}
}Total Traffic Trend ¶
POST/v9_1/traffic/total/trend
Use this API command to retrieve Swich/Port trend data based on the time duration.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1529118470191,
"end": 1529122070191,
"interval": 300000
},
"options": {},
"limit": 10,
"page": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 12,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"total": 2458964,
"timestamp": "2018-06-16 03:07:50",
"tx": 177902,
"rx": 2281062
},
{
"total": 2459416,
"timestamp": "2018-06-16 03:12:50",
"tx": 158437,
"rx": 2300979
},
{
"total": 2481033,
"timestamp": "2018-06-16 03:17:50",
"tx": 174794,
"rx": 2306239
},
{
"total": 2504247,
"timestamp": "2018-06-16 03:22:50",
"tx": 186058,
"rx": 2318189
},
{
"total": 2275852,
"timestamp": "2018-06-16 03:27:50",
"tx": 24141,
"rx": 2251711
},
{
"total": 2515155,
"timestamp": "2018-06-16 03:32:50",
"tx": 169814,
"rx": 2345341
},
{
"total": 2508112,
"timestamp": "2018-06-16 03:37:50",
"tx": 172864,
"rx": 2335248
},
{
"total": 2544093,
"timestamp": "2018-06-16 03:42:50",
"tx": 173314,
"rx": 2370779
},
{
"total": 2495784,
"timestamp": "2018-06-16 03:47:50",
"tx": 180249,
"rx": 2315535
},
{
"total": 2518829,
"timestamp": "2018-06-16 03:52:50",
"tx": 162750,
"rx": 2356079
},
{
"total": 2510602,
"timestamp": "2018-06-16 03:57:50",
"tx": 181968,
"rx": 2328634
},
{
"total": 2519676,
"timestamp": "2018-06-16 04:02:50",
"tx": 171959,
"rx": 2347717
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total traffic count",
"type": "integer"
},
"totalCount": {
"description": "Total of traffic list count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more traffic list after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first traffic list returned out of the complete traffic list",
"type": "integer"
},
"extra": {
"description": "Extra information for traffic list",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"timestamp": {
"description": "Timestamp of the switch traffic",
"type": "string"
},
"total": {
"description": "Total traffic of the switch",
"type": "integer"
},
"tx": {
"description": "TX traffic of the switch",
"type": "string"
},
"rx": {
"description": "RX traffic of the switch",
"type": "string"
}
}
}
}
}
}Top Traffic Usage ¶
POST/v9_1/traffic/top/usage
Use this API command to retrieve Top Swich/Port usage data based on the time duration.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"attributes": [
"Port_Name"
],
"extraTimeRange": {
"start": 1529136949883,
"end": 1529140549883,
"interval": 300000
},
"options": {},
"limit": 10,
"page": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 10,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "60:9c:9f:da:63:80",
"key": "10GigabitEthernet1/1/1",
"value": 29938727
},
{
"id": "60:9c:9f:da:63:97",
"key": "10GigabitEthernet1/1/24",
"value": 0
},
{
"id": "60:9c:9f:da:63:92",
"key": "10GigabitEthernet1/1/19",
"value": 0
},
{
"id": "60:9c:9f:da:63:91",
"key": "10GigabitEthernet1/1/18",
"value": 0
},
{
"id": "60:9c:9f:da:63:90",
"key": "10GigabitEthernet1/1/17",
"value": 0
},
{
"id": "60:9c:9f:da:63:93",
"key": "10GigabitEthernet1/1/20",
"value": 0
},
{
"id": "60:9c:9f:da:63:96",
"key": "10GigabitEthernet1/1/23",
"value": 0
},
{
"id": "60:9c:9f:da:63:88",
"key": "10GigabitEthernet1/1/9",
"value": 0
},
{
"id": "60:9c:9f:da:63:87",
"key": "10GigabitEthernet1/1/8",
"value": 0
},
{
"id": "60:9c:9f:da:63:8a",
"key": "10GigabitEthernet1/1/11",
"value": 0
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Top traffic usage count",
"type": "integer"
},
"totalCount": {
"description": "Total of top traffic usage count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more top traffic usage after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first top traffic usage returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Extra information for top traffic usage",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Traffic Usage",
"type": "string"
},
"key": {
"description": "Interface of the Traffic Usage",
"type": "string"
},
"value": {
"description": "Total Tx and Rx of Traffic Usage",
"type": "number"
}
}
}
}
}
}Top Port Traffic Usage ¶
POST/v9_1/traffic/top/portusage
Use this API command to get the top 10 ports by the traffic.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"attributes": [
"Port_Name"
],
"extraTimeRange": {
"start": 1529375699025,
"end": 1529379299025,
"interval": 300000
},
"options": {},
"limit": 10,
"page": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 10,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "60:9c:9f:da:63:80",
"key": "ICX7750-1-10GigabitEthernet1/1/1",
"value": 29236001
},
{
"id": "00:00:00:01:01:16",
"key": "icx_0-(INTERFACE1/1/22) GigabitEthernet1/1/22",
"value": 0
},
{
"id": "00:00:00:01:01:10",
"key": "icx_0-(INTERFACE1/1/16) GigabitEthernet1/1/16",
"value": 0
},
{
"id": "00:00:00:01:01:14",
"key": "icx_0-(INTERFACE1/1/20) GigabitEthernet1/1/20",
"value": 0
},
{
"id": "00:00:00:01:01:11",
"key": "icx_0-(INTERFACE1/1/17) GigabitEthernet1/1/17",
"value": 0
},
{
"id": "00:00:00:01:01:12",
"key": "icx_0-(INTERFACE1/1/18) GigabitEthernet1/1/18",
"value": 0
},
{
"id": "00:00:00:01:01:13",
"key": "icx_0-(INTERFACE1/1/19) GigabitEthernet1/1/19",
"value": 0
},
{
"id": "00:00:00:01:01:08",
"key": "icx_0-(INTERFACE1/1/8) GigabitEthernet1/1/8",
"value": 0
},
{
"id": "00:00:00:01:01:09",
"key": "icx_0-(INTERFACE1/1/9) GigabitEthernet1/1/9",
"value": 0
},
{
"id": "00:00:00:01:01:18",
"key": "icx_0-(INTERFACE1/1/24) GigabitEthernet1/1/24",
"value": 0
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Top port traffic usage count",
"type": "integer"
},
"totalCount": {
"description": "Total of top port traffic usage count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more top port traffic usage after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first top port traffic usage returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Extra information for top port traffic usage",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Traffic Usage",
"type": "string"
},
"key": {
"description": "Interface of the Traffic Usage",
"type": "string"
},
"value": {
"description": "Total Tx and Rx of Traffic Usage",
"type": "number"
}
}
}
}
}
}Top PoE Utilization ¶
POST/v9_1/traffic/top/poeutilization
Use this API command retrieve the top 10 switches by the PoE utilization.
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "PoE utilization count",
"type": "integer"
},
"totalCount": {
"description": "Total PoE utilization count",
"type": "integer"
},
"hasMore": {
"description": "Indicates if there are more top PoE usage after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first top PoE usage returned out of the complete list",
"type": "integer"
},
"extra": {
"description": "Extra information for top PoE utilization",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the Traffic Usage",
"type": "string"
},
"key": {
"description": "Interface of the Traffic Usage",
"type": "string"
},
"value": {
"description": "Total Tx and Rx of Traffic Usage",
"type": "number"
}
}
}
}
}
}Total Port Errors ¶
POST/v9_1/traffic/total/porterror
Use this API command to retrieve Switch/Port Port Errors data based on the time duration.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1529118470191,
"end": 1529122070191,
"interval": 300000
},
"options": {},
"limit": 10,
"page": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 12,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"total": 7,
"timestamp": "2018-06-16 03:07:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 03:12:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 03:17:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 03:22:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 03:27:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 03:32:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 03:37:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 03:42:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 03:47:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 03:52:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 03:57:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
},
{
"total": 17,
"timestamp": "2018-06-16 04:02:50",
"crcErr": 17,
"outErr": 0,
"inErr": 0
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"timestamp": {
"type": "string"
},
"total": {
"type": "integer"
},
"crcErr": {
"type": "string"
},
"outErr": {
"type": "string"
},
"inErr": {
"type": "string"
}
}
}
}
}
}Total Multicast Traffic Trend ¶
POST/v9_1/traffic/total/multicast
Use this API command to retrieve Switch/Port Multicast trend data based on the time duration.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1529118470191,
"end": 1529122070191,
"interval": 300000
},
"options": {},
"limit": 10,
"page": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 12,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"total": 2458964,
"timestamp": "2018-06-16 03:07:50",
"multicastOut": 177902,
"multicastIn": 2281062
},
{
"total": 2459416,
"timestamp": "2018-06-16 03:12:50",
"multicastOut": 158437,
"multicastIn": 2300979
},
{
"total": 2481033,
"timestamp": "2018-06-16 03:17:50",
"multicastOut": 174794,
"multicastIn": 2306239
},
{
"total": 2504247,
"timestamp": "2018-06-16 03:22:50",
"multicastOut": 186058,
"multicastIn": 2318189
},
{
"total": 2275852,
"timestamp": "2018-06-16 03:27:50",
"multicastOut": 24141,
"multicastIn": 2251711
},
{
"total": 2515155,
"timestamp": "2018-06-16 03:32:50",
"multicastOut": 169814,
"multicastIn": 2345341
},
{
"total": 2508112,
"timestamp": "2018-06-16 03:37:50",
"multicastOut": 172864,
"multicastIn": 2335248
},
{
"total": 2544093,
"timestamp": "2018-06-16 03:42:50",
"multicastOut": 173314,
"multicastIn": 2370779
},
{
"total": 2495784,
"timestamp": "2018-06-16 03:47:50",
"multicastOut": 180249,
"multicastIn": 2315535
},
{
"total": 2518829,
"timestamp": "2018-06-16 03:52:50",
"multicastOut": 162750,
"multicastIn": 2356079
},
{
"total": 2510602,
"timestamp": "2018-06-16 03:57:50",
"multicastOut": 181968,
"multicastIn": 2328634
},
{
"total": 2519676,
"timestamp": "2018-06-16 04:02:50",
"multicastOut": 171959,
"multicastIn": 2347717
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"timestamp": {
"type": "string"
},
"total": {
"type": "integer"
},
"multicastOut": {
"type": "string"
},
"multicastIn": {
"type": "string"
}
}
}
}
}
}Total Unicast Traffic Trend ¶
POST/v9_1/traffic/total/unicast
Use this API command to retrieve Switch/Port Unicast trend data based on the time duration.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1529118470191,
"end": 1529122070191,
"interval": 300000
},
"options": {},
"limit": 10,
"page": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 12,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"total": 2458964,
"timestamp": "2018-06-16 03:07:50",
"unicastOut": 177902,
"unicastIn": 2281062
},
{
"total": 2459416,
"timestamp": "2018-06-16 03:12:50",
"unicastOut": 158437,
"unicastIn": 2300979
},
{
"total": 2481033,
"timestamp": "2018-06-16 03:17:50",
"unicastOut": 174794,
"unicastIn": 2306239
},
{
"total": 2504247,
"timestamp": "2018-06-16 03:22:50",
"unicastOut": 186058,
"unicastIn": 2318189
},
{
"total": 2275852,
"timestamp": "2018-06-16 03:27:50",
"unicastOut": 24141,
"unicastIn": 2251711
},
{
"total": 2515155,
"timestamp": "2018-06-16 03:32:50",
"unicastOut": 169814,
"unicastIn": 2345341
},
{
"total": 2508112,
"timestamp": "2018-06-16 03:37:50",
"unicastOut": 172864,
"unicastIn": 2335248
},
{
"total": 2544093,
"timestamp": "2018-06-16 03:42:50",
"unicastOut": 173314,
"unicastIn": 2370779
},
{
"total": 2495784,
"timestamp": "2018-06-16 03:47:50",
"unicastOut": 180249,
"unicastIn": 2315535
},
{
"total": 2518829,
"timestamp": "2018-06-16 03:52:50",
"unicastOut": 162750,
"unicastIn": 2356079
},
{
"total": 2510602,
"timestamp": "2018-06-16 03:57:50",
"unicastOut": 181968,
"unicastIn": 2328634
},
{
"total": 2519676,
"timestamp": "2018-06-16 04:02:50",
"unicastOut": 171959,
"unicastIn": 2347717
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"timestamp": {
"type": "string"
},
"total": {
"type": "integer"
},
"unicastOut": {
"type": "string"
},
"unicastIn": {
"type": "string"
}
}
}
}
}
}Total Broadcast Traffic Trend ¶
POST/v9_1/traffic/total/broadcast
Use this API command to retrieve Switch/Port Broadcast trend data based on the time duration.
Request
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"extraFilters": [
{
"type": "SWITCH",
"value": "60:9C:9F:DA:63:80"
}
],
"extraTimeRange": {
"start": 1529118470191,
"end": 1529122070191,
"interval": 300000
},
"options": {},
"limit": 10,
"page": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 12,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"total": 2458964,
"timestamp": "2018-06-16 03:07:50",
"broadcastOut": 177902,
"broadcastIn": 2281062
},
{
"total": 2459416,
"timestamp": "2018-06-16 03:12:50",
"broadcastOut": 158437,
"broadcastIn": 2300979
},
{
"total": 2481033,
"timestamp": "2018-06-16 03:17:50",
"broadcastOut": 174794,
"broadcastIn": 2306239
},
{
"total": 2504247,
"timestamp": "2018-06-16 03:22:50",
"broadcastOut": 186058,
"broadcastIn": 2318189
},
{
"total": 2275852,
"timestamp": "2018-06-16 03:27:50",
"broadcastOut": 24141,
"broadcastIn": 2251711
},
{
"total": 2515155,
"timestamp": "2018-06-16 03:32:50",
"broadcastOut": 169814,
"broadcastIn": 2345341
},
{
"total": 2508112,
"timestamp": "2018-06-16 03:37:50",
"broadcastOut": 172864,
"broadcastIn": 2335248
},
{
"total": 2544093,
"timestamp": "2018-06-16 03:42:50",
"broadcastOut": 173314,
"broadcastIn": 2370779
},
{
"total": 2495784,
"timestamp": "2018-06-16 03:47:50",
"broadcastOut": 180249,
"broadcastIn": 2315535
},
{
"total": 2518829,
"timestamp": "2018-06-16 03:52:50",
"broadcastOut": 162750,
"broadcastIn": 2356079
},
{
"total": 2510602,
"timestamp": "2018-06-16 03:57:50",
"broadcastOut": 181968,
"broadcastIn": 2328634
},
{
"total": 2519676,
"timestamp": "2018-06-16 04:02:50",
"broadcastOut": 171959,
"broadcastIn": 2347717
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"extra": {
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"timestamp": {
"type": "string"
},
"total": {
"type": "integer"
},
"broadcastOut": {
"type": "string"
},
"broadcastIn": {
"type": "string"
}
}
}
}
}
}Switch Troubleshooting ¶
Request ICX to prepare support log ¶
GET/v9_1/supportLog/{switchId}
Use this API to request ICX to prepare support log.
Response
200Body
{
"id": "9f43c198-50ae-4079-b973-5fe722e2752f"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Get the status of current support log request ¶
GET/v9_1/supportLog/status/{switchId}
Use this API to get the status of current support log request.
Response
200Body
{
"serialNumber": "LKK3222P061",
"switchId": "C4:D1:9E:1F:8B:5C",
"downloadStatus": "DOWNLOADING",
"createdTime": "1568280684918"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"serialNumber": {
"description": "Switch Serial Number",
"type": "string"
},
"switchId": {
"description": "Switch MAC Address",
"type": "string"
},
"downloadStatus": {
"description": "SupportLog Download Status (DOWNLOADING, DONE, FAILED)",
"type": "string",
"enum": [
"DOWNLOADING",
"DONE",
"TIMEOUT",
"FAILED"
]
},
"createdTime": {
"description": "Created Time of this SupportLog Request",
"type": "string"
}
}
}Switch AAA Servers ¶
Retrieve AAA Server List ¶
GET/v9_1/group/{groupId}/aaaServers
Use this API command to retrieve a list of AAA server.
Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 3,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"id": "0a3737fc-8bfe-4033-af93-9fa27b06d2c5",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"name": "RuckusAAAServer-1",
"createdTime": 1536112813463,
"updatedTime": 1536113453001,
"serverType": "RADIUS",
"ip": "1.1.1.1",
"authPort": 122,
"acctPort": 333,
"secret": "secretphrase",
"purpose": "",
"username": "",
"password": "",
"level": "",
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"updaterUsername": "admin",
"updaterId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
},
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"id": "45ec73e7-0a2c-4222-957c-c9fe40119727",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"name": "RuckusAAAServer-2",
"createdTime": 1536112849565,
"updatedTime": 1536113453123,
"serverType": "TACACS_PLUS",
"ip": "3.3.3.3",
"authPort": 5566,
"acctPort": 0,
"secret": "secretphrase",
"purpose": "AUTHENTICATION_ONLY",
"username": "",
"password": "",
"level": "",
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"updaterUsername": "admin",
"updaterId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
},
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"id": "e4fe4c25-8b24-4635-804d-fc38384a41d0",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"name": "RuckusAAAServer-3",
"createdTime": 1536112841781,
"updatedTime": 1536113453898,
"serverType": "LOCAL",
"ip": "",
"authPort": 0,
"acctPort": 0,
"secret": "",
"purpose": "",
"username": "myusername",
"password": "yourpass",
"level": "READ_WRITE",
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"updaterUsername": "admin",
"updaterId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total AAA Servers count",
"type": "integer"
},
"totalCount": {
"description": "Total AAA Servers count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more AAA Servers after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first AAA Server returned out of the complete AAA Server list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"id": {
"description": "AAA server ID",
"type": "string"
},
"groupId": {
"description": "Group ID of the AAA server",
"type": "string"
},
"name": {
"description": "Name of the AAA server",
"type": "string"
},
"createdTime": {
"description": "The create time of the AAA server",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The modify time of the AAA server",
"type": "integer",
"format": "int64"
},
"serverType": {
"description": "The server tpye of the AAA server",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS",
"LOCAL"
]
},
"ip": {
"description": "AAA server IP address",
"type": "string"
},
"authPort": {
"description": "AAA server authentication port",
"type": "integer"
},
"acctPort": {
"description": "AAA server accounting port",
"type": "integer"
},
"secret": {
"description": "AAA server secret",
"type": "string"
},
"purpose": {
"description": "AAA server purpose",
"type": "string",
"enum": [
"DEFAULT",
"AUTHENTICATION_ONLY",
"AUTHORIZATION_ONLY",
"ACCOUNTING_ONLY"
]
},
"username": {
"description": "Username for local user",
"type": "string"
},
"password": {
"description": "Password for local user",
"type": "string"
},
"level": {
"description": "Access level of AAA server",
"type": "string",
"enum": [
"READ_WRITE",
"PORT_CONFIG",
"READ_ONLY"
]
},
"creatorUsername": {
"description": "AAA server creator name",
"type": "string"
},
"creatorId": {
"description": "AAA server creator Id",
"type": "string"
},
"updaterUsername": {
"description": "AAA server updater name",
"type": "string"
},
"updaterId": {
"description": "AAA server updater Id",
"type": "string"
}
}
}
}
}
}Retrieve a AAA Server. ¶
GET/v9_1/group/{groupId}/aaaServers/{id}
Use this API command to retrieve a AAA server.
Response
200Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"id": "8945d8e9-028d-4013-b474-d489c05a2d06",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"name": "RuckusAAAServer4",
"createdTime": 1536114677061,
"updatedTime": 1534225505,
"serverType": "RADIUS",
"ip": "4.4.4.4",
"authPort": 5566,
"acctPort": 7788,
"secret": "cannot tell you",
"purpose": "",
"username": "",
"password": "",
"level": "",
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"updaterUsername": "admin",
"updaterId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"id": {
"description": "AAA server ID",
"type": "string"
},
"groupId": {
"description": "Group ID of the AAA server",
"type": "string"
},
"name": {
"description": "Name of the AAA server",
"type": "string"
},
"createdTime": {
"description": "The create time of the AAA server",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The modify time of the AAA server",
"type": "integer",
"format": "int64"
},
"serverType": {
"description": "The server tpye of the AAA server",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS",
"LOCAL"
]
},
"ip": {
"description": "AAA server IP address",
"type": "string"
},
"authPort": {
"description": "AAA server authentication port",
"type": "integer"
},
"acctPort": {
"description": "AAA server accounting port",
"type": "integer"
},
"secret": {
"description": "AAA server secret",
"type": "string"
},
"purpose": {
"description": "AAA server purpose",
"type": "string",
"enum": [
"DEFAULT",
"AUTHENTICATION_ONLY",
"AUTHORIZATION_ONLY",
"ACCOUNTING_ONLY"
]
},
"username": {
"description": "Username for local user",
"type": "string"
},
"password": {
"description": "Password for local user",
"type": "string"
},
"level": {
"description": "Access level of AAA server",
"type": "string",
"enum": [
"READ_WRITE",
"PORT_CONFIG",
"READ_ONLY"
]
},
"creatorUsername": {
"description": "AAA server creator name",
"type": "string"
},
"creatorId": {
"description": "AAA server creator Id",
"type": "string"
},
"updaterUsername": {
"description": "AAA server updater name",
"type": "string"
},
"updaterId": {
"description": "AAA server updater Id",
"type": "string"
}
}
}Create AAA Server ¶
POST/v9_1/group/{groupId}/aaaServers
Use this API command to create a new AAA server.
Request
Body
{
"name": "RuckusAAAServer4",
"serverType": "RADIUS",
"ip": "4.4.4.4",
"authPort": 5566,
"acctPort": 7788,
"secret": "cannot tell you"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altoId" : {
"type" : "string"
},
"name" : {
"description" : "Name of the AAA server",
"type" : "string",
"pattern" : "^(?:(?!\").)*$"
},
"serverType" : {
"description" : "The server tpye of the AAA server",
"type" : "string",
"enum" : [ "RADIUS", "TACACS_PLUS", "LOCAL" ]
},
"ip" : {
"description" : "AAA server IP address",
"type" : "string"
},
"authPort" : {
"description" : "AAA server authentication port",
"type" : "integer"
},
"acctPort" : {
"description" : "AAA server accounting port",
"type" : "integer"
},
"secret" : {
"description" : "AAA server secret",
"type" : "string",
"pattern" : "^(?:(?!!).)*$"
},
"purpose" : {
"description" : "AAA server purpose",
"type" : "string",
"enum" : [ "DEFAULT", "AUTHENTICATION_ONLY", "AUTHORIZATION_ONLY", "ACCOUNTING_ONLY" ]
},
"username" : {
"description" : "Username for local user",
"type" : "string",
"pattern" : "^(?:(?!\")(?!\s).)*$"
},
"password" : {
"description" : "Password for local user",
"type" : "string",
"pattern" : "^(?:(?!!).)*$"
},
"level" : {
"description" : "Access level of AAA server",
"type" : "string",
"enum" : [ "READ_WRITE", "PORT_CONFIG", "READ_ONLY" ]
}
}
}Response
201Body
{
"id": "8945d8e9-028d-4013-b474-d489c05a2d06"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Modify a AAA Server. ¶
PUT/v9_1/group/{groupId}/aaaServers/{id}
Use this API command to modify the basic information on a AAA server by complete attributes.
Request
Body
{
"name": "RuckusAAAServer4",
"serverType": "RADIUS",
"ip": "4.4.4.4",
"authPort": 5566,
"acctPort": 7788,
"secret": "cannot tell you"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altoId" : {
"type" : "string"
},
"name" : {
"description" : "Name of the AAA server",
"type" : "string",
"pattern" : "^(?:(?!\").)*$"
},
"serverType" : {
"description" : "The server tpye of the AAA server",
"type" : "string",
"enum" : [ "RADIUS", "TACACS_PLUS", "LOCAL" ]
},
"ip" : {
"description" : "AAA server IP address",
"type" : "string"
},
"authPort" : {
"description" : "AAA server authentication port",
"type" : "integer"
},
"acctPort" : {
"description" : "AAA server accounting port",
"type" : "integer"
},
"secret" : {
"description" : "AAA server secret",
"type" : "string",
"pattern" : "^(?:(?!!).)*$"
},
"purpose" : {
"description" : "AAA server purpose",
"type" : "string",
"enum" : [ "DEFAULT", "AUTHENTICATION_ONLY", "AUTHORIZATION_ONLY", "ACCOUNTING_ONLY" ]
},
"username" : {
"description" : "Username for local user",
"type" : "string",
"pattern" : "^(?:(?!\")(?!\s).)*$"
},
"password" : {
"description" : "Password for local user",
"type" : "string",
"pattern" : "^(?:(?!!).)*$"
},
"level" : {
"description" : "Access level of AAA server",
"type" : "string",
"enum" : [ "READ_WRITE", "PORT_CONFIG", "READ_ONLY" ]
}
}
}Response
204Delete a AAA Server. ¶
DELETE/v9_1/group/{groupId}/aaaServers/{id}
Use this API command to delete a AAA server.
Response
204Delete AAA Servers. ¶
DELETE/v9_1/group/{groupId}/aaaServers
Use this API command to delete AAA Servers.
Request
Body
{
"idList": [
"74e9579a-0e71-4135-b628-90fd7f24930f",
"851508ed-a896-4cd7-a021-dc9fabe30083"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Response
204Switch AAA Settings ¶
Retrieve AAA Settings. ¶
GET/v9_1/group/{groupId}/aaaSettings
Use this API command to retrieve the AAA settings.
Response
200Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"authentication": {
"enabledSSHAuthn": true,
"enableTelnetAuthn": true,
"firstPref": "TACACS_PLUS",
"secondPref": "LOCAL",
"thirdPref": "RADIUS"
},
"authorization": {
"enabledCommandAuthz": true,
"enabledExecAuthz": true,
"commands": {
"level": "READ_WRITE",
"server1": "TACACS_PLUS",
"server2": "RADIUS"
},
"exec": {
"server1": "RADIUS",
"server2": "TACACS_PLUS"
}
},
"accounting": {
"enabledCommandAccounting": true,
"enabledExecAccounting": true,
"commands": {
"level": "READ_WRITE",
"server1": "TACACS_PLUS",
"server2": "RADIUS"
},
"exec": {
"server1": "TACACS_PLUS",
"server2": "RADIUS"
}
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"authentication": {
"description": "Authentication service",
"type": "object",
"additionalProperties": false,
"properties": {
"enabledSSHAuthn": {
"description": "SSH Enabled",
"type": "boolean"
},
"enableTelnetAuthn": {
"description": "Telnet Enabled",
"type": "boolean"
},
"firstPref": {
"description": "Primary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS",
"LOCAL"
]
},
"secondPref": {
"description": "Secondary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS",
"LOCAL"
]
},
"thirdPref": {
"description": "Third server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS",
"LOCAL"
]
}
}
},
"authorization": {
"description": "Authorization service",
"type": "object",
"additionalProperties": false,
"properties": {
"enabledCommandAuthz": {
"description": "Command Enabled",
"type": "boolean"
},
"enabledExecAuthz": {
"description": "Exec Enabled",
"type": "boolean"
},
"commands": {
"description": "Commands service",
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"description": "Access level of command",
"type": "string",
"enum": [
"READ_WRITE",
"PORT_CONFIG",
"READ_ONLY"
]
},
"server1": {
"description": "Primary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
},
"server2": {
"description": "Secondary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
}
}
},
"exec": {
"description": "Exec Service",
"type": "object",
"additionalProperties": false,
"properties": {
"server1": {
"description": "Primary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
},
"server2": {
"description": "Secondary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
}
}
}
}
},
"accounting": {
"description": "Accounting service",
"type": "object",
"additionalProperties": false,
"properties": {
"enabledCommandAccounting": {
"description": "Command Enabled",
"type": "boolean"
},
"enabledExecAccounting": {
"description": "Exec Enabled",
"type": "boolean"
},
"commands": {
"description": "Commands service",
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"description": "Access level of command",
"type": "string",
"enum": [
"READ_WRITE",
"PORT_CONFIG",
"READ_ONLY"
]
},
"server1": {
"description": "Primary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
},
"server2": {
"description": "Secondary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
}
}
},
"exec": {
"description": "Exec service",
"type": "object",
"additionalProperties": false,
"properties": {
"server1": {
"description": "Primary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
},
"server2": {
"description": "Secondary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
}
}
}
}
}
}
}Modify AAA Settings. ¶
PUT/v9_1/group/{groupId}/aaaSettings
Use this API command to modify the AAA settings.
Request
Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"authentication": {
"enabledSSHAuthn": true,
"enableTelnetAuthn": true,
"firstPref": "TACACS_PLUS",
"secondPref": "LOCAL",
"thirdPref": "RADIUS"
},
"authorization": {
"enabledCommandAuthz": true,
"enabledExecAuthz": true,
"commands": {
"level": "READ_WRITE",
"server1": "TACACS_PLUS",
"server2": "RADIUS"
},
"exec": {
"server1": "RADIUS",
"server2": "TACACS_PLUS"
}
},
"accounting": {
"enabledCommandAccounting": true,
"enabledExecAccounting": true,
"commands": {
"level": "READ_WRITE",
"server1": "TACACS_PLUS",
"server2": "RADIUS"
},
"exec": {
"server1": "TACACS_PLUS",
"server2": "RADIUS"
}
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"authentication": {
"description": "Authentication service",
"type": "object",
"additionalProperties": false,
"properties": {
"enabledSSHAuthn": {
"description": "SSH Enabled",
"type": "boolean"
},
"enableTelnetAuthn": {
"description": "Telnet Enabled",
"type": "boolean"
},
"firstPref": {
"description": "Primary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS",
"LOCAL"
]
},
"secondPref": {
"description": "Secondary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS",
"LOCAL"
]
},
"thirdPref": {
"description": "Third server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS",
"LOCAL"
]
}
}
},
"authorization": {
"description": "Authorization service",
"type": "object",
"additionalProperties": false,
"properties": {
"enabledCommandAuthz": {
"description": "Command Enabled",
"type": "boolean"
},
"enabledExecAuthz": {
"description": "Exec Enabled",
"type": "boolean"
},
"commands": {
"description": "Commands service",
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"description": "Access level of command",
"type": "string",
"enum": [
"READ_WRITE",
"PORT_CONFIG",
"READ_ONLY"
]
},
"server1": {
"description": "Primary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
},
"server2": {
"description": "Secondary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
}
}
},
"exec": {
"description": "Exec Service",
"type": "object",
"additionalProperties": false,
"properties": {
"server1": {
"description": "Primary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
},
"server2": {
"description": "Secondary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
}
}
}
}
},
"accounting": {
"description": "Accounting service",
"type": "object",
"additionalProperties": false,
"properties": {
"enabledCommandAccounting": {
"description": "Command Enabled",
"type": "boolean"
},
"enabledExecAccounting": {
"description": "Exec Enabled",
"type": "boolean"
},
"commands": {
"description": "Commands service",
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"description": "Access level of command",
"type": "string",
"enum": [
"READ_WRITE",
"PORT_CONFIG",
"READ_ONLY"
]
},
"server1": {
"description": "Primary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
},
"server2": {
"description": "Secondary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
}
}
},
"exec": {
"description": "Exec service",
"type": "object",
"additionalProperties": false,
"properties": {
"server1": {
"description": "Primary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
},
"server2": {
"description": "Secondary server type",
"type": "string",
"enum": [
"RADIUS",
"TACACS_PLUS"
]
}
}
}
}
}
}
}Response
204Switch Common Settings ¶
Retrieve DNS Config. ¶
GET/v9_1/dnsConfig/{switchGroupId}
Use this API command to Retrieve DNS Config.
Response
200Body
{
"dns": {
"ip": "1.1.1.21,2.2.2.25"
},
"createdTime": 1538368487085,
"updatedTime": 1538368669420
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"createdTime": {
"description": "The create time of the DNS Config",
"type": "integer"
},
"updatedTime": {
"description": "The modify time of the DNS Config",
"type": "integer"
},
"dns": {
"description": "DNS Config",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "DNS Config IP",
"type": "string"
}
}
}
}
}Create DNS Config. ¶
POST/v9_1/dnsConfig
Use this API command to Create DNS Config.
Request
Body
{
"id": "9f43c198-50ae-4079-b973-5fe722e2752f",
"dns": {
"ip": "1.1.1.21,2.2.2.25"
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Switch Group Id",
"type": "string"
},
"dns": {
"description": "DNS Config",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "DNS Config IP",
"type": "string"
}
}
}
}
}Response
201Body
{
"id": "9f43c198-50ae-4079-b973-5fe722e2752f"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Update DNS Config. ¶
PUT/v9_1/dnsConfig/{switchGroupId}
Use this API command to Update DNS Config.
Request
Body
{
"dns": {
"ip": "1.1.1.21,2.2.2.25"
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"dns": {
"description": "DNS Config",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "DNS Config IP",
"type": "string"
}
}
}
}
}Response
204Switch Static Route ¶
Retrieve Static Route. ¶
GET/v9_1/staticRoutes/{id}
Use this API command to Retrieve Static Route.
Response
200Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"groupId": "adcdac39-cfeb-4633-b684-e9bee8ac940b",
"familyId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"id": "0a3737fc-8bfe-4033-af93-9fa27b06d2c5",
"destinationIp": "1.1.1.1/32",
"nextHop": "1.1.1.1",
"adminDistance": 122,
"pushTimeType": "NOW",
"createdTime": 1536112813463,
"updatedTime": 1536113453001
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"groupId": {
"description": "Switch Group Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"id": {
"description": "Static Route Id",
"type": "string"
},
"destinationIp": {
"description": "Destination IP",
"type": "string"
},
"nextHop": {
"description": "Next Hop",
"type": "string"
},
"adminDistance": {
"description": "Admin Distance",
"type": "string"
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
},
"createdTime": {
"description": "The create time of the Static Route",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The modify time of the Static Route",
"type": "integer",
"format": "int64"
}
}
}Retrieve Static Route list. ¶
POST/v9_1/staticRoutes/query
Use this API command to Retrieve Static Route list.
Request
Body
{
"filters": [
{
"type": "SWITCH_GROUP",
"value": "9f43c198-50ae-4079-b973-5fe722e2752f"
}
],
"extraFilters": [
{
"type": "FAMILY_ID",
"value": "e4fe4c25-8b24-4635-804d-fc38384a41d0"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total Static Route count",
"type": "integer"
},
"totalCount": {
"description": "Total Static Route Servers count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Static Routes after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Static Route returned out of the complete Static Route list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"groupId": {
"description": "Switch Group Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"id": {
"description": "Static Route Id",
"type": "string"
},
"destinationIp": {
"description": "Destination IP",
"type": "string"
},
"nextHop": {
"description": "Next Hop",
"type": "string"
},
"adminDistance": {
"description": "Admin Distance",
"type": "string"
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
},
"createdTime": {
"description": "The create time of the Static Route",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The modify time of the Static Route",
"type": "integer",
"format": "int64"
}
}
}
}
}
}Create Static Route. ¶
POST/v9_1/staticRoutes
Use this API command to Create Static Route.
Request
Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"groupId": "adcdac39-cfeb-4633-b684-e9bee8ac940b",
"familyId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"destinationIp": "1.1.1.1/32",
"nextHop": "1.1.1.1",
"adminDistance": 122,
"pushTimeType": "NOW"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"groupId": {
"description": "Switch Group Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"destinationIp": {
"description": "Destination IP",
"type": "string"
},
"nextHop": {
"description": "Next Hop",
"type": "string"
},
"adminDistance": {
"description": "Admin Distance",
"type": "integer"
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
}
}
}Response
201Body
{
"id": "8945d8e9-028d-4013-b474-d489c05a2d06"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Update Static Route. ¶
PUT/v9_1/staticRoutes/{id}
Use this API command to Update Static Route.
Request
Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"destinationIp": "1.1.1.1/32",
"nextHop": "1.1.1.1",
"adminDistance": 122,
"pushTimeType": "NOW"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"destinationIp": {
"description": "Destination IP",
"type": "string"
},
"nextHop": {
"description": "Next Hop",
"type": "string"
},
"adminDistance": {
"description": "Admin Distance",
"type": "integer"
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
}
}
}Response
200Delete Static Route. ¶
Delete Static Route by Id list. ¶
DELETE/v9_1/staticRoutes
Use this API command to Delete Static Route by Id list.
Request
Body
{
"idList": [
"039fc9f4-f1f6-47f5-807f-29a737320f7d",
"a4eaa396-38e5-425b-9686-165fe1f71059"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Response
204Switch Access Control List ¶
Retrieve Access Control Config. ¶
GET/v9_1/accessControls/{id}
Use this API command to Retrieve the Access Control Config.
Response
200Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"familyId": "e4fe4c25-8b24-4635-804d-fc38384a41d0",
"switchId": "",
"name": "blue1",
"aclType": "EXTENDED",
"pushTimeType": "SCHEDULE",
"pushTime": 1479250540110,
"createdTime": 1538368487085,
"updatedTime": 1538368669420,
"aclRule": [
{
"seq": 1,
"action": "ALLOW",
"protocol": "IP",
"srcNetwork": "1.1.1.1/1",
"destNetwork": "11.11.11.11/1",
"srcPort": 100,
"destPort": 200
},
{
"seq": 2,
"action": "ALLOW",
"protocol": "IP",
"srcNetwork": "2.2.2.2/1",
"destNetwork": "22.22.22.22/1",
"srcPort": 100,
"destPort": 200
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"groupId": {
"description": "Switch Group Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"id": {
"description": "Id",
"type": "string"
},
"name": {
"description": "ACL Name/ID",
"type": "string"
},
"aclType": {
"description": "ACL Type",
"type": "string",
"enum": [
"STANDARD",
"EXTENDED"
]
},
"aclRule": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"seq": {
"description": "The seq of AccessControl Rule",
"type": "integer"
},
"action": {
"description": "The action of AccessControl Rule",
"type": "string",
"enum": [
"PERMIT",
"DENY"
]
},
"protocol": {
"description": "The protocol of AccessControl Rule",
"type": "string",
"enum": [
"IP",
"TCP",
"UDP"
]
},
"srcNetwork": {
"description": "The source network of AccessControl Rule",
"type": "string"
},
"destNetwork": {
"description": "The destination network of AccessControl Rule",
"type": "string"
},
"srcPort": {
"description": "The source port of AccessControl Rule",
"type": "string"
},
"destPort": {
"description": "The destination port of AccessControl Rule",
"type": "string"
},
"dscpMatching": {
"description": "The DSCP value for matching of AccessControl Rule",
"type": "integer"
},
"dscpMarking": {
"description": "The DSCP value to be used for marking of AccessControl Rule",
"type": "integer"
},
"internalPriority": {
"description": "The QoS priority of AccessControl Rule",
"type": "integer"
}
}
}
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
},
"createdTime": {
"description": "The create time of the AccessControl",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The modify time of the AccessControl",
"type": "integer",
"format": "int64"
}
}
}Retrieve Access Control Config list. ¶
POST/v9_1/accessControls/query
Use this API command to Retrieve the Access Control Config list.
Request
Body
{
"extraFilters": [
{
"type": "FAMILY_ID",
"value": "ICX7150"
}
],
"filters": [
{
"type": "SWITCH_GROUP",
"value": "9f43c198-50ae-4079-b973-5fe722e2752f"
}
],
"page": 1,
"limit": 80
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 1,
"hasMore": false,
"firstIndex": 80,
"list": [
{
"id": "45ec73e7-0a2c-4222-957c-c9fe40119727",
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"familyId": "e4fe4c25-8b24-4635-804d-fc38384a41d0",
"switchId": "",
"name": "ACLConfig1",
"aclType": "EXTENDED",
"pushTimeType": "SCHEDULE",
"pushTime": 1479250540110,
"createdTime": 1538368487085,
"updatedTime": 1538368669420,
"aclRule": [
{
"seq": 1,
"action": "ALLOW",
"protocol": "IP",
"srcNetwork": "1.1.1.1/1",
"destNetwork": "11.11.11.11/1",
"srcPort": 100,
"destPort": 200
},
{
"seq": 2,
"action": "ALLOW",
"protocol": "IP",
"srcNetwork": "2.2.2.2/1",
"destNetwork": "22.22.22.22/1",
"srcPort": 100,
"destPort": 200
}
]
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total AccessControl count",
"type": "integer"
},
"totalCount": {
"description": "Total AccessControl count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more AccessControl after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first AccessControl returned out of the complete AccessControl list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"groupId": {
"description": "Switch Group Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"id": {
"description": "Id",
"type": "string"
},
"name": {
"description": "ACL Name/ID",
"type": "string"
},
"aclType": {
"description": "ACL Type",
"type": "string",
"enum": [
"STANDARD",
"EXTENDED"
]
},
"aclRule": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"seq": {
"description": "The seq of AccessControl Rule",
"type": "integer"
},
"action": {
"description": "The action of AccessControl Rule",
"type": "string",
"enum": [
"PERMIT",
"DENY"
]
},
"protocol": {
"description": "The protocol of AccessControl Rule",
"type": "string",
"enum": [
"IP",
"TCP",
"UDP"
]
},
"srcNetwork": {
"description": "The source network of AccessControl Rule",
"type": "string"
},
"destNetwork": {
"description": "The destination network of AccessControl Rule",
"type": "string"
},
"srcPort": {
"description": "The source port of AccessControl Rule",
"type": "string"
},
"destPort": {
"description": "The destination port of AccessControl Rule",
"type": "string"
},
"dscpMatching": {
"description": "The DSCP value for matching of AccessControl Rule",
"type": "integer"
},
"dscpMarking": {
"description": "The DSCP value to be used for marking of AccessControl Rule",
"type": "integer"
},
"internalPriority": {
"description": "The QoS priority of AccessControl Rule",
"type": "integer"
}
}
}
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
},
"createdTime": {
"description": "The create time of the AccessControl",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The modify time of the AccessControl",
"type": "integer",
"format": "int64"
}
}
}
}
}
}Create Access Control Config. ¶
POST/v9_1/accessControls
Use this API command to Create the Access Control Config.
Request
Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"name": "ACL1",
"aclType": "STANDARD",
"pushTimeType": "NOW",
"aclRule": [
{
"seq": 10,
"action": "DENY",
"protocol": "IP",
"srcNetwork": "192.168.254.254/32"
},
{
"seq": 65000,
"action": "PERMIT",
"protocol": "IP",
"srcNetwork": "any",
"destNetwork": "any",
"dscpMatching": 46,
"dscpMarking": 46,
"internalPriority": 3
}
],
"groupId": "1e8dd452-132f-4389-b135-f6e489e408be",
"switchId": "78:A6:E1:44:11:BE"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"groupId": {
"description": "Switch Group Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"name": {
"description": "ACL Name/ID",
"type": "string"
},
"aclType": {
"description": "ACL Type",
"type": "string",
"enum": [
"STANDARD",
"EXTENDED"
]
},
"aclRule": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"seq": {
"description": "The seq of AccessControl Rule",
"type": "integer"
},
"action": {
"description": "The action of AccessControl Rule",
"type": "string",
"enum": [
"PERMIT",
"DENY"
]
},
"protocol": {
"description": "The protocol of AccessControl Rule",
"type": "string",
"enum": [
"IP",
"TCP",
"UDP"
]
},
"srcNetwork": {
"description": "The source network of AccessControl Rule",
"type": "string"
},
"destNetwork": {
"description": "The destination network of AccessControl Rule",
"type": "string"
},
"srcPort": {
"description": "The source port of AccessControl Rule",
"type": "string"
},
"destPort": {
"description": "The destination port of AccessControl Rule",
"type": "string"
},
"dscpMatching": {
"description": "The DSCP value for matching of AccessControl Rule",
"type": "integer"
},
"dscpMarking": {
"description": "The DSCP value to be used for marking of AccessControl Rule",
"type": "integer"
},
"internalPriority": {
"description": "The QoS priority of AccessControl Rule",
"type": "integer"
}
}
}
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
}
}
}Response
200Body
{
"id": "45ec73e7-0a2c-4222-957c-c9fe40119727"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Update Access Control Config. ¶
PUT/v9_1/accessControls/{id}
Use this API command to Update the Access Control Config.
Request
Body
{
"aclType": "EXTENDED",
"pushTimeType": "SCHEDULE",
"aclRule": [
{
"seq": 1,
"action": "ALLOW",
"protocol": "IP",
"srcNetwork": "1.1.1.1/1",
"destNetwork": "11.11.11.11/1",
"srcPort": 100,
"destPort": 200
},
{
"seq": 2,
"action": "ALLOW",
"protocol": "IP",
"srcNetwork": "2.2.2.2/1",
"destNetwork": "22.22.22.22/1",
"srcPort": 100,
"destPort": 200
}
],
"pushTime": 1479250540110
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"aclType": {
"description": "ACL Type",
"type": "string",
"enum": [
"STANDARD",
"EXTENDED"
]
},
"aclRule": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"seq": {
"description": "The seq of AccessControl Rule",
"type": "integer"
},
"action": {
"description": "The action of AccessControl Rule",
"type": "string",
"enum": [
"PERMIT",
"DENY"
]
},
"protocol": {
"description": "The protocol of AccessControl Rule",
"type": "string",
"enum": [
"IP",
"TCP",
"UDP"
]
},
"srcNetwork": {
"description": "The source network of AccessControl Rule",
"type": "string"
},
"destNetwork": {
"description": "The destination network of AccessControl Rule",
"type": "string"
},
"srcPort": {
"description": "The source port of AccessControl Rule",
"type": "string"
},
"destPort": {
"description": "The destination port of AccessControl Rule",
"type": "string"
},
"dscpMatching": {
"description": "The DSCP value for matching of AccessControl Rule",
"type": "integer"
},
"dscpMarking": {
"description": "The DSCP value to be used for marking of AccessControl Rule",
"type": "integer"
},
"internalPriority": {
"description": "The QoS priority of AccessControl Rule",
"type": "integer"
}
}
}
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
}
}
}Response
200Delete Access Control Config. ¶
DELETE/v9_1/accessControls/{id}
Use this API command to Delete the Access Control Config.
Response
204Delete Access Control Config by Id list. ¶
DELETE/v9_1/accessControls
Use this API command to Delete the Access Control Config by Id list.
Request
Body
{
"idList": [
"f75bf810-6a99-46f0-bba1-b1b026041967",
"37f6c84c-ffcb-4d04-a735-f51fcb982eeb"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Response
204Switch VLAN Setting ¶
Retrieve VLAN Config List. ¶
GET/v9_1/vlans
Use this API command to Retrieve the VLAN Config List.
Response
200Body
{
"success": true,
"error": null,
"data": [
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"name": "My Vlan Setting1",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"familyId": "e4fe4c25-8b24-4635-804d-fc38384a41d0",
"switchId": "78:A6:E1:22:92:CC",
"vlanId": 1,
"enableIpv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "2/1/1",
"enableArpInspection": true,
"arpInspectionTrustPort": "2/1/2",
"multicastVersion": 2,
"igmpSnooping": "IST_NONE",
"spanningTree": "RSTP",
"spanningTreePriority": 2,
"pushTimeType": "NOW",
"pushTime": "",
"ports": [
{
"switchModel": "7650-24",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
},
{
"switchModel": "7650-48",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
}
]
},
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"name": "My Vlan Setting2",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"familyId": "e4fe4c25-8b24-4635-804d-fc38384a41d0",
"switchId": "78:A6:E1:22:92:DD",
"vlanId": 2,
"enableIpv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "1/2/1",
"enableArpInspection": true,
"arpInspectionTrustPort": "1/2/1",
"multicastVersion": 2,
"igmpSnooping": "IST_NONE",
"spanningTree": "STP",
"spanningTreePriority": 1,
"pushTimeType": "SCHEDULE",
"pushTime": 1479250540110,
"ports": [
{
"switchModel": "7650-24",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
},
{
"switchModel": "7650-48",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
}
]
}
],
"extra": {},
"metaData": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total Vlan Configs count",
"type": "integer"
},
"totalCount": {
"description": "Total Vlan Configs count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Vlan Configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Vlan Configs returned out of the complete Vlan Configs list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"id": {
"description": "Id",
"type": "string"
},
"groupId": {
"description": "Group Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"vlanId": {
"description": "Vlan Id",
"type": "integer"
},
"name": {
"description": "Vlan Name",
"type": "string"
},
"enableIpv4DhcpSnooping": {
"description": "IPv4 DHCP Snooping Enabled",
"type": "boolean"
},
"ipv4DhcpSnoopingTrustPort": {
"description": "IPv4 DHCP Snooping Trust Port",
"type": "string"
},
"enableArpInspection": {
"description": "ARP Inspection Enabled",
"type": "boolean"
},
"arpInspectionTrustPort": {
"description": "ARP Inspection Trust Port",
"type": "string"
},
"arpInspections": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "The IP of ArpInspections",
"type": "string"
},
"mac": {
"description": "The MAC of ArpInspections",
"type": "string"
}
}
}
},
"igmpSnooping": {
"description": "IGMP Snooping",
"type": "string"
},
"multicastVersion": {
"description": "Mutilcast Version",
"type": "integer"
},
"rootBridgeFamilyId": {
"type": "string"
},
"spanningTree": {
"description": "Spanning Tree",
"type": "string",
"enum": [
"STT_NONE",
"STP",
"RSTP"
]
},
"spanningTreePriority": {
"description": "Spanning Tree Priority",
"type": "integer"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"switchModel": {
"description": "The Switch Model of Ports",
"type": "string"
},
"untaggedPorts": {
"description": "The Untagged Ports of Ports",
"type": "string"
},
"taggedPorts": {
"description": "The Tagged Ports of Ports",
"type": "string"
}
}
}
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
},
"createdTime": {
"description": "The create time of the Vlan Config",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The update time of the Vlan Config",
"type": "integer",
"format": "int64"
},
"enableManagementVlan": {
"type": "boolean"
},
"enableAsDefaultVlan": {
"type": "boolean"
}
}
}
}
}
}Retrieve VLAN Config By Id. ¶
GET/v9_1/vlans/{id}
Use this API command to Retrieve the VLAN Config.
Response
200Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"name": "My Vlan Setting",
"id": "d7acd23b-fdd1-4aeb-b30f-b625a2f10612",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"familyId": "e4fe4c25-8b24-4635-804d-fc38384a41d0",
"switchId": "78:A6:E1:22:92:CC",
"vlanId": 1,
"enableIpv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "1/2/1",
"enableArpInspection": true,
"arpInspectionTrustPort": "1/2/1",
"multicastVersion": 2,
"igmpSnooping": "IST_NONE",
"spanningTree": "STP",
"spanningTreePriority": 1,
"pushTimeType": "SCHEDULE",
"pushTime": 1479250540110,
"createdTime": 1538368487085,
"updatedTime": 1538368669420,
"ports": [
{
"switchModel": "7650-24",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
},
{
"switchModel": "7650-48",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"id": {
"description": "Id",
"type": "string"
},
"groupId": {
"description": "Group Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"vlanId": {
"description": "Vlan Id",
"type": "integer"
},
"name": {
"description": "Vlan Name",
"type": "string"
},
"enableIpv4DhcpSnooping": {
"description": "IPv4 DHCP Snooping Enabled",
"type": "boolean"
},
"ipv4DhcpSnoopingTrustPort": {
"description": "IPv4 DHCP Snooping Trust Port",
"type": "string"
},
"enableArpInspection": {
"description": "ARP Inspection Enabled",
"type": "boolean"
},
"arpInspectionTrustPort": {
"description": "ARP Inspection Trust Port",
"type": "string"
},
"arpInspections": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "The IP of ArpInspections",
"type": "string"
},
"mac": {
"description": "The MAC of ArpInspections",
"type": "string"
}
}
}
},
"igmpSnooping": {
"description": "IGMP Snooping",
"type": "string"
},
"multicastVersion": {
"description": "Mutilcast Version",
"type": "integer"
},
"rootBridgeFamilyId": {
"type": "string"
},
"spanningTree": {
"description": "Spanning Tree",
"type": "string",
"enum": [
"STT_NONE",
"STP",
"RSTP"
]
},
"spanningTreePriority": {
"description": "Spanning Tree Priority",
"type": "integer"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"switchModel": {
"description": "The Switch Model of Ports",
"type": "string"
},
"untaggedPorts": {
"description": "The Untagged Ports of Ports",
"type": "string"
},
"taggedPorts": {
"description": "The Tagged Ports of Ports",
"type": "string"
}
}
}
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
},
"createdTime": {
"description": "The create time of the Vlan Config",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The update time of the Vlan Config",
"type": "integer",
"format": "int64"
},
"enableManagementVlan": {
"type": "boolean"
},
"enableAsDefaultVlan": {
"type": "boolean"
}
}
}Create VLAN Config. ¶
POST/v9_1/vlans
Use this API command to Create the VLAN Config.
Request
Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"name": "My Vlan Setting2",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"familyId": "e4fe4c25-8b24-4635-804d-fc38384a41d0",
"switchId": "78:A6:E1:22:92:CC",
"vlanId": 1,
"enableIpv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "1/2/1",
"enableArpInspection": true,
"arpInspectionTrustPort": "1/2/1",
"multicastVersion": 2,
"igmpSnooping": "IST_NONE",
"spanningTree": "STP",
"spanningTreePriority": 1,
"pushTimeType": "SCHEDULE",
"pushTime": 1479250540110,
"ports": [
{
"switchModel": "7650-24",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
},
{
"switchModel": "7650-48",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"groupId": {
"description": "Group Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"name": {
"description": "Vlan Name",
"type": "string"
},
"vlanId": {
"description": "Vlan Id",
"type": "integer"
},
"enableAsDefaultVlan": {
"type": "boolean"
},
"enableManagementVlan": {
"type": "boolean"
},
"enableIpv4DhcpSnooping": {
"description": "IPv4 DHCP Snooping Enabled",
"type": "boolean"
},
"ipv4DhcpSnoopingTrustPort": {
"description": "IPv4 DHCP Snooping Trust Port",
"type": "string"
},
"enableArpInspection": {
"description": "ARP Inspection Enabled",
"type": "boolean"
},
"arpInspectionTrustPort": {
"description": "ARP Inspection Trust Port",
"type": "string"
},
"arpInspections": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "The IP of ArpInspections",
"type": "string"
},
"mac": {
"description": "The MAC of ArpInspections",
"type": "string"
}
}
}
},
"igmpSnooping": {
"description": "IGMP Snooping",
"type": "string",
"enum": [
"IST_NONE",
"ACTIVE",
"PASSIVE"
]
},
"multicastVersion": {
"description": "Mutilcast Version",
"type": "integer"
},
"rootBridgeFamilyId": {
"type": "string"
},
"spanningTree": {
"description": "Spanning Tree",
"type": "string",
"enum": [
"STT_NONE",
"STP",
"RSTP"
]
},
"spanningTreePriority": {
"description": "Spanning Tree Priority",
"type": "integer"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"switchModel": {
"description": "The Switch Model of Ports",
"type": "string"
},
"untaggedPorts": {
"description": "The Untagged Ports of Ports",
"type": "string"
},
"taggedPorts": {
"description": "The Tagged Ports of Ports",
"type": "string"
}
}
}
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
}
}
}Response
201Body
{
"id": "45ec73e7-0a2c-4222-957c-c9fe40119727"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Retrieve VLAN Config list. ¶
POST/v9_1/vlans/query
Use this API command to Retrieve the VLAN Config list.
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"success": true,
"error": null,
"data": [
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"name": "My Vlan Setting1",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"familyId": "e4fe4c25-8b24-4635-804d-fc38384a41d0",
"switchId": "78:A6:E1:22:92:CC",
"vlanId": 1,
"enableIpv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "2/1/1",
"enableArpInspection": true,
"arpInspectionTrustPort": "2/1/2",
"multicastVersion": 2,
"igmpSnooping": "IST_NONE",
"spanningTree": "RSTP",
"spanningTreePriority": 2,
"pushTimeType": "NOW",
"pushTime": "",
"ports": [
{
"switchModel": "7650-24",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
},
{
"switchModel": "7650-48",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
}
]
},
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"name": "My Vlan Setting2",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"familyId": "e4fe4c25-8b24-4635-804d-fc38384a41d0",
"switchId": "78:A6:E1:22:92:DD",
"vlanId": 2,
"enableIpv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "1/2/1",
"enableArpInspection": true,
"arpInspectionTrustPort": "1/2/1",
"multicastVersion": 2,
"igmpSnooping": "IST_NONE",
"spanningTree": "STP",
"spanningTreePriority": 1,
"pushTimeType": "SCHEDULE",
"pushTime": 1479250540110,
"ports": [
{
"switchModel": "7650-24",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
},
{
"switchModel": "7650-48",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
}
]
}
],
"extra": {},
"metaData": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total Vlan Configs count",
"type": "integer"
},
"totalCount": {
"description": "Total Vlan Configs count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Vlan Configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Vlan Configs returned out of the complete Vlan Configs list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"id": {
"description": "Id",
"type": "string"
},
"groupId": {
"description": "Group Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"vlanId": {
"description": "Vlan Id",
"type": "integer"
},
"name": {
"description": "Vlan Name",
"type": "string"
},
"enableIpv4DhcpSnooping": {
"description": "IPv4 DHCP Snooping Enabled",
"type": "boolean"
},
"ipv4DhcpSnoopingTrustPort": {
"description": "IPv4 DHCP Snooping Trust Port",
"type": "string"
},
"enableArpInspection": {
"description": "ARP Inspection Enabled",
"type": "boolean"
},
"arpInspectionTrustPort": {
"description": "ARP Inspection Trust Port",
"type": "string"
},
"arpInspections": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "The IP of ArpInspections",
"type": "string"
},
"mac": {
"description": "The MAC of ArpInspections",
"type": "string"
}
}
}
},
"igmpSnooping": {
"description": "IGMP Snooping",
"type": "string"
},
"multicastVersion": {
"description": "Mutilcast Version",
"type": "integer"
},
"rootBridgeFamilyId": {
"type": "string"
},
"spanningTree": {
"description": "Spanning Tree",
"type": "string",
"enum": [
"STT_NONE",
"STP",
"RSTP"
]
},
"spanningTreePriority": {
"description": "Spanning Tree Priority",
"type": "integer"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"switchModel": {
"description": "The Switch Model of Ports",
"type": "string"
},
"untaggedPorts": {
"description": "The Untagged Ports of Ports",
"type": "string"
},
"taggedPorts": {
"description": "The Tagged Ports of Ports",
"type": "string"
}
}
}
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
},
"createdTime": {
"description": "The create time of the Vlan Config",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The update time of the Vlan Config",
"type": "integer",
"format": "int64"
},
"enableManagementVlan": {
"type": "boolean"
},
"enableAsDefaultVlan": {
"type": "boolean"
}
}
}
}
}
}Update VLAN Config. ¶
PUT/v9_1/vlans/{id}
Use this API command to Update the VLAN Config.
Request
Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"name": "My Vlan Setting2",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"familyId": "e4fe4c25-8b24-4635-804d-fc38384a41d0",
"switchId": "78:A6:E1:22:92:CC",
"enableIpv4DhcpSnooping": true,
"ipv4DhcpSnoopingTrustPort": "1/2/1",
"enableArpInspection": true,
"arpInspectionTrustPort": "1/2/1",
"multicastVersion": 2,
"igmpSnooping": "IST_NONE",
"spanningTree": "STP",
"spanningTreePriority": 1,
"pushTimeType": "SCHEDULE",
"pushTime": 1479250540110,
"ports": [
{
"switchModel": "7650-24",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
},
{
"switchModel": "7650-48",
"untaggedPorts": "1/2/1,2/2/1",
"taggedPorts": "1/2/2,2/2/2"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"name": {
"description": "Vlan Name",
"type": "string"
},
"enableIpv4DhcpSnooping": {
"description": "IPv4 DHCP Snooping Enabled",
"type": "boolean"
},
"ipv4DhcpSnoopingTrustPort": {
"description": "IPv4 DHCP Snooping Trust Port",
"type": "string"
},
"enableArpInspection": {
"description": "ARP Inspection Enabled",
"type": "boolean"
},
"arpInspectionTrustPort": {
"description": "ARP Inspection Trust Port",
"type": "string"
},
"arpInspections": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "The IP of ArpInspections",
"type": "string"
},
"mac": {
"description": "The MAC of ArpInspections",
"type": "string"
}
}
}
},
"igmpSnooping": {
"description": "IGMP Snooping",
"type": "string",
"enum": [
"IST_NONE",
"ACTIVE",
"PASSIVE"
]
},
"multicastVersion": {
"description": "Mutilcast Version",
"type": "integer"
},
"rootBridgeFamilyId": {
"type": "string"
},
"spanningTree": {
"description": "Spanning Tree",
"type": "string",
"enum": [
"STT_NONE",
"STP",
"RSTP"
]
},
"spanningTreePriority": {
"description": "Spanning Tree Priority",
"type": "integer"
},
"ports": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"switchModel": {
"description": "The Switch Model of Ports",
"type": "string"
},
"untaggedPorts": {
"description": "The Untagged Ports of Ports",
"type": "string"
},
"taggedPorts": {
"description": "The Tagged Ports of Ports",
"type": "string"
}
}
}
},
"pushTimeType": {
"description": "Puch Config Type",
"type": "string",
"enum": [
"NOW",
"SCHEDULE"
]
},
"pushTime": {
"description": "Puch Schedule Time",
"type": "integer",
"format": "int64"
},
"enableManagementVlan": {
"type": "boolean"
}
}
}Response
200Delete VLAN Config. ¶
Delete VLAN Config by Id list. ¶
DELETE/v9_1/vlans
Use this API command to Delete the VLAN Config by Id list.
Request
Body
{
"idList": [
"2f13556e-cc46-4784-bd71-72cd278de858",
"10b689d4-237c-451c-b020-7bb64bd474d2"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Response
204Switch VE Setting ¶
Retrieve VE Config ¶
GET/v9_1/veConfigs/{id}
Use this API command to Retrieve VE Config.
Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID",
"type": "string"
},
"veId": {
"description": "VE Id",
"type": "integer"
},
"name": {
"description": "name",
"type": "string"
},
"switchId": {
"description": "Switch ID",
"type": "string"
},
"switchName": {
"description": "Switch Name",
"type": "string"
},
"switchStatus": {
"description": "Switch Status",
"type": "string"
},
"groupId": {
"description": "Switch Group ID",
"type": "string"
},
"ospfArea": {
"description": "OSPF IP Address",
"type": "string"
},
"vlanId": {
"description": "VLAN ID",
"type": "integer"
},
"dhcpRelayAgent": {
"description": "DHCP Replay IP Address",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask",
"type": "string"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"createdTime": {
"description": "Created Time",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "Updated Time",
"type": "integer",
"format": "int64"
},
"inAclConfigName": {
"description": "Ingress ACL Config Name",
"type": "string"
},
"outAclConfigName": {
"description": "Egress ACL Config Name",
"type": "string"
},
"altoId": {
"type": "string"
}
}
}Retrieve VE Config List ¶
GET/v9_1/veConfigs
Use this API command to Retrieve VE Config List.
Response
200Body
{
"totalCount": 26,
"hasMore": true,
"firstIndex": 1,
"list": [
{
"id": "9f43c198-50ae-4079-b973-5fe722e2752f",
"switchId": "22:22:22:21:00:04",
"switchName": "icx_0",
"switchStatus": "ONLINE",
"groupId": "45ec73e7-0a2c-4222-957c-c9fe40119727",
"veId": 3,
"name": "My New ICX Switch VE Config",
"inAclConfigUUID": "05750761-5059-4f31-bbda-5cb42b047989",
"outAclConfigUUID": "5d5w3dds-6655-55d5-ddad-add5e3w2d15f",
"vlanId": 10,
"port": "1/2/2",
"dhcpRelayAgent": "154.21.22.232",
"ipAddress": "10.0.0.2",
"subnetMask": "255.255.0.0",
"ospfArea": "154.21.22.232",
"createdTime": 1538368487085,
"updatedTime": 1538368669420,
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total configs count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first config returned out of the complete list",
"type": "integer"
},
"list": {
"description": "The list of configs in this response",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID",
"type": "string"
},
"veId": {
"description": "VE Id",
"type": "integer"
},
"name": {
"description": "name",
"type": "string"
},
"switchId": {
"description": "Switch ID",
"type": "string"
},
"switchName": {
"description": "Switch Name",
"type": "string"
},
"switchStatus": {
"description": "Switch Status",
"type": "string"
},
"groupId": {
"description": "Switch Group ID",
"type": "string"
},
"ospfArea": {
"description": "OSPF IP Address",
"type": "string"
},
"vlanId": {
"description": "VLAN ID",
"type": "integer"
},
"dhcpRelayAgent": {
"description": "DHCP Replay IP Address",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask",
"type": "string"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"createdTime": {
"description": "Created Time",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "Updated Time",
"type": "integer",
"format": "int64"
},
"inAclConfigName": {
"description": "Ingress ACL Config Name",
"type": "string"
},
"outAclConfigName": {
"description": "Egress ACL Config Name",
"type": "string"
},
"altoId": {
"type": "string"
}
}
}
}
}
}Create VE Config ¶
POST/v9_1/veConfigs
Use this API command to Create VE Config.
Request
Body
{
"veId": 3,
"name": "My ICX Switch VE Config",
"switchId": "45ec73e7-0a2c-4222-957c-c9fe40119727",
"groupId": "45ec73e7-0a2c-4222-957c-c9fe40119727",
"vlanId": 10,
"dhcpRelayAgent": "154.21.22.232",
"ipAddress": "10.0.0.2",
"subnetMask": "255.255.0.0",
"ospfArea": "154.21.22.232",
"inAclConfigUUID": "05750761-5059-4f31-bbda-5cb42b047989",
"outAclConfigUUID": "5d5w3dds-6655-55d5-ddad-add5e3w2d15f",
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"veId": {
"description": "VE Id",
"type": "integer"
},
"name": {
"description": "name",
"type": "string"
},
"switchId": {
"description": "Switch ID",
"type": "string"
},
"groupId": {
"description": "Switch Group ID",
"type": "string"
},
"ospfArea": {
"description": "OSPF IP Address",
"type": "string"
},
"vlanId": {
"description": "VLAN ID",
"type": "integer"
},
"dhcpRelayAgent": {
"description": "DHCP Replay IP Address",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask",
"type": "string"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"altoId": {
"type": "string"
}
}
}Response
201Body
{
"id": "45ec73e7-0a2c-4222-957c-c9fe40119727"
}Schema
{
"properties": {
"id": {
"description": "The ID of Setting",
"type": "string"
}
}
}Retrieve VE Config list. ¶
POST/v9_1/veConfigs/query
Use this API command to Retrieve VE Config list.
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"totalCount": 26,
"hasMore": true,
"firstIndex": 1,
"list": [
{
"id": "9f43c198-50ae-4079-b973-5fe722e2752f",
"switchId": "22:22:22:21:00:04",
"switchName": "icx_0",
"switchStatus": "ONLINE",
"groupId": "45ec73e7-0a2c-4222-957c-c9fe40119727",
"veId": 3,
"name": "My New ICX Switch VE Config",
"inAclConfigUUID": "05750761-5059-4f31-bbda-5cb42b047989",
"outAclConfigUUID": "5d5w3dds-6655-55d5-ddad-add5e3w2d15f",
"vlanId": 10,
"port": "1/2/2",
"dhcpRelayAgent": "154.21.22.232",
"ipAddress": "10.0.0.2",
"subnetMask": "255.255.0.0",
"ospfArea": "154.21.22.232",
"createdTime": 1538368487085,
"updatedTime": 1538368669420,
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total configs count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first config returned out of the complete list",
"type": "integer"
},
"list": {
"description": "The list of configs in this response",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID",
"type": "string"
},
"veId": {
"description": "VE Id",
"type": "integer"
},
"name": {
"description": "name",
"type": "string"
},
"switchId": {
"description": "Switch ID",
"type": "string"
},
"switchName": {
"description": "Switch Name",
"type": "string"
},
"switchStatus": {
"description": "Switch Status",
"type": "string"
},
"groupId": {
"description": "Switch Group ID",
"type": "string"
},
"ospfArea": {
"description": "OSPF IP Address",
"type": "string"
},
"vlanId": {
"description": "VLAN ID",
"type": "integer"
},
"dhcpRelayAgent": {
"description": "DHCP Replay IP Address",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask",
"type": "string"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"createdTime": {
"description": "Created Time",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "Updated Time",
"type": "integer",
"format": "int64"
},
"inAclConfigName": {
"description": "Ingress ACL Config Name",
"type": "string"
},
"outAclConfigName": {
"description": "Egress ACL Config Name",
"type": "string"
},
"altoId": {
"type": "string"
}
}
}
}
}
}Update VE Config. ¶
PUT/v9_1/veConfigs/{id}
Use this API command to Update VE Config.
Request
Body
{
"name": "My ICX Switch VE Config",
"vlanId": 10,
"dhcpRelayAgent": "154.21.22.232",
"ipAddress": "10.0.0.2",
"subnetMask": "255.255.0.0",
"ospfArea": "154.21.22.232",
"inAclConfigUUID": "05750761-5059-4f31-bbda-5cb42b047989",
"outAclConfigUUID": "5d5w3dds-6655-55d5-ddad-add5e3w2d15f",
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "name",
"type": "string"
},
"switchId": {
"description": "Switch ID",
"type": "string"
},
"ospfArea": {
"description": "OSPF IP Address",
"type": "string"
},
"vlanId": {
"description": "VLAN ID",
"type": "integer"
},
"dhcpRelayAgent": {
"description": "DHCP Replay IP Address",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask",
"type": "string"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"altoId": {
"type": "string"
}
}
}Response
200Delete VE Config by Id list. ¶
DELETE/v9_1/veConfigs
Use this API command to Delete VE Config by Id list.
Request
Body
{
"idList": [
"becc2cf7-2687-4c7f-8466-51b9b8370521",
"e801f959-4e40-413f-926c-30f05872530e",
"45ec73e7-0a2c-4222-957c-c9fe40119727"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Response
204Switch IP Setting ¶
Retrieve IP Config ¶
GET/v9_1/ipConfigs/{id}
Use this API command to Retrieve IP Config.
Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"id": {
"description": "Config ID",
"type": "string"
},
"portName": {
"description": "Switch Port Name",
"type": "string"
},
"switchId": {
"description": "Switch ID",
"type": "string"
},
"switchName": {
"description": "Switch Name",
"type": "string"
},
"switchStatus": {
"description": "Switch Status",
"type": "string"
},
"port": {
"description": "Switch Port",
"type": "string"
},
"groupId": {
"description": "Switch Group ID",
"type": "string"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"ospfArea": {
"description": "OSPF IP Address",
"type": "string"
},
"dhcpRelayAgent": {
"description": "DHCP Replay IP Address",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"createdTime": {
"description": "Config Created Time",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "Config Updated Time",
"type": "integer",
"format": "int64"
},
"inAclConfigName": {
"description": "Ingress ACL Config Name",
"type": "string"
},
"outAclConfigName": {
"description": "Egress ACL Config Name",
"type": "string"
}
}
}Retrieve IP Config List ¶
GET/v9_1/ipConfigs
Use this API command to Retrieve IP Config List.
Response
200Body
{
"totalCount": 26,
"hasMore": true,
"firstIndex": 1,
"list": [
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"Id": "9f43c198-50ae-4079-b973-5fe722e2752f",
"portName": "PortName",
"switchId": "22:22:22:21:00:04",
"switchName": "icx_0",
"switchStatus": "ONLINE",
"inAclConfigUUID": "05750761-5059-4f31-bbda-5cb42b047989",
"outAclConfigUUID": "5d5w3dds-6655-55d5-ddad-add5e3w2d15f",
"port": "1/2/2",
"dhcpRelayAgent": "154.21.22.232",
"ipAddress": "10.0.0.2",
"ospfArea": "154.21.22.232",
"subnetMask": "255.255.0.0",
"createdTime": 1538368487085,
"updatedTime": 1538368669420
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total configs count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first config returned out of the complete list",
"type": "integer"
},
"list": {
"description": "The list of configs in this response",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"id": {
"description": "Config ID",
"type": "string"
},
"portName": {
"description": "Switch Port Name",
"type": "string"
},
"switchId": {
"description": "Switch ID",
"type": "string"
},
"switchName": {
"description": "Switch Name",
"type": "string"
},
"switchStatus": {
"description": "Switch Status",
"type": "string"
},
"port": {
"description": "Switch Port",
"type": "string"
},
"groupId": {
"description": "Switch Group ID",
"type": "string"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"ospfArea": {
"description": "OSPF IP Address",
"type": "string"
},
"dhcpRelayAgent": {
"description": "DHCP Replay IP Address",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"createdTime": {
"description": "Config Created Time",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "Config Updated Time",
"type": "integer",
"format": "int64"
},
"inAclConfigName": {
"description": "Ingress ACL Config Name",
"type": "string"
},
"outAclConfigName": {
"description": "Egress ACL Config Name",
"type": "string"
}
}
}
}
}
}Create IP Config ¶
POST/v9_1/ipConfigs
Use this API command to Create IP Config.
Request
Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"switchId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"portName": "PortName",
"inAclConfigUUID": "05750761-5059-4f31-bbda-5cb42b047989",
"outAclConfigUUID": "5d5w3dds-6655-55d5-ddad-add5e3w2d15f",
"port": "1/2/1",
"dhcpRelayAgent": "154.21.22.232",
"ipAddress": "10.0.0.1",
"ospfArea": "154.21.22.232",
"subnetMask": "255.255.0.0"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"portName": {
"description": "Switch Port Name",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"groupId": {
"description": "Switch Group Id",
"type": "string"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"port": {
"description": "Switch Port",
"type": "string"
},
"dhcpRelayAgent": {
"description": "DHCP Relay IP Address",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"ospfArea": {
"description": "OSPF IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
}
}
}Response
201Body
{
"id": "45ec73e7-0a2c-4222-957c-c9fe40119727"
}Schema
{
"properties": {
"id": {
"description": "The ID of Setting",
"type": "string"
}
}
}Retrieve IP Config list. ¶
POST/v9_1/ipConfigs/query
Use this API command to Retrieve IP Config list.
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"totalCount": 26,
"hasMore": true,
"firstIndex": 1,
"list": [
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"Id": "9f43c198-50ae-4079-b973-5fe722e2752f",
"portName": "PortName",
"switchId": "22:22:22:21:00:04",
"switchName": "icx_0",
"switchStatus": "ONLINE",
"inAclConfigUUID": "05750761-5059-4f31-bbda-5cb42b047989",
"outAclConfigUUID": "5d5w3dds-6655-55d5-ddad-add5e3w2d15f",
"port": "1/2/2",
"dhcpRelayAgent": "154.21.22.232",
"ipAddress": "10.0.0.2",
"ospfArea": "154.21.22.232",
"subnetMask": "255.255.0.0",
"createdTime": 1538368487085,
"updatedTime": 1538368669420
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total configs count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first config returned out of the complete list",
"type": "integer"
},
"list": {
"description": "The list of configs in this response",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"id": {
"description": "Config ID",
"type": "string"
},
"portName": {
"description": "Switch Port Name",
"type": "string"
},
"switchId": {
"description": "Switch ID",
"type": "string"
},
"switchName": {
"description": "Switch Name",
"type": "string"
},
"switchStatus": {
"description": "Switch Status",
"type": "string"
},
"port": {
"description": "Switch Port",
"type": "string"
},
"groupId": {
"description": "Switch Group ID",
"type": "string"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"ospfArea": {
"description": "OSPF IP Address",
"type": "string"
},
"dhcpRelayAgent": {
"description": "DHCP Replay IP Address",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
},
"createdTime": {
"description": "Config Created Time",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "Config Updated Time",
"type": "integer",
"format": "int64"
},
"inAclConfigName": {
"description": "Ingress ACL Config Name",
"type": "string"
},
"outAclConfigName": {
"description": "Egress ACL Config Name",
"type": "string"
}
}
}
}
}
}Update IP Config. ¶
PUT/v9_1/ipConfigs/{id}
Use this API command to Update IP Config.
Request
Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"portName": "PortName",
"inAclConfigUUID": "05750761-5059-4f31-bbda-5cb42b047989",
"outAclConfigUUID": "5d5w3dds-6655-55d5-ddad-add5e3w2d15f",
"port": "1/2/2",
"dhcpRelayAgent": "154.21.22.232",
"ipAddress": "10.0.0.2",
"ospfArea": "154.21.22.232",
"subnetMask": "255.255.0.0"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"portName": {
"description": "Switch Port Name",
"type": "string"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"port": {
"description": "Switch Port",
"type": "string"
},
"dhcpRelayAgent": {
"description": "DHCP Relay IP Address",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"ospfArea": {
"description": "OSPF IP Address",
"type": "string"
},
"subnetMask": {
"description": "Subnet mask",
"type": "string"
}
}
}Response
200Delete IP Config by Id list. ¶
DELETE/v9_1/ipConfigs
Use this API command to Delete IP Config by Id list.
Request
Body
{
"idList": [
"becc2cf7-2687-4c7f-8466-51b9b8370521",
"e801f959-4e40-413f-926c-30f05872530e",
"45ec73e7-0a2c-4222-957c-c9fe40119727"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Response
204Switch LAG Setting ¶
Retrieve all LAG Config list. ¶
GET/v9_1/lagConfigs
Use this API command to Retrieve all LAG Config list.
Response
200Body
{
"success": true,
"error": null,
"data": [
{
"id": "9f43c198-50ae-4079-b973-5fe722e2752f",
"switchId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"name": "My ICX Switch LAG Config2",
"ports": [
"1/2/2",
"2/2/3"
],
"type": "DYNAMIC",
"createdTime": 1538368487085,
"updatedTime": 1538368669420,
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
},
{
"id": "9f43c198-50ae-4079-b973-5fe722e2752f",
"switchId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"name": "My ICX Switch LAG Config3",
"ports": [
"3/2/2",
"3/2/3"
],
"type": "STATIC",
"createdTime": 1538368487085,
"updatedTime": 1538368669420,
"altoId": "f88f63a7-5176-4ea6-9e7c-17c7d502fc86"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total configs count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first config returned out of the complete list",
"type": "integer"
},
"list": {
"description": "The list of configs in this response",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of LAG Config",
"type": "string"
},
"name": {
"description": "The Name of LAG Config",
"type": "string"
},
"type": {
"description": "The LAG Types in STATIC or DYNAMIC",
"type": "string",
"enum": [
"STATIC",
"DYNAMIC"
]
},
"ports": {
"description": "The Switch ports would like to join together",
"type": "array",
"items": {
"type": "string"
}
},
"switchId": {
"description": "The ID of Switch",
"type": "string"
},
"groupId": {
"description": "The ID of Switch Group",
"type": "string"
},
"createdTime": {
"description": "The LAG Types in STATIC or DYNAMIC",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The LAG Types in STATIC or DYNAMIC",
"type": "integer",
"format": "int64"
},
"altoId": {
"type": "string"
}
}
}
}
}
}Retrieve Specific LAG Config. ¶
GET/v9_1/lagConfigs/{id}
Use this API command to Retrieve Specific LAG Config.
Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of LAG Config",
"type": "string"
},
"name": {
"description": "The Name of LAG Config",
"type": "string"
},
"type": {
"description": "The LAG Types in STATIC or DYNAMIC",
"type": "string",
"enum": [
"STATIC",
"DYNAMIC"
]
},
"ports": {
"description": "The Switch ports would like to join together",
"type": "array",
"items": {
"type": "string"
}
},
"switchId": {
"description": "The ID of Switch",
"type": "string"
},
"groupId": {
"description": "The ID of Switch Group",
"type": "string"
},
"createdTime": {
"description": "The LAG Types in STATIC or DYNAMIC",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The LAG Types in STATIC or DYNAMIC",
"type": "integer",
"format": "int64"
},
"altoId": {
"type": "string"
}
}
}Create LAG Config. ¶
POST/v9_1/lagConfigs
Use this API command to Create LAG Config.
Request
Body
{
"switchId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"name": "My ICX Switch LAG Config",
"ports": [
"1/2/2",
"2/2/2"
],
"type": "STATIC",
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"switchId": {
"description": "Switch Id",
"type": "string"
},
"groupId": {
"description": "Switch Group Id",
"type": "string"
},
"name": {
"description": "The Name of LAG Config",
"type": "string"
},
"ports": {
"description": "The Switch ports would like to join together",
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"description": "The LAG Types in STATIC or DYNAMIC",
"type": "string",
"enum": [
"STATIC",
"DYNAMIC"
]
},
"altoId": {
"type": "string"
}
}
}Response
201Body
{
"id": "45ec73e7-0a2c-4222-957c-c9fe40119727"
}Schema
{
"properties": {
"id": {
"description": "The ID of LAG Config",
"type": "string"
}
}
}Retrieve LAG Config list. ¶
POST/v9_1/lagConfigs/query
Use this API command to Retrieve LAG Config list.
Request
Body
{
"extraFilters": [
{
"type": "SWITCH_ID",
"value": "78:A6:E1:44:11:BE"
}
],
"filters": [
{
"type": "SWITCH_GROUP",
"value": "9f43c198-50ae-4079-b973-5fe722e2752f"
}
],
"page": 1,
"limit": 80
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"success": true,
"error": null,
"data": [
{
"id": "9f43c198-50ae-4079-b973-5fe722e2752f",
"switchId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"name": "My ICX Switch LAG Config2",
"ports": [
"1/2/2",
"2/2/3"
],
"type": "DYNAMIC",
"createdTime": 1538368487085,
"updatedTime": 1538368669420,
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
},
{
"id": "9f43c198-50ae-4079-b973-5fe722e2752f",
"switchId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"name": "My ICX Switch LAG Config3",
"ports": [
"3/2/2",
"3/2/3"
],
"type": "STATIC",
"createdTime": 1538368487085,
"updatedTime": 1538368669420,
"altoId": "f88f63a7-5176-4ea6-9e7c-17c7d502fc86"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total configs count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first config returned out of the complete list",
"type": "integer"
},
"list": {
"description": "The list of configs in this response",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of LAG Config",
"type": "string"
},
"name": {
"description": "The Name of LAG Config",
"type": "string"
},
"type": {
"description": "The LAG Types in STATIC or DYNAMIC",
"type": "string",
"enum": [
"STATIC",
"DYNAMIC"
]
},
"ports": {
"description": "The Switch ports would like to join together",
"type": "array",
"items": {
"type": "string"
}
},
"switchId": {
"description": "The ID of Switch",
"type": "string"
},
"groupId": {
"description": "The ID of Switch Group",
"type": "string"
},
"createdTime": {
"description": "The LAG Types in STATIC or DYNAMIC",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The LAG Types in STATIC or DYNAMIC",
"type": "integer",
"format": "int64"
},
"altoId": {
"type": "string"
}
}
}
}
}
}Update LAG Config. ¶
PUT/v9_1/lagConfigs/{id}
Use this API command to Update LAG Config.
Request
Body
{
"name": "My ICX Switch LAG Config2",
"ports": [
"1/2/2",
"2/2/2"
],
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "The Name of LAG Config",
"type": "string"
},
"ports": {
"description": "The Switch ports would like to join together",
"type": "array",
"items": {
"type": "string"
}
},
"altoId": {
"type": "string"
}
}
}Response
200Delete LAG Config. ¶
Delete LAG Config by Id list. ¶
DELETE/v9_1/lagConfigs
Use this API command to Delete LAG Config by Id list.
Request
Body
{
"idList": [
"becc2cf7-2687-4c7f-8466-51b9b8370521",
"e801f959-4e40-413f-926c-30f05872530e",
"45ec73e7-0a2c-4222-957c-c9fe40119727"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Response
204Switch Specific Settings ¶
Retrieve Specific Settings. ¶
GET/v9_1/specificSettings/{id}
Use this API command to Retrieve Specific Settings.
Response
200Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"id": "9f43c198-50ae-4079-b973-5fe722e2752f",
"hostname": "hostname123",
"igmpSnooping": "ACTIVE",
"jumboMode": true,
"dhcpServerEnabled": true,
"dhcpServers": [
{
"poolName": "present",
"network": "1.1.1.1",
"excludedStart": "1.1.1.1",
"excludedEnd": "1.1.1.2",
"leaseDays": 10,
"leaseHrs": 20,
"leaseMins": 30,
"defaultRouterIp": "255.255.255.0",
"dhcpOptions": [
{
"seq": 5,
"type": "ASCII",
"value": "123"
},
{
"seq": 7,
"type": "ASCII",
"value": "456"
}
]
},
{
"poolName": "poolName223",
"network": "12.12.12.12",
"excludedStart": "1.1.1.1",
"excludedEnd": "1.1.1.2",
"defaultRouterIp": "255.255.255.0",
"dhcpOptions": [
{
"seq": 5,
"type": "ASCII",
"value": "123"
},
{
"seq": 7,
"type": "ASCII",
"value": "456"
}
]
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"id": {
"description": "Id",
"type": "string"
},
"createdTime": {
"description": "The create time of the Specific Settings",
"type": "integer"
},
"updatedTime": {
"description": "The modify time of the Specific Settings",
"type": "integer"
},
"hostname": {
"description": "Hostname",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "SubnetMask",
"type": "string"
},
"defaultGateway": {
"description": "DefaultGateway",
"type": "string"
},
"igmpSnooping": {
"description": "IGMP snopping",
"type": "string"
},
"jumboMode": {
"description": "JumboMode",
"type": "boolean"
},
"dhcpServerEnabled": {
"description": "DHCP server enabled",
"type": "boolean"
},
"dhcpServers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"poolName": {
"description": "Pool Name",
"type": "string"
},
"network": {
"description": "Network/Mask",
"type": "string"
},
"excludedStart": {
"description": "Excluded range start",
"type": "string"
},
"excludedEnd": {
"description": "Excluded range end",
"type": "string"
},
"leaseDays": {
"description": "Lease Days",
"type": "integer"
},
"leaseHrs": {
"description": "Lease Hours",
"type": "integer"
},
"leaseMins": {
"description": "Lease Mins",
"type": "integer"
},
"defaultRouterIp": {
"description": "Default Router Ip",
"type": "string"
},
"dhcpOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"seq": {
"description": "Seq of Option",
"type": "integer"
},
"type": {
"description": "Type of Option",
"type": "string"
},
"value": {
"description": "Value of Option",
"type": "string"
}
}
}
}
}
}
}
}
}Retrieve all Specific Setting list. ¶
GET/v9_1/specificSettings
Use this API command to Retrieve all Specific Setting list.
Response
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total Specific Settings count",
"type": "integer"
},
"totalCount": {
"description": "Total Specific Settings count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Specific Settings after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Specific Settings returned out of the complete Specific Settings list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Id",
"type": "string"
},
"hostname": {
"description": "Hostname",
"type": "string"
}
}
}
}
}
}Update Specific Settings. ¶
PUT/v9_1/specificSettings/{id}
Use this API command to Update Specific Settings.
Request
Body
{
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2",
"hostname": "hostname123",
"ipAddress": "10.176.165.3",
"subnetMask": "255.255.255.192",
"defaultGateway": "10.2.0.1",
"igmpSnopping": "ACTIVE",
"jumboMode": true,
"dhcpServerEnabled": true,
"dhcpServers": [
{
"poolName": "present",
"network": "1.1.1.1",
"excludedStart": "1.1.1.1",
"excludedEnd": "1.1.1.2",
"leaseDays": 10,
"leaseHrs": 20,
"leaseMins": 30,
"defaultRouterIp": "255.255.255.0",
"dhcpOptions": [
{
"seq": 5,
"type": "ASCII",
"value": "123"
},
{
"seq": 7,
"type": "ASCII",
"value": "456"
}
]
},
{
"poolName": "poolName",
"network": "12.12.12.12",
"excludedStart": "1.1.1.1",
"excludedEnd": "1.1.1.2",
"defaultRouterIp": "255.255.255.0",
"dhcpOptions": [
{
"seq": 5,
"type": "ASCII",
"value": "123"
},
{
"seq": 7,
"type": "ASCII",
"value": "456"
}
]
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"altoId": {
"type": "string"
},
"hostname": {
"description": "Hostname",
"type": "string"
},
"ipAddress": {
"description": "IP Address",
"type": "string"
},
"subnetMask": {
"description": "SubnetMask",
"type": "string"
},
"defaultGateway": {
"description": "DefaultGateway",
"type": "string"
},
"igmpSnooping": {
"description": "IGMP snopping",
"type": "string"
},
"jumboMode": {
"description": "JumboMode",
"type": "boolean"
},
"dhcpServerEnabled": {
"description": "DHCP server enabled",
"type": "boolean"
},
"dhcpServers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"poolName": {
"description": "Pool Name",
"type": "string"
},
"network": {
"description": "Network/Mask",
"type": "string"
},
"excludedStart": {
"description": "Excluded range start",
"type": "string"
},
"excludedEnd": {
"description": "Excluded range end",
"type": "string"
},
"leaseDays": {
"description": "Lease Days",
"type": "integer"
},
"leaseHrs": {
"description": "Lease Hours",
"type": "integer"
},
"leaseMins": {
"description": "Lease Mins",
"type": "integer"
},
"defaultRouterIp": {
"description": "Default Router Ip",
"type": "string"
},
"dhcpOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"seq": {
"description": "Seq of Option",
"type": "integer"
},
"type": {
"description": "Type of Option",
"type": "string"
},
"value": {
"description": "Value of Option",
"type": "string"
}
}
}
}
}
}
}
}
}Response
204Switch Port Settings ¶
Retrieve all Port Settings list. ¶
GET/v9_1/portSettings
Use this API command to Retrieve all Port Settings list.
Response
200Body
{
"success": true,
"error": null,
"data": [
{
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"switchId": "test",
"port": "1",
"portName": "portName",
"portEnabled": true,
"taggedVlans": "10,11",
"untaggedVlans": "12",
"poeEnabled": true,
"poeClass": "0",
"poePriority": 1,
"aclConfigUUID": "",
"ingressAndEgress": "",
"portSpeed": "10G",
"rstpAdminEdgePortEnabled": true,
"stpBpduGuardEnabled": true,
"stpRootGuardEnabled": true,
"dhcpSnoopingTrustPortEnabled": true,
"ipsgEnabled": true,
"lldpEnabled": true,
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
}
],
"extra": {},
"metaData": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total Port Settings count",
"type": "integer"
},
"totalCount": {
"description": "Total Port Settings count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Port Settings after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Port Settings returned out of the complete Port Settings list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"groupId": {
"description": "Group Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"id": {
"description": "Id",
"type": "string"
},
"port": {
"description": "Port",
"type": "string"
},
"portName": {
"description": "Port Name",
"type": "string"
},
"poeCapability": {
"description": "PoE Capability",
"type": "boolean"
},
"portEnabled": {
"description": "Port Enabled",
"type": "boolean"
},
"portProtected": {
"type": "boolean"
},
"taggedVlans": {
"description": "Tagged Vlans",
"type": "string"
},
"untaggedVlans": {
"description": "Untagged vlans",
"type": "string"
},
"poeEnabled": {
"description": "PoE Enabled",
"type": "boolean"
},
"poeClass": {
"description": "PoE Class",
"type": "string",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
]
},
"poePriority": {
"description": "PoE Priority",
"type": "integer"
},
"poeBudget": {
"type": "integer"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"inAclConfigName": {
"type": "string"
},
"outAclConfigName": {
"type": "string"
},
"portSpeed": {
"description": "Port Speed",
"type": "string",
"enum": [
"NONE",
"1G",
"10G",
"AUTO",
"10-HALF",
"10-FULL",
"100-HALF",
"100-FULL",
"1000-FULL",
"1000-FULL-MASTER",
"1000-FULL-SLAVE",
"2500-FULL",
"2500-FULL-MASTER",
"2500-FULL-SLAVE",
"5G-FULL",
"5G-FULL-MASTER",
"5G-FULL-SLAVE",
"10G-FULL",
"10G-FULL-MASTER",
"10G-FULL-SLAVE",
"25G-FULL",
"40G-FULL",
"100G-FULL"
]
},
"rstpAdminEdgePortEnabled": {
"description": "RSTP Admin Edge Port Enabled",
"type": "boolean"
},
"stpBpduGuardEnabled": {
"description": "STP BPDU GUARD Enabled",
"type": "boolean"
},
"stpRootGuardEnabled": {
"description": "STP Root Guard Enabled",
"type": "boolean"
},
"dhcpSnoopingTrustPortEnabled": {
"description": "DHCP Snooping Trust Port Enabled",
"type": "boolean"
},
"ipsgEnabled": {
"description": "IPSG Enabled",
"type": "boolean"
},
"lldpEnabled": {
"description": "LLDP Enabled",
"type": "boolean"
},
"lldpQosList": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"applicationType": {
"type": "string",
"enum": [
"GUEST_VOICE",
"GUEST_VOICE_SIGNALING",
"SOFTPHONE_VOICE",
"STREAMING_VIDEO",
"VIDEO_CONFERENCING",
"VIDEO_SIGNALING",
"VOICE",
"VOICE_SIGNALING"
]
},
"qosVlanType": {
"type": "string",
"enum": [
"PRIORITY_TAGGED",
"TAGGED",
"UNTAGGED"
]
},
"vlanId": {
"type": "integer"
},
"priority": {
"type": "integer"
},
"dscp": {
"type": "integer"
}
}
}
},
"voiceVlanId": {
"type": "integer"
},
"dscpRemark": {
"type": "integer"
},
"createdTime": {
"description": "The create time of the Port Settings",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The modify time of the Port Settings",
"type": "integer",
"format": "int64"
},
"altoId": {
"type": "string"
}
}
}
}
}
}Retrieve Port Settings. ¶
GET/v9_1/portSettings/{id}
Use this API command to Retrieve Port Settings.
Response
200Body
{
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"switchId": "test",
"port": "1",
"portName": "portName",
"portEnabled": true,
"taggedVlans": "10,11",
"untaggedVlans": "12",
"poeEnabled": true,
"poeClass": "0",
"poePriority": 1,
"aclConfigUUID": "",
"ingressAndEgress": "",
"portSpeed": "10G",
"rstpAdminEdgePortEnabled": true,
"stpBpduGuardEnabled": true,
"stpRootGuardEnabled": true,
"dhcpSnoopingTrustPortEnabled": true,
"ipsgEnabled": true,
"lldpEnabled": true,
"createdTime": 1538368487085,
"updatedTime": 1538368669420,
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"groupId": {
"description": "Group Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"id": {
"description": "Id",
"type": "string"
},
"port": {
"description": "Port",
"type": "string"
},
"portName": {
"description": "Port Name",
"type": "string"
},
"poeCapability": {
"description": "PoE Capability",
"type": "boolean"
},
"portEnabled": {
"description": "Port Enabled",
"type": "boolean"
},
"portProtected": {
"type": "boolean"
},
"taggedVlans": {
"description": "Tagged Vlans",
"type": "string"
},
"untaggedVlans": {
"description": "Untagged vlans",
"type": "string"
},
"poeEnabled": {
"description": "PoE Enabled",
"type": "boolean"
},
"poeClass": {
"description": "PoE Class",
"type": "string",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
]
},
"poePriority": {
"description": "PoE Priority",
"type": "integer"
},
"poeBudget": {
"type": "integer"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"inAclConfigName": {
"type": "string"
},
"outAclConfigName": {
"type": "string"
},
"portSpeed": {
"description": "Port Speed",
"type": "string",
"enum": [
"NONE",
"1G",
"10G",
"AUTO",
"10-HALF",
"10-FULL",
"100-HALF",
"100-FULL",
"1000-FULL",
"1000-FULL-MASTER",
"1000-FULL-SLAVE",
"2500-FULL",
"2500-FULL-MASTER",
"2500-FULL-SLAVE",
"5G-FULL",
"5G-FULL-MASTER",
"5G-FULL-SLAVE",
"10G-FULL",
"10G-FULL-MASTER",
"10G-FULL-SLAVE",
"25G-FULL",
"40G-FULL",
"100G-FULL"
]
},
"rstpAdminEdgePortEnabled": {
"description": "RSTP Admin Edge Port Enabled",
"type": "boolean"
},
"stpBpduGuardEnabled": {
"description": "STP BPDU GUARD Enabled",
"type": "boolean"
},
"stpRootGuardEnabled": {
"description": "STP Root Guard Enabled",
"type": "boolean"
},
"dhcpSnoopingTrustPortEnabled": {
"description": "DHCP Snooping Trust Port Enabled",
"type": "boolean"
},
"ipsgEnabled": {
"description": "IPSG Enabled",
"type": "boolean"
},
"lldpEnabled": {
"description": "LLDP Enabled",
"type": "boolean"
},
"lldpQosList": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"applicationType": {
"type": "string",
"enum": [
"GUEST_VOICE",
"GUEST_VOICE_SIGNALING",
"SOFTPHONE_VOICE",
"STREAMING_VIDEO",
"VIDEO_CONFERENCING",
"VIDEO_SIGNALING",
"VOICE",
"VOICE_SIGNALING"
]
},
"qosVlanType": {
"type": "string",
"enum": [
"PRIORITY_TAGGED",
"TAGGED",
"UNTAGGED"
]
},
"vlanId": {
"type": "integer"
},
"priority": {
"type": "integer"
},
"dscp": {
"type": "integer"
}
}
}
},
"voiceVlanId": {
"type": "integer"
},
"dscpRemark": {
"type": "integer"
},
"createdTime": {
"description": "The create time of the Port Settings",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The modify time of the Port Settings",
"type": "integer",
"format": "int64"
},
"altoId": {
"type": "string"
}
}
}Retrieve Port Settings list. ¶
POST/v9_1/portSettings/query
Use this API command to Retrieve Port Settings list.
Request
Body
{
"extraFilters": [
{
"type": "SWITCH_ID",
"value": "78:A6:E1:44:57:96"
},
{
"type": "port",
"value": "1/2/3"
}
],
"filters": [
{
"type": "SWITCH_GROUP",
"value": "9f43c198-50ae-4079-b973-5fe722e2752f"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"success": true,
"error": null,
"data": [
{
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"switchId": "test",
"port": "1",
"portName": "portName",
"portEnabled": true,
"taggedVlans": "10,11",
"untaggedVlans": "12",
"poeEnabled": true,
"poeClass": "0",
"poePriority": 1,
"aclConfigUUID": "",
"ingressAndEgress": "",
"portSpeed": "10G",
"rstpAdminEdgePortEnabled": true,
"stpBpduGuardEnabled": true,
"stpRootGuardEnabled": true,
"dhcpSnoopingTrustPortEnabled": true,
"ipsgEnabled": true,
"lldpEnabled": true,
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
}
],
"extra": {},
"metaData": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total Port Settings count",
"type": "integer"
},
"totalCount": {
"description": "Total Port Settings count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Port Settings after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Port Settings returned out of the complete Port Settings list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"groupId": {
"description": "Group Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"id": {
"description": "Id",
"type": "string"
},
"port": {
"description": "Port",
"type": "string"
},
"portName": {
"description": "Port Name",
"type": "string"
},
"poeCapability": {
"description": "PoE Capability",
"type": "boolean"
},
"portEnabled": {
"description": "Port Enabled",
"type": "boolean"
},
"portProtected": {
"type": "boolean"
},
"taggedVlans": {
"description": "Tagged Vlans",
"type": "string"
},
"untaggedVlans": {
"description": "Untagged vlans",
"type": "string"
},
"poeEnabled": {
"description": "PoE Enabled",
"type": "boolean"
},
"poeClass": {
"description": "PoE Class",
"type": "string",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
]
},
"poePriority": {
"description": "PoE Priority",
"type": "integer"
},
"poeBudget": {
"type": "integer"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"inAclConfigName": {
"type": "string"
},
"outAclConfigName": {
"type": "string"
},
"portSpeed": {
"description": "Port Speed",
"type": "string",
"enum": [
"NONE",
"1G",
"10G",
"AUTO",
"10-HALF",
"10-FULL",
"100-HALF",
"100-FULL",
"1000-FULL",
"1000-FULL-MASTER",
"1000-FULL-SLAVE",
"2500-FULL",
"2500-FULL-MASTER",
"2500-FULL-SLAVE",
"5G-FULL",
"5G-FULL-MASTER",
"5G-FULL-SLAVE",
"10G-FULL",
"10G-FULL-MASTER",
"10G-FULL-SLAVE",
"25G-FULL",
"40G-FULL",
"100G-FULL"
]
},
"rstpAdminEdgePortEnabled": {
"description": "RSTP Admin Edge Port Enabled",
"type": "boolean"
},
"stpBpduGuardEnabled": {
"description": "STP BPDU GUARD Enabled",
"type": "boolean"
},
"stpRootGuardEnabled": {
"description": "STP Root Guard Enabled",
"type": "boolean"
},
"dhcpSnoopingTrustPortEnabled": {
"description": "DHCP Snooping Trust Port Enabled",
"type": "boolean"
},
"ipsgEnabled": {
"description": "IPSG Enabled",
"type": "boolean"
},
"lldpEnabled": {
"description": "LLDP Enabled",
"type": "boolean"
},
"lldpQosList": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"applicationType": {
"type": "string",
"enum": [
"GUEST_VOICE",
"GUEST_VOICE_SIGNALING",
"SOFTPHONE_VOICE",
"STREAMING_VIDEO",
"VIDEO_CONFERENCING",
"VIDEO_SIGNALING",
"VOICE",
"VOICE_SIGNALING"
]
},
"qosVlanType": {
"type": "string",
"enum": [
"PRIORITY_TAGGED",
"TAGGED",
"UNTAGGED"
]
},
"vlanId": {
"type": "integer"
},
"priority": {
"type": "integer"
},
"dscp": {
"type": "integer"
}
}
}
},
"voiceVlanId": {
"type": "integer"
},
"dscpRemark": {
"type": "integer"
},
"createdTime": {
"description": "The create time of the Port Settings",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The modify time of the Port Settings",
"type": "integer",
"format": "int64"
},
"altoId": {
"type": "string"
}
}
}
}
}
}Bulk Port Configuration ¶
POST/v9_1/portSettings/bulk
Use this API command to Bulk update the port setting
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"groupId": {
"description": "Group Id",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"port": {
"description": "Port",
"type": "string"
},
"portName": {
"description": "Port Name",
"type": "string"
},
"portEnabled": {
"description": "Port Enabled",
"type": "boolean"
},
"portProtected": {
"type": "boolean"
},
"taggedVlans": {
"description": "Tagged Vlans",
"type": "string"
},
"untaggedVlans": {
"description": "Untagged vlans",
"type": "string"
},
"poeEnabled": {
"description": "PoE Enabled",
"type": "boolean"
},
"poeClass": {
"description": "PoE Class",
"type": "string",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
]
},
"poePriority": {
"description": "PoE Priority",
"type": "integer"
},
"poeBudget": {
"type": "integer"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"inAclConfigName": {
"type": "string"
},
"outAclConfigName": {
"type": "string"
},
"portSpeed": {
"description": "Port Speed",
"type": "string",
"enum": [
"NONE",
"1G",
"10G",
"AUTO",
"10-HALF",
"10-FULL",
"100-HALF",
"100-FULL",
"1000-FULL",
"1000-FULL-MASTER",
"1000-FULL-SLAVE",
"2500-FULL",
"2500-FULL-MASTER",
"2500-FULL-SLAVE",
"5G-FULL",
"5G-FULL-MASTER",
"5G-FULL-SLAVE",
"10G-FULL",
"10G-FULL-MASTER",
"10G-FULL-SLAVE",
"25G-FULL",
"40G-FULL",
"100G-FULL"
]
},
"rstpAdminEdgePortEnabled": {
"description": "RSTP Admin Edge Port Enabled",
"type": "boolean"
},
"stpBpduGuardEnabled": {
"description": "STP BPDU GUARD Enabled",
"type": "boolean"
},
"stpRootGuardEnabled": {
"description": "STP Root Guard Enabled",
"type": "boolean"
},
"dhcpSnoopingTrustPortEnabled": {
"description": "DHCP Snooping Trust Port Enabled",
"type": "boolean"
},
"ipsgEnabled": {
"description": "IPSG Enabled",
"type": "boolean"
},
"lldpEnabled": {
"description": "LLDP Enabled",
"type": "boolean"
},
"idList": {
"type": "array",
"items": {
"type": "string"
}
},
"ignoreList": {
"description": "attributes not to overwrite",
"type": "array",
"items": {
"type": "string"
}
},
"altoId": {
"type": "string"
},
"lldpQosList": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"applicationType": {
"type": "string",
"enum": [
"GUEST_VOICE",
"GUEST_VOICE_SIGNALING",
"SOFTPHONE_VOICE",
"STREAMING_VIDEO",
"VIDEO_CONFERENCING",
"VIDEO_SIGNALING",
"VOICE",
"VOICE_SIGNALING"
]
},
"qosVlanType": {
"type": "string",
"enum": [
"PRIORITY_TAGGED",
"TAGGED",
"UNTAGGED"
]
},
"vlanId": {
"type": "integer"
},
"priority": {
"type": "integer"
},
"dscp": {
"type": "integer"
}
}
}
},
"voiceVlanId": {
"type": "integer"
},
"dscpRemark": {
"type": "integer"
}
}
}Response
204Update Port Settings. ¶
PUT/v9_1/portSettings/{id}
Use this API command to Update Port Settings.
Request
Body
{
"portName": "portName",
"portEnabled": true,
"poeEnabled": true,
"poeClass": "ONE",
"poePriority": 1,
"aclConfigUUID": "45ec73e7-0a2c-4222-957c-c9fe40119727",
"ingressAndEgress": "IN",
"portSpeed": "ONE_G",
"rstpAdminEdgePortEnabled": true,
"stpBpduGuardEnabled": true,
"stpRootGuardEnabled": true,
"dhcpSnoopingTrustPortEnabled": true,
"ipsgEnabled": true,
"lldpEnabled": true,
"altoId": "5dfe5sde-35dc-5d8e-ccd8-ef84e6s8d5e2"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"description": "Port Name",
"type": "string"
},
"portEnabled": {
"description": "Port Enabled",
"type": "boolean"
},
"portProtected": {
"type": "boolean"
},
"taggedVlans": {
"description": "Tagged Vlans",
"type": "string"
},
"untaggedVlans": {
"description": "Untagged vlans",
"type": "string"
},
"poeEnabled": {
"description": "PoE Enabled",
"type": "boolean"
},
"poeClass": {
"description": "PoE Class",
"type": "string",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
]
},
"poePriority": {
"description": "PoE Priority",
"type": "integer"
},
"poeBudget": {
"type": "integer"
},
"inAclConfigUUID": {
"description": "Ingress ACL Config UUID",
"type": "string"
},
"outAclConfigUUID": {
"description": "Egress ACL Config UUID",
"type": "string"
},
"inAclConfigName": {
"type": "string"
},
"outAclConfigName": {
"type": "string"
},
"portSpeed": {
"description": "Port Speed",
"type": "string",
"enum": [
"NONE",
"1G",
"10G",
"AUTO",
"10-HALF",
"10-FULL",
"100-HALF",
"100-FULL",
"1000-FULL",
"1000-FULL-MASTER",
"1000-FULL-SLAVE",
"2500-FULL",
"2500-FULL-MASTER",
"2500-FULL-SLAVE",
"5G-FULL",
"5G-FULL-MASTER",
"5G-FULL-SLAVE",
"10G-FULL",
"10G-FULL-MASTER",
"10G-FULL-SLAVE",
"25G-FULL",
"40G-FULL",
"100G-FULL"
]
},
"rstpAdminEdgePortEnabled": {
"description": "RSTP Admin Edge Port Enabled",
"type": "boolean"
},
"stpBpduGuardEnabled": {
"description": "STP BPDU GUARD Enabled",
"type": "boolean"
},
"stpRootGuardEnabled": {
"description": "STP Root Guard Enabled",
"type": "boolean"
},
"dhcpSnoopingTrustPortEnabled": {
"description": "DHCP Snooping Trust Port Enabled",
"type": "boolean"
},
"ipsgEnabled": {
"description": "IPSG Enabled",
"type": "boolean"
},
"lldpEnabled": {
"description": "LLDP Enabled",
"type": "boolean"
},
"altoId": {
"type": "string"
},
"lldpQosList": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"applicationType": {
"type": "string",
"enum": [
"GUEST_VOICE",
"GUEST_VOICE_SIGNALING",
"SOFTPHONE_VOICE",
"STREAMING_VIDEO",
"VIDEO_CONFERENCING",
"VIDEO_SIGNALING",
"VOICE",
"VOICE_SIGNALING"
]
},
"qosVlanType": {
"type": "string",
"enum": [
"PRIORITY_TAGGED",
"TAGGED",
"UNTAGGED"
]
},
"vlanId": {
"type": "integer"
},
"priority": {
"type": "integer"
},
"dscp": {
"type": "integer"
}
}
}
},
"voiceVlanId": {
"type": "integer"
},
"dscpRemark": {
"type": "integer"
}
}
}Response
200Switch Group Model Config ¶
Retrieve Group Model Configs. ¶
POST/v9_1/groupModelConfigs/query
Use this API command to retrieve the list of group model configs.
Request
Body
{
"extraFilters": [
{
"type": "FAMILY_ID",
"value": "ICX7650"
}
],
"filters": [
{
"type": "SWITCH_GROUP",
"value": "511807dc-0276-44ed-964e-c78ac7c974a5"
}
],
"page": 1,
"limit": 25
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 6,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "b4cac420-1c63-4c93-a6e1-c3a5a312782a",
"familyId": "ICX7850",
"groupId": "511807dc-0276-44ed-964e-c78ac7c974a5",
"createdTime": 1539358182701,
"updatedTime": 0,
"hasVlanConfig": false,
"hasAclConfig": false,
"hasStaticRouteConfig": false,
"hasConfigured": false,
"hasSelected": false
},
{
"id": "e56bd87e-f092-496b-9f9b-a4398ff2b804",
"familyId": "ICX7750",
"groupId": "511807dc-0276-44ed-964e-c78ac7c974a5",
"createdTime": 1539358182699,
"updatedTime": 0,
"hasVlanConfig": false,
"hasAclConfig": false,
"hasStaticRouteConfig": false,
"hasConfigured": false,
"hasSelected": false
},
{
"id": "234cc310-558d-440e-8bdc-cccabc175605",
"familyId": "ICX7450",
"groupId": "511807dc-0276-44ed-964e-c78ac7c974a5",
"createdTime": 1539358182699,
"updatedTime": 0,
"hasVlanConfig": false,
"hasAclConfig": false,
"hasStaticRouteConfig": false,
"hasConfigured": false,
"hasSelected": false
},
{
"id": "6f031edd-f04a-4adc-81d4-0057dd8ed62e",
"familyId": "ICX7250",
"groupId": "511807dc-0276-44ed-964e-c78ac7c974a5",
"createdTime": 1539358182698,
"updatedTime": 0,
"hasVlanConfig": false,
"hasAclConfig": false,
"hasStaticRouteConfig": false,
"hasConfigured": false,
"hasSelected": false
},
{
"id": "b9c0ff37-fc78-4586-a763-b6486ec9dd01",
"familyId": "ICX7150",
"groupId": "511807dc-0276-44ed-964e-c78ac7c974a5",
"createdTime": 1539358182692,
"updatedTime": 0,
"hasVlanConfig": false,
"hasAclConfig": false,
"hasStaticRouteConfig": false,
"hasConfigured": false,
"hasSelected": false
},
{
"id": "b88a4a70-76af-4288-9ca3-738bc3f8c7da",
"familyId": "ICX7650",
"groupId": "511807dc-0276-44ed-964e-c78ac7c974a5",
"createdTime": 1539358182699,
"updatedTime": 0,
"hasVlanConfig": false,
"hasAclConfig": false,
"hasStaticRouteConfig": false,
"hasConfigured": false,
"hasSelected": false
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total Group Model Configs count",
"type": "integer"
},
"totalCount": {
"description": "Total Group Model Configs count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Group Model Configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Group Model Config returned out of the complete Group Model Configs list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Id",
"type": "string"
},
"familyId": {
"description": "Family Id",
"type": "string"
},
"groupId": {
"description": "Group Id",
"type": "string"
},
"createdTime": {
"description": "The create time of the Group Model Config",
"type": "integer",
"format": "int64"
},
"updatedTime": {
"description": "The update time of the Group Model Config",
"type": "integer",
"format": "int64"
},
"hasVlanConfig": {
"description": "Indicates if there is any VlanConfig in the Group Model Config",
"type": "boolean"
},
"hasAclConfig": {
"description": "Indicates if there is any ACLConfig in the Group Model Config",
"type": "boolean"
},
"hasStaticRouteConfig": {
"description": "Indicates if there is any StaticRoute in the Group Model Config",
"type": "boolean"
},
"hasConfigured": {
"description": "Indicates if there is any config in the Group Model Config",
"type": "boolean"
},
"hasSelected": {
"description": "Indicates if this Group Model Config has been selected",
"type": "boolean"
}
}
}
}
}
}Add-Remove Selected Model Family. ¶
PUT/v9_1/groupModelConfigs/{groupId}
Use this API command to add or remove the model family of a group config.
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"selectedIdList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "b88a4a70-76af-4288-9ca3-738bc3f8c7da",
"name": null
},
{
"id": "b4cac420-1c63-4c93-a6e1-c3a5a312782a",
"name": null
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total updated Group Model Configs count",
"type": "integer"
},
"totalCount": {
"description": "Total updated Group Model Configs count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more updated Group Model Configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first updated Group Model Config returned out of the complete Group Model Configs list",
"type": "integer"
},
"extra": {
"description": "Any additional response data",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "The identifier of the Group Model Config",
"type": "string"
},
"name": {
"description": "The name of the Group Model Config",
"type": "string"
}
}
}
}
}
}Switch Configuration History ¶
Retrieve Configuration History Detail List ¶
GET/v9_1/configurationHistory/detail
Use this API command to Retrieve Configuration History List.
Response
200Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 80,
"list": [
{
"id": "32cf973d-8b6e-4a60-9777-5acb109f9fd0",
"transactionId": "d12c7062-b8d6-4ac7-8121-17ea541e4de6",
"switchId": "78:A6:E1:22:92:CC",
"switchName": "ICX7250-24P Router",
"serialNumber": "DUI3848N0JE",
"yang": "{\n "provision-configs": {\n "global-configs": {},\n "common-configs": {},\n "feature-configs": {\n "acls": {}\n }\n }\n}",
"clis": "\nno ip access-list STANDARD "dd"\n\r\n",
"dispatchStatus": "SUCCESS",
"dispatchFailedReason": {
"lineNumber": null,
"message": null
},
"startTime": 1546495848641,
"endTime": 1546495869452
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total records count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "integer"
},
"list": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Switch Deployment History Id",
"type": "string"
},
"transactionId": {
"description": "Transaction Id of depolyment",
"type": "string"
},
"switchName": {
"description": "Switch Name",
"type": "string"
},
"serialNumber": {
"description": "Serical Number of Switch",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"clis": {
"description": "CLI Command",
"type": "string"
},
"dispatchStatus": {
"description": "Status of Deployment",
"type": "string",
"enum": [
"PENDING",
"IN_PROGRESS",
"SUCCESS",
"FAILED"
]
},
"dispatchFailedReason": {
"description": "Deployment Fail Description",
"type": "object",
"additionalProperties": false,
"properties": {
"lineNumber": {
"description": "Line Number Fail to Execute Cmd",
"type": "integer"
},
"message": {
"description": "Status",
"type": "integer"
}
}
},
"startTime": {
"description": "Deployment begin datetime",
"type": "integer",
"format": "int64"
},
"endTime": {
"description": "Deployment end datetime",
"type": "integer",
"format": "int64"
}
}
}
}
}
}Retrieve Configuration History List ¶
GET/v9_1/configurationHistory
Use this API command to Retrieve Configuration History List.
Response
200Body
{
"totalCount": 13,
"hasMore": false,
"firstIndex": 80,
"list": [
{
"id": "07b13abd-9962-4f2a-9ae1-4d292bc2417d",
"transactionId": "6136a2a4-e15a-4d8f-8ffa-6e9078252275",
"groupId": "55c3db90-a5ca-428a-9bd6-eeb79c58817c",
"nodeId": "0bbfb272-9aae-4081-9c47-8125acfd8f86",
"nodeName": "node-1",
"modelFamily": "ICX7250",
"yang": "",
"configType": "MODEL",
"deployScope": "SWITCH",
"deployStatus": "STARTED",
"switchIds": "78:A6:E1:22:92:CC",
"summary": {
"success": 0,
"failed": 0,
"failedNoResponse": 0,
"failedSaveFlash": 0
},
"scheduled": 0,
"startTime": 1546425484248,
"endTime": 0
},
{
"id": "9609fd6b-c66d-4001-b152-3f2a18dd089e",
"transactionId": "1748c69c-e698-4d46-a2ab-79d8aa200e5c",
"groupId": "55c3db90-a5ca-428a-9bd6-eeb79c58817c",
"nodeId": "20d2cd72-1bf5-415b-9343-4d801b00e752",
"nodeName": "node-2",
"modelFamily": "ICX7250",
"yang": "",
"configType": "MODEL",
"deployScope": "SWITCH",
"deployStatus": "SUCCESS",
"switchIds": "78:A6:E1:22:92:CC",
"summary": {
"success": 1,
"failed": 0,
"failedNoResponse": 0,
"failedSaveFlash": 0
},
"scheduled": 0,
"startTime": 1546482080182,
"endTime": 1546482105038
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total records count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first config returned out of the complete list",
"type": "integer"
},
"list": {
"description": "The list of configs in this response",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID",
"type": "string"
},
"transactionId": {
"description": "Deploy Transaction ID",
"type": "string"
},
"groupId": {
"description": "Switch Group ID",
"type": "string"
},
"modelFamily": {
"description": "Switch Model Family",
"type": "string"
},
"yang": {
"description": "YANG Model",
"type": "string"
},
"configType": {
"description": "Config Type",
"type": "string",
"enum": [
"PROVISIONING",
"GLOBAL",
"AAA_SETTING",
"AAA_SERVER",
"COMMON",
"MODEL",
"SWITCH_SETTINGS",
"PORT_SETTINGS"
]
},
"deployScope": {
"description": "Deploy Scope",
"type": "string",
"enum": [
"PROVISION",
"GROUP",
"PORT",
"SWITCH"
]
},
"deployStatus": {
"description": "Deploy Status",
"type": "string",
"enum": [
"PENDING",
"STARTED",
"END"
]
},
"switchIds": {
"description": "Switch ID",
"type": "string"
},
"scheduled": {
"description": "Schedule",
"type": "integer",
"format": "int64"
},
"startTime": {
"description": "Deploy Start Time",
"type": "integer",
"format": "int64"
},
"endTime": {
"description": "Deploy End Time",
"type": "integer",
"format": "int64"
},
"summary": {
"description": "The Summary of the deployment status",
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Deployment Success Counter",
"type": "integer"
},
"failed": {
"description": "Deployment Fail Counter",
"type": "integer"
},
"failedNoResponse": {
"description": "Deployment Fail No Response Counter",
"type": "integer"
},
"failedSaveFlash": {
"description": "Deployment Fail to Save Flash",
"type": "integer"
}
}
},
"nodeId": {
"type": "string"
},
"nodeName": {
"type": "string"
}
}
}
}
}
}Query Configuration History Detail List ¶
POST/v9_1/configurationHistory/detail/query
Use this API command to Query Configuration History List.
Request
Body
{
"criteria": "",
"extraFilters": [
{
"type": "transactionId",
"value": "0216dd1a-cf48-4ca2-93b9-3fe75045ddcc"
}
],
"sortInfo": {
"sortColumn": "startTime",
"dir": "ASC"
},
"page": 1,
"limit": 80
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 80,
"list": [
{
"id": "32cf973d-8b6e-4a60-9777-5acb109f9fd0",
"transactionId": "d12c7062-b8d6-4ac7-8121-17ea541e4de6",
"switchId": "78:A6:E1:22:92:CC",
"switchName": "ICX7250-24P Router",
"serialNumber": "DUI3848N0JE",
"yang": "{\n "provision-configs": {\n "global-configs": {},\n "common-configs": {},\n "feature-configs": {\n "acls": {}\n }\n }\n}",
"clis": "\nno ip access-list STANDARD "dd"\n\r\n",
"dispatchStatus": "SUCCESS",
"dispatchFailedReason": {
"lineNumber": null,
"message": null
},
"startTime": 1546495848641,
"endTime": 1546495869452
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total records count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "integer"
},
"list": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Switch Deployment History Id",
"type": "string"
},
"transactionId": {
"description": "Transaction Id of depolyment",
"type": "string"
},
"switchName": {
"description": "Switch Name",
"type": "string"
},
"serialNumber": {
"description": "Serical Number of Switch",
"type": "string"
},
"switchId": {
"description": "Switch Id",
"type": "string"
},
"clis": {
"description": "CLI Command",
"type": "string"
},
"dispatchStatus": {
"description": "Status of Deployment",
"type": "string",
"enum": [
"PENDING",
"IN_PROGRESS",
"SUCCESS",
"FAILED"
]
},
"dispatchFailedReason": {
"description": "Deployment Fail Description",
"type": "object",
"additionalProperties": false,
"properties": {
"lineNumber": {
"description": "Line Number Fail to Execute Cmd",
"type": "integer"
},
"message": {
"description": "Status",
"type": "integer"
}
}
},
"startTime": {
"description": "Deployment begin datetime",
"type": "integer",
"format": "int64"
},
"endTime": {
"description": "Deployment end datetime",
"type": "integer",
"format": "int64"
}
}
}
}
}
}Query Configuration History List ¶
POST/v9_1/configurationHistory/query
Use this API command to Query Configuration History List.
Request
Body
{
"filters": [
{
"type": "SWITCH_GROUP",
"value": "21760608-d699-11e8-bf34-2c4d54448625"
}
],
"page": 1,
"limit": 8
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"enum": [
"SYSTEM",
"CATEGORY",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"BLADE",
"SYNCEDSTATUS",
"REGISTRATIONSTATE",
"STATUS",
"SWITCH_GROUP",
"FAMILY_ID",
"PORT",
"SWITCH_ID_PORT_IDENTIFIER"
],
"type": "string"
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"SWITCH_GROUP",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"transactionId",
"hasLayerThreeConfig",
"clientAuthType",
"clientIpv4Addr",
"clientIpv6Addr",
"clientMac",
"clientUserName",
"switchName",
"ADMIN_STATUS",
"PORT_STATUS",
"POE_ENABLED"
],
"type": "string"
},
"value": {
"description": "Value to search",
"type": "string"
},
"operator": {
"description": "Operator",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
}
}
},
"extraNotFilters": {
"description": "\"NOT\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"enum": [
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"ProtocolType",
"TIMERANGE",
"RADIOID",
"WLANID",
"CATEGORY",
"CLIENT",
"CP",
"DP",
"CLUSTER",
"NODE",
"BLADE",
"SYNCEDSTATUS",
"OSTYPE",
"APP",
"PORT",
"STATUS",
"REGISTRATIONSTATE",
"GATEWAY",
"APIPADDRESS",
"CLIENTIPADDRESS",
"SEVERITY",
"ACKNOWLEDGED",
"MVNOID",
"USER",
"USERID",
"WLANNAME",
"AUDITIPADDRESS",
"AUDITUSERUUID",
"AUDITOBJECT",
"AUDITACTION",
"AUDITTENANTUUID",
"AUDITOBJECTUUID",
"AUTHTYPE",
"AUDITTYPE",
"H20SuppportEnabled",
"AaaSuppportEnabled",
"GppSuppportEnabled",
"Type",
"RogueMac",
"SSID",
"ALARMSTATE",
"DEVICENAME",
"SWITCH",
"ZoneAffinityProfileId",
"FIRMWARE_TYPE",
"SCHEDULED_TIME",
"VLAN",
"FAMILY_ID",
"SWITCH_ID",
"switchStatus.alerts",
"switchStatus.status",
"transactionId",
"hasLayerThreeConfig"
],
"type": "string"
},
"value": {
"description": "Value not to search",
"type": "string"
}
}
}
},
"options": {
"description": "Specified feature required informaion",
"type": "object",
"additionalProperties": false,
"properties": {
"auth_includeNa": {
"description": "Include Not Available auth service option while returning result",
"type": "boolean"
},
"auth_includeLocalDb": {
"description": "Include LocalDB auth service while returning result",
"type": "boolean"
},
"auth_includeGuest": {
"description": "Include Guest auth service while returning result",
"type": "boolean"
},
"auth_includeAdGlobal": {
"description": "If AD is in list, include only AD with Global Catalog configured",
"type": "boolean"
},
"auth_type": {
"description": "Authentication service types to get, use comma to separate, Ex: RADIUS,AD",
"type": "string"
},
"auth_realmType": {
"description": "To get specific authentication service information for configuring realm based authentication profile",
"enum": [
"ALL",
"RADIUS"
],
"type": "string"
},
"acct_type": {
"description": "Accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
"type": "string"
},
"auth_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_testableOnly": {
"description": "Only get testable service type",
"type": "boolean"
},
"acct_includeNa": {
"description": "Include Not Available acct service option while returning result",
"type": "boolean"
},
"forwarding_type": {
"description": "Forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
"type": "string"
},
"includeSharedResources": {
"description": "Whether to include the resources of parent domain or not",
"type": "boolean"
},
"INCLUDE_RBAC_METADATA": {
"description": "Whether to include RBAC metadata or not",
"type": "boolean"
},
"TENANT_ID": {
"description": "Specify Tenant ID for query",
"type": "string"
},
"inMap": {
"description": "Specify inMap status for query",
"type": "boolean"
},
"globalFilterId": {
"description": "Specify GlobalFilter ID for query",
"type": "string"
},
"auth_hostedAaaSupportedEnabled": {
"description": "Indicate if Hosted AAA Support is enabled",
"type": "boolean"
},
"auth_plmnIdentifierEnabled": {
"description": "Indicate if Configure PLMN identifier is enabled",
"type": "boolean"
},
"includeUsers": {
"description": "Should also retrieve users or not",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"enum": [
"insertionTime"
],
"type": "string"
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}Response
200Body
{
"totalCount": 13,
"hasMore": false,
"firstIndex": 80,
"list": [
{
"id": "07b13abd-9962-4f2a-9ae1-4d292bc2417d",
"transactionId": "6136a2a4-e15a-4d8f-8ffa-6e9078252275",
"groupId": "55c3db90-a5ca-428a-9bd6-eeb79c58817c",
"nodeId": "0bbfb272-9aae-4081-9c47-8125acfd8f86",
"nodeName": "node-1",
"modelFamily": "ICX7250",
"yang": "",
"configType": "MODEL",
"deployScope": "SWITCH",
"deployStatus": "STARTED",
"switchIds": "78:A6:E1:22:92:CC",
"summary": {
"success": 0,
"failed": 0,
"failedNoResponse": 0,
"failedSaveFlash": 0
},
"scheduled": 0,
"startTime": 1546425484248,
"endTime": 0
},
{
"id": "9609fd6b-c66d-4001-b152-3f2a18dd089e",
"transactionId": "1748c69c-e698-4d46-a2ab-79d8aa200e5c",
"groupId": "55c3db90-a5ca-428a-9bd6-eeb79c58817c",
"nodeId": "20d2cd72-1bf5-415b-9343-4d801b00e752",
"nodeName": "node-2",
"modelFamily": "ICX7250",
"yang": "",
"configType": "MODEL",
"deployScope": "SWITCH",
"deployStatus": "SUCCESS",
"switchIds": "78:A6:E1:22:92:CC",
"summary": {
"success": 1,
"failed": 0,
"failedNoResponse": 0,
"failedSaveFlash": 0
},
"scheduled": 0,
"startTime": 1546482080182,
"endTime": 1546482105038
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total records count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first config returned out of the complete list",
"type": "integer"
},
"list": {
"description": "The list of configs in this response",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID",
"type": "string"
},
"transactionId": {
"description": "Deploy Transaction ID",
"type": "string"
},
"groupId": {
"description": "Switch Group ID",
"type": "string"
},
"modelFamily": {
"description": "Switch Model Family",
"type": "string"
},
"yang": {
"description": "YANG Model",
"type": "string"
},
"configType": {
"description": "Config Type",
"type": "string",
"enum": [
"PROVISIONING",
"GLOBAL",
"AAA_SETTING",
"AAA_SERVER",
"COMMON",
"MODEL",
"SWITCH_SETTINGS",
"PORT_SETTINGS"
]
},
"deployScope": {
"description": "Deploy Scope",
"type": "string",
"enum": [
"PROVISION",
"GROUP",
"PORT",
"SWITCH"
]
},
"deployStatus": {
"description": "Deploy Status",
"type": "string",
"enum": [
"PENDING",
"STARTED",
"END"
]
},
"switchIds": {
"description": "Switch ID",
"type": "string"
},
"scheduled": {
"description": "Schedule",
"type": "integer",
"format": "int64"
},
"startTime": {
"description": "Deploy Start Time",
"type": "integer",
"format": "int64"
},
"endTime": {
"description": "Deploy End Time",
"type": "integer",
"format": "int64"
},
"summary": {
"description": "The Summary of the deployment status",
"type": "object",
"additionalProperties": false,
"properties": {
"success": {
"description": "Deployment Success Counter",
"type": "integer"
},
"failed": {
"description": "Deployment Fail Counter",
"type": "integer"
},
"failedNoResponse": {
"description": "Deployment Fail No Response Counter",
"type": "integer"
},
"failedSaveFlash": {
"description": "Deployment Fail to Save Flash",
"type": "integer"
}
}
},
"nodeId": {
"type": "string"
},
"nodeName": {
"type": "string"
}
}
}
}
}
}Switch Configuration Clone ¶
Get Switch Config ¶
POST/v9_1/cloneConfiguration
Use this API command to Get Switch Config.
Request
Body
{
"source": "faa4e1a6-6c60-4354-aad5-6edc16cc9322",
"id": "7f74e396-e78f-429b-942c-b88d14d5a9ac"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID",
"type": "string"
},
"source": {
"description": "Source",
"type": "string"
}
}
}Response
200Clone Switch Group Config ¶
POST/v9_1/cloneConfiguration/byGroup
Use this API command to Clone Switch Group Config.
Request
Body
{
"source": "faa4e1a6-6c60-4354-aad5-6edc16cc9322",
"destination": [
"7f74e396-e78f-429b-942c-b88d14d5a9ac"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"source": {
"description": "Source",
"type": "string"
},
"destination": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Response
201Clone Switch Config ¶
PUT/v9_1/cloneConfiguration
Use this API command to Clone Switch Config.
Request
Body
{
"config": "config terminal",
"source": "faa4e1a6-6c60-4354-aad5-6edc16cc9322",
"destination": [
"7f74e396-e78f-429b-942c-b88d14d5a9ac"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"config": {
"description": "Config",
"type": "string"
},
"source": {
"description": "Source",
"type": "string"
},
"destination": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Response
200Switch Port Capacity ¶
Retrieve Switch Port Capacity List ¶
GET/v9_1/portCapacity
Use this API command to Retrieve Switch Port Capacity List.
Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 8,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"capacity": "AUTO"
},
{
"capacity": "10-FULL"
},
{
"capacity": "10-HALF"
},
{
"capacity": "100-HALF"
},
{
"capacity": "100-FULL"
},
{
"capacity": "1000-FULL"
},
{
"capacity": "1000-FULL-MASTER"
},
{
"capacity": "1000-FULL-SLAVE"
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "Total Data Count",
"type": "integer"
},
"totalCount": {
"description": "Total Data Count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of remaining data",
"type": "boolean"
},
"firstIndex": {
"description": "The first data index for current reulst",
"type": "integer"
},
"extra": {
"description": "Extra field",
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"capacity": {
"description": "Port Speed Capacity",
"type": "string"
}
}
}
}
}
}Switch Syslog Servers ¶
Retrieve Syslog Server ¶
GET/v9_1/group/{groupId}/syslogServers
Use this API command to get Syslog servers.
Response
200Body
{
"rawDataTotalCount": 0,
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "0a3737fc-8bfe-4033-af93-9fa27b06d2c5",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"createdTime": 1536112813463,
"updatedTime": 1536113453001,
"ip": "1.1.1.1",
"udpPort": 122,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"updaterUsername": "admin",
"updaterId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
},
{
"id": "45ec73e7-0a2c-4222-957c-c9fe40119727",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"createdTime": 1536112849565,
"updatedTime": 1536113453123,
"ip": "3.3.3.3",
"udpPort": 5566,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"updaterUsername": "admin",
"updaterId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
],
"extra": {}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"type": "integer"
},
"totalCount": {
"description": "Total records count in this response",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Indicator of whether there are more configs after the current displayed list",
"type": "integer"
},
"extra": {
"type": "object"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"createdTime": {
"type": "integer"
},
"updatedTime": {
"type": "integer"
},
"ip": {
"type": "string"
},
"udpPort": {
"type": "integer"
},
"creatorUsername": {
"type": "string"
},
"creatorId": {
"type": "string"
},
"updaterUsername": {
"type": "string"
},
"updaterId": {
"type": "string"
},
"groupId": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
}
}Create Syslog Server ¶
POST/v9_1/group/{groupId}/syslogServers
Use this API command to create a new Syslog server.
Request
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"type": "string"
},
"udpPort": {
"type": "integer"
}
}
}Response
200Body
{
"id": "8945d8e9-028d-4013-b474-d489c05a2d06"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Update Syslog Server ¶
PUT/v9_1/group/{groupId}/syslogServers/{id}
Use this API command to update a Syslog server.
Request
Body
{
"id": "8945d8e9-028d-4013-b474-d489c05a2d06",
"groupId": "9f43c198-50ae-4079-b973-5fe722e2752f",
"createdTime": 1536114677061,
"updatedTime": 1534225505,
"ip": "4.4.4.4",
"udpPort": 5566,
"creatorUsername": "admin",
"creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"updaterUsername": "admin",
"updaterId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"createdTime": {
"type": "integer"
},
"updatedTime": {
"type": "integer"
},
"ip": {
"type": "string"
},
"udpPort": {
"type": "integer"
},
"creatorUsername": {
"type": "string"
},
"creatorId": {
"type": "string"
},
"updaterUsername": {
"type": "string"
},
"updaterId": {
"type": "string"
},
"groupId": {
"type": "string"
},
"id": {
"type": "string"
}
}
}Response
204