Getting Started with UCS Manager

Documentation and Product Information

To begin, download the UCS XML API Programmer's Guide. This guide provides an overview of the UCS, the UCS management information model, the XML API, and contains numerous API examples.

UCS is certified as a platform for leading enterprise applications, virtualization, and operating systems. Cisco UCS Manager is fully interoperable with the major systems management tools commonly found in heterogeneous data centers.

Review the UCS XML API training video for a high level understanding of the API structure, methods and functionality. You can use the UCS Communities to ask and answer questions. You can also search the forums to see if your question was already raised. The UCS blog also contains much useful information provided by expert technical users.

UCS Platform Emulator

The UCS Platform Emulator (UCSPE) was developed to enable the use of Cisco UCS Manager and the UCS XML API without requiring physical hardware. UCSPE significantly shortens the development cycle for applications that are based on the UCS XML API. You can create and test programs using only UCSPE installed on a laptop. UCSPE presents a controlled environment for the following:

  • Emulation of large-scale environments
  • Changes in the hardware inventory (device discovery)
  • Firmware upgrade testing
  • Troubleshooting real UCS problems

UCSPE also assists developers to do the following:

  • Test UCS XML API requests in lieu of a real server
  • Invoke the UCS GUI to become familiar with its usage and features
  • Invoke the model object browser and internal documentation
  • Provide a convenient way to demonstrate UCS operations for training and other activities

Cisco UCS Platform Emulator is now available for download.

NOTE - Starting with UCSPE version 2.1, UCSPE is provided in both OVA and VMX / VMDK virtual machine format. The VMX / VMDK format has been tested and can be converted to use with Microsoft Hyper-V.
Third Party Tools For UCS XML Application Development

  • Wireshark is a network protocol analyzer that enables a developer to inspect network traffic. For UCS API development, inspecting the traffic going from and returning to the UCS Manager GUI greatly enhances a developers understanding of the UCS API XML messages.
  • Firefox Poster is a developer tool for interacting with web services and other web resources that lets you make HTTP requests, set the entity body, and content type. Poster aids developers using UCS API by alleviating the need to create a language dependent HTTP/HTTPS client.
  • Third party tools documentation provides explanations and examples of how to use Wireshark and Poster with the UCS API.
Sample XML