Cisco UCS Central PowerTool, Release 1.x

Managed Objects

Managed Objects (MO) are abstractions of Cisco UCS domain resources, such as fabric interconnects, chassis, blades, and rack-mounted servers. Managed Objects represent any physical or logical entity that is configured / managed in the Cisco UCS Central MIT. For example, physical entities such as Servers, Chassis, I/O cards, Processors and logical entities such as resource pools, user roles, service profiles, and policies are represented as managed objects.

Figure 2 Managed Objects

Every managed object is uniquely identified in the tree with its Distinguished Name (Dn) and can be uniquely identified within the context of its parent with its Relative Name (Rn). The Dn identifies the place of the MO in the MIT. A Dn is a concatenation of all the relative names starting from the root to the MO itself. Essentially, Dn = [Rn]/[Rn]/[Rn]/…/[Rn].

In the example below, Dn provides a fully qualified name for adaptor-1 in the model.

The above written Dn is composed of the following Rn:

A Relative Name (Rn) may have the value of one or more of the MO’s properties embedded in it. This allows in differentiating multiple MOs of the same type within the context of the parent. Any properties that form part of the Rn as described earlier are referred to as Naming properties.

For instance, multiple blade MOs reside under a chassis MO. The blade MO contains the blade identifier as part of its Rn (blade-[Id]), thereby uniquely identifying each blade MO in the context of a chassis.

References to Managed Objects

The contents of the managed objects are referred to during the operation of Cisco UCS Central. Some of the MOs are referred to implicitly or as part of deployment of another MO (The Service Profile MO may refer to a template or a VNIC refers to a number of VLAN MOs).

The different types of references can be classified as shown below:

Figure 3 References to Managed Objects

A singleton MO type is found at most once in the entire MIT and is typically referred to implicitly.

Non-Singleton MO type may be instantiated one or more times in the MIT. In many cases, when an MO refers to another, the reference is made by name. Depending on the type of the referenced MO, the resolution may be hierarchical. For instance, a service profile template is defined under an org. Since an org may contain sub-orgs, a sub org may have a service profile template defined with the same name. Now, when a service profile instance refers to a service profile template (by name), the name is looked up hierarchically from the org of the service profile instance up until the root org. The first match is used. If no match is found, the name “default” is looked up in the similar way and the first such match is used.

Properties of Managed Objects

Properties of Managed Objects may be classified as Configuration or Operational.

Configuration properties may be classified as:

• Naming properties: Form part of the Rn. Needs to be specified only during MO creation and cannot be modified later.
• Create-Only properties: May be specified only during MO creation and cannot be modified later. If the property is not specified, a default value is assumed.
• Read / Write properties: May be specified during MO creation and can also be modified subsequently.

Operational properties indicate the current status of the MO / system and are hence read-only.

Figure 4 Properties of Managed Objects

The table below lists the examples of the various property types.

Methods

Methods are Cisco UCS Central XML APIs used to manage and monitor the system. There are methods supported for:

• Authentication

– AaaLogin

– AaaRefresh

– AaaLogout

• Configuration

– ConfigConfMo(s)

– LsClone

– LsInstantiate*

– FaultAckFaults

• Query

– ConfigResolveDn(s)

– ConfigResolveClass(es)

– ConfigResolveChildren

• Event Monitor

– EventSubscribe

The class query methods (ConfigResolveClass(es), ConfigResolveChildren) allow a filter to be specified so that a specific set of MOs are matched and returned by the method.

The supported filters are:

• Property Filters:

Supported Filter	Definition
allbits	Match if all specified values present in a multi-valued property
anybit	Match if any of the specified values present in a multi-valued property
bw	Match if the property’s value lies between the two values specified
eq	Match if property’s value is the same as the specified value
ge	Match if property’s value is greater than or equal to the specified value
gt	Match if property’s value is greater than the specified value
le	Match if property’s value is lesser than or equal to the specified value
lt	Match if property’s value is lesser than the specified value
ne	Match if property’s value is not equal to the specified value
wcard	Match if property’s value matches the pattern specified

• Composite Filters (Acts on sub-filters)

Composite Filter	Definition
not	Negates result of sub-filter
and	True, if all the sub-filters return true
or	True, if any of the sub-filters return true

Cisco UCS Central

Cisco UCS Central PowerTool is compatible with the followoing Cisco UCS Central releases:

• Release 1.2
• Release 1.3

Windows PowerShell Requirements

• Cisco UCS Central PowerTool supports Windows PowerShell 2.0 and later

Before You Begin

• Ensure you have PowerShell v2.0 installed in your system
• Close any instances of PowerShell running with the PowerTool module loaded

Installation

Step 1 Download and launch the installer.

Step 2 (Optional) Select Create Shortcut to add a shortcut on the desktop.

Getting Started

Step 1 Launch Cisco UCS Central PowerTool from the desktop shortcut.

Step 2 View all cmdlets, functions, and aliases supported by the Cisco UCS Central PowerTool.

Step 3 Connect to a Ucs Central system.

Note If login is successful Connect-UcsCentral, by default, adds the UCS Central handle to the Default UCS Central list, unless the -NotDefault option is specified. Every cmdlet that operates on Ucs Central takes the –UcsCentral parameter, where the handle can be specified.

Step 4 Use the following cmdlets:

a. Get org objects.

Default UCS Central

If no handle or name is specified, the UCS Central handle is added to a Default UCS Central list. Unless the –UcsCentral parameter is specified, the first cmdlet in the pipeline operates on the default UCS Central list.

Get the Default UCS Central list.

Get the set of all chassis objects.

Get the object pertaining to chassis 1.

Get the set of blades, pertaining to chassis 1.

Disconnect.

Default UCS Central List with Multiple UCS Central Systems

PowerTool cmdlets can work with multiple UCS Central systems by specifying multiple handles.

Connect to a Cisco UCS Central system.

By default, multiple Cisco UCS Central handles are not allowed in Default UCS Central. This can be overridden using the Set-UcsCentralPowerToolConfiguration cmdlet.

Connect to multiple Cisco UCS Central systems using the same login credentials.

Credentials to/from File

Credentials can be stored to a file. The stored credentials are encrypted with a specified Key.

Login can be initiated from credentials stored in a file.

Login to an additional system and add the credentials to the file.

SSL Handling

When a user connects to a Cisco UCS Central server and the server cannot recognize any valid certificates, the connection depends on InvalidCertificateAction. InvalidCertificateAction is set to Ignore by default. By default PowerTool is configured to establish the connection without considering the validity of the certificate.

You can override this using the Set-UcsCentralPowerToolConfiguration cmdlet.

Aliases

Aliases are the simplified cmdlets which can be used to perform Cisco UCS Central operations.

Generate Cmdlets From UCS Central GUI Actions

Before You Begin

• Install Flash Debugger (not flash player) for your Internet browser. You can download the software from this URL: https://www.adobe.com/support/flashplayer/downloads.html.

Note Flash debuggers are different for different browsers. For example, Internet Explorer has a different flash debugger than Mozilla Firefox.

• Configure mm.cfg file located under user directory. For instance, if there is a user name demoUser on the windows system, this file should be located in this path - “C:\Users\demoUser”. This file provides instructions to the Flash Debugger about settings related to log dumping. Modify the following properties as:

If there is no mm.cfg file user can create one and follow below mentioned link to edit/configure mm.cfg file:

http://helpx.adobe.com/flash-player/kb/configure-debugger-version-flash-player.html

Step 1 After the UCS Central GUI launches, at the login page, press ctrl + alt + shift + L. The Logger Console flash popup is displayed. You need to modify the logger preferences as follows:

a. Select the Trace option for the property Destination.

b. Click the Set Log Preference button.

Step 2 Enter the username and password for UCS Central and log on to UCS Central.

A log file is created in the log file location depending on the OS. For more information on the exact location of the log files, see https://helpx.adobe.com/flash-player/kb/configure-debugger-version-flash-player.html. The name of the log file is the name mentioned in the property TraceOutputFileName in mm.cfg. If this property does not exist, the name will be flashlog.txt.

Note If there is no Logs folder, create a Logs folder and repeat steps 1through step 2.

Step 3 Launch UCS Central PowerTool and run the ConvertTo-UcsCentralCmdlet.

This cmdlet monitors the configuration logs in the log file.

Step 4 Perform operations in the GUI.

The cmdlets for actions performed in the GUI are generated in the powertool console.

If you are using Google Chrome, perform the following steps to disable the integrated flash player and to install the flash debugger:

Step 1 Install Flash debugger that is compatible with the Netscape browser.

Step 2 Select chrome://plugins and click the "[+] Details" icon, located at the top right corner of the screen.

Step 3 Search for the Shockwave Flash or Flash option.

Step 4 Disable the integrated version installed under the Chrome directory on your local machine. For example, C:\Program Files (x86)\Google\Chrome\Application\39.0.2171.71\PepperFlash\pepflashplayer.dll

Step 5 Enable the Netscape compatible Flash Debugger which you installed in the Systems directory on your local machine. For example, C:\Windows\SysWOW64\Macromed\Flash\NPSWF32_15_0_0_239.dll.

Step 6 Restart the Google Chrome browser.

Generate Cmdlets From Backup file

The following example is used to generate cmdlet from a backup file.

Generate cmdlets from backup file

Generating Cmdlets From UCS Central PowerShell Object

Cmdlets can be generated by piping the UCS Central objects from a Get cmdlet to the ConvertTo cmdlet. In the following example, ConvertTo cmdlet generates the cmdlets required to re-create the 'testSP' service profile object.

Generate cmdlets for the specified managed object

Org

Get a list of orgs across Cisco UCS Central systems, in the Default UCS Central list.

Get a handle to the root level Org.

Add 5 orgs to UCS.

Faults

Retrieve faults, group them by severity.

Retrieve critical faults.

Get Cmdlet -Hierarchy Flag

Get Managed Object including all children.

Get Cmdlet –LimitScope Flag

Get service profile at the root level without descending into org root children.

Transaction Support

Start a transaction.

Perform an operation.

End a transaction.

Undo a transaction.

UUID Suffix Pools

Create a UUID Suffix pool.

Add a block of UUID Suffixes to the suffix pool.

Remove a UUID Suffix pool.

MAC Pools

Create a MAC pool.

Add a block of mac to the mac pool.

Remove a mac pool.

WWNN Pools & Blocks

Get all WWNN pool in UCS Central.

Create a WWNN pool.

Add a WWN block to the WWNN pool.

Remove a WWNN pool.

WWPN Pools & Blocks

Get all WWPN pool in UCS Central.

Create a WWPN pool.

Remove a WWPN pool.

Clone a Service Profile

Copies a service profile.

Add Service Profile Using Service Profile Template

Adds new service profiles using an existing service profile template.

Rename Service Profile

Renames existing service profile.

Associate Service Profile

Associates a service profile to a server pool/blade or rackunit servers.

Disassociate Service Profile

Renames existing service profile.

Configuration Backup

Remove any previously stored backups in UCS Central.

The PathPattern can be auto-filled, allowing the cmdlet to be used with multiple Cisco UCS Central domains. Create and download full-state system backup of UCS Central. This creates a binary file that includes a snapshot of the entire system. You can use the file generated from this backup to restore the system during disaster recovery. This file can restore or rebuild the configuration on the new UCS Central VM. You cannot use this file for an import.

Create and download logical backup of UCS Central. This creates an XML file that includes all logical configuration settings such as service profiles, VLANs, VSANs, pools, and policies. You can use the file generated from this backup to import these configuration settings to the UCS Central. You cannot use this file for a system restore.

Create and download system backup of UCS Central. This creates an XML file that includes all system configuration settings such as usernames, roles, and locales. You can use the file generated from this backup to import these configuration settings to the UCS Central. You cannot use this file for a system restore.

Create and download config-all backup of UCS Central. This creates an XML file that includes all system and logical configuration settings. You can use the file generated from this backup to import these configuration settings to the UCS Central. You cannot use this file for a system restore. This file does not include passwords for locally authenticated users.

Import Configuration

The import function is available for all configuration, system configuration, and logical configuration files. You can perform an import while the system is up and running.

Import all configuration xml (An XML file that includes all system and logical configuration settings. The current configuration information is replaced with the information in the imported configuration file one object at a time.

Import all configuration xml. The information in the imported configuration file is #compared with the existing configuration information. If there are conflicts, the import operation overwrites the information on the Cisco UCS Central domain with the information in the import configuration file.

Tech Support

Technical support data for the entire UCS Central instance is created and downloaded to the specified file.

Technical support data for the Operation Manager provider is created and downloaded to the specified file.

Filters

Get all Local Service Profiles with Name containing string ‘SJC’.

Get all Roles that have the fault privilege.

Get all Roles that have the fault or operations privilege.

Get all Roles that have the fault and operations privilege.

Get a list of faults generated between 4/18/2012 9:00 and 4/19/2012 9:30.

Get Local Service Profiles with Name equals ‘SJC’.

Get all Local Service Profiles with Name equals ‘SJC/sjc/SjC’ etc.

Get all Local Service Profiles with Name beginning with string ‘SJC/sjc/SjC’ etc.

Get all Local Service Profiles with Name except ‘SJC/sjc/SjC’ etc.

Generic Managed Object Queries

Get Managed Object of a specific DN.

Get all Managed Objects of a particular class.

Get DNs of Managed Objects of a particular class.

Get names of all Service Profiles from org-root.

Get immediate children of org-root.

Get parent of a Managed Object.

Generic Managed Object Cmdlets

Create an Org

Modify description of Managed Object.

Remove a Managed Object.

CCO Integration

There are two cmdlets related to CCO Image handling:

Get a List of Images from CCO.

Select 1.2(1a) images and download the images. Get-UcsCentralCcoImage first checks if the image is available locally. If the image exists and md5sum matches, no download is initiated. If not, the image is downloaded.

Re-running the command should not initiate any downloads, if the previous download was successful.

A proxy can be used if required.

Export to XML

Export the configuration of a Managed Object.

Export the xml of a Managed Object into a file.

Import from XML

Import the configuration from the XML file.

Import xml of a Managed Object and convert it into objects.

KVM

Start a KVM session for service profile.

Start a KVM session for blade 2.

Start a KVM session for RackUnit 1 with custom frame Title.

Registered UCS Domains

Get a list of Registered UCS Domains

Cmdlet Meta Information

Get Meta information about all Managed Object mapped cmdlets.

Get Meta information about ComputeRequirement mapped cmdlets.

View the hierarchy of the ComputeRequirement class.

Get Meta information for the ComputeRequirement noun.

See the Managed Object information for ComputeRequirement.

See the Managed Object property information for ComputeRequirement.

Add Cmdlet –ModifyPresent Flag

The ModifyPresent option ensures that the add-cmdlets modify the MO, if it already exists, instead of returning an error.

Compare UCS Central Managed Object

The Compare-UcsCentralManagedObject cmdlet compares the managed objects from same or different UcsCentral domains and provides the ManagedObject Difference object generated by the cmdlet.

Note For running this cmdlet, connection handle is not required.

Synchronize UCS Central Managed Object

The Sync-UcsCentralManagedObject cmdlet uses the ManagedObject Difference object to synchronize the managed objects on a same or different UcsCentral and make the configuration same throughout UcsCentral.

Launch UCS Central Domain Session

The Start-UcsCentralDomainSession cmdlet launches the UCS Manager GUI sessions registered with UcsCentral. You can provide a specific IP address of the UCS Manager to launch a particular UCS Manager GUI session..

Get UCS Central Server

The Get-UcsCentralServer cmdlet returns all the servers regardless of the form factor.

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: 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)

Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.

© 2015 Cisco Systems, Inc. All rights reserved.