0% found this document useful (0 votes)

50 views

Cisco UCS Platform Emulator User Guide Version 3.0 (1cPE1)

VMWare Getting Started With OpenStack and VSphere

Uploaded by

ritesh_aladdin

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

50 views

Cisco UCS Platform Emulator User Guide Version 3.0 (1cPE1)

VMWare Getting Started With OpenStack and VSphere

Uploaded by

ritesh_aladdin

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 60

Cisco UCS Platform Emulator User Guide, Release 3.

0(1cPE1)
First Published: July 25, 2014

Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY 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 THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR 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 public domain 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" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, 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 CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
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 display output, 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 in illustrative content is unintentional
and coincidental.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://

www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)
Cisco Systems, Inc. All rights reserved.

CONTENTS

Preface

Preface vii
Audience vii
Conventions vii
Related Cisco UCS Documentation ix
Documentation Feedback ix

CHAPTER 1

New and Changed Information 1

New and Changed Information for this Release 1

CHAPTER 2

Overview 3
Information About Cisco UCS Platform Emulator 3
Cisco UCS Platform Emulator Control Panel 3
Navigation Pane 3
Work Pane 4

CHAPTER 3

Installing and Running Cisco UCS Platform Emulator Using the VM Console 5
IP Address for Cisco UCS Platform Emulator 5
Installing and Launching Cisco UCS Platform Emulator 6
Launching Cisco UCS Platform Emulator Using Hypervisors 6
Changing the Static IP Address 9
Changing the Cluster Status Using the VM Console 9
Modifying Network Settings Using the VM Console 10
Restarting and Rebooting Cisco UCS Platform Emulator Using the VM Console 10
Starting the Cisco UCS Manager CLI Using the VM Console 11
Preserving and Resetting the Database 12

CHAPTER 4

Restarting and Shutting Down Cisco UCS Platform Emulator Using the Control Panel 13

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

iii

Contents

Restarting Cisco UCS Platform Emulator 13

Persisting Settings During a Cisco UCS Platform Emulator Restart 14
Restarting Cisco UCS Platform Emulator and Performing a Factory Reset 14
Rebooting the Cisco UCS Platform Emulator VM 15
Shutting Down the Cisco UCS Platform Emulator VM 15

CHAPTER 5

Configuring Cisco UCS Platform Emulator 17

Status Summary Page 17
Viewing the Cisco UCS Platform Emulator Current Status and Settings 19
Modifying the Cisco UCS Manager High Availability Setting 19
Modifying the Cisco UCS Manager Direct Connect Rack Setting 20
Modifying the Cisco UCS Platform Emulator Startup Configuration Source 20
Modifying the Fabric Interconnect Emulation Settings 21
Dynamically Inducing and Clearing Faults 22
Server Specific Sensor Listing for Blade and Rack Mounted Servers 23

CHAPTER 6

Configuring the Hardware Inventory 25

Hardware Inventory 25
Startup Hardware Inventory Icons 25
Inventory Stash Area 26
Stash Area Icons 27
Chassis Area 27
Chassis Area Icons 27
Viewing the Hardware Catalog 28
Manually Configuring the Hardware Inventory 29
Adding a New Chassis 29
Creating a New Blade Server 29
Creating a New Rack-Mount Server 30
Modifying Server Components 31
Disconnecting a Chassis from the Fabric Interconnect 32
Connecting a Chassis to the Fabric Interconnect 32
Removing a Chassis from the Hardware Inventory 33
Emptying the Stash Area 33
Configuring Hardware Inventory using Templates 33
Using Existing Hardware Inventory Configurations 34

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Contents

Importing a Hardware Inventory Configuration File 34

Importing the Equipment from a Cisco UCS Domain 35
Loading a Saved Hardware Inventory Configuration 36
Saving the Current Hardware Inventory Configuration 37
Exporting the Hardware Inventory Configuration as an XML File 37

CHAPTER 7

Accessing Features in Cisco UCS Platform Emulator 39

Starting the Cisco UCS Manager GUI from the Cisco UCS Platform Emulator Control Panel 39
Accessing Cisco DevNet 40
Accessing goUCS 40
Information About goUCS 40
Downloading goUCS 41
Accessing Cisco UCS PowerTool 41
Information about Cisco UCS PowerTool 41
Downloading Cisco UCS PowerTool 41

CHAPTER 8

Using the Managed Object Browser 43

Information About the Managed Object Browser 43
Managed Object Browser Page 43
Running a Query in the Managed Object Browser 45

CHAPTER 9

Accessing the Cisco UCS Manager XML API Documentation 47

Information About the Cisco UCS Manager XML API 47
Information About the Cisco UCS Manager XML API Documentation 48
Accessing the Cisco UCS Manager XML API Documentation 48
Saving the Cisco UCS Manager XML API Schema and Samples 49

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Contents

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Preface
This preface includes the following sections:
Audience, page vii
Conventions, page vii
Related Cisco UCS Documentation, page ix
Documentation Feedback, page ix

Audience
This guide is intended primarily for data center administrators with responsibilities and expertise in one or
more of the following:
Server administration
Storage administration
Network administration
Network security

Conventions
Text Type

Indication

GUI elements

GUI elements such as tab titles, area names, and field labels appear in this font.
Main titles such as window, dialog box, and wizard titles appear in this font.

Document titles

Document titles appear in this font.

TUI elements

In a Text-based User Interface, text the system displays appears in this font.

System output

Terminal sessions and information that the system displays appear in this
font.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

vii

Preface
Conventions

Text Type

Indication

CLI commands

CLI command keywords appear in this font.

Variables in a CLI command appear in this font.

Note

Tip

[]

Elements in square brackets are optional.

{x | y | z}

Required alternative keywords are grouped in braces and separated by vertical

bars.

[x | y | z]

Optional alternative keywords are grouped in brackets and separated by vertical

bars.

string

A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.

Nonprinting characters such as passwords are in angle brackets.

[]

Default responses to system prompts are in square brackets.

!, #

An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.

Means reader take note. Notes contain helpful suggestions or references to material not covered in the
document.

Means the following information will help you solve a problem. The tips information might not be
troubleshooting or even an action, but could be useful information, similar to a Timesaver.

Caution

Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.

Timesaver

Means the described action saves time. You can save time by performing the action described in the
paragraph.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

viii

Preface
Related Cisco UCS Documentation

Warning

IMPORTANT SAFETY INSTRUCTIONS

This warning symbol means danger. You are in a situation that could cause bodily injury. Before you
work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with
standard practices for preventing accidents. Use the statement number provided at the end of each warning
to locate its translation in the translated safety warnings that accompanied this device.
SAVE THESE INSTRUCTIONS

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Preface
Documentation Feedback

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

CHAPTER

New and Changed Information

This chapter includes the following sections:
New and Changed Information for this Release, page 1

New and Changed Information for this Release

The following tables provide an overview of the significant new features and behavioral changes to the Cisco
UCS Platform Emulator. The tables do not provide an exhaustive list of all changes or of the new features in
each release.
Table 1: New Features and Significant Behavioral Changes in Cisco UCS, Release 3.0(1cPE1)

New or Changed Feature

Description

Support for new UCS Mini Platform

UCS-FI-M-6324 combines the IOM and fabric interconnect

functionality in a single hardware element. You must select
Fabric Interconnect (UCS-FI-M-6324) with the Chassis
UCSB-5108-AC2 or UCSB-5108-DC2.
Note

UCS Mini supports only direct connect rack

servers.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

New and Changed Information

New and Changed Information for this Release

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

CHAPTER

Overview
This chapter includes the following sections:
Information About Cisco UCS Platform Emulator, page 3
Cisco UCS Platform Emulator Control Panel, page 3

Information About Cisco UCS Platform Emulator

Cisco UCS Platform Emulator is the Cisco UCS Manager application bundled into a virtual machine (VM).
The VM includes software that emulates hardware communications for the Cisco Unified Computing System
(Cisco UCS) hardware that is configured and managed by Cisco UCS Manager.
For example, you can use Cisco UCS Platform Emulator to create and test a supported Cisco UCS configuration,
or to duplicate an existing Cisco UCS environment for troubleshooting or development purposes.

Note

For the latest hardware and software feature information, prerequisites, limitations, and caveats, see the
release notes for Cisco UCS Platform Emulator.

Cisco UCS Platform Emulator Control Panel

Navigation Pane
The Navigation pane displays on the left side of the Cisco UCS Platform Emulator Control Panel. This pane
enables you to navigate to all components in the Cisco UCS Platform Emulator.
UCS MANAGER Menu Tab
The items in this menu tab provide access to Cisco UCS Manager and its functionality within Cisco UCS
Platform Emulator.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Overview
Work Pane

EMULATOR SETTINGS Menu Tab

The items in this menu tab enable you to configure the settings for Cisco UCS Platform Emulator.
RESTART Menu Tab
The items in this menu tab enable you to access the restart options for Cisco UCS Platform Emulator.

Work Pane
The Work pane displays on the right side of Cisco UCS Platform Emulator Control Panel. The Work pane
includes a content area that displays information related to the menu item selected in the Navigation pane.
You can view and modify information in the Work pane.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

CHAPTER

Installing and Running Cisco UCS Platform

Emulator Using the VM Console
This chapter includes the following sections:
IP Address for Cisco UCS Platform Emulator, page 5
Installing and Launching Cisco UCS Platform Emulator, page 6
Launching Cisco UCS Platform Emulator Using Hypervisors, page 6
Changing the Static IP Address, page 9
Changing the Cluster Status Using the VM Console, page 9
Modifying Network Settings Using the VM Console, page 10
Restarting and Rebooting Cisco UCS Platform Emulator Using the VM Console, page 10
Starting the Cisco UCS Manager CLI Using the VM Console, page 11
Preserving and Resetting the Database, page 12

IP Address for Cisco UCS Platform Emulator

Cisco UCS Platform Emulator supports both DHCP and static IP. By default, Cisco UCS Platform Emulator
is configured to use the local network to obtain an IP address via DHCP. If your network does not include a
DHCP server, you must assign a static IP address to Cisco UCS Platform Emulator.
After the initial installation completes, Cisco UCS Platform Emulator displays the management IP address in
the VM console. If you assign a static IP address, the IP address persists across VM reboots. If the IP address
was assigned by DHCP server, the IP address persists across VM reboots for the duration of the lease.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Installing and Running Cisco UCS Platform Emulator Using the VM Console
Installing and Launching Cisco UCS Platform Emulator

Installing and Launching Cisco UCS Platform Emulator

Note

The VM performs a one-time installation process the first time it starts up. Allow the installation to
complete before you reboot the VM.

Procedure
Step 1
Step 2

Extract the Cisco UCS Platform Emulator .zip file and .ova file to a folder.
Open or import the unzipped Cisco UCS Platform Emulator into a supported hypervisor, as required by the
hypervisor.
Do not continue with the next step until the VM has finished booting.

Step 3

(Optional) If you want to use DHCP for Cisco UCS Platform Emulator, enter the IP address from the VM
console window in a supported Mozilla-based web browser to start Cisco UCS Platform Emulator.
(Optional) If you want to assign a static IP address to Cisco UCS Platform Emulator, do the following:
Note
Steps 4 f), g), and h) should be repeated three times - one for each of the three interfaces.

Step 4

a) In the VM console window, at the cisco-ucspe login prompt, enter config and press Enter.
b) At the Password prompt, enter config and press Enter.
c) At the Select prompt, enter a to change the network settings to use a statically assigned IP address.
d) At the Change settings prompt, enter y and press Enter.
e) At the Use DHCP? prompt, enter n and press Enter.
f) At the Enter IP address prompt, enter the static IP address and press Enter.
g) At the Enter netmask prompt, enter your netmask and press Enter.
h) At the Enter default gateway prompt, enter your default gateway and press Enter.
After you enter the default gateway, the network interface reinitializes with your settings and the system
becomes accessible via the new IP address. To cancel an entry and return to the menu, press Ctrl+C.

Launching Cisco UCS Platform Emulator Using Hypervisors

You can launch Cisco UCS Platform Emulator using VMplayer, VMfusion, VMware vSphere Hypervisor
(ESXi), and Microsoft Hyper-V.
Launching Cisco UCS Platform Emulator Using Hypervisors With An .ova File
Using VMplayer on Microsoft Windows and Linux, Release 5.0:
1 Download the VMware OVF Tool, Release 3.0.1 from VMware. You can download the tool from the
website.
2 When the download is complete, open your terminal or command prompt, navigate to where the VMware
OVF Tool was installed and run the following to convert the image to a VMX file:
ovftool <path_to_ova\UCSPE.ova> <path_to_store_converted_image\UCSPE.vmx>

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Installing and Running Cisco UCS Platform Emulator Using the VM Console
Launching Cisco UCS Platform Emulator Using Hypervisors

The conversion begins and a progress window is displayed. When finished, you can use VMware player
to open the converted image and launch Cisco UCS Platform Emulator.
3 From the File menu on the VMware Player menu bar, select Open a Virtual Machine.
4 Browse to the folder where the VMX file was converted and double-click the VMX file to launch Cisco
UCS Platform Emulator.
Launching Cisco UCS Platform Emulator Using Hypervisors With A .zip File
The .zip file contains the VMX and VMDK files that can be used directly with VMware Player, VMware
Workstation and VMware Fusion.
1 Download the .zip file.
2 Extract the .zip file to a folder.
3 Click Open a Virtual Machine and browse to the extracted files. Select the VMX file and click Open..
4 To install in vSphere, the VMDK files must be processed with VMware Converter Standalone, then
deployed to vCenter directly.
5 Open VMware Converter Standalone.
6 In the Converter view pane, select.Convert Machine
7 Set the source type as VMware Workstation or Other Virtual Machine.
8 Select the VMX file from the folder. Click Next.
9 Enter the destination information for the vCenter Server.
10 Select a destination cluster resource, and suitable datastore.
11 Click on Finish
12 When the conversion completes successfuly, power on the VM.
Launching Cisco UCS Platform Emulator Using Microsoft Hyper-V With A .zip File

Note

This task applies to the .zip file only; for example,

Cisco_UCS_Platform_Emulator_3.0.1cPE1.zip. Cisco UCS Platform Emulator is delivered
as an .ova file and as a .zip file. Each file contains the VMX and VMDK files that can be used directly
with VMware Player, VMware Workstation and VMware Fusion.
1 Download the .zip file.
2 Extract the .zip file to a folder.
3 Download the StarWind V2V converter from www.starwindsoftware.com. Install the converter in Microsoft
Windows.
4 Launch the StarWind converter and convert the VMDK file into VHD format. Use the Microsoft Virtual
PC growable image as the destination image format.
5 Copy the VHD files to any Hyper-V server and using the Hyper-v Manager to create a new virtual machine
using the existing VHD files with the following parameters:

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Installing and Running Cisco UCS Platform Emulator Using the VM Console
Launching Cisco UCS Platform Emulator Using Hypervisors

Name the Virtual Machine: Cisco UCS Platform Emulator 3.0(1cPE1)

Assign startup memory to 2048MB
Networking Connection Leave at not connected
Connect Virtual Hard Disk Set to attach a virtual hard disk later
After the Virtual Machine is created, edit the settings:
Delete the DVD Drive
Assign each of the 4 VHDs to IDE controllers 0 and 1. (0:0, 0:1, 1:0 & 1:1)
Delete the existing Network Adapter
Create 3 NICS each using Legacy Network Adapter type and associate to your vSwitch
Change the BIOS boot to IDE
6 Power on the VM.
Launching Cisco UCS Platform Emulator Using VMware Fusion on Mac OS X With An .ova File
If you are running VMware Fusion 4 or below, you can use the VMware OVF Tool to convert the image to
the VMware runtime file format (.vmx). VMware Fusion 5 can import the .ova image file without conversion.
1 From the File menu on the VMware Fusion menu bar, select Import. The Import Library window displays
a dialog box for browsing to the location of the .ovf file.
2 Browse to the .ova file and click Open.
3 Type the name for the imported virtual machine in the Save As text box and indicate where to save it. The
default destination is the Virtual Machines folder created by VMware Fusion.
4 Click Import. A status bar indicates the progress of the import process.
When the import is complete, the virtual machine appears in the virtual machine library and in a separate
virtual machine window.
Launching Cisco UCS Platform Emulator Using VMware Workstation on Microsoft Windows and Linux With
An .ova File
You can directly import an .ova file into VMware Workstation 8.
1 From the File menu on the VMware Workstation 8 menu bar, select Open.
2 Browse to the .ovf or .ova file and click Open.
3 Type a name for the virtual machine, browse to the directory for the virtual machine files, and click Import.
Launching Cisco UCS Platform Emulator Using VMware vSphere ESXi 5.0 With An .ova File
Connect to your VMware Vcenter or VMware vSphere ESXi using the vSphere client.
1 From the File menu in the Vcenter or ESXi menu bar, select Deploy OVF Template.
2 Browse to the .ova file and click Open.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Installing and Running Cisco UCS Platform Emulator Using the VM Console
Changing the Static IP Address

Changing the Static IP Address

Note

If clustering is disabled, you must set a static IP address.

Procedure
Step 1

If necessary log into the console window for the Cisco UCS Platform Emulator VM, as follows:
a) At the cisco-ucspe login prompt, enter config and press Enter.
b) At the Password prompt, enter config and press Enter.

Step 2

At the Setup prompt, enter a.

Step 3

At the Change settings prompt, enter y and press Enter.

Step 4

At the Use DHCP? prompt, enter n and press Enter.

Step 5

At the Enter IP address prompt, enter the static IP address and press Enter.

Step 6

At the Enter netmask prompt, enter your netmask and press Enter.

Step 7

At the Enter default gateway prompt, enter your default gateway and press Enter. The network
interface reinitializes with your settings and the system becomes accessible via the new IP address. To cancel
an entry and return to the menu, press Ctrl+C.
Repeat Steps 5, 6, and 7 for each interface.

Step 8

Changing the Cluster Status Using the VM Console

You can use the Cisco UCS Platform Emulator VM console to change the cluster status. The console window
for the Cisco UCS Platform Emulator VM supports a single CLI session.

Note

If clustering is disabled, you must set a static IP address.

Procedure
Step 1
Step 2
Step 3

(Optional) If the VM console window displays the Select prompt, type x to exit the menu.
At the cisco-ucspe login prompt, type config and press Enter.
At the Password prompt, type config and press Enter.
The VM console window displays the configuration menu.

Step 4

At the Select prompt, type h and press Enter.

The VM console window displays a confirmation message.

Step 5

At the Change Cluster State (yes/no)? prompt, type yes and press Enter.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Installing and Running Cisco UCS Platform Emulator Using the VM Console
Modifying Network Settings Using the VM Console

Note

Changing the cluster status restarts the Cisco UCS Platform Emulator and Cisco UCS Manager and
removes all configurations and databases. This option also removes all hardware configurations
performed in the Cisco UCS Platform Emulator control panel and also changes the database persistence
setting to Reset the database.

Modifying Network Settings Using the VM Console

You can use the Cisco UCS Platform Emulator VM console to change some network settings. The console
window for the Cisco UCS Platform Emulator VM supports a single CLI session.

Procedure
Step 1
Step 2
Step 3

Step 4

At the Select prompt, type a and press Enter.

The VM console window displays a confirmation message.

Step 5

At the Change settings? prompt, type yes and press Enter.

Note
Changing network settings restarts the Cisco UCS Platform Emulator and Cisco UCS Manager.

Restarting and Rebooting Cisco UCS Platform Emulator Using

the VM Console
You can use the Cisco UCS Platform Emulator VM console to restart and reboot UCSPE.

Note

If you restart or reboot using the VM console, the Cisco UCS Manager database will only be reset if the
persistent setting is configured to reset the database. You can only configure the persistent setting in the
Cisco UCS Platform Emulator GUI (Emulator Settings > Database Persistence > Preserve or Reset).

Procedure
Step 1
Step 2
Step 3

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Installing and Running Cisco UCS Platform Emulator Using the VM Console
Starting the Cisco UCS Manager CLI Using the VM Console

Step 4

(Optional) At the Select prompt, type b and press Enter to restart Cisco UCS Platform Emulator with the
settings in the Cisco UCS Platform Emulator GUI (Emulator Settings > Database Persistence > Preserve
or Reset).
The VM console window displays a confirmation message. This option does not clear the Cisco UCS Manager
database and configurations; however, this option clears the Cisco UCS Platform Emulator database. Hardware
configurations performed in the Cisco UCS Platform Emulator control panel remain.

Step 5

(Optional) At the Select prompt, type i and press Enter to perform a factory reset.
The VM console window displays a confirmation message. This option reverts Cisco UCS Platform Emulator
settings and configurations to the factory settings. All user-configured files and configurations are lost.

Step 6

(Optional) At the Select prompt, type j and press Enter to reboot Cisco UCS Platform Emulator.
The VM console window displays a confirmation message. This option reboots the Cisco UCS Platform
Emulator VM console.

Step 7

(Optional) At the Select prompt, type k and press Enter to shutdown Cisco UCS Platform EmulatorVM
console.
The VM console window displays a confirmation message.

Step 8

(Optional) At the Select prompt, type x and press Enter to exist the menu.
The VM console window displays a confirmation message.

Starting the Cisco UCS Manager CLI Using the VM Console

You can use the supported commands from the Cisco UCS Manager CLI to configure and manage the hardware
in your Cisco UCS Platform Emulator environment. The console window for the Cisco UCS Platform Emulator
VM supports a single CLI session.
For information about Cisco UCS Manager CLI commands, see the Cisco UCS Manager CLI Configuration
Guide and the Cisco UCS Manager CLI Command Reference. You can access these documents through the
Cisco UCS B-Series Servers Documentation Roadmap available at the following URL: http://www.cisco.com/
go/unifiedcomputing/b-series-doc .

Note

Cisco UCS Platform Emulator does not support Cisco UCS Manager CLI commands for unsupported
features or within the connect nxos or connect local-mgmt scopes

Procedure
Step 1
Step 2
Step 3

(Optional) If the VM console window displays the Select prompt, type x to exit the menu.
At the cisco-ucspe login prompt, type cliuser and press Enter.
At the Password prompt, type cliuser and press Enter.
The VM console window displays the cisco-ucspe# prompt, which is the equivalent of the top-level scope in
the Cisco UCS Manager CLI.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Installing and Running Cisco UCS Platform Emulator Using the VM Console
Preserving and Resetting the Database

Preserving and Resetting the Database

This setting determines whether the Cisco UCS Platform Emulator configuration, persists after you restart
Cisco UCS Platform Emulator or reboot the VM. These settings do not change the persistence of the hardware
inventory.

Note

Changes to this setting do not take effect until you restart the Cisco UCS Platform Emulator application.

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Database Persistence.

Click one of the following radio buttons:
Preserve UCS Database upon Restart
Reset UCS Database upon Restart

Step 4

Click Submit.

What to Do Next
Restart the Cisco UCS Platform Emulator application, as described in Restarting Cisco UCS Platform Emulator,
on page 13.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

CHAPTER

Restarting and Shutting Down Cisco UCS

Platform Emulator Using the Control Panel
This chapter includes the following sections:
Restarting Cisco UCS Platform Emulator, page 13
Persisting Settings During a Cisco UCS Platform Emulator Restart, page 14
Restarting Cisco UCS Platform Emulator and Performing a Factory Reset, page 14
Rebooting the Cisco UCS Platform Emulator VM, page 15
Shutting Down the Cisco UCS Platform Emulator VM, page 15

Restarting Cisco UCS Platform Emulator

Procedure
Step 1

In the Navigation pane, click the Restart menu tab.

Step 2
Step 3

Click Restart UCSPE.

In the Are you sure you want to restart UCS Emulator with Current Settings now? field of the Work
pane, click one of the following radio buttons:
YesTo restart Cisco UCS Platform Emulator with current settings.
NoTo cancel the action.

Step 4

Click Restart UCS Emulator with Current Settings.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Restarting and Shutting Down Cisco UCS Platform Emulator Using the Control Panel
Persisting Settings During a Cisco UCS Platform Emulator Restart

Persisting Settings During a Cisco UCS Platform Emulator

Restart
When Cisco UCS Platform Emulator restarts, the database either persists or is reset depending on the persistence
setting made in the Cisco UCS Platform Emulator GUI . By default, this procedure erases all settings and
configuration in the database, including pools, policies, and service profiles. However, you can configure
Cisco UCS Platform Emulator to preserve the database upon restart using the Cisco UCS Platform Emulator
GUI (Emulator Settings > Database Persistence > Preserve or Reset).

Procedure
In the Navigation pane, click Emulator Settings > Database Persistence, click one of the following radio
buttons:
YesTo restart the Cisco UCS Platform Emulator and reset the database to erase all settings and
configuration.
NoTo cancel the action.

Restarting Cisco UCS Platform Emulator and Performing a

Factory Reset
By default, when Cisco UCS Platform Emulator restarts, the database is erased, any hardware that you added
to Cisco UCS Manager within Cisco UCS Platform Emulator is deleted, and all configurations and settings
are returned to the factory defaults.

Procedure
Step 1

In the Navigation pane, click the Restart menu tab.

Step 2

Click Factory Reset.

In the Are you sure you want to perform Factory Reset now? field of the Work pane, click one of the
following radio buttons:

Step 3

YesTo restart the Cisco UCS Platform Emulator and erase all hardware, settings, and configuration
NoTo cancel the action.
Step 4

Click Perform Factory Reset.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Restarting and Shutting Down Cisco UCS Platform Emulator Using the Control Panel
Rebooting the Cisco UCS Platform Emulator VM

Rebooting the Cisco UCS Platform Emulator VM

Rebooting the VM from the Cisco UCS Platform Emulator ensures a clean shutdown of the Cisco UCS
Platform Emulator before the VM reboots.

Note

If clustering is disabled, you must set a static IP address.

Procedure
Step 1

In the Navigation pane, click the Restart menu tab.

Step 2

Click Reboot VM.

Step 3

In the Are you sure you want to reboot Virtual Machine now? field of the Work pane, click one of the
following radio buttons:
YesTo shutdown the Cisco UCS Platform Emulator and reboot the VM
NoTo cancel the action.

Step 4

Click Reboot Virtual Machine.

Shutting Down the Cisco UCS Platform Emulator VM

Shutting down the VM from the Cisco UCS Platform Emulator ensures a clean shutdown of the Cisco UCS
Platform Emulator.

Procedure
Step 1

In the Navigation pane, click the Restart menu tab.

Step 2
Step 3

Click Shutdown VM.

In the Are you sure you want to shut down Virtual Machine now? field of the Work pane, click one of
the following radio buttons:
YesTo shutdown the VM
NoTo cancel the action.

Step 4

Click Shut Down Virtual Machine.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Restarting and Shutting Down Cisco UCS Platform Emulator Using the Control Panel
Shutting Down the Cisco UCS Platform Emulator VM

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

CHAPTER

Configuring Cisco UCS Platform Emulator

This chapter includes the following sections:
Status Summary Page, page 17
Viewing the Cisco UCS Platform Emulator Current Status and Settings, page 19
Modifying the Cisco UCS Manager High Availability Setting, page 19
Modifying the Cisco UCS Manager Direct Connect Rack Setting, page 20
Modifying the Cisco UCS Platform Emulator Startup Configuration Source, page 20
Modifying the Fabric Interconnect Emulation Settings, page 21
Dynamically Inducing and Clearing Faults, page 22
Server Specific Sensor Listing for Blade and Rack Mounted Servers, page 23

Status Summary Page

The Status Summary page displays the current status and a summary of the Cisco UCS Platform Emulator
settings. These settings are updated when you modify any of the Cisco UCS Platform Emulator settings.
Runtime Status Area
This area provides information about the current status of Cisco UCS Platform Emulator. The number in
parentheses shows the number of instances of the processes that are running. This example is for a cluster
setting. For a non-cluster (standalone setting), everything will be (1) and the SAM Controller will not be
running.
Name

Description

Emulator field

Running(1)

UCS Manager field

Running(2)

Blade AG field

Running(2)

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring Cisco UCS Platform Emulator

Status Summary Page

Name

Description

RsdAG field

Running(2)

PortAG field

Running(2)

StatsAG field

Running(2)

NicAG field

Running(2)

DeosAG field

Running(2)

HostagentAG field

Running(2)

ExtvmmAG field

Running(2)

SAM Controller field

Running(2)

Available Memory field

The memory currently available to Cisco UCS Platform Emulator.

Current Mgmt IP field

The current management IP address.

Netmask field

The netmask configured for Cisco UCS Platform Emulator.

Gateway field

The gateway configured for Cisco UCS Platform Emulator.

Emulator Startup Settings Area

This area provides details of the fabric interconnect configuration for Cisco UCS Platform Emulator.
Name

Description

High-Availability Mode field

The number of fabric interconnects configured for Cisco UCS Platform

Emulator. This can be one of the following:
High availability cluster configuration with two fabric
interconnects
Single standalone fabric interconnect

Persistent DB Mode field

Whether the database is preserved or erased when Cisco UCS Platform

Emulator is restarted.

Emulator Hardware Config Area

Name

Description

Startup Config URL field

The location where the startup configuration for Cisco UCS Platform
Emulator is stored.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring Cisco UCS Platform Emulator

Viewing the Cisco UCS Platform Emulator Current Status and Settings

Viewing the Cisco UCS Platform Emulator Current Status and

Settings
Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Status Summary.

In the Work pane, review the current status and settings of Cisco UCS Platform Emulator.

Modifying the Cisco UCS Manager High Availability Setting

The High Availability setting determines which of the following configurations is emulated by Cisco UCS
Platform Emulator:
High availability cluster configuration with two fabric interconnects
Single standalone fabric interconnect

Note

Changes to this setting do not take effect until you restart the Cisco UCS Platform Emulator. If you restart
or reboot Cisco UCS Platform Emulator, the Cisco UCS Manager database will only be reset if the persistent
setting is configured to reset the database. You can only configure the persistent setting in the Cisco UCS
Platform Emulator GUI (Emulator Settings > Database Persistence > Preserve or Reset).

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click High Availability.

Click one of the following radio buttons:
Dual Fabric Interconnect, HA
Single Fabric Interconnect, no HA

Step 4

Click Submit.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring Cisco UCS Platform Emulator

Modifying the Cisco UCS Manager Direct Connect Rack Setting

What to Do Next
Restart the VM and reset the database, as described in Persisting Settings During a Cisco UCS Platform
Emulator Restart, on page 14.

Modifying the Cisco UCS Manager Direct Connect Rack Setting

In Direct Connect Rack mode, the servers are directly connected to the switch with no intermediate Fabric
Extender (FEX) connectivity. The rack server platform slots supported by Direct Connect Rack are:

Note

Adaptor

Rack Server Model

Adaptor Slots

UCSC-PCIE-CSC-02

C220

UCSC-PCIE-CSC-02

C240

In this release, the Direct Connect Rack Settings are always set to ON.

Modifying the Cisco UCS Platform Emulator Startup

Configuration Source
This setting determines which hardware inventory configuration is loaded into Cisco UCS Platform Emulator
when it restarts. By default, the current hardware inventory configured in Cisco UCS Platform Emulator is
loaded.
For example, you can use this setting to ensure that multiple Cisco UCS Platform Emulator VMs have the
same hardware inventory configuration. You can maintain the hardware inventory in a one Cisco UCS Platform
Emulator and configure the other Cisco UCS Platform Emulator VMs to use that hardware inventory.

Note

Changes to this setting do not take effect until you restart Cisco UCS Platform Emulator and reset the
database. If you restart or reboot Cisco UCS Platform Emulator, the Cisco UCS Manager database will
only be reset if the persistent setting is configured to reset the database. You can only configure the
persistent setting in the Cisco UCS Platform Emulator GUI (Emulator Settings > Database Persistence
> Preserve or Reset).

Before You Begin

If you plan to load the hardware inventory configuration from another Cisco UCS Platform Emulator, you
must save that hardware inventory to ensure that it is available as a file.
If you plan to load the hardware inventory configuration from a web server, you must export the hardware
inventory from an existing Cisco UCS Platform Emulator and store it on the web server.
Make sure that the Cisco UCS Platform Emulator cluster state setting is the same as the source cluster setting.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring Cisco UCS Platform Emulator

Modifying the Fabric Interconnect Emulation Settings

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3
Step 4

Click Startup Config URL.

To use the local hardware inventory configuration, click the Use Local Startup Inventory radio button.
To load the startup configuration from another Cisco UCS Platform Emulator, do the following:
a) Click the Load From Another UCSPE radio button.
b) Complete the following fields:
Name

Description

Host field

The management IP address of the Cisco UCS Platform Emulator

from which you want to load the startup configuration.

Port field

Port 80, the web server port used by Cisco UCS Platform Emulator.

File field

The name of the saved hardware inventory configuration file in the

other Cisco UCS Platform Emulator that you want to load into this
Cisco UCS Platform Emulator on start up.

Step 5

To load the startup inventory from a web server, do the following:

a) Click the Load From External URL radio button.
b) In the External URL field, enter the URL for the hardware inventory configuration file.
The URL should use a format such as http://IP_Address/File_Name. For example,
http://209.165.202.129/ucspe_hardware_sample.xml

Step 6

Click Submit.

What to Do Next
Restart the VM and reset the database, as described in Persisting Settings During a Cisco UCS Platform
Emulator Restart, on page 14.

Modifying the Fabric Interconnect Emulation Settings

This setting determines which fabric interconnect is used by Cisco UCS Platform Emulator and the number
of IOM links between the chassis and fabric interconnects.

Note

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring Cisco UCS Platform Emulator

Dynamically Inducing and Clearing Faults

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Fabric Interconnect.

From the Number of IOM links drop-down list, choose the number of IOM links between the chassis and
fabric interconnects.
For the Cisco UCS-Mini 6324 IOM links, the combo box is disabled.

Step 4

From the Fabric Interconnect drop-down list, choose which fabric interconnect you want to use in Cisco
UCS Platform Emulator.
UCS Mini supports the Cisco UCS-Mini 6324 interconnect.

Step 5

Click Submit.

What to Do Next
Restart the VM and reset the database, as described in Persisting Settings During a Cisco UCS Platform
Emulator Restart, on page 14.

Dynamically Inducing and Clearing Faults

You can induce and clear faults using the Command Line Interface (CLI) and observe the fault behavior in
the GUI.

Procedure
Command or Action

Purpose

Step 1

<<cat <test.xml> | POST http://<Ape

IP:8081>/nuova

Induces or clears faults by reading values

from the XML file.

Step 2

inChassisIdChassis number

Enters the chassis ID.

Step 3

inServerIdServer number

Enters the server ID.

Step 4

inSensorNameSensor name

Enters the sensor ID.

Step 5

inFaultLevel Fault level

Enters the fault level.

Step 6

inOperation 1 | 0

1 - Deletes a fault
0 - Adds a fault

The following example shows how to dynamically induce and clear faults:
<methodVessel>
<inStimuli>
<apeSetApeSensorReading
inChassisId="1"

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring Cisco UCS Platform Emulator

Server Specific Sensor Listing for Blade and Rack Mounted Servers

inServerId="5"
inSensorName="0"
inFaultLevel="6"
inOperation="1"
>
</apeSetApeSensorReading>
</inStimuli>
</methodVessel>

Server Specific Sensor Listing for Blade and Rack Mounted

Servers
Table 2: Sensor List for Blade Servers

Blade Server
B200M3

Sensor
P3V_BAT_SCALED -- 0
P12_V - 8
TEMP_SENS_FRONT - 76
TEMP_SENS_REAR - 77
P1_TEMP_SENS - 78
P2_TEMP_SENS - 79
POWER_USAGE - 40

Table 3: Sensor List for Rack Mounted Servers

Rack Mounted Server

C220M3

Sensor
P1_TEMP_SENS - 59
P2_TEMP_SENS - 60

C240M3

P1_TEMP_SENS - 55
P2_TEMP_SENS - 56

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring Cisco UCS Platform Emulator

Server Specific Sensor Listing for Blade and Rack Mounted Servers

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

CHAPTER

Configuring the Hardware Inventory

This chapter includes the following sections:
Hardware Inventory, page 25
Inventory Stash Area, page 26
Chassis Area, page 27
Viewing the Hardware Catalog, page 28
Manually Configuring the Hardware Inventory, page 29
Using Existing Hardware Inventory Configurations, page 34

Hardware Inventory
The inventory of supported hardware components is stored in the Hardware Catalog. This catalog is drawn
from the Capability Catalog that is included in Cisco UCS Platform Emulator. It contains the inventory of the
supported components that you can use to build a chassis in Cisco UCS Platform Emulator, including servers,
DIMMs, and adapters. If a component is not included in the Hardware Catalog, it is not supported by Cisco
UCS Platform Emulator.
The Hardware Catalog does not include fabric interconnects. You need to configure fabric interconnects and
the links between the chassis and the fabric interconnect in the emulator settings. For more information, see
Modifying the Fabric Interconnect Emulation Settings.

Note

Cisco UCS Mini supports only UCSB-B200-M3 Blade and UCSC-C220-M3 and UCSC-C240-M3 Rack
Servers, and only UCSB-5108-AC2 or UCSB-5108-DC2 Chassis with the FI-IOM UCS-FI-M-6324

Startup Hardware Inventory Icons

The following table contains the icons above the Stash and Chassis areas on the Startup Hardware Inventory
page.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Inventory Stash Area

Icon

Description

Add New Chassis

Adds a chassis to the hardware inventory.

Load a Saved
Configuration

Loads a previously saved hardware inventory configuration. After

you restart Cisco UCS Platform Emulator, this configuration
overwrites and replaces the current hardware inventory.

Import XML File

Imports an XML file that contains hardware inventory configuration

data from a file on the local disk. After you restart Cisco UCS
Platform Emulator, this configuration overwrites and replaces the
current hardware inventory.

Import Equipment from Imports the hardware inventory configuration from a live Cisco
Live Cisco UCS
UCS domain. After you restart Cisco UCS Platform Emulator, this
configuration overwrites and replaces the current hardware
inventory.
Restart Emulator with
this Hardware Setup

Restarts Cisco UCS Platform Emulator to enable the emulated Cisco

UCS Manager to discover the new hardware inventory configuration.

Save Configuration

Saves the current hardware inventory configuration. A file with this

name displays in the Load previously saved configuration list.

Export Configuration as Exports the current hardware inventory configuration as an XML

XML file
file then opens a new browser tab and displays the contents of the
XML file.
Validate the present
Configuration

Validates the configuration.

Inventory Stash Area

The Stash area is a virtual lab desk where you can place a blade server after you remove it from, or before
you insert it into a chassis. You can change the components of a server in the Stash area, such as the DIMMs
or CPU, before you insert the server into a chassis. You can drag and drop servers into the Stash area from

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Stash Area Icons

the Chassis area (after ejection) or from the Hardware Catalog table below. If a server in the Stash area was
removed from a chassis, Cisco UCS Platform Emulator tracks the chassis and slot from which the server was
removed and reinserts it back into the same location when you drag and drop the server back into the Chassis
area. For rack servers, you can place a server in the Stash area, change or add components, and then drag and
drop the server on the Rack Servers area.
You can drag and drop servers into the Stash area from the Chassis area or from the Hardware Catalog table
below. If a server in the Stash area was removed from a chassis, Cisco UCS Platform Emulator tracks the
chassis and slot from which the server was removed and reinserts it back into the same location when you
drag and drop the server back into the Chassis area.

Stash Area Icons

Icon

Description
Collapses all elements of the Stash area.

Expands all elements of the Stash area.

Removes all servers and components from the Stash area.

Chassis Area
The Chassis area holds all of the chassis in Cisco UCS Platform Emulator. By default, the Chassis area
includes one chassis.
While you can modify servers in the Chassis area, we recommend that you drag the server from a chassis and
drop it in the Stash area and modify the server components there. When you drag the server back to the
Chassis area, Cisco UCS Platform Emulator returns it to the same chassis and slot from which it was removed.

Chassis Area Icons

Icon

Description
Collapses all elements of the Chassis area.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Viewing the Hardware Catalog

Icon

Description
Expands all elements of the Chassis area.

Makes a duplicate of this chassis.

Disconnects the chassis from the fabric interconnect, but does not remove
it from the hardware inventory.

Removes the chassis from the hardware inventory.

Viewing the Hardware Catalog

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Hardware Catalog.

In the Work pane, click one or more of the following tabs to view the components supported in the current
release:
Blades
CPU
DIMM
HDD
I/O Adapters
Fans
PSU
Rack Servers
Templates

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Manually Configuring the Hardware Inventory

Storage Controller

Manually Configuring the Hardware Inventory

Adding a New Chassis
Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Start-up Inventory.

On the Startup Hardware Inventory page, click the Add New Chassis icon on the top icon bar.

Step 4
Step 5
Step 6

In the ID field, enter an unused number that you want to assign to the chassis.
In the Name field, enter a name for the chassis.
Click Add.
Cisco UCS Platform Emulator adds a Chassis area for the new chassis.
Note

Fabric Model UCS-FI-M-6324 is only supported with the chassis UCSB-5108-AC2 and
UCSB-5108-DC2. UCS Mini supports only one chassis with a chassis ID value of 1.

What to Do Next
Add servers to the chassis.

Creating a New Blade Server

We recommend that you create a new blade server in the Stash area. Blade servers that are moved from the
startup inventory table to the Stash area do not include any components, such as DIMMs, adapters, or fans.
You must add those components and build your blade server before you insert the blade server in a chassis.
After you have added all desired components to the blade server, you can drag it over to and drop it into a
chassis.

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3
Step 4

Click Start-up Inventory.

On the Startup Hardware Inventory page, click the Blades tab.
Click in the row for the desired blade server and, holding the mouse button down, drag the blade server to the
Stash area and drop it into that area.
Add the components that you want to include in the blade server, as follows:

Step 5

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Creating a New Rack-Mount Server

a) Click on the tab for the component you want to add to the blade server.
b) Click in the row for the desired configuration for the component and, holding the mouse button down,
drag the component to the Stash area and drop it on top of the blade server.
c) If prompted, enter the desired slot number for the component and press Enter.
d) Repeat Steps a through c until you have added all desired components to the blade server.
Step 6

Add the blade server to a chassis:

a) Click on the blade server in the Stash area and, holding the mouse button down, drag the component to
the appropriate Chassis area and drop it into that area.
b) In the Enter Server Slot field, enter the number of the empty slot where you want to insert the blade
server and press Enter.
c) In the Enter Server Slot field, enter the number of the empty slot where you want to insert the blade
server and press Enter.

Step 7

Click the Validate icon in the Startup Hardware Inventory area to ensure that all necessary components for
a server are added. Missing components are displayed if the component is missing on the server.

Creating a New Rack-Mount Server

We recommend you to create a new rack-mount server in the Stash area However, you can also drag-drop
the rack-server from the catalog to the Rack Server area.
Other components such as DIMMs, adapters, or fans are not included automatically. After you have added
all desired components to the rack-mount server in the Stash area, you can drag it and drop it into a Rack
Servers area. You can also configure the empty rack-mount server dropped directly on the Rack Servers
area, then add components.

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3
Step 4

Click Start-up Inventory.

On the Startup Hardware Inventory page, click the Rack Servers tab.
Click in the row for the desired rack-mount server and, holding the mouse button down, drag the rack-mount
server to the Stash area and drop it into that area.
Add the components that you want to include in the rack-mount server, as follows:
a) Click on the tab for the component you want to add to the rack-mount server.
b) Click in the row for the desired configuration for the component and, holding the mouse button down,
drag the component to the Stash area and drop it on top of the rack-mount server.
c) If prompted, enter the desired slot number for the component and press Enter.
d) Repeat Steps a through c until you have added all desired components to the rack-mount server.

Step 5

Step 6

Add the rack-mount server to a Rack Servers area:

a) Click on the rack-mount server in the Stash area and, holding the mouse button down, drag and drop the
component to the appropriate Rack Servers area.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Modifying Server Components

b) In the Enter Server Slot field, enter the number of the empty slot where you want to insert the rack-mount
server and press Enter.

Modifying Server Components

We recommend that you eject the server that you wish to modify from the chassis into the Stash area, modify
the components as desired, then reinsert it into a chassis.

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Start-up Inventory.

Move the server you want to modify to the Stash area as follows:
a) In the appropriate Chassis area, click the + icon to expand the Servers.
b) Click the - icon next to the slot that holds the server you want to modify.
c) In the Eject Server? field, click the green checkmark icon.
Cisco UCS Platform Emulator ejects the server from the chassis and moves it to the Stash area.

Step 4

Add components to the server, as follows:

a) Click on the tab for the component you want to add to the server.
b) Click in the row for the desired configuration for the component and, holding the mouse button down,
drag the component to the Stash area and drop it on top of the server.
c) If prompted, enter the desired slot number for the component and press Enter.
If the slot is occupied, Cisco UCS Platform Emulator replaces the existing component with the new one.
d) If prompted, enter the desired range for the component and press Enter.
If the slot is occupied, Cisco UCS Platform Emulator replaces the existing component with the new one.
You can enter slot range only while adding DIMM, HDD, CPU, or PSU on rack servers and
chassis or while adding fans on chassis. The input for the range must be in the format [a-b]. It is
not valid for adaptors.
e) Repeat Steps a through c until you have modified all desired components in the server.
Note

Step 5

Reinsert the server into the chassis from which you ejected it, as follows:
a) In the Stash area, click on the + icon within the field for the server you want to reinsert.
b) In the Reinsert Server? field, click the green checkmark icon.
Cisco UCS Platform Emulator removes the server from the Stash area and reinserts the server into the
chassis and slot from which you ejected it.
Tip

If you prefer, you can also drag the server from the Stash and drop it into another chassis with an
available slot.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Disconnecting a Chassis from the Fabric Interconnect

This procedure does not remove the chassis from the hardware inventory. It is the equivalent of uncabling the
chassis from the fabric interconnects.

Note

The chassis is not disconnected from the fabric interconnect until you restart the Cisco UCS Platform
Emulator application.

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2

Click Start-up Inventory.

Step 3

In the Chassis area for the chassis you want to connect, click the Disconnect this Chassis from Switch icon
on the icon bar.
In the Disconnect this Chassis from Fabric Interconnect field, click the green checkmark icon to confirm.
Click the Restart the Emulator with this Hardware Setup icon on the icon bar to restart the Cisco UCS
Platform Emulator application and have this change take effect.

Step 4
Step 5

Connecting a Chassis to the Fabric Interconnect

This procedure is the equivalent of cabling the chassis to the fabric interconnects.

Note

The chassis is not connected to the fabric interconnect until you restart the Cisco UCS Platform Emulator
application.

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Start-up Inventory.

In the Chassis area for the chassis you want to connect, click the Connect this Chassis to Fabric Interconnect
icon on the icon bar.
In the Connect this Chassis to Fabric Interconnect field, click the green checkmark icon to confirm.
Click the Restart the Emulator with this Hardware Setup icon on the icon bar to restart the Cisco UCS
Platform Emulator application and have this change take effect.

Step 4
Step 5

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Removing a Chassis from the Hardware Inventory

With this procedure, Cisco UCS Platform Emulator removes the chassis and all servers in the chassis from
the hardware inventory.

Note

The chassis and its servers are not removed from the hardware inventory until you restart the Cisco UCS
Platform Emulator application.

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2

Click Start-up Inventory.

Step 3
Step 4
Step 5

In the Chassis area for the chassis you want to remove, click the Remove this Chassis icon on the icon bar.
In the Remove this Chassis field, click the green checkmark icon to confirm.
Click the Restart the Emulator with this Hardware Setup icon on the icon bar to restart the Cisco UCS
Platform Emulator application and have this change take effect.

Emptying the Stash Area

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3
Step 4

Click Start-up Inventory.

In the Stash area, click the Empty Stash icon on the icon bar.
In the Empty Stash? field, click the green icon to confirm that you want to empty the stash.
Cisco UCS Platform Emulator removes all servers and other components from the Stash area.

Configuring Hardware Inventory using Templates

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Start-up Inventory.

On the Startup Hardware Inventory page, click the Templates tab in the Work pane.

Step 4

From the list of templates, drag and drop the desired template on either the Chassis or Rack servers area.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Using Existing Hardware Inventory Configurations

To configure hardware inventory for blade components, you must drag and drop the template in the
Chassis area.
Note
An error is shown if no slots are available on the
chassis.
To configure hardware inventory for rack components, you must drag and drop the template in the Rack
servers area.
Step 5

Click Submit.
Cisco UCS Platform Emulator replaces the existing configuration with the template configuration.

Using Existing Hardware Inventory Configurations

Importing a Hardware Inventory Configuration File
You can import a hardware configuration file that you exported from one Cisco UCS Platform Emulator into
another Cisco UCS Platform Emulator. You cannot import a backup file from a Cisco UCS domain. If you
want to import the configuration from a Cisco UCS domain, see Importing the Equipment from a Cisco UCS
Domain, on page 35.

Note

Export and import of the configuration file is supported only on the Cisco UCS Platform Emulator, Release
3.0(1aPE1) and not with other versions.

Before You Begin

Changes to this setting do not take effect until you restart Cisco UCS Platform Emulator and reset the database.
If you restart or reboot Cisco UCS Platform Emulator, the Cisco UCS Manager database will only be reset if
the persistent setting is configured to reset the database. You can only configure the persistent setting in the
Cisco UCS Platform Emulator GUI (Emulator Settings > Database Persistence > Preserve or Reset).

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Start-up Inventory.

On the Startup Hardware Inventory page, click the Import XML File icon on the icon bar.

Step 4
Step 5
Step 6

ClickBrowse and navigate to the file that you want to load into the Cisco UCS Platform Emulator.
Click Load File.
Restart the Cisco UCS Platform Emulator VM to overwrite and replace the existing hardware inventory
configuration with the new one, as follows:
a) On the Startup Hardware Inventory page, click the Restart Emulator with this Hardware Setup icon
on the icon bar.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Importing the Equipment from a Cisco UCS Domain

b) In the Are you sure you want to reset UCSM Database and Restart UCS Emulator now? field, click
the Yes radio button.
c) Click Reset UCSM Database and Restart UCS Emulator.
Note
The exported XML configuration now contains information about the fabric interconnect model,
number of IOM links, cluster configuration state and UCSM DB persistence status. When you import
this XML file, all these configurations are also imported along with the file.

Importing the Equipment from a Cisco UCS Domain

Before You Begin
Changes to this setting do not take effect until you restart Cisco UCS Platform Emulator and reset the database.
If you restart or reboot Cisco UCS Platform Emulator, the Cisco UCS Manager database will only be reset if
the persistent setting is configured to reset the database. You can only configure the persistent setting in the
Cisco UCS Platform Emulator GUI (Emulator Settings > Database Persistence > Preserve or Reset).

Note

Importing a configuration using HTTPS is now supported. If HTTPS is disabled on a Cisco UCS domain,
enable HTTPS redirection.
Live import of the configuration is possible only with the UCS Mini and not with other versions of the
Cisco UCS Manager.

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Start-up Inventory.

On the Startup Hardware Inventory page, click the Import Equipment from Live UCS icon on the icon
bar.
In the Cisco UCS Server field, enter the web link for the Cisco UCS Manager GUI of the Cisco UCS domain
from which you want to import the equipment.

Step 4

The default web link is http://UCSManager_IP:port , where UCSManager_IP represents the IP

address assigned to Cisco UCS Manager. This IP address can be one of the following:
Cluster configuration: UCSManager_IP represents the virtual or cluster IP address assigned to
Cisco UCS Manager. Do not use the IP addresses assigned to the management port on the fabric
interconnects.
Standalone configuration: UCSManager_IP represents the IP address for the management port on
the fabric interconnect
And where port represents the port used to access the Cisco UCS Manager GUI. By default, this port is 80
for HTTP access and 443 for HTTPS access.
Step 5

Enter a valid user name and password for the Cisco UCS domain.
Any user with read-only or higher privileges can access the hardware inventory configuration.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Loading a Saved Hardware Inventory Configuration

Step 6
Step 7

Click Load.
Restart the Cisco UCS Platform Emulator VM to overwrite and replace the existing hardware inventory
configuration with the new one, as follows:
a) On the Startup Hardware Inventory page, click the Restart Emulator with this Hardware Setup icon
on the icon bar.
b) In the Are you sure you want to reset UCSM Database and Restart UCS Emulator now? field, click
the Yes radio button.
c) Click Reset UCSM Database and Restart UCS Emulator.
Note
The exported XML configuration now contains information about the fabric interconnect model,
number of IOM links, cluster configuration state and UCSM DB persistence status. When you import
this XML file, all these configurations are also imported along with the file.

Loading a Saved Hardware Inventory Configuration

If you restart or reboot Cisco UCS Platform Emulator, the Cisco UCS Manager database will only be reset if
the persistent setting is configured to reset the database. You can only configure the persistent setting in the
Cisco UCS Platform Emulator GUI (Emulator Settings > Database Persistence > Preserve or Reset).

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Start-up Inventory.

On the Startup Hardware Inventory page, click the Load a Saved Configuration icon on the icon bar.
Note
Only a user created configuration file is shown when you try to load a configuration
file.
In the menu below, click the link for the hardware inventory configuration you want to load into the Cisco
UCS Platform Emulator.
Restart the Cisco UCS Platform Emulator VM to overwrite and replace the existing hardware inventory
configuration with the new one, as follows:
a) On the Startup Hardware Inventory page, click the Restart Emulator with this Hardware Setup icon
on the icon bar.
b) In the Are you sure you want to reset UCSM Database and Restart UCS Emulator now? field, click
the Yes radio button.
c) Click Reset UCSM Database and Restart UCS Emulator.
Note
The exported XML configuration now contains information about the fabric interconnect model,
number of IOM links, cluster configuration state and UCSM DB persistence status. When you import
this XML file, all these configurations are also imported along with the file.

Step 4
Step 5

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Saving the Current Hardware Inventory Configuration

You can save the current hardware inventory configuration from the Startup Hardware Inventory page to
use in another Cisco UCS Platform Emulator VM or as a backup for the current VM. The configuration is
saved as an XML file.

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Start-up Inventory.

On the Startup Hardware Inventory page, click the Save Configuration icon on the icon bar.

Step 4

In the File Name field, enter a name for the configuration file.
The file name must include only alphanumeric chars only, dashes (-) and underscores ( _ ). It cannot include
spaces.

Step 5

Click Save.
The configuration file is saved in Cisco UCS Platform Emulator and added to the saved configuration list.

Exporting the Hardware Inventory Configuration as an XML File

You can save the exported XML file with the hardware inventory configuration and then import it into another
Cisco UCS Platform Emulator or place it on a web server to use as a start up configuration.

Procedure
Step 1

In the Navigation pane, click the Emulator Settings menu tab.

Step 2
Step 3

Click Start-up Inventory.

On the Startup Hardware Inventory page, click the Export Configuration as XML File icon on the icon
bar.
Cisco UCS Platform Emulator opens a new browser tab and displays the contents of the hardware inventory
configuration as an XML file.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Configuring the Hardware Inventory

Exporting the Hardware Inventory Configuration as an XML File

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

CHAPTER

Accessing Features in Cisco UCS Platform

Emulator
This chapter includes the following sections:
Starting the Cisco UCS Manager GUI from the Cisco UCS Platform Emulator Control Panel, page 39
Accessing Cisco DevNet, page 40
Accessing goUCS, page 40
Accessing Cisco UCS PowerTool, page 41

Starting the Cisco UCS Manager GUI from the Cisco UCS
Platform Emulator Control Panel
You can use the Cisco UCS Manager GUI to configure and manage the hardware in your Cisco UCS Platform
Emulator environment.
For information about Cisco UCS Manager GUI commands, see the Cisco UCS Manager GUI Configuration
Guide. You can access this document through the Cisco UCS B-Series Servers Documentation Roadmap
available at the following URL: http://www.cisco.com/go/unifiedcomputing/b-series-doc .

Procedure
Step 1

In the Navigation pane, click the UCS Manager menu tab.

Step 2
Step 3

Click UCS Manager Home.

In the Work pane, click Launch UCS Manager.

Step 4

If a Security dialog box displays, do the following:

a) (Optional) Check the check box to accept all content from the IP address for Cisco UCS Platform Emulator.
b) Click Yes to accept the certificate and continue.

Step 5

In the Login dialog box, do the following:

a) In the User Name field, enter config.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Accessing Features in Cisco UCS Platform Emulator

Accessing Cisco DevNet

b) In the Password field, enter config.

c) Click Login.

Accessing Cisco DevNet

The Cisco DevNet provides information, documentation, and support resources for developers working with
Cisco UCS. You can also access information and documentation for the Cisco UCS Manager XML API from
the Cisco DevNet.

Note

Internet access is required in order to access the Cisco UCS Platform Emulator.

Procedure
Step 1

In the Navigation pane, click the UCS Manager menu tab.

Step 2

Click Cisco DevNet.

Accessing goUCS
Information About goUCS
goUCS is an application that allows you to view the communication between Cisco UCS Manager GUI and
Cisco UCS. This communication is through the Cisco UCS Manager XML API. goUCS parses the Cisco
UCS Manager GUI's log file and extracts the XML documents sent to Cisco UCS. goUCS also allows you to
substitute attribute values in captured XML documents in order to customize commands. goUCS can greatly
simplify UCS integration since programmers can mimick the Cisco UCS Manager GUI operations and
customize them if necessary.
goUCS enables you to automate any action that can be performed in the Cisco UCS Manager GUI, including:
Query for data
Modify existing objects in the Cisco UCS domain
Complete complex tasks in a single transaction, such as the following:
Create ten service profiles from a service profile template
Associate each of those service profiles with a server
Power on each of the servers

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Accessing Features in Cisco UCS Platform Emulator

Downloading goUCS

Downloading goUCS
Note

Cisco UCS Platform Emulator must have access to the internet to download goUCS.

Procedure
Step 1

In the Navigation pane, click the UCS Manager menu tab.

Step 2

Click GoUCS Tool Download.

Accessing Cisco UCS PowerTool

Information about Cisco UCS PowerTool
Cisco UCS PowerTool is a Microsoft PowerShell command line toolkit and interface to Cisco UCS. You can
use Cisco UCS PowerTool to integrate, automate, and orchestrate all aspects of Cisco UCS management
within the data center, including network, storage and hypervisor management.
Cisco UCS includes over 1800 PowerShell command-lets (cmdlets) that enable you to integrate and automate
Cisco UCS with Microsoft products and many third party products.

Downloading Cisco UCS PowerTool

Note

Cisco UCS Platform Emulator must have access to the internet to download Cisco UCS PowerTool.

Procedure
Step 1

In the Navigation pane, click the UCS Manager menu tab.

Step 2

Click GoUCS Tool Download.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Accessing Features in Cisco UCS Platform Emulator

Downloading Cisco UCS PowerTool

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

CHAPTER

Using the Managed Object Browser

This chapter includes the following sections:
Information About the Managed Object Browser, page 43
Managed Object Browser Page, page 43
Running a Query in the Managed Object Browser, page 45

Information About the Managed Object Browser

The Managed Object Browser, or Visore, that you can access through Cisco UCS Platform Emulator provides
you with a graphical view of the managed objects in the XML database. You can also use the Managed Object
Browser to find out what type of data Cisco UCS stores in the database for each type of managed object. In
addition, since the Managed Object Browser uses the Cisco UCS Manager XML API to query the runtime
managed objects and display the results, it also enables you to see the query that was used to obtain the
information from the database.
For example, you can use the Managed Object Browser to see which service profiles have been configured
and the XML query that was used to access that information in the database. You can also use it to view the
type of data stored in the database about servers, such as the number of cores, the type of adapter, or the
number of CPUs. You can then use that information when you design or debug a Cisco UCS domain.

Tip

You can also connect to and run queries with the Managed Object Browser on a running Cisco UCS
domain through the following URL: http://UCSManager_IP:port_number/visore.html.

Managed Object Browser Page

Filter Area
The filter form is case sensitive. This area supports all simple Cisco UCS Manager XML API operations.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Using the Managed Object Browser

Managed Object Browser Page

Name

Description

Class or DN field

Object class name or full distinguished name of a managed object.

Property field

The property of the managed object on which you want to filter the
results. If you leave the Property field empty, the search returns all
instances of the specific class.

Op drop-down list

Operator for the values of the property on which you want to filter the
results. The following are valid operators are:
==equal to
!=not equal to
<less than
>greater than
less than or equal to
greater than or equal to
between
wildcard
anybit
allbits

Val1 field

The first value for the property on which you want to filter.

Val2 field

The second value on which you want to filter.

Display XML of Last Query Link

The Display XML of last query link displays the full Cisco UCS Manager XML API translation of the most
recent query run in the Managed Object Browser.
Results Area
You can bookmark any query results page in your browser to view the results again because the query is
encoded in the URL.

Note

Many of the managed objects are only used internally and are not generally applicable to Cisco UCS
Manager program development.
Name

Description

Pink background

Separates individual managed object instances and displays the class

name of the object below it.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Using the Managed Object Browser

Running a Query in the Managed Object Browser

Name

Description

Blue or green background

Indicates the property names of the managed object.

Yellow or beige background

Indicates the value of a property name.

dn property

Absolute address of each managed object in the object model.

dn link

When clicked, displays all managed objects with that dn.

Class name link

When clicked, displays all managed objects of that class.

Left arrow

When clicked, takes you to the parent object of the managed object.

Right arrow

When clicked, takes you to the child objects of the managed object.

Question mark

Links you to the XML API documentation for the managed object.

Running a Query in the Managed Object Browser

Procedure
Step 1

In the Navigation pane, click the UCS Manager menu tab.

Step 2
Step 3

Click Managed Object Browser.

In the Work pane, In the Class or DN field, type the class or DN of the managed object you want to query.
This is the only required field in a query. For information about the available classes or DNs, see the Cisco
UCS Manager XML API documentation.
Example:

If you want to search on all instances of the blade class in the object model, enter computeBlade in the Class
or DN field. However, if you want to limit the query to a specific server, such as blade server 1 in chassis 1,
enter sys/chassis-1/blade-1.
Step 4

(Optional) If you want to filter the results of your query, complete the following fields:
Name

Description

Property field

Enter a property of the managed object on which you

want to filter the results of the search. For example,
if you are querying computeBlade, you could enter
association.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Using the Managed Object Browser

Running a Query in the Managed Object Browser

Name

Description

Op drop-down list

Choose the operator on which you want to filter the

values for the property. This can be:
==, !=, <, >, , , between, wildcard, anybit, allbits
==equal to
!=not equal to
<less than
>greater than
less than or equal to
greater than or equal to
between
wildcard
anybit
allbits

Step 5

Val1 field

Enter an available value for the property entered in

the Property field. For example, if you are filtering
on the association property, you could enter
unassociated.

Val2 field

Enter an available second value for the property

entered in the Property field.

Click Run Query

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

CHAPTER

Accessing the Cisco UCS Manager XML API

Documentation
This chapter includes the following sections:
Information About the Cisco UCS Manager XML API, page 47
Information About the Cisco UCS Manager XML API Documentation, page 48
Accessing the Cisco UCS Manager XML API Documentation, page 48
Saving the Cisco UCS Manager XML API Schema and Samples, page 49

Information About the Cisco UCS Manager XML API

The Cisco UCS Manager XML API is a programmatic interface to Cisco Unified Computing System (UCS).
The API accepts XML documents through HTTP or HTTPS. Developers can use any programming language
to generate XML documents that contain the API methods. Configuration and state information for Cisco
UCS is stored in a hierarchical tree structure known as the management information tree, which is completely
accessible through the XML API.
The Cisco UCS Manager XML API supports operations on a single object or an object hierarchy. A single
API call can make changes to a single attribute of an object such as the power state of a blade, or many objects
such as chassis, blades, adapters, policies, and other configurable components.
The API operates in forgiving mode. Missing attributes are substituted with default values (if applicable) that
are maintained in the internal data management engine (DME). The DME ignores incorrect attributes. If
multiple managed objects (MOs) are being configured (for example, virtual NICs), and any of the MOs cannot
be configured, the API stops its operation. It rolls back the management information tree to its prior state
(before the operation) and returns an error.
Updates to MOs and properties conform to the existing object model, ensuring backward compatibility. If
existing properties are changed during a product upgrade, they are managed during the database load after
the upgrade. New properties are assigned default values.
Operation of the API is transactional and terminates on a single data model. Cisco UCS is responsible for all
endpoint communication, such as state updates; users cannot communicate directly to endpoints. In this way,
developers are relieved from the task of administering isolated, individual component configurations.
The API model includes the following programmatic entities:

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Accessing the Cisco UCS Manager XML API Documentation

Information About the Cisco UCS Manager XML API Documentation

ClassesDefine the properties and states of objects in the management information tree.
MethodsActions that the API performs on one or more objects.
TypesObject properties that map values to the object state (for example, equipmentPresence).
A typical request comes into the DME and is placed in the transactor queue in FIFO order. The transactor
gets the request from the queue, interprets the request, and performs an authorization check. After the request
is confirmed, the transactor updates the management information tree. This complete operation is done in a
single transaction.
Full event subscription is enabled. After subscribing, any event notification is sent along with its type of state
change.

Information About the Cisco UCS Manager XML API

Documentation
The Cisco UCS Manager XML API documentation that you can access through the Cisco UCS Platform
Emulator provides information about the Cisco UCS Manager information model
When you view the XML API documentation, the navigation frames on the left list the following information:
Managed objects
Methods
Types
Fault rules
Finite State Machine (FSM) rules
For more information about the Cisco UCS Manager XML API, see the Cisco UCS Manager XML API
Programmer's Guide.

Accessing the Cisco UCS Manager XML API Documentation

Procedure
Step 1

In the Navigation pane, click the UCS Manager menu tab.

Step 2

Click XML API Docs.

The XML API docs are displayed in the Work pane. The links provide navigation through the information
model.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Accessing the Cisco UCS Manager XML API Documentation

Saving the Cisco UCS Manager XML API Schema and Samples

Saving the Cisco UCS Manager XML API Schema and Samples
Cisco provides the Cisco UCS Manager XML API schema and samples for you use as a reference when
programming with the Cisco UCS Manager XML API.

Procedure
Step 1

In the Navigation pane, click the UCS Manager menu tab.

Step 2
Step 3

Click API Schema & Samples.

Follow the prompts to save and extract the files to a location on your hard drive.

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Accessing the Cisco UCS Manager XML API Documentation

Saving the Cisco UCS Manager XML API Schema and Samples

Cisco UCS Platform Emulator User Guide, Release 3.0(1cPE1)

Cisco UCS Manager Troubleshooting Reference Guide
No ratings yet
Cisco UCS Manager Troubleshooting Reference Guide
122 pages
Linux Security Fundamentals
From Everand
Linux Security Fundamentals
David Clinton
No ratings yet
Datacenter Build Quotation
No ratings yet
Datacenter Build Quotation
12 pages
Cisco UCS Platform Emulator User Guide, Release 3.0 (2cPE1) : Americas Headquarters
No ratings yet
Cisco UCS Platform Emulator User Guide, Release 3.0 (2cPE1) : Americas Headquarters
60 pages
Cisco UCS Platform Emulator User Guide Version 2 1 (3aPE1
No ratings yet
Cisco UCS Platform Emulator User Guide Version 2 1 (3aPE1
66 pages
Cisco UCS Platform Emulator User Guide Version 2.2 (1bPE1)
No ratings yet
Cisco UCS Platform Emulator User Guide Version 2.2 (1bPE1)
66 pages
Cisco UCS Platform Emulator User Guide Version 2.2 (2cPE1)
No ratings yet
Cisco UCS Platform Emulator User Guide Version 2.2 (2cPE1)
71 pages
B Cisco UCS Platform Emulator User Guide Release 3 1.2bPE1 Final2
No ratings yet
B Cisco UCS Platform Emulator User Guide Release 3 1.2bPE1 Final2
68 pages
B Cisco UCS Platform Emulator User Guide Release 3 1 2e PE1
No ratings yet
B Cisco UCS Platform Emulator User Guide Release 3 1 2e PE1
68 pages
Cisco UCS Platform Emulator User Guide
No ratings yet
Cisco UCS Platform Emulator User Guide
54 pages
B UCSM Getting Started Guide 4 0 PDF
No ratings yet
B UCSM Getting Started Guide 4 0 PDF
58 pages
b_ucsm_getting_started_guide_4_3
No ratings yet
b_ucsm_getting_started_guide_4_3
68 pages
B UCSM2 1 C Integration
No ratings yet
B UCSM2 1 C Integration
58 pages
Cisco UCS Platform Emulator Release Notes version 2.2(3aPE1)
No ratings yet
Cisco UCS Platform Emulator Release Notes version 2.2(3aPE1)
7 pages
UCS-SCU22 Book
No ratings yet
UCS-SCU22 Book
36 pages
B UCS MIBRef
No ratings yet
B UCS MIBRef
36 pages
B Cisco UCS C-Series GUI Configuration Guide 31 PDF
No ratings yet
B Cisco UCS C-Series GUI Configuration Guide 31 PDF
372 pages
B Ucs Api Book
No ratings yet
B Ucs Api Book
44 pages
UCSPE_Release_Notes_4_1_2cPE1
No ratings yet
UCSPE_Release_Notes_4_1_2cPE1
7 pages
UCSE-series GUI Configuration Guide 322 PDF
No ratings yet
UCSE-series GUI Configuration Guide 322 PDF
176 pages
B UCSM CLI Configuration Guide 2 2
No ratings yet
B UCSM CLI Configuration Guide 2 2
808 pages
Cisco UCS C-Series Servers Linux Installation Guide
No ratings yet
Cisco UCS C-Series Servers Linux Installation Guide
26 pages
B Cisco UCS C-Series GUI Configuration Guide 201
No ratings yet
B Cisco UCS C-Series GUI Configuration Guide 201
398 pages
Cisco UCS C240 Server Installation and Service Guide
No ratings yet
Cisco UCS C240 Server Installation and Service Guide
160 pages
UCSM GUI Configuration Guide 2 2
No ratings yet
UCSM GUI Configuration Guide 2 2
672 pages
Dcuci50 SG Vol1
No ratings yet
Dcuci50 SG Vol1
448 pages
UCSPE Release Notes 3.2 3ePE1
No ratings yet
UCSPE Release Notes 3.2 3ePE1
8 pages
B Cisco Ucs x210c m7 Install Guide
No ratings yet
B Cisco Ucs x210c m7 Install Guide
102 pages
C210M1 UCS Server Installation and Service Guide
No ratings yet
C210M1 UCS Server Installation and Service Guide
104 pages
Cisco CIMC CLI Configuration Guide
No ratings yet
Cisco CIMC CLI Configuration Guide
80 pages
B CLI VMware VM-FEX UCSM Configuration Guide
No ratings yet
B CLI VMware VM-FEX UCSM Configuration Guide
66 pages
B CLI Config Guide 1 3 1
No ratings yet
B CLI Config Guide 1 3 1
462 pages
Cisco UCS C220 M3 Server Installation and Service Guide
No ratings yet
Cisco UCS C220 M3 Server Installation and Service Guide
136 pages
Cisco UCS C-Series Servers Integrated Management Controller Configuration Guide 1
No ratings yet
Cisco UCS C-Series Servers Integrated Management Controller Configuration Guide 1
80 pages
Cisco UCS C-Series Servers Integrated Management Controller Configuration Guide 1-0 1x
No ratings yet
Cisco UCS C-Series Servers Integrated Management Controller Configuration Guide 1-0 1x
80 pages
B Ise InstallationGuide32 2
No ratings yet
B Ise InstallationGuide32 2
122 pages
B Cisco UCS Manager Server MGMT Guide 3 1
No ratings yet
B Cisco UCS Manager Server MGMT Guide 3 1
312 pages
B Ise InstallationGuide32
No ratings yet
B Ise InstallationGuide32
130 pages
Cisco UCS C220 M3 Server Installation
No ratings yet
Cisco UCS C220 M3 Server Installation
134 pages
Cisco UCS Manager Server MGMT Guide 3 1
No ratings yet
Cisco UCS Manager Server MGMT Guide 3 1
332 pages
Cisco UCS C220 M3 Server Installation and Service Guide
No ratings yet
Cisco UCS C220 M3 Server Installation and Service Guide
130 pages
Implementing Cisco UCS Solutions Sample Chapter
No ratings yet
Implementing Cisco UCS Solutions Sample Chapter
44 pages
HCS 12 5 SRND PDF
No ratings yet
HCS 12 5 SRND PDF
134 pages
B Command Reference 2 0 PDF
No ratings yet
B Command Reference 2 0 PDF
1,798 pages
Cisco UCS C220 M4 Server PDF
No ratings yet
Cisco UCS C220 M4 Server PDF
130 pages
B ACI Simulator Guide Rel 3 X
No ratings yet
B ACI Simulator Guide Rel 3 X
38 pages
Cisco UCS B200 M4 Blade Server Installation and Service Note
No ratings yet
Cisco UCS B200 M4 Blade Server Installation and Service Note
56 pages
cisco_ucs_competitive_battlecard
No ratings yet
cisco_ucs_competitive_battlecard
2 pages
B UCSM CLI Configuration Guide 2 0 Password Recovery
No ratings yet
B UCSM CLI Configuration Guide 2 0 Password Recovery
690 pages
Cisco Unified Presence 8.0
No ratings yet
Cisco Unified Presence 8.0
54 pages
UCSM GUI Configuration Guide
No ratings yet
UCSM GUI Configuration Guide
812 pages
C220
No ratings yet
C220
134 pages
Cisco PI Hardware Appliance Installation Guidee
No ratings yet
Cisco PI Hardware Appliance Installation Guidee
20 pages
Cisco Identity Services Engine Installation Guide, Release 2.3
No ratings yet
Cisco Identity Services Engine Installation Guide, Release 2.3
88 pages
Cisco Prime Infrastructure Appliance Hardware Installation Guide
No ratings yet
Cisco Prime Infrastructure Appliance Hardware Installation Guide
18 pages
UCS B200 M4 Installation Service
No ratings yet
UCS B200 M4 Installation Service
56 pages
Cisco IE 4010 Switch Hardware Installation Guide: September 2016 September 2019
No ratings yet
Cisco IE 4010 Switch Hardware Installation Guide: September 2016 September 2019
76 pages
B Cisco UCS Admin MGMT Guide 3 1
No ratings yet
B Cisco UCS Admin MGMT Guide 3 1
154 pages
Framework for SCADA Cybersecurity
From Everand
Framework for SCADA Cybersecurity
Richard Clark
5/5 (1)
Docker, Containers And All The Rest: First Edition, #1
From Everand
Docker, Containers And All The Rest: First Edition, #1
Ami Adi
No ratings yet
Implementing Cisco UCS Solutions
From Everand
Implementing Cisco UCS Solutions
Farhan Ahmed Nadeem
No ratings yet
Wa002
No ratings yet
Wa002
11 pages
Accounting For Managers
No ratings yet
Accounting For Managers
286 pages
Mba Zc415 Ec-2r Second Sem 2016-2017
No ratings yet
Mba Zc415 Ec-2r Second Sem 2016-2017
3 pages
Arp Timelines and Activities Group-10
No ratings yet
Arp Timelines and Activities Group-10
1 page
Elastic Search
No ratings yet
Elastic Search
19 pages
The Learning Card
No ratings yet
The Learning Card
1 page
Project Charter Template
No ratings yet
Project Charter Template
3 pages
MBA in Consultancy Management
No ratings yet
MBA in Consultancy Management
6 pages
Easy Sol Project
No ratings yet
Easy Sol Project
6 pages
Business Hypotheses Test: Backlog Test: Build Test: Measure Test: Learn Progress
No ratings yet
Business Hypotheses Test: Backlog Test: Build Test: Measure Test: Learn Progress
1 page
We Believed That: Insight Name Person Responsible Date of Learning
No ratings yet
We Believed That: Insight Name Person Responsible Date of Learning
1 page
LTSP Docu PDF
No ratings yet
LTSP Docu PDF
69 pages
High Levelopenstack Cloudcomputing 1435958434
No ratings yet
High Levelopenstack Cloudcomputing 1435958434
67 pages
Enterprise Amazon Web Services Architecture
No ratings yet
Enterprise Amazon Web Services Architecture
1 page
Lecture 13
No ratings yet
Lecture 13
1 page
AWS Syllabus
100% (1)
AWS Syllabus
3 pages
Hive User Defined Functions: Step 1: Code
No ratings yet
Hive User Defined Functions: Step 1: Code
5 pages