Cisco IMC PowerTool, Release 1.x

Managed Objects

Managed Objects (MOs) (see Figure 2) are abstractions of Cisco IMC MIT resources, such as CPUs, DIMMs, adapter cards, fans, and power supply units. Managed Objects represent any physical or logical entity that is configured or managed in the Cisco IMC MIT For example, physical entities such as CPUs, DIMMs, adapter cards and fans and logical entities such as users, communication services like HTTP, SSH are represented as MOs.

Figure 2 Managed Objects

Each MO 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 that start from the root to the MO itself. Essentially, DN = [RN]/[RN]/[RN]/…/[RN].

In the following example, DN provides a fully qualified name for adapter-1 in the model.

The above written DN is composed of the following RN:

A relative name (RN) might have a value of one or more of the MO properties embedded in it. This allows you to differentiate 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, adaptor MOs reside under a rack unit MO. The adaptor MO contains the adaptor identifier as part of its Rn(adaptor-[Id]), which uniquely identifies each adaptor MO in the context of a rack unit.

Cisco IMC

Cisco IMC PowerTool is compatible with the following Cisco IMC releases:

• Release 1.5 and above for the C-Series servers
• Release 2.2(1) and above for the E-Series servers

Windows PowerShell Requirements

• Cisco IMC PowerTool requires Windows PowerShell v2.0 or higher version to be installed on the system
• Check the Microsoft web site for specific Windows PowerShell requirements

Installation Requirements

• Before installing Cisco IMC PowerTool, you must do the following:
• Close any instances of PowerShell running with the PowerTool module loaded.
• Uninstall the beta versions of the Cisco IMC PowerTool

Methods

Methods are Cisco UCS XML APIs used to manage and monitor the system. The following methods are supported:

• Authentication
• aaaLogin—Initial method for logging in.
• aaaRefresh—Refreshes the current authentication cookie.
• aaaLogout—Exits the current session and deactivates the corresponding authentication cookie.
• configResolveDn—Retrieves objects by DN.
• configResolveClass—Retrieves objects of a given class.
• configResolveChildren—Retrieves the child objects of an object.
• configResolveParent—Retrieves the parent object of an object.
• configConfMo—Affects a single managed object (for example, a DN).
• eventSubscribe—To register for events

Cisco IMC PowerTool Mapping

All but about 10 of the Cisco IMC PowerTool cmdlets are generated from the MO specification. A noun is used in place of the type (Fan instead of EquipmentFan and so on). Get, Add, Set, Remove cmdlets or a subset is generated for the various MO types. All cmdlets support the XML parameter, which dumps the XML request and response on the screen.

Add Cmdlet —Uses the ConfigConfMo method with the MO status “created” with the specified property values. If the Force parameter is specified, there is no prompt for confirmation.

Get Cmdlet —Uses the ConfigResolveClass method to retrieve MOs. XML API of Cisco UCS C-Series Rack Mount servers do not support any filters. So if any property parameters are specified, PowerTool gets all the instances of the specified class and filters them on the client side using the property values.

Set Cmdlet —Uses the ConfigConfMo method with MO status “modified” with the specified property values. If the Force parameter is specified, there is no prompt for confirmation.

Remove Cmdlet —Uses the ConfigConfMo method with the MO status “deleted”. If the Force parameter is specified, there is no prompt for confirmation.

This table lists the properties that can be specified for a given verb:

This table lists the types that can come down the pipeline for corresponding cmdlets:

This table lists the methods invoked to generate the required XML requests:

Get-ImcCmdletMeta is a useful cmdlet to explore the MO types, the corresponding nouns, supported verbs, properties of the MOs, the details of properties including the type (Naming, Read/Write and so on), and the version of Cisco IMC that the property was introduced in.

Before You Begin

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

Installation

Step 1 Download and launch the installer.

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

Getting Started

Step 1 From the desktop shortcut, launch IMC PowerTool.

Step 2 View all cmdlets, functions, and aliases supported by Cisco IMC PowerTool.

Step 3 Connect to a Cisco UCS C-Series and E-Series Server.

Note After logging on, by default, the Cisco UCS handle is added to the default Cisco UCS C-Series and E-Series Server list, unless the -NotDefault option is specified. Every cmdlet that operates on a Cisco UCS C-Series and E-Series Server takes the –Imc parameter, where the handle can be specified.

Step 4 Connect to a Cisco UCS C-Series and E-Series Server using a proxy.

Step 5 Use the following cmdlets:

a. Get the consolidated status information from the Cisco C-Series and E-Series Server.

Get-ImcStatus -Imc $handle

b. Get the inventory summary of the C-Series Unit.

Get-ImcRackUnit -Imc $handle

c. Disconnect.

Disconnect-Imc –Imc $handle

Default Cisco UCS

If no handle or name is specified, the Cisco UCS C-Series and E-Series Server handle is added to a DefaultImc server list unless the –Imc parameter is specified. The first cmdlet in the pipeline operates on the default UCS list.

Connect to UCS C-Series rack server

Get the default rack server.

Get the status information and CIMC version of the rack server.

Get information about the physical unit of the rack server.

Enable HTTP on the rack server.

Disable HTTP on the rack server.

Disconnect the rack server.

Default UCS List with Multiple UCS

Cisco IMC PowerTool cmdlets can work with multiple Cisco UCS C-Series Rack Servers if you specify multiple handles.

Connect to a Cisco UCS C-Series and E-Series Server.

By default, multiple Cisco UCS C-Series handles are not allowed in DefaultImc. You can override this restriction by using the Set-UcsPowerToolConfiguration cmdlet.

Connect to multiple Cisco C-Series and E-Series Server by using the same login credentials.

Credentials to/from a File

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

A login can be initiated from credentials stored in a file.

Specify proxy while logging in with credentials stored in a file.

Log in to an additional system and add the credentials to the file.

SSL Handling

When a user connects to a Cisco UCS C-Series and E-Series Server and the server cannot recognize any valid certificates, the connection establishment depends on InvalidCertificateAction. InvalidCertificateAction is set to Ignore by default. By default Cisco IMC PowerTool is configured to establish the connection without taking into account if the certificate is invalid.

You can override this setting by using the Set-ImcPowerToolConfiguration cmdlet.

Following table describes the options to check the validity of the certificate.

Aliases

Some aliases have been defined for convenience. To view the list of all aliases, run the following cmdlet:

Add User

Note Clear-ImcLocalUser only changes the status to inactive and does not remove the user or data.

Enable IP Blocking

Get-ImcIpBlocking | Set-ImcIpBlocking -Enable “yes”

Configure NTP Settings

Modify Syslog Settings

Get-ImcSyslog | Set-ImcSyslog -LocalSeverity warning -RemoteSeverity debug -Force

Configure SoL

Get-ImcSolif -Dn “sys/rack-unit-1/sol-if” | Set-ImcSolIf -AdminState “enable” -Speed “57600” -Force

Set Boot Order

Get-ImcLsbootStorage | Set-ImcLsbootStorage -Order 2 -Force

vMedia Configuration

Get-ImcCommVMedia | Set-ImcCommVMedia -AdminState “enabled” -EncryptionState “enabled” -Force

Get Adapter and Controller Information

# PCI Adapter Properties

Get-ImcPciEquipSlot -Id “1”

# Network Adapter Information

# Storage Controller Information

Transaction Support

# Start a transaction

# Perform an operation.

# End a transaction.

# Undo a transaction.

Managed Object Synchronization

# Enable SupportMultipleDefaultImc to connect to multiple CIMC.

# Get credential and store it in a variable.

# Connect to different CIMC.

# Get local user from different CIMC.

# Synchronize a set of MOs from CIMC2 to CIMC1.

Filters

# Get SysdebugMEpLog managed object where Type equals to “SEL” or Type equals to “Syslog”.

# Get SysdebugMEpLog managed object where (Type equals to “SEL” or Type equals to #”Syslog”) and Id equals to “0” and Type equals to “SEL”.

# Get local user where name is like “admin” (case sensitive).

# Get User where name is like “test*” (support * regular expression/case sensitive).

# Get local user where AccountStatus is not equals to inactive.

# Get local user where AccountStatus matches ‘inacti’.

# Get local user where AccountStatus matches with ‘active’ (starts with active/case sensitive).

# Get local user where AccountStatus does not matches with ‘active’ (starts with active/case sensitive).

# Get local user where Accountstatus is not like ‘active’ (starts with active/case sensitive).

HUU Firmware Update

Create a user credential

Update HUU firmware

Cisco IMC Firmware Update

Create a user credential

Cisco IMC Firmware Update

Activate Cisco IMC Firmware

Create a Virtual Drive

Create virtual using unused physical drive

Create a virtual drive using a virtual drive group

Set a Boot Drive

Set a physical drive as a boot Drive

Set a virtual drive as a boot Drive

Clear a Boot Drive

PowerTool Cmdlet Generation

ConvertTo-ImcCmdlet:

Cisco IMC GUI does not support XML logging. To generate Cmdlets ConvertTo-IMC Cmdlet rely on the output of the Get cmdlet and generate Cmdlets to replicate the same object hierarchy.

Generate cmdlets for the specified MOs.

Save the cmdlet output in file.

Setting BIOS Password

Note Setting BIOS password feature is applicable for E-Series servers only.

Server Actions

Added the following new aliases to perform server actions:

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.