Overview

Cisco Data Center Network Manager

Cisco Data Center Network Manager (Cisco DCNM) automates the infrastructure of Cisco Nexus 5000, 6000, 7000, and 9000 Series Switches and Cisco MDS 9000 Series switches. Cisco DCNM enables you to manage multiple devices, while providing ready-to-use capabilities, such as, control, automation, monitoring, visualization, and troubleshooting.


Note
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product.

Configuring the Device Connector is mandatory if you've deployed Cisco DCNM in LAN Fabric mode. If you did not configure Device Connector during installation, a message appears asking you to configure Device Connector everytime you login. If you check the Do not show again, the message will not appear. However, an alarm notification will be added under the Alarms icon.

The Cisco DCNM home page contains a navigation pane to the left, and shortcuts to a few Cisco DCNM features in the middle pane.

This guide provides comprehensive information about the UI functionality for Cisco DCNM SAN deployment.

The top pane displays the following UI elements:

  • Help: Launches the context-sensitive online help.

  • Search: Helps locate records according to the following search criteria:

    • Name

    • IP Address

    • WWN

    • Alias

    • MAC Address

    • Serial Number

  • User Role : Displays the role of the user who is currently logged in, for example, admin.

  • Gear icon: Click on the gear icon to see a drop-down list with the following options:

    • Logged in as: displays the user role of the current logged in user.

    • DCNM SAN & DM: Click to download the SAN Client and Device Manager setup. You can install FM Client and Device Manager for management.

      Your system Java cache remembers the older version of DCNM. Therefore, when you download the latest version on the DCNM SAN and DM, ensure that you clear the Java cache before launching the applications.

    • Change Password: Allows you to change the password for current logged in user.

      If you are a network administrator user, you can modify the passwords of the other users.

    • About: Displays the Version, Installation Type, and time since when the Web UI is operational.

    • REST API Tool: Allows you to examine the APIs invoked for every operation. See the REST API Tool section for more information about the API inspection.

    • Logout: Allows you to terminate the Web UI and returns to the login screen.

For more information about Cisco DCNM, see:

https://www.cisco.com/c/en/us/support/cloud-systems-management/data-center-network-manager-11/model.html.

REST API Tool

Operations like discovery, fabric management, monitoring, and so on, which are performed in Cisco DCNM Web UI, invoke HTTP calls to fetch and commit the information accessed. The REST API tool enables you to examine the API call by viewing the structure of an API call. This tool also provides a corresponding CURL request to help with building quick prototypes and testing APIs.

The REST API Tool dialog box has the following fields.

Table 1. Fields and Description for the REST API Tool Dialog Box

Field

Description

Filter

Enter any keyword to search the log.

scroll to new items

Check this check box to scroll to the new entries when you navigate back to the REST API Tool dialog box after you perform an operation in the Web UI.

This check box is checked by default.

clear log

Click clear log to clear the log in the dialog box.

API-docs

Click API-docs to view the Cisco DCNM REST API documentation in the Web UI. Clicking this option takes you to the following URL: https://DCNM-IP/api-docs

All actions you perform in the Cisco DCNM Web UI appear in the API inspector tool. The following information appears in the APIs invoked for every operation:

  • HTTP method

  • URI

  • Payload

  • HTTP status code

  • Time taken for the operation

The following image displays how the log appears in the REST API Tool dialog box.

Click the URI to expand or collapse each REST method. You can perform the following actions after expanding a REST method:

  • Prettify output: Click this option to arrange the response code in a more presentable way, which otherwise appears in a single line. Scroll through the response to view it completely.

  • Copy response: Click this option to copy the response code to your clipboard.

  • Copy CURL request: Click this option to copy the CURL request to your clipboard. 

    curl -k -XGET --header 'Dcnm-Token: <DCNM_TOKEN>' --header 'Content-Type: application/x-www-form-urlencoded' https://<ip-address>/fm/fmrest/dcnm/rbacNavigation/?uname=admin

The REST API Tool dialog box updates every time the Cisco DCNM Web UI updates.

To use the API inspector from the Cisco DCNM Web UI, perform the following steps:

Procedure

Step 1

Click the Gear icon in the top pane.

Step 2

Choose REST API Tool from the drop-down list.

The REST API Tool dialog box appears and the log is empty before you perform any operation in the Cisco DCNM Web UI.
Step 3

Minimize the REST API Tool dialog box.

Note 

You can also keep the dialog box open, but not close it.
Step 4

Perform an operation in the Cisco DCNM Web UI.

Note 

You can perform any operation in the Cisco DCNM Web UI like viewing any options, adding, deleting, and so on.
Step 5

Navigate back to the REST API Tool dialog box.

The log is populated with the REST APIs fetched depending on the operations you performed.

Note 

Closing the REST API Tool dialog box, instead of minimizing it before performing any operations, clears the log.

For a demo on some of the operations that can be performed using the REST API tool, see the Using REST API Tool in Cisco DCNM video.