cisco ucs platform emulator guidedocshare02.docshare.tips/files/4843/48434792.pdf · 2017-01-26 ·...

30
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 Cisco UCS Platform Emulator Guide April 21, 2010

Upload: others

Post on 31-Mar-2020

65 views

Category:

Documents


3 download

TRANSCRIPT

Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706 USAhttp://www.cisco.comTel: 408 526-4000

800 553-NETS (6387)Fax: 408 527-0883

Cisco UCS Platform Emulator GuideApril 21, 2010

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.

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 relationship between 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 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 UCS Platform Emulator Guide © 2010 Cisco Systems, Inc. All rights reserved.

iiiCisco UCS Platform Emulator Guide

C O N T E N T S

Preface v

Audience v

Organization v

UCS Developers Support and User Community v

Related Documentation vi

Documentation Feedback vi

C H A P T E R 1 Cisco UCS Platform Emulator 1-1

About Cisco UCS Platform Emulator 1-1

Installing the UCS Platform Emulator 1-2

Installation Prerequisites 1-2

UCS Platform Emulator Virtual Machine Packaging 1-2

Start UCSPE 1-3

UCSPE Configuration Menu 1-3

Connecting to UCS Manager Facilities 1-4

Ending a UCSPE Session 1-4

UCS Platform Emulator Limitations 1-5

Advantages of Using the UCS Platform Emulator 1-6

UCS Platform Emulator Use Cases 1-6

UCS Platform Emulator Architecture 1-6

Troubleshooting the UCS Platform Emulator 1-7

C H A P T E R 2 UCS Manager Model Object Documentation 2-1

About Model Object Documentation 2-1

Navigation Pane 2-3

Main Pane 2-4

C H A P T E R 3 Visore UCS Manager Model Object Browser 3-1

About Visore 3-1

Starting Visore 3-1

Visore Interface Description 3-2

Filter Form 3-4

Contents

ivCisco UCS Platform Emulator Guide

G L O S S A R Y

I N D E X

vCisco UCS Platform Emulator Guide

Preface

This chapter includes the following:

• Audience, page v

• Organization, page v

• Related Documentation, page vi

• Documentation Feedback, page vi

AudienceThis 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 Platform Emulator (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 UCS application developers.

You can post issues and requests relating to the UCS Platform Emulator and UCS XML API to the UCS Manager forum. The forums are periodically monitored by Cisco developers and support personnel, but there 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 Manager

viCisco UCS Platform Emulator Guide

Preface

Related DocumentationFor information on the Cisco UCS, visit the following product pages:

http://www.cisco.com/en/US/products/ps10265/index.html

http://www.cisco.com/en/US/products/ps10281/index.html

Documentation for Cisco UCS is available at the following URL:

http://www.cisco.com/en/US/docs/unified_computing/ucs/overview/guide/UCS_roadmap.html

The documentation set for the Cisco Unified Computing System environment includes the following guides:

• 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 Manager

Note The Cisco UCS Manager GUI Configuration Guide and the Cisco UCS Manager CLI Command Reference provide an overview of the Unified Computing System and the UCS Manager. This is important 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 com-ments to [email protected]. We appreciate your feedback.

C H A P T E R

1-1Cisco UCS Platform Emulator Guide

1Cisco UCS Platform Emulator

This 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-7

About Cisco UCS Platform EmulatorThe Cisco Unified Computing System Platform Emulator (UCSPE) simulates various UCS hardware device 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 OS

1-2Cisco UCS Platform Emulator Guide

Chapter 1 Cisco UCS Platform EmulatorInstalling the UCS Platform Emulator

Installing the UCS Platform EmulatorYou must have an account on the Cisco Network to download UCSPE. UCSPE is available internally so that any Cisco employee can download it. Any UCSPE download has a unique encrypted ID so that users can 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 to virtual machine conversions)

• Install Firefox (or any Mozilla compatible browser). This is the required browser for connecting to UCSPE.

• 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,” under which 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 Linux distribution. This virtual machine (VM) can run an entire UCS Manager multichassis, multiblade simulation on a single laptop or desktop computer with no internet connection required. The end-user experience 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 the UCSPE release number, such as CiscoUCSPEv1.1.1j.zip. The file is approximately 2 GB. Unzip the file to your hard drive using WinZip or the open source 7-Zip. The extracted directory, CiscoUCSPEv1.1.1j, is approximately 4.7 GB.

1-3Cisco UCS Platform Emulator Guide

Chapter 1 Cisco UCS Platform EmulatorInstalling the UCS Platform Emulator

Start UCSPEAfter unzipping the virtual machine package to your hard drive, follow the steps below to begin a UCSPE session.

Step 1 Go to the UCS Platform Emulator directory, for example, CiscoUCSPEv1.1.1j, and double click the VMX executable file CiscoUCSPEv1.1.1j.vmx. This launches the VMware console.

Step 2 The first time that you start UCSPE, the VMware virtual machine asks whether this VM was moved or copied. Select copied to ensure that your virtual machine acquires a unique hardware identity.

Step 3 The VM is configured to use the local DHCP network to obtain its IP address. If your local network does not support DHCP, you can change the UCSPE VM networking setting from the default NAT mode to Host Only mode. Select Network Adapter from the Device drop-down menu of the VMware console window.

Step 4 When the VM splash page first appears, the virtual machine IP address is displayed, similar to the following:

========== My IP is: 111.222.33.44 ==========Use your browser and connect to http://111.222.33.44/ after the boot up is complete.

Step 5 Type the VM IP address into the address bar of the browser. If the connection is successful, the Cisco UCS Manager page displays in the browser window. The IP address is also displayed at the top of VM console window after you log in (see Step 6).

Step 6 In the VM console window, at the login prompt type config. Type the same for the password.

UCSPE Configuration Menu

The configuration menu appears in the VM console window after you log in. There are several UCSPE settings that you can modify. The settings are displayed above the menu and they change depending on your configuration selections. Some changes restart UCSPE to enable the virtual machine configuration changes.

Current Settings:

HA Mode: HA

Number of Chassis: 2

Number of Blades 4

Number of Uplinks: 1

Table 1-1 UCSPE Configuration Options

Re-Stamp Changes the unique ID encrypted on UCSPE that identifies the user. Only a Cisco representative should use this option.

Un-Stamp Removes the unique UCSPE encrypted ID. Only a Cisco representative should use this option. This disables UCSPE and requires restamping.

Toggle HA Mode (clears DB) Changes from a single to dual fabric interconnect emulation. Toggling clears all configuration data and service profiles.

1-4Cisco UCS Platform Emulator Guide

Chapter 1 Cisco UCS Platform EmulatorInstalling the UCS Platform Emulator

Connecting to UCS Manager Facilities

From 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 specifics on 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-style documentation interface detailing the XML API objects).

• XML samples and the XML schema definition (XSD). The UCS XML API examples and XSD schema are packaged in a zip file that you can unzip to a folder of your choice.

Ending a UCSPE Session

To exit a session, do the following:

Step 1 Go to the VM console window.

Step 2 From the configuration menu, select Shutdown.

Change Number of Chassis/Blades

Specifies the number of chassis (1-8) and the number of blades per chassis (1-8).

Change Number of Uplinks Specifies either one or two uplinks.

Restart UCSPE & Force DB Reset

Restarts the emulator and clears all configuration information in the database.

Factory Reset Reinstalls the emulator software and restarts. Only a Cisco representative should use this option. This disables UCSPE and requires restamping.

Reboot Reboots the virtual machine.

Shutdown Shuts down the emulator and operating system.

Exit This Menu Exits the configuration menu. Log in again to restore menu.

Table 1-1 UCSPE Configuration Options

1-5Cisco UCS Platform Emulator Guide

Chapter 1 Cisco UCS Platform EmulatorInstalling the UCS Platform Emulator

UCS Platform Emulator Limitations

Inherent Limitations

No data path UCSPE emulates only what is necessary for the UCS manager to function; it does not emulate network data flow.

No cut-through interfaces to equipment

Servers in a real Cisco UCS system contain integrated management controllers (CIMCs), each of which supports an IPMI interface. Switch components of UCS support an SNMP interface. Because both switch and CIMCs are considered endpoints of the UCS management system, these interfaces are, in fact, cut-through interfaces that bypass the UCS manager. An emulated environment cannot support these interfaces.

No KVM KVM (keyboard/video/mouse) is also a cut-through interface and is not supported. And as there are no real servers attached to the emulator, there are no ports to which KVM can connect.

No Telnet, SSH, or FTP communication

Similar to the SNMP and IPMI interfaces, SSH, FTP, and Telnet, access (through user-facing or UCS Manager Ethernet interfaces) is unavailable because it also bypasses the UCS Manager software and is considered cut-through access.

Limited HA failover scenarios Although UCSPE can run in high-availability mode, it runs both sets of UCS management processes on a single OS. Consequently, it supports only one failover scenario: when one of the two management processes in the HA pair dies. Scenarios pertaining to link loss between cluster members, loss of EEPROM readability, and others, are not supported.

Current Limitations

No RBAC authentication control In UCSPE, the UCS Manager accepts security configuration changes, but does not enforce security. Specifically, any username and password combination can successfully login to the GUI, and all such logins have the “administrator” role.

Mandatory database reset When you switch to or from HA mode, the UCS Manager database. is cleared. This is the only setting change for which DB cleanup is done.

Command-line interface issues UCSPE does not support the command-line interface.

Known Issues

Locator LED is not fully emulated

The LED state defaults to “on” on all chassis, and to “off” on all servers. The states cannot be changed from the GUI.

Settings not persistent between VM restarts

All settings created using the GUI are lost after each UCSPE virtual machine reboot. There are two ways to preserve user-created configuration:

• Use the Configuration Export/Import feature of the GUI

• Hibernate the virtual machine (for example, in VMware Player close the Player window)

1-6Cisco UCS Platform Emulator Guide

Chapter 1 Cisco UCS Platform EmulatorAdvantages of Using the UCS Platform Emulator

Advantages of Using the UCS Platform EmulatorThe UCSPE significantly shortens the development cycle for applications that are based on the UCS XML API. Using UCSPE, you can create programs without needing real hardware until the final stages of 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 problems

UCS Platform Emulator Use CasesIn addition to the previously mentioned advantages for program development, UCSPE can be used to do the following:

• Provide a convenient way to demonstrate UCS operations for training and other purposes due to its portability

• 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 UCS system, these drivers run on the fabric interconnect. An endpoint driver can be replaced by simulation software to mimic the hardware for UCSPE. These simulated drivers are actually Linux processes that run on CentOS.

UCSPE data management engine (DME) leverages the actual DME architecture so that the finite state machine (FSM) scenarios are consistent. In other words, the simulated stimuli that are received must be identical to stimuli received in a real system).

UCSPE behavior is controlled through the XML configuration facility which populates equipment managed objects. Configuration is done by XML scripts that simulate real-world actions.

1-7Cisco UCS Platform Emulator Guide

Chapter 1 Cisco UCS Platform EmulatorTroubleshooting the UCS Platform Emulator

Troubleshooting the UCS Platform EmulatorVMware for UCSPE requires that DHCP be available to retrieve IP addresses. See the VMware documentation 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 VMware console 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.

1-8Cisco UCS Platform Emulator Guide

Chapter 1 Cisco UCS Platform EmulatorTroubleshooting the UCS Platform Emulator

C H A P T E R

2-1Cisco UCS Platform Emulator Guide

2UCS Manager Model Object Documentation

This chapter includes the following:

• About Model Object Documentation, page 2-1

• Navigation Pane, page 2-3

• Main Pane, page 2-4

About Model Object DocumentationUCS hardware components, such as NICs, ports, blades, and processors (this also includes physical infrastructure such as power supplies, fans, and LEDs) are represented as model objects (MOs). Statistics, faults, and events are also represented as MOs. All UCS MOs are organized hierarchically in the management information tree (MIT).

Managed objects in the MIT contain (called the contained hierarchy), or are contained (called the container hierarchy), in other managed objects. This applies to all MOs except topRoot, which is the base of the tree and contains all other MOs.

The UCS model documentation documents the model object properties, containments, and relationships. The model documentation can be viewed only through Firefox or other Mozilla-compatible browser.

Note Many of the model objects are only used internally by the UCS Manager and are not generally applicable to UCS program development.

Figure 2-1 shows the opening view of the model documentation after you click the link in the UCS Manager Page.

2-2Cisco UCS Platform Emulator Guide

Chapter 2 UCS Manager Model Object DocumentationAbout Model Object Documentation

Figure 2-1 Opening View of the API Model Documentation

2-3Cisco UCS Platform Emulator Guide

Chapter 2 UCS Manager Model Object DocumentationAbout Model Object Documentation

Navigation PaneClick the All Packages heading in the navigation pane to display all class objects alphabetically by group. The class name prefix displays in the heading. Click the class prefix displayed in the heading, and then click All Packages to return to the original navigation pane configuration.

The browser Find function searches for text only in the currently displayed panes. Note the colon (:) separating the object name group from the object name descriptive element. Be sure to include the colon when searching for an object. Searches are not case sensitive.

Table 2-1 UCS Manager Model Documentation Navigation Pane Elements

Classes Define the properties and states of UCS managed objects (such as a blade server—computeBlade) in the management information tree.

Method Operations performed on UCS managed objects.

Types Properties of UCS objects that map values to the object state.

Event Rules Rules that trigger additions to the UCS Manager audit log. For example, removal of hardware or modification of a pool.

Fault Rules Specify the characteristics (such as the cause, status, and type) of faults that occur in various UCS components.

FSM Rules Define workflows performed by the UCS Manager on various UCS endpoints.

2-4Cisco UCS Platform Emulator Guide

Chapter 2 UCS Manager Model Object DocumentationAbout Model Object Documentation

Main PaneThe following are the names of the sections that comprise the class object main pane.

Click the word “details” when it appears next to a class object name to view a pop-up window showing summary information for that object. Click “details” again to close the pop-up.

Table 2-2 Element Links in the UCS Manager Model Documentation

Naming Rules Lists the distinguished name and relative name of all instances of the object class.

Containers Hierarchies Schematic representation of all the object classes above the current object in the management information tree. The current object may be in more than one branch of the MIT.

Contained Hierarchies Schematic representation of all the object classes below this object in the management information tree. The current object may be in more than one branch of the MIT.

Inheritance Properties inherited by a subclass (child classes) from a superclass (parent class).

Event Rules Rules that trigger additions to the UCS Manager audit log. For example, removal of hardware or modification of a pool.

Fault Rules Specify the characteristics (such as the cause, status, and type) of faults that occur in various UCS components.

FSM Rules Define workflows performed by the UCS Manager on various UCS endpoints.

Properties Summary Lists and links to all the attributes of the current object class.

Properties Detail Class name and properties descriptions.

C H A P T E R

3-1Cisco UCS Platform Emulator Guide

3Visore UCS Manager Model Object Browser

This chapter includes the following:

• About Visore, page 3-1

• Starting Visore, page 3-1

• Visore Interface Description, page 3-2

About VisoreVisore is the Cisco Unified Computing System model object browsing tool. Using Visore, you can inspect elements of the UCS model object tree. It uses the UCS XML API to query the runtime model objects and view the formatted results as a web page. Visore lets you see the API representation of each query submitted, so it is an excellent learning and debugging tool. Visore can be viewed only through Firefox or other Mozilla-compatible browser.

Starting VisoreTo start Visore, click Model Browser on the UCS Manager page (see Connecting to UCS Manager Facilities, page 1-4).

After becoming operational, you can connect to any running UCS system at http://UCSIP:port#/visore.html to display the Visore interface.

3-2Cisco UCS Platform Emulator Guide

Chapter 3 Visore UCS Manager Model Object BrowserVisore Interface Description

Visore Interface DescriptionThe Visore interface is easy to follow if you understand the concepts of the management information tree, model objects, containment, and naming. The following are characteristics of the Visore interface:

Note Colors described below may render differently depending on your monitor. See Figure 3-1 for description of the Visore interface fields.)

• The pink background color separates individual model object instances and displays the class name of the model object below it.

• Blue/green indicates the property names of the model object.

• Yellow/beige indicate value of a property name.

• The absolute address of each model object in the tree is the “dn” (distinguished name) property.

• Click a “dn” link (for example, sys/chassis-1/locator-led) to display the model object with that distinguished name.

• Click a class name (for example, equipmentLocatorLed) to show all model objects of that class.

• Click a left arrow to navigates to the parent of the model object.

• Click a right arrow to navigates to the child of the model object (that is, the contained model objects).

• Click a question mark (?) link to view the model documentation page for the class object.

• Click Display XML of last query to show the full UCS XML API translation of the most recent interface operation. You can copy and past queries from the display box into an XML document.

• You can bookmark any Visore page in your browser because the query is encoded in the URL.

3-3Cisco UCS Platform Emulator Guide

Chapter 3 Visore UCS Manager Model Object BrowserVisore Interface Description

Figure 3-1 Visore Interface Description

LEGEND

1. UCS XML API command translation

2. Managed object class name

3. Model object property

4. Property value

5. Model object DN

6. Click to display parent object

7. Click to display child object

8. Click for managed object class description

(2)

(2)

(3)

(3)

(3)

(4)

(4)

(4)

(5)

(6) (7)

(6) (7)

(8)

(8)

(5)

(1)

3-4Cisco UCS Platform Emulator Guide

Chapter 3 Visore UCS Manager Model Object BrowserVisore Interface Description

Filter FormThe following are the operational characteristics of the Visore filter form (shown in Figure 3-2). The filter is case sensitive. This form supports all simple UCS XML API filter operations.

• Type an object class name in the Class or DN field. If you leave the Property field empty, the search returns all instances of the specified class.

• Alternatively, you can enter the full distinguished name of a model object into the Class or DN field.

Figure 3-2 Visore Filter Form

GL-1Cisco UCS Platform Emulator Guide

G L O S S A R Y

A

Application

Gateway (AG)

Translation layer between the model-centric and endpoint-specific messages. The AG is a hardware abstraction layer that acts as a translator between the DME and the endpoints. It propagates configuration changes to the endpoints, and reports system state information from the endpoints to the DME.

Abstract Class An abstract class typically represents an abstract concept or entity and cannot be instantiated; it can only be a parent class from which child classes are derived. The child classes then extend the functionality by implementing methods inherited from the abstract parent class. Note that UCS objects contain only attributes, not methods, and you cannot modify UCS objects by adding attributes. (See Concrete Class.)

C

Classes Define the properties and states of UCS objects (such as a blade server) in the management information tree.

Concrete Class A class that can be instantiated. (See Abstract Class.)

Contained Hierarchy The subtree of a managed object. topRoot is the root of the management information tree, so all UCS managed objects are part of topRoot’s contained hierarchy.

Container Hierarchy A listing of a model object’s parents up to topRoot in the MIT hierarchy.

Glossary

GL-2Cisco UCS Platform Emulator Guide

D

Data Management

Engine (DME)

The central service that manages components of the UCS. It consists of a transaction engine and an information repository (the management information tree). It is the only component in the UCS that stores and maintains states for UCS managed devices and elements. The DME manages and maintains the following:

• Object life cycle management

• Management information tree and database

• Transaction services

• Data mutations

• Replication of data and state

• UCS Manager high availability services

• Business logic and behavior rules

• Asynchronous deployments to application gateways

• Validation and modifications

• Role-based access control

Distinguished Name

(DN/dn)

Immutable property of all managed objects (MO) that provides a fully qualified and unambiguous name for the managed object.

E

Endpoints Managed UCS devices, including adaptors, blades, chassis, fabric extenders, and fabric interconnects.

Event Rules Rules that trigger additions to the UCS Manager audit log.

F

Fabric Interconnect The central nervous system of the UCS. It is the management and communication backbone for UCS B-Series blades and the UCS 5100 Series blade server chassis. The fabric interconnect consolidates I/O, provides management capabilities, and enables uniform access to networks and storage.

Fault Rules Specify the characteristics (such as the cause, status, and type) of faults that occur in various UCS components.

Finite State Machine A programmatic behavioral model consisting of a finite number of states, transitions between states, and actions. An FSM maintains an internal memory to ensure that actions occur in a specific sequence, and that no state transition takes place until a required action completes. In other words, a condition must be fulfilled to enable the transition. A finite state machine is sometimes referred to as workflow engine.

Glossary

GL-3Cisco UCS Platform Emulator Guide

FSM Rules Define workflows performed by the UCS Manager on various UCS endpoints.

FSM Tasks Any of the automated routines that the UCS Manager invokes to facilitate the flow of information, events and operations.

I

Inheritance Inheritance is a way to form new classes using classes that are already defined. A new class inherits the attributes and behavior of the pre-existing classes on which it is based. This allows the reuse of existing code with little or no modification.

Information Model

(IM)

Domain-specific formal specification of the managed object class rules (properties, containment, inheritance, and so on) and service APIs used by the management framework.

Information Model

XML (IMXML)

XML representation of the native information model (IM) and API to access and manipulate the IM. This includes mechanisms for getting and setting managed objects (RPC), as well as mechanisms to register for events.

M

Management

Information Tree

(MIT)

Repository of all managed object instances, indexed by their distinguished name (DN). The management information tree (MIT) resembles a file system structure, going from a main folder to the next lowest folder and so on, until the full “path name” to a managed object is established (see Relative Name (RN/rn).

Managed Object

(MO

A base class for all objects of the management framework. All managed object classes are specified by the information model (IM). All managed object instances are stored in the management information tree and accessed using their distinguished name (DN) or relative name (RN).

Methods Actions that the API performs on UCS objects.

N

Network Address

Translation (NAT)

A technique in which a router or firewall rewrites the source and/or destination Internet addresses in a packet as it passes through, typically to allow multiple hosts to connect to the Internet by way of a single external IP address. NAT keeps track of outbound connections and distributes incoming packets to the correct machine.

R

Relative Name

(RN/rn)

Name of an object relative to the name of its container object. Similar to the relative path of a file in a file system, where the DN would be the full pathname of that file (see Distinguished Name (DN/dn)).

Role-based Access

Control (RBAC)

Functionality that provides a way to determine the types of operations that a user can preform; and restricts access of various capabilities to authorized users in the system.

Glossary

GL-4Cisco UCS Platform Emulator Guide

S

Service Profile Synonymous with the lsServer API class. The identity, processor node requirements, connectivity requirements, association policy, and storage resources used by a server. (Also referred to as a logical server.)

Stimuli Entities that can change the administrative state of a managed object. Events are input to the data management engine (DME) and to the application gateways (AGs) that queue and process them.

T

Types Properties of UCS objects that map values to the object state.

X

XML Schema A schema describes the structure of an XML document and validates data in an XML environment. An XML schema is also referred to as an XML schema definition (XSD). An XML schema for UCS is available and distributed with the UCS XML API.

IN-1Cisco UCS Platform Emulator Guide

I N D E X

A

about the model object documentation 2-1

about the UCS Platform Emulator 1-1

about Visore 3-1

abstract class, definition 1-1

application gateway, definition 1-1

audience, book i-v

B

browser, required 1-2

C

CentOS, packaged with UCSPE 1-2

classes, definition 1-1

concrete class, definition 1-1

configuration menu 1-3

connecting to UCS Manager facilities 1-4

contained hierarchy, definition 1-1

container hierarchy, definition 1-1

D

data management engine, definition 1-2

distinguished name (DN/dn), definition 1-2

DN/dn (distinguished name) 1-2

document

audience i-v

organization i-v

documentation, related i-vi

E

ending a UCSPE session 1-4

endpoints, definition 1-2

event rules, definition 2-3, 2-4, 1-2

F

fabric interconnect, definition 1-2

fault rules, definition 2-3, 2-4, 1-2

Find function, limitation 2-3

finite state machine (FSM), definition 1-2

Firefox browser 1-2

FSM rules, definition 2-3, 2-4, 1-3

FSM tasks, definition 1-3

I

IM (information model) 1-3

IMXML (information model XML) 1-3

information model (IM), definition 1-3

information model XML (IMXML), definition 1-3

inheritance, definition 1-3

installation prerequisites 1-2

L

limitations of UCSPE 1-5

M

main pane, description 2-4

managed object (MO), definition 1-3

Index

IN-2Cisco UCS Platform Emulator Guide

management information tree (MIT), definition 1-3

methods, definition 1-3

MIT (management information tree) 1-3

MO (managed object) 1-3

model browser, Visore 3-1

model object documentation 1-4

N

NAT network adapter mode 1-7

navigation pane, description 2-3

network adapter mode, recommended 1-7

network address translation (NAT), definition 1-3

O

organization, book i-v

P

pop-up window, summary 2-4

prerequisites for installing UCSPE 1-2

R

RBAC (role-based access control) definition 1-3

related documentation i-vi

relative name, definition 1-3

RN/rn (relative name) 1-3

role-based access control (RBAC), definition 1-3

S

service profile, definition 1-4

starting UCSPE 1-3

starting Visore 3-1

stimuli, definition 1-4

summary pop-up window 2-4

T

troubleshooting UCSPE 1-7

types, definition 1-4

U

UCS Manager, model object documentation 2-1

UCS Manager facilities, launching 1-4

UCSPE

advantages 1-6

architecture 1-6

configuration menu 1-3

installation 1-2

installation prerequisites 1-2

limitations 1-5

package size 1-2

release numbering 1-2

session shutdown 1-4

starting up 1-3

supported VMware products 1-2

troubleshooting 1-7

use cases 1-6

V

Visore

display XML query 3-2

model browser 3-1

property field 3-4

starting 3-1

VMware, supported products on UCSPE 1-2

W

workflow engine (see finite state machine) 1-2

Index

IN-3Cisco UCS Platform Emulator Guide

X

XML schema

accessing examples 1-4

definition 1-4

Index

IN-4Cisco UCS Platform Emulator Guide