Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Fault and Monitoring API Elements and Sample Output Files

 

This topic provides the following sample API requests and associated output:

  • Resource utilization

  • Alarms and alarm count trend data

  • Port traffic trend data

  • Client sessions

Options on how to display the output are also provided. Options include viewing the output based on a range of pages (pagination) and the amount of detail (detail).

This topic provides the following information:

Managed Devices API Sample Output

All APIs require that you provide an accept header in the API request, otherwise the output data will be presented by default.

Here is an example of an API request, followed by sample output. The sample output is in JSON format:

Managed Devices API Sample Output Using Paging Option

You can use the paging option to apply filters on the output. For example, you can specify how many entries to display and from which entry in the output set. In this example, the API request specifies output for three entries, starting from the second entry.

Here is an example API request, followed by sample output. The sample output is in JSON format:

Managed Devices API Sample Output Using Detail Option

You can request detailed information for a device by using the query parameter in each device summary block.

Here is an example API request, followed by sample output. This sample output is in XML format.

Resource Utilization and Alarm Count Trending APIs Sample Output

Resource utilization and alarm count trend data are supported only on EX Series devices, Access Points, Wireless LAN Controllers, and QFabric systems.

Here is an example API request, followed by sample output. This sample output is in XML format.

Port APIs Sample Output

You can use port API requests to query managed ports for summary information for each port based on query parameters. If the query parameter value is omitted, summary information for all ports will be displayed.

Here is an example without any query parameters:

Output is not included.

You can use the paging option to apply filters on the output. For example, you can specify how many entries to display and from which entry in the output set. In this example, the API request specifies output for three entries, starting from the tenth entry.

Here is an example API request, followed by sample output. The sample output is in XML format:

Port APIs Sample Output Using Detail Option

You can request detailed information for a port by using the query parameter in each port summary block.

Here is an example API request, followed by sample output. The sample output is in XML format:

Port Traffic Trend Data APIs Sample Output

You can use Port traffic trend data API requests to query ports based on the port ID as well as the time range given by the parameters. You must provide either start time and end time of the query or the last number of hours.

Here is an example API request, followed by sample output. The sample output is in XML format:

Client Sessions APIs Sample Output

You can use the client sessions APIs to query client sessions based on search parameters, such as username, MAC address, IPv4 address, IPv6 address, and so on. If you do not specify a search parameter, an exception error is issued.

Here is an example API request, followed by sample output. The sample output is in XML format:

You can also search using partial search data:

Here is an example API request, followed by sample output. The sample output is in XML format:

Alarm APIs Sample Output

You can use alarm API requests to query alarms based on the query parameters. If you omit the query parameter, information for all alarms will be provided.

Here is an example API request, followed by sample output. The sample output is in XML format:

Alarm APIs Sample Output Using Detail Option

You can use alarm API requests to query alarms based on query parameters. If you omit the query parameter, information for all alarms will be provided.

Here is an example API request, followed by sample output. The sample output is in XML format: