Introduction
Cisco Nexus Dashboard is a central management console for multiple data center sites and a common platform for hosting Cisco data center operation applications, such as Nexus Dashboard Insights and Nexus Dashboard Orchestrator. These applications are universally available for all the data center sites and provide real time analytics, visibility, and assurance for network policies and operations. Cisco Nexus Dashboard Orchestrator can also run on Nexus Dashboard as a hosted app.
Nexus Dashboard provides a common platform and modern technology stack for these micro-services-based applications, simplifying the life cycle management of the different modern applications and reducing the operational overhead to run and maintain these applications. It also provides a central integration point for external 3rd party applications with the locally hosted applications.
Nexus Dashboard API
The Nexus Dashboard REST API is a programmatic interface that uses REST architecture. The API accepts and returns HTTP or HTTPS messages that contain JavaScript Object Notation (JSON) payloads. You can use any programming language to generate the messages and the JSON that contain the API methods or Managed Object (MO) descriptions.
The REST API is also used by the GUIs of the Nexus Dashboard and the services running on it. So that whenever information is displayed, it is read through the REST API; and when configuration changes are made, they are written through the REST API.
This release of Nexus Dashboard provides only the authentication APIs for the platform in order to enable API access for the Nexus Dashboard Insights service.
Future releases will provide additional APIs for the Nexus Dashboard and other services hosted on the platform.
Nexus Dashboard Services APIs
The Nexus Dashboard Services APIs provide programmatic interfaces for the specific services running in your Nexus Dashboard.
If multiple different releases of the same service, which have different API versions, are supported on the same release of Nexus Dashboard, they will be included separately in the navigation menu.
Release of Nexus Dashboard, Release 2.1.1 integrates complete APIs for the Nexus Dashboard platform and Nexus Dashboard Insights service only. Nexus Dashboard, Release 2.1.2 adds support for the Nexus Dashboard Fabric Controller and Orchestrator services. All supported APIs are available from the navigation menu on the left; for the full list of changes between 2.1.x releases, see What's New.
Compatiblity
Not every version of a Nexus Dashboard service is supported on every version of the Nexus Dashboard platform. The following two tools provide full compatibility information related to the specific combinations of services' releases and platform releases as well as available co-hosting use cases:
Nexus Dashboard Capacity Planning -- provides information on cohosting services and cluster sizing.
Nexus Dashboard and Services Compatibility Matrix -- provides compatibility information for specific platform and service releases combinations.