Information About the Cisco Nexus 1000V REST API
The REST API supports retrieving system information from the Cisco Nexus 1000V.
You can read an object on the Cisco Nexus 1000V Virtual Supervisor Module (VSM) using the Representational State Transfer (REST) web services API. In order to call any REST function, you can use tools such as a web browser, the cURL tool, and Windows PowerShell.
The following is the basic construct of a REST URL:
http[s]://<IP_address>/api/<resource locator>
The resource locator consists of two parts:
<resource locator> := <name space>/<resource name>
<name space> indicates the broader class of functions and <resource name> refers to the specific object.
For example, in the following URL:
http://10.10.10.2/api/n1k/license
n1k is the namespace and license is the resource name.
If you are using a browser, type in the URL. For example, if you want to get the license information of your VSM that has an IP address of 10.10.10.2, you type the URL as follows:
https://10.10.10.2/api/n1k/license
The browser prompts you for a username and a password and returns the HTML output.
To access the same through cURL, you use the following format:
curl http://username:password@10.10.10.2/api/n1k/license
You get the following XML output:
<set name="license_set">
<instance name="NEXUS_VSG_SERVICES_PKG" url="/api/n1k/license">
<properties>
<expires>04 May 2013</expires>
<type>NEXUS_VSG_SERVICES_PKG</type>
<available>512</available>
<status>Unused</status>
<used>0</used>
</properties>
</instance>
<instance name="NEXUS_ASA1000V_SERVICES_PKG" url="/api/n1k/license">
<properties>
<expires>04 May 2013</expires>
<type>NEXUS_ASA1000V_SERVICES_PKG</type>
<available>16</available>
<status>Unused</status>
<used>0</used>
</properties>
</instance>
<instance name="NEXUS1000V_LAN_SERVICES_PKG" url="/api/n1k/license">
<properties>
<expires>04 May 2013</expires>
<type>NEXUS1000V_LAN_SERVICES_PKG</type>
<available>1024</available>
<status>Unused</status>
<used>0</used>
</properties>
</instance>
</set>