Cisco UCS Platform Emulator GuideApril 21, 2010Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USA 408 526-4000800 553-NETS (6387)Fax: 408 527-0883

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALLSTATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUTWARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THATSHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSEOR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s publicdomain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITHALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUTLIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OFDEALING, USAGE, OR TRADE PRACTICE.IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCOOR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.CCDE, CCENT, CCSI, Cisco Eos, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase, Cisco StackPower,Cisco StadiumVision, Cisco TelePresence, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip Mino, Flipshare (Design), Flip Ultra,Flip Video, Flip Video (Design), Instant Broadband, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn, Cisco Capital,Cisco Capital (Design), Cisco:Financed (Stylized), Cisco Store, Flip Gift Card, and One Million Acts of Green are service marks; and Access Registrar, Aironet, AllTouch,AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo,Cisco IOS, Cisco Lumin, Cisco Nexus, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation,Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Follow Me Browsing, GainMaker, iLYNX, IOS, iPhone, IronPort, the IronPort logo, Laser Link, LightStream,Linksys, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, PCNow, PIX, PowerKEY, PowerPanels, PowerTV, PowerTV (Design),PowerVu, Prisma, ProConnect, ROSA, SenderBase, SMARTnet, Spectrum Expert, StackWise, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc.and/or its affiliates in the United States and certain other countries.All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationshipbetween Cisco and any other company. (0910R)Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command displayoutput, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers inillustrative content is unintentional and coincidental.Cisco UCS Platform Emulator Guide 2010 Cisco Systems, Inc. All rights reserved.

CONTENTSPrefacevAudiencevOrganizationvUCS Developers Support and User CommunityRelated DocumentationviDocumentation FeedbackCHAPTER1vCisco UCS Platform Emulatorvi1-1About Cisco UCS Platform Emulator1-1Installing the UCS Platform Emulator 1-2Installation Prerequisites 1-2UCS Platform Emulator Virtual Machine PackagingStart UCSPE 1-3UCSPE Configuration Menu 1-3Connecting to UCS Manager Facilities 1-4Ending a UCSPE Session 1-4UCS Platform Emulator Limitations 1-5Advantages of Using the UCS Platform EmulatorUCS Platform Emulator Use CasesUCS Platform Emulator Architecture21-6UCS Manager Model Object DocumentationAbout Model Object DocumentationNavigation Pane 2-3Main Pane 2-4CHAPTER3Starting Visore1-72-12-1Visore UCS Manager Model Object BrowserAbout Visore1-61-6Troubleshooting the UCS Platform EmulatorCHAPTER1-23-13-13-1Visore Interface DescriptionFilter Form 3-43-2Cisco UCS Platform Emulator Guideiii

ContentsGLOSSARYINDEXCisco UCS Platform Emulator Guideiv

PrefaceThis chapter includes the following: Audience, page v Organization, page v Related Documentation, page vi Documentation Feedback, page viAudienceThis guide is intended for software engineers with a background in programming and the use of APIs.Engineers should have knowledge of XML, data systems, networking protocols, and storage protocol;and for Cisco field service engineers for use in training and demonstrations.OrganizationChapter 1 explains the structure and capabilities of the Cisco Unified Computing System PlatformEmulator (UCSPE), and provides an overview of the UCS XML API Model Documentation.Chapter 2 describes the UCS Visore model object browser.The Glossary defines major terms used throughout the document.UCS Developers Support and User CommunityVisit the Cisco Developer’s Network website for forums, blogs, and additional resources for UCSapplication developers.You can post issues and requests relating to the UCS Platform Emulator and UCS XML API to the UCSManager forum. The forums are periodically monitored by Cisco developers and support personnel, butthere is no guaranteed response-time.Additional documents available on the Cisco Developer’s Network include the following: Cisco UCS Manager XML API Programmer’s Guide Cisco UCS Manager API Management Information Model Third-Party Tools for Cisco UCS ManagerCisco UCS Platform Emulator Guidev

PrefaceRelated DocumentationFor information on the Cisco UCS, visit the following product 281/index.htmlDocumentation for Cisco UCS is available at the following URL: computing/ucs/overview/guide/UCS roadmap.htmlThe documentation set for the Cisco Unified Computing System environment includes the followingguides:Note Cisco UCS Documentation Roadmap Cisco UCS Manager CLI Configuration Guide Cisco UCS Manager GUI Configuration Guide Cisco UCS Manager CLI Command Reference Cisco UCS Manager System and Error Message Reference Cisco UCS 5108 Server Chassis Hardware Installation Guide Cisco UCS 6100 Series Fabric Interconnect Hardware Installation Guide Cisco UCS Site Preparation Guide Regulatory Compliance and Safety Information for Cisco UCS Release Notes for Cisco UCS ManagerThe Cisco UCS Manager GUI Configuration Guide and the Cisco UCS Manager CLI CommandReference provide an overview of the Unified Computing System and the UCS Manager. This isimportant background information for XML API software developers.Documentation FeedbackTo provide technical feedback on this document, or to report an error or omission, please send your comments to [email protected] We appreciate your feedback.Cisco UCS Platform Emulator Guidevi

CH A P T E R1Cisco UCS Platform EmulatorThis chapter includes the following: About Cisco UCS Platform Emulator, page 1-1 Installing the UCS Platform Emulator, page 1-2– Installation Prerequisites, page 1-2– UCS Platform Emulator Virtual Machine Packaging, page 1-2– Start UCSPE, page 1-3– UCS Platform Emulator Limitations, page 1-5 Advantages of Using the UCS Platform Emulator, page 1-6 UCS Platform Emulator Use Cases, page 1-6 UCS Platform Emulator Architecture, page 1-6 Troubleshooting the UCS Platform Emulator, page 1-7About Cisco UCS Platform EmulatorThe Cisco Unified Computing System Platform Emulator (UCSPE) simulates various UCS hardwaredevice endpoints that can be configured by the UCS Manager. These include the following: Fabric interconnects I/O adapters (fabric extenders) Cisco integrated management controllers (CIMC) Chassis management controllers (CMC) VMware vCenter Server virtual machines (through VM port profiles) Cisco server utility OSCisco UCS Platform Emulator Guide1-1

Chapter 1Cisco UCS Platform EmulatorInstalling the UCS Platform EmulatorInstalling the UCS Platform EmulatorYou must have an account on the Cisco Network to download UCSPE. UCSPE is available internally sothat any Cisco employee can download it. Any UCSPE download has a unique encrypted ID so that userscan be identified.Installation PrerequisitesBefore installing UCSPE, do the following: Ensure that the target system meets the following requirements:– 1 GB free RAM– 8 GB disk space– 1.8 GHz single CPU Install one of the following VMware products; the UCSPE virtual machine can execute on:– VMware Player– VMware Workstation on Windows XP– VMware Fusion on Mac OS X– VMware ESX hypervisor (use the VMware vCenter Converter tool to perform physical tovirtual machine conversions) Install Firefox (or any Mozilla compatible browser). This is the required browser for connecting toUCSPE. Install Java Runtime Environment 1.6 to use the UCS Manager GUI. For Windows, it is standard practice to create a folder on the C drive, typically named “VMs,” underwhich to unzip and store UCSPE file and executables.UCS Platform Emulator Virtual Machine PackagingUCSPE is packaged as a compact VMware virtual machine along with the CentOS open source Linuxdistribution. This virtual machine (VM) can run an entire UCS Manager multichassis, multibladesimulation on a single laptop or desktop computer with no internet connection required. The end-userexperience on UCSPE is in most cases no different than that on a live UCS.UCSPE is typically delivered in a zip file, either downloaded or media. The zip file name includes theUCSPE release number, such as The file is approximately 2 GB. Unzip the fileto your hard drive using WinZip or the open source 7-Zip. The extracted directory, CiscoUCSPEv1.1.1j,is approximately 4.7 GB.Cisco UCS Platform Emulator Guide1-2

Chapter 1Cisco UCS Platform EmulatorInstalling the UCS Platform EmulatorStart UCSPEAfter unzipping the virtual machine package to your hard drive, follow the steps below to begin a UCSPEsession.Step 1Go to the UCS Platform Emulator directory, for example, CiscoUCSPEv1.1.1j, and double click theVMX executable file CiscoUCSPEv1.1.1j.vmx. This launches the VMware console.Step 2The first time that you start UCSPE, the VMware virtual machine asks whether this VM was moved orcopied. Select copied to ensure that your virtual machine acquires a unique hardware identity.Step 3The VM is configured to use the local DHCP network to obtain its IP address. If your local network doesnot support DHCP, you can change the UCSPE VM networking setting from the default NAT mode toHost Only mode. Select Network Adapter from the Device drop-down menu of the VMware consolewindow.Step 4When the VM splash page first appears, the virtual machine IP address is displayed, similar to thefollowing: My IP is: Use your browser and connect to after the boot up is complete.Step 5Type the VM IP address into the address bar of the browser. If the connection is successful, the CiscoUCS Manager page displays in the browser window. The IP address is also displayed at the top of VMconsole window after you log in (see Step 6).Step 6In the VM console window, at the login prompt type config. Type the same for the password.UCSPE Configuration MenuThe configuration menu appears in the VM console window after you log in. There are several UCSPEsettings that you can modify. The settings are displayed above the menu and they change depending onyour configuration selections. Some changes restart UCSPE to enable the virtual machine configurationchanges.Current Settings:HA Mode: HANumber of Chassis: 2Number of Blades 4Number of Uplinks: 1Table 1-1UCSPE Configuration OptionsRe-StampChanges the unique ID encrypted on UCSPE that identifies the user.Only a Cisco representative should use this option.Un-StampRemoves the unique UCSPE encrypted ID. Only a Ciscorepresentative should use this option. This disables UCSPE andrequires restamping.Toggle HA Mode (clears DB)Changes from a single to dual fabric interconnect emulation.Toggling clears all configuration data and service profiles.Cisco UCS Platform Emulator Guide1-3

Chapter 1Cisco UCS Platform EmulatorInstalling the UCS Platform EmulatorTable 1-1UCSPE Configuration OptionsChange Number ofChassis/BladesSpecifies the number of chassis (1-8) and the number of blades perchassis (1-8).Change Number of UplinksSpecifies either one or two uplinks.Restart UCSPE & Force DBResetRestarts the emulator and clears all configuration information in thedatabase.Factory ResetReinstalls the emulator software and restarts. Only a Ciscorepresentative should use this option. This disables UCSPE andrequires restamping.RebootReboots the virtual machine.ShutdownShuts down the emulator and operating system.Exit This MenuExits the configuration menu. Log in again to restore menu.Connecting to UCS Manager FacilitiesFrom the UCS Manager page, you can launch any of the following applications: The UCS GUI (click Launch). The Cisco UCS Manager GUI Configuration Guide contains specificson GUI operations; see Related Documentation, page -vi. The Visore object browser tool (click Model Browser). The UCS Manager XML API model object documentation (this is similar to Java-styledocumentation interface detailing the XML API objects). XML samples and the XML schema definition (XSD). The UCS XML API examples and XSDschema are packaged in a zip file that you can unzip to a folder of your choice.Ending a UCSPE SessionTo exit a session, do the following:Step 1Go to the VM console window.Step 2From the configuration menu, select Shutdown.Cisco UCS Platform Emulator Guide1-4

Chapter 1Cisco UCS Platform EmulatorInstalling the UCS Platform EmulatorUCS Platform Emulator LimitationsInherent LimitationsNo data pathUCSPE emulates only what is necessary for the UCS manager tofunction; it does not emulate network data flow.No cut-through interfaces toequipmentServers in a real Cisco UCS system contain integrated managementcontrollers (CIMCs), each of which supports an IPMI interface.Switch components of UCS support an SNMP interface. Becauseboth switch and CIMCs are considered endpoints of the UCSmanagement system, these interfaces are, in fact, cut-throughinterfaces that bypass the UCS manager. An emulated environmentcannot support these interfaces.No KVMKVM (keyboard/video/mouse) is also a cut-through interface and isnot supported. And as there are no real servers attached to theemulator, there are no ports to which KVM can connect.No Telnet, SSH, or FTPcommunicationSimilar to the SNMP and IPMI interfaces, SSH, FTP, and Telnet,access (through user-facing or UCS Manager Ethernet interfaces) isunavailable because it also bypasses the UCS Manager softwareand is considered cut-through access.Limited HA failover scenariosAlthough UCSPE can run in high-availability mode, it runs bothsets of UCS management processes on a single OS. Consequently,it supports only one failover scenario: when one of the twomanagement processes in the HA pair dies. Scenarios pertaining tolink loss between cluster members, loss of EEPROM readability,and others, are not supported.Current LimitationsNo RBAC authentication control In UCSPE, the UCS Manager accepts security configurationchanges, but does not enforce security. Specifically, any usernameand password combination can successfully login to the GUI, andall such logins have the “administrator” role.Mandatory database resetWhen you switch to or from HA mode, the UCS Manager cleared. This is the only setting change for which DB cleanup isdone.Command-line interface issuesUCSPE does not support the command-line interface.Known IssuesLocator LED is not fullyemulatedThe LED state defaults to “on” on all chassis, and to “off” on allservers. The states cannot be changed from the GUI.Settings not persistent betweenVM restartsAll settings created using the GUI are lost after each UCSPE virtualmachine reboot. There are two ways to preserve user-createdconfiguration: Use the Configuration Export/Import feature of the GUI Hibernate the virtual machine (for example, in VMware Playerclose the Player window)Cisco UCS Platform Emulator Guide1-5

Chapter 1Cisco UCS Platform EmulatorAdvantages of Using the UCS Platform EmulatorAdvantages of Using the UCS Platform EmulatorThe UCSPE significantly shortens the development cycle for applications that are based on the UCSXML API. Using UCSPE, you can create programs without needing real hardware until the final stagesof development. 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 problemsUCS Platform Emulator Use CasesIn addition to the previously mentioned advantages for program development, UCSPE can be used to dothe following: Provide a convenient way to demonstrate UCS operations for training and other purposes due to itsportability Test UCS XML API requests in lieu of a real server Invoke the UCS GUI so that you can become familiar with its usage and features Invoke the Visore object browser (see Visore UCS Manager Model Object Browser, page 3-1) Invoke the UCS model object documentation (see UCS Manager Model Object Documentation,page 2-1)UCS Platform Emulator ArchitectureAll application gateways (AGs) share a driver framework that includes an endpoint driver. In a UCSsystem, these drivers run on the fabric interconnect. An endpoint driver can be replaced by simulationsoftware to mimic the hardware for UCSPE. These simulated drivers are actually Linux processes thatrun on CentOS.UCSPE data management engine (DME) leverages the actual DME architecture so that the finite statemachine (FSM) scenarios are consistent. In other words, the simulated stimuli that are received must beidentical to stimuli received in a real system).UCSPE behavior is controlled through the XML configuration facility which populates equipmentmanaged objects. Configuration is done by XML scripts that simulate real-world actions.Cisco UCS Platform Emulator Guide1-6

Chapter 1Cisco UCS Platform EmulatorTroubleshooting the UCS Platform EmulatorTroubleshooting the UCS Platform EmulatorVMware for UCSPE requires that DHCP be available to retrieve IP addresses. See the VMwaredocumentation for information about enabling DHCP on your network.There are three network adapter modes that can be set from the Device drop-down menu of the VMwareconsole window: Host-only (only the local laptop can see the IP) NAT (Network Address Translation; the subnet can also see the IP) Bridged (the VM is accessible to the full network)NAT is the default configuration.Cisco UCS Platform Emulator Guide1-7

Chapter 1Troubleshooting the UCS Platform EmulatorCisco UCS Platform Emulator Guide1-8Cisco UCS Platform Emulator

CH A P T E R2UCS Manager Model Object DocumentationThis chapter includes the following: About Model Object Documentation, page 2-1 Navigation Pane, page 2-3 Main Pane, page 2-4About Model Object DocumentationUCS hardware components, suc