Back to top

Switch Manager

Switch Manager APIs

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.1 v6_0 v6_1 v7_0 v8_0

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.

Open API document

Open API document is based on OAS 2.0 and is now a POC program, Please try it for free, click the link for the detail. You can get the usage at https://swagger.io/, use the Swagger tools to meet your needs.

Switch Configuration

Retrieve Configuration Backup Content

GET/v8_0/switchconfig/{configId}

Use this API command to retrieve configuration backup content.

Response  200

Download Configuration Backup Content

GET/v8_0/switchconfig/download/{configId}

Use this API command to download configuration backup content as plain text.

Response  200

Delete Config Backup

DELETE/v8_0/switchconfig/{configId}

Use this API command to delete the configuration backup.

Response  204

Delete Config Backups

DELETE/v8_0/switchconfig

Use this API command to delete config backups by a list of config backup id.

Request
HideShow
Body
[
  "844db453-2112-42ad-b6eb-6bf5a0fd987b",
  "69acdc88-ab7c-4007-9301-91df234bb185"
]
Schema
{
  "type": "array",
  "items": {
    "description": "Config backup id",
    "type": "string"
  }
}
Response  204

Get Config Backup List

POST/v8_0/switchconfig

Use this API command to retrieve configuration backup list with specified filters.

Response  200
HideShow
Body
{
  "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"
            }
          }
        }
      }
    },
    "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"
          },
          "restoreStatus": {
            "description": "Status of config restore",
            "type": "string"
          },
          "restoreTimestamp": {
            "description": "the timestamp of the config restore",
            "type": "integer"
          },
          "failureReason": {
            "description": "Failure reason of the config backup and config restore",
            "type": "string"
          }
        }
      }
    }
  }
}

Backup 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
HideShow
Body
[
  "CC:4E:24:8B:5C:30",
  "CC:4E:24:8B:19:D8"
]
Schema
{
  "type": "array",
  "items": {
    "description": "Switch id",
    "type": "string"
  }
}
Response  204

Backup Configuration for Switches

POST/v8_0/switchconfig/backup

Use this API command to backup configuration for a list of switches.

Request
HideShow
Body
[
  "CC:4E:24:8B:5C:30",
  "CC:4E:24:8B:19:D8"
]
Schema
{
  "type": "array",
  "items": {
    "description": "Switch id",
    "type": "string"
  }
}
Response  201
HideShow
Body
{
  "rawDataTotalCount": 0,
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "configBackupId": "b3921397-d6e9-4877-befc-2bcbf65158e7",
      "switchId": "CC:4E:24:8B:5C:30"
    },
    {
      "configBackupId": "ca074b14-f54a-424a-9074-19ee3597d951",
      "switchId": "CC:4E:24:8B:19:D8"
    }
  ],
  "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"
            }
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "configBackupId": {
            "description": "Identifier of config backup",
            "type": "string"
          },
          "switchId": {
            "description": "Identifier of switch",
            "type": "string"
          }
        }
      }
    }
  }
}

Backup Configurations for a Group

PUT/v8_0/switchconfig/{groupType}/{groupId}/backup

Use this API command to backup configurations for all switches under a group.

Response  204

Restore Configuration

PUT/v8_0/switchconfig/backup/{backupId}/restore

Restore a configuration backup to the switch.

Response  200

Diff between two Config Backup Files

POST/v8_0/switchconfig/backup/diff

Use this API command to diff between two config back up files for a switch.

Request
HideShow
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  200
HideShow
Body
{
  "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"
        }
      }
    }
  }
}

Switch Firmware

Upload Firmware Image

POST/v8_0/firmware/upload

Use this API command to upload a firmware image zip file to SmartZone.

Response  200

Delete Firmware

DELETE/v8_0/firmware/{version}

Use this API command to deletes a firmware image file from SmartZone.

Response  200

List Firmwares

POST/v8_0/firmware

Use this API command to retrieve list of switch firmwares uploaded to SmartZone.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

List Firmwares

GET/v8_0/firmware

Use this API command to retrieve list of switch firmwares uploaded to SmartZone.

Response  200
HideShow
Body
{
  "rawDataTotalCount": 0,
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "version": "B254",
      "switchModels": [
        {
          "name": "ICX7650",
          "imageFileNames": [
            "TNS08080b254ufi.bin",
            "TNR08080b254ufi.bin"
          ]
        },
        {
          "name": "ICX7250",
          "imageFileNames": [
            "SPS08080b254ufi.bin",
            "SPR08080b254ufi.bin"
          ]
        },
        {
          "name": "ICX7450",
          "imageFileNames": [
            "SPS08080b254ufi.bin",
            "SPR08080b254ufi.bin"
          ]
        },
        {
          "name": "ICX7150",
          "imageFileNames": [
            "SPS08080b254ufi.bin",
            "SPR08080b254ufi.bin"
          ]
        },
        {
          "name": "ICX7750",
          "imageFileNames": [
            "SWS08080b254ufi.bin",
            "SWR08080b254ufi.bin"
          ]
        }
      ]
    },
    {
      "version": "B207",
      "switchModels": [
        {
          "name": "ICX7650",
          "imageFileNames": [
            "TNR08080b207ufi.bin",
            "TNS08080b207ufi.bin"
          ]
        },
        {
          "name": "ICX7250",
          "imageFileNames": [
            "SPR08080b207ufi.bin",
            "SPS08080b207ufi.bin"
          ]
        },
        {
          "name": "ICX7450",
          "imageFileNames": [
            "SPR08080b207ufi.bin",
            "SPS08080b207ufi.bin"
          ]
        },
        {
          "name": "ICX7150",
          "imageFileNames": [
            "SPR08080b207ufi.bin",
            "SPS08080b207ufi.bin"
          ]
        },
        {
          "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/v8_0/firmware/{version}

Use this API command to update the given firmware version on switches matching criteria.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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 Health Status

POST/v8_0/health/status

Use this API command to retrieve switch health status.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Schema
{
  "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": {
          "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"
          }
        }
      }
    },
    "fan": {
      "description": "Fan",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "slotNumber": {
            "description": "Fan slot number",
            "type": "integer"
          },
          "type": {
            "description": "Fan type",
            "type": "string"
          },
          "status": {
            "description": "Fan status",
            "type": "string"
          }
        }
      }
    }
  }
}

Hardware Status

POST/v8_0/health/status/all

Use this API command to retrieve fan, temperature and power supply status for the switch managed by SmartZone.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Schema
{
  "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": {
          "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"
          }
        }
      }
    },
    "fan": {
      "description": "Fan",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "slotNumber": {
            "description": "Fan slot number",
            "type": "integer"
          },
          "type": {
            "description": "Fan type",
            "type": "string"
          },
          "status": {
            "description": "Fan status",
            "type": "string"
          }
        }
      }
    }
  }
}

CPU Trend

POST/v8_0/health/cpu/line

Use this API command to retrieve CPU trend data based on the time duration.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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/v8_0/health/mem/line

Use this API command to retrieve switch memory trend data based on the time duration.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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/v8_0/health/cpu/agg

Use this API command to retrieve aggregated CPU (min, max, avg, curr) data based on the time duration.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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/v8_0/health/mem/agg

Use this API command to retrieve aggregated CPU (min, max, avg, curr) data based on the time duration.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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 Stack

Get Stack Members

GET/v8_0/stack/member/{switchId}

Use this API command to retrieve the member of switches in a stack.

Response  200
HideShow
Schema
{
  "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"
          },
          "switchModule": {
            "description": "Switch module of stack",
            "type": "string"
          },
          "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"
                }
              }
            }
          }
        }
      }
    }
  }
}

Switch

List Switches

POST/v8_0/switch

Use this API command to retrieve all the switches currently managed by SmartZone.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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",
      "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",
      "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",
      "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",
      "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"
            }
          }
        }
      }
    },
    "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"
          },
          "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"
          },
          "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"
          },
          "lastRestoreTime": {
            "description": "Last config restore time of switch",
            "type": "integer"
          },
          "lastBackupStatus": {
            "description": "Last config backup status of switch",
            "enum": [
              "STARTED",
              "SUCCESS",
              "FAILED"
            ]
          },
          "lastRestoreStatus": {
            "description": "Last config restore status of switch",
            "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"
              }
            }
          }
        }
      }
    }
  }
}

List SNMP Synced Switches

POST/v8_0/switch/snmpSyncedSwitch

Use this API command to retrieve all the switches currently managed by SmartZone and SNMP synced.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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",
      "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",
      "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",
      "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",
      "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"
            }
          }
        }
      }
    },
    "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"
          },
          "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"
          },
          "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"
          },
          "lastRestoreTime": {
            "description": "Last config restore time of switch",
            "type": "integer"
          },
          "lastBackupStatus": {
            "description": "Last config backup status of switch",
            "enum": [
              "STARTED",
              "SUCCESS",
              "FAILED"
            ]
          },
          "lastRestoreStatus": {
            "description": "Last config restore status of switch",
            "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"
              }
            }
          }
        }
      }
    }
  }
}

Export switches to CSV format

POST/v8_0/switch/exportcsv

Use this API command to retrieve all the switches currently managed by SmartZone.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200

Delete Switch

DELETE/v8_0/switch/{id}

Use this API command to delete a switch managed by SmartZone.

Response  200
HideShow
Body
{
  "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/v8_0/switch

Use this API command to delete multiple switches managed by SmartZone

Request
HideShow
Body
[
  "18:A0:12:32:00:01",
  "18:A0:12:32:00:00"
]
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}
Response  200
HideShow
Schema
{
  "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"
          }
        }
      }
    }
  }
}

Get Switch

GET/v8_0/switch/{id}

Use this API command to retrieve a switch status.

Response  200
HideShow
Body
{
  "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",
  "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"
    },
    "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"
    },
    "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"
    },
    "lastRestoreTime": {
      "description": "Last config restore time of switch",
      "type": "integer"
    },
    "lastBackupStatus": {
      "description": "Last config backup status of switch",
      "enum": [
        "STARTED",
        "SUCCESS",
        "FAILED"
      ]
    },
    "lastRestoreStatus": {
      "description": "Last config restore status of switch",
      "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"
        }
      }
    }
  }
}

Move to Switch Group

PUT/v8_0/switch/move/{destinationSwitchGroupId}

Use this API command to move a list of switches to a switch group.

Request
HideShow
Body
[
  "18:A0:12:32:00:01",
  "18:A0:12:32:00:00"
]
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}
Response  200

Retrieve Switch & Port Details

POST/v8_0/switch/view/details

Use this API command to retrieve switch and port details for the selected Switch/SwitchGroup/Domain.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Schema
{
  "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": {
            "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"
              },
              "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"
                  },
                  "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"
              }
            }
          }
        }
      }
    }
  }
}

Get Switch Firmware Update History

GET/v8_0/switch/{switchId}/firmware

Use this API command to get a list of firmware update history.

Response  200
HideShow
Schema
{
  "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"
          }
        }
      }
    }
  }
}

Switch Group

Create Switch Group

POST/v8_0/group

Use this API command to create a new switch group under an existing domain or switch group.

Request
HideShow
Body
{
  "name": "SwitchGroup3",
  "description": "Switch Group 3 Description",
  "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"
    },
    "name": {
      "description": "Name of the switch group",
      "type": "string"
    },
    "description": {
      "description": "Description 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"
    }
  }
}
Response  201
HideShow
Body
{
  "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"
    }
  }
}

Get Switch Group

GET/v8_0/group/{switchGroupId}

Use this API command to retrieve switch group detail.

Response  200
HideShow
Body
{
  "id": "0e4ac34b-9472-44bd-9d3b-9ea621adee4b",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "creatorId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "tenantId": "",
  "switchGroupLevelOneId": "",
  "switchGroupLevelTwoId": "",
  "createDatetime": 1529372796662,
  "name": "SwitchGroup3",
  "description": "Switch Group 3 Description",
  "sampledInstant": null,
  "levelTwo": false,
  "levelOne": true
}
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"
    },
    "name": {
      "description": "Name of the switch group",
      "type": "string"
    },
    "description": {
      "description": "Description 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"
    }
  }
}

Update Switch Group

PATCH/v8_0/group/{switchGroupId}

Use this API command to update an existing switch group name or description.

Request
HideShow
Body
{
  "name": "SwitchGroupUpdate3",
  "description": "Switch Group Update 3 Description"
}
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"
    },
    "name": {
      "description": "Name of the switch group",
      "type": "string"
    },
    "description": {
      "description": "Description 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"
    }
  }
}
Response  200
HideShow
Body
{
  "id": "0e4ac34b-9472-44bd-9d3b-9ea621adee4b",
  "name": "SwitchGroupUpdate3"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Audit Id",
      "type": "string"
    },
    "name": {
      "description": "Audit name",
      "type": "string"
    }
  }
}

Delete Switch Group

DELETE/v8_0/group/{switchGroupId}

Use this API command to delete a switch group.

Response  200
HideShow
Body
{
  "id": "0e4ac34b-9472-44bd-9d3b-9ea621adee4b",
  "name": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Audit Id",
      "type": "string"
    },
    "name": {
      "description": "Audit name",
      "type": "string"
    }
  }
}

Retrieve Switch Groups

GET/v8_0/group/ids/byDomain/{domainId}

Use this API command to retrieve the switch groups by domain ID.

Response  200
HideShow
Body
{
  "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"
    }
  }
}

Switch Ports

List Ports

POST/v8_0/switch/ports/details

Use this API command to retrieve all the switch ports and its details currently managed by SmartZone.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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 Gbits per second",
      "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"
          },
          "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"
              },
              "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/v8_0/switch/ports/summary

Use this API command to retrieve ports summary based on status, speed of a switch, currently managed by SmartZone.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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": {
        "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/v8_0/switch/clients

Use this API command to retrieve all the wired clients connected to switch, currently managed by SmartZone.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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",
      "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"
          },
          "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/v8_0/switch/clients/ap

Use this API command to retrieve all the Ruckus APs connected to switch, currently managed by SmartZone.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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"
          },
          "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"
          }
        }
      }
    }
  }
}

Top Reports

Top Switches by Firmware

POST/v8_0/switch/top/byFirmware

Use this API command to retrieves top N switch count based on firmware version.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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/v8_0/switch/top/byModel

Use this API command to retrieve top N switch count based on switch model.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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/v8_0/job/{jobId}

Use this API command to retrieve a given job.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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"
    },
    "modifiedTimestamp": {
      "description": "Modified timestamp of the job",
      "type": "integer"
    },
    "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": {}
    }
  }
}

List Jobs

POST/v8_0/job

Use this API command to retrieve a list of jobs.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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"
          },
          "modifiedTimestamp": {
            "description": "Modified timestamp of the job",
            "type": "integer"
          },
          "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/v8_0/job/schedule/{scheduleId}

Use this API command to retrieve a given schedule.

Response  200
HideShow
Body
{
  "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"
    }
  }
}

Delete Schedule

DELETE/v8_0/job/schedule

Use this API command to delete a selected schedule.

Response  200

Switch Registration Rules

Create Rule

POST/v8_0/registrationRules

Use this API command to create new switch registration rule.

Request
HideShow
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"
    },
    "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  201
HideShow
Body
{
  "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"
    }
  }
}

Delete Rule

DELETE/v8_0/registrationRules/{id}

Use this API command to delete a switch registration rule.

Response  200
HideShow
Body
{
  "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/v8_0/registrationRules

Use this API command to delete multiple switch registration rules.

Request
HideShow
Body
[
  "8c2d7d4a-2c06-42d5-874b-9537d58a0887",
  "4c846bec-07aa-4cf9-ad10-f35f565154df"
]
Schema
{
  "type": "array",
  "items": {
    "description": "registration rule UUID id",
    "type": "string"
  }
}
Response  200
HideShow
Schema
{
  "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"
              },
              "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"
    }
  }
}

List Rules

GET/v8_0/registrationRules

Use this API command to retrieves all the registration rules configured in SmartZone.

Response  200
HideShow
Body
{
  "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"
              },
              "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"
    }
  }
}

Update Rule

PUT/v8_0/registrationRules/{id}

Use this API command to modify the registration rule.

Request
HideShow
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"
    },
    "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  200
HideShow
Body
{
  "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"
    }
  }
}

Switch Traffic

Total Traffic Trend

POST/v8_0/traffic/total/trend

Use this API command to retrieve Swich/Port trend data based on the time duration.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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/v8_0/traffic/top/usage

Use this API command to retrieve Top Swich/Port usage data based on the time duration.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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 Error Switch

POST/v8_0/traffic/top/porterror

Use this API command to get the top 10 switches by the porterror.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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"
          }
        }
      }
    }
  }
}

Top Port Traffic Usage

POST/v8_0/traffic/top/portusage

Use this API command to get the top 10 ports by the traffic.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Body
{
  "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/v8_0/traffic/top/poeutilization

Use this API command retrieve the top 10 switches by the PoE utilization.

Request
HideShow
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"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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",
              "ZoneAffinityProfileId",
              "FIRMWARE_TYPE",
              "SCHEDULED_TIME",
              "VLAN"
            ]
          },
          "value": {
            "description": "Value to search",
            "type": "string"
          },
          "operator": {
            "description": "Operator",
            "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"
            ]
          },
          "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"
          ]
        },
        "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"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "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"
          ]
        }
      }
    },
    "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  200
HideShow
Schema
{
  "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"
          }
        }
      }
    }
  }
}

Generated by aglio on 16 Nov 2018