Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Fault and Monitoring APIs

The fault and monitoring APIs provide monitoring information, alarm notifications, and client information.

Network Director management APIs are a set of Representational State Transfer (REST) APIs that enable network management functions, including:

  • Exporting monitoring and fault data for location, logical, and virtualization hierarchy to a third party management system

  • Providing client data regarding location, equipment, and domains, as well information for wireless connected and unconnected clients

  • Using notification profiles for forwarding events for alarms relating to all categories and severities

  • Querying alarm history and filters based on time, type, and severity

  • Allowing clients to specify host and NIC (network interface card) information

This topic describes:

Monitoring APIs

Monitoring APIs provide inventory information for managed devices in the network in both summarized and detailed levels. At the detailed level, the APIs provide data about the device’s operational and environmental status, as well as the operational status of ports on the devices.

The monitoring APIs provide the following types of device information:

  • Junos devices

  • QFabric systems

  • Virtual Chassis

  • Wireless LAN controllers

  • Access points

  • Radios

  • Power supplies

  • Fans

  • Ports

  • Virtual machines (VMs)

See the Network Director API reference documentation for more details regarding specific APIs.

Client APIs

Client APIs provide information about wired and wireless clients and sessions on the network. A client is any device that is connected to the network through a wireless access point or through an access port on a switch that is an 802.1X authenticator port. Examples of clients include VoIP phones, laptops, printers, security cameras, and so on. Examples of session information includes number of sessions, session activity, information about each client, such as MAC address, IP address, username, client VLAN, port or wireless access point to which client is connected to, and so on.

See the Network Director API reference documentation for more details regarding specific APIs.

Alarm APIs

Network Director alarm APIs collect SNMP notifications and system alerts from devices and systems that are monitored. Depending on the notification or alert, an alarm is triggered. Client applications are required to receive alarms that are forwarded. The client application must use the same login credential as the one used for Network Director UI.

The alarm APIs provide the following types of alarm information:

  • Name of alarm

  • ID number of alarm

  • Alarm type

  • Category of alarm

  • Severity of alarm

  • State of alarm

  • Acknowlegment of alarm

  • Entity ID of alarm

  • Source address of device that triggered alarm

  • Date and time when alarm was created and updated

  • Party that updated alarm

See the Network Director API reference documentation for more details regarding specific APIs.