API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read NAE agents

Configure and Manage Network Analytics Engine (NAE) agents.
Network Analytics Engine (NAE) is a troubleshooting solution that monitors switch database resources
and executes operations when monitor conditions are met.
NAE Agent is a running instance of an NAE script that acts as a template for agent creation.
When a new agent is created, all monitors specified in the script become active and alerts are
generated when conditions are met. Each agent:

  • References an existing NAE script as its template
  • Can have custom parameter values specific to this agent instance
  • Monitors data every 5 seconds and generates alerts when conditions are satisfied
  • Can be temporarily disabled to stop monitoring without deleting the configuration
  • Operates independently, allowing multiple agents from the same script with different parameters
    Agents provide real-time network analytics and automated troubleshooting capabilities.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

LIBRARY - Returns shared objects in library. For LIBRARY, all other parameters listed below, except 'detailed' , will be ignored. LOCAL - Returns configurations for a scope and one or more device function based on parameters below.

string

Retrieves LOCAL or SHARED or both(default) configuration objects.

string

Configuration at a given scope. Mandatory for view-type = LOCAL.

string

Filters configuration specific to given device-function type. If not provided and view_type = LOCAL, then defaults to all device-function's.

boolean

True - Returns effective configuration (i.e hierarchically merged configuration). False - Returns committed configuration at a given scope.

boolean

True - Includes annotations in the returned json to indicate the type of object, scope, and device function. False - Returns only config objects without annotations.

integer

Limit for pagination.

integer

Offset for pagination.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json