Cisco UCS PowerTool Suite - PowerShell Modules for Cisco UCS Manager, Cisco IMC, UCS Central

[Jeffrey Foster]

We are pleased to announce the release of Cisco UCS PowerTool Suite version 2.4.1.

Cisco UCS PowerTool suite is a set of PowerShell modules for Cisco UCS Manager, Cisco IMC and Cisco UCS Central that helps in configuration and management of Cisco UCS domains and solutions.

Key Features in Release 2.4.1

• Support for new features in Cisco IMC Release 3.1(3a)
• Support for new features in Cisco UCSM Release 3.2(3)
• Updated cmdletSet-ImcHuuFirmwareUpdaterwith new parameters.
• Updated catalog rules for M5 Servers.

Key Features in Release 2.3.1

• Support for new features in Cisco IMC Release 3.1(1d)
• Support for new features in Cisco UCS Central Release 2.0(1b)
• Support for new features in Cisco UCSM Release 3.2(1d)
• Updated cmdletAdd-UcsCentralServiceProfileFromTemplateto create Service profile with service profile template
• Added cmdletGet-UcsCentralPolicyUsageto provide support to fetch policy details for any managed object.

Key Features in Release 2.2.1

• Support for new features in Cisco IMC Release 3.0(1c) and 3.0(2b)
• Support to launch the UCS Manager HTML GUI automatic login
• Support to specify the JSON file as input for uploading the hardware profile to HCL Tool
• Support to collect advisories for the hardware profile in HCL Tool cmdlet
• Security enhancement to HCL Tool cmdlets

Your scripts written using PowerTool 1.x will break due to module name changes.

The following table lists the module name changes in this release:

Previous Module Name	New Module Name
CiscoUcsCentralPS	Cisco.UCSCentral
CiscoImcPS	Cisco.IMC
CiscoUcsPS	Cisco.UCSManager

Installer download (from cisco.com):

• Download Cisco UCS PowerTool Suite Version 2.4.1(Requires Cisco.com login)

Module download (from Powershell Gallery):

• Cisco.UCSManager

             https://www.powershellgallery.com/packages/Cisco.UCSManager/2.4.1.3

• Cisco.IMC

               https://www.powershellgallery.com/packages/Cisco.IMC/2.4.1.3

• Cisco.UCSCentral

              https://www.powershellgallery.com/packages/Cisco.UCSCentral/2.4.1.3

• Cisco.UCS.DesiredStateConfiguration

               https://www.powershellgallery.com/packages/Cisco.UCS.DesiredStateConfiguration/2.4.1.3

Documentation:

• Release Notes for Cisco UCS PowerTool Suite 2.x
• Installation and Configuration Guide  for Cisco UCS PowerTool Suite 2.x
• User Guide for Cisco UCS Manager PowerTool
• User Guide for Cisco IMC PowerTool
• User Guide for Cisco UCS Central PowerTool
• Cisco UCS PowerTool Scripts Index

Reference: Cisco UCS PowerTool Command Reference for Cisco UCS Manager

External customers - For any queries/feedback on PowerTool, contact Cisco TAC or ucs-powertool@cisco.com or add a discussion to the Cisco Developed Integrations sub-space on Cisco UCS Communities

We are also on Slack - slack requires registration, but the cisco-ucs-powertool channel on powershell team is open invitation to anyone to register here. Once you join the powershell slack team you can join cisco-ucs-powertool channel here

Internal (Cisco) customers and employees - Contact us at ucs-powertool@cisco.com for support questions and ask-ucs-tme@cisco.com or ask-ucs-pm@cisco.com for roadmap questions and feedback.

[vigneshkumark]

Looking for good user guide or tutorial...... please update asap.

[Jeffrey Foster]

There are a number of good resources here on the Cisco Communities site including the following:

1. Video: Automate your Infrastructure: Programmatic Management of Cisco UCS with Microsoft System Center and PowerShell:

https://communities.cisco.com/videos/11207

This session was delivered at MMS 2013 by Eric Williams and Jason Shaw

2. UCS Tech Talk: Tips and tricks for managing Cisco UCS with PowerShell and Microsoft Systems Center:

https://communities.cisco.com/docs/DOC-36655

This Tech Talk was recorded in October 2013 and includes great references to PowerShell and a number of UCS Integrations for Microsoft System Center.

3. Scripts: There are also a number of scripts provided by the community available on our UCS Integrations site here:

https://communities.cisco.com/ucsintegrations

Note: You can filter by topic, and in this case I would suggest filtering PowerTool content to help you locate the most topical resources.

4. User Guides: UCS PowerTool documentation is available here:

https://communities.cisco.com/docs/DOC-37154

[tg_bennett]

I am using PowerTool 1.0.1. With UCSM 2.2 there are new boot options, Internal USB, External USB, Internal SD or local LUN. In my script I use Add-UcsLsbootStorage, Add-UcsLsbootLan and Add-UcsLsbootLocalStorage to specify boot order in the policy.

# Create Boot Policy

    Write-Host "UCS: Creating Boot Policy: $bootpolname"

Start-UcsTransaction

$bootpol =  Get-UcsOrg -Level root | Get-UcsOrg -Name $org -LimitScope | Add-UcsBootPolicy -Descr "" -EnforceVnicName "yes" -Name $bootpolname -RebootOnUpdate "no" -ModifyPresent

$pxe = $bootpol | Add-UcsLsbootLan -ModifyPresent -Order "1" -Prot "pxe"

$eth0 = $pxe| Add-UcsLsbootLanImagePath -BootIpPolicyName "" -ISCSIVnicName "" -ImgPolicyName "" -ImgSecPolicyName "" -ProvSrvPolicyName "" -Type "primary" -VnicName "eth0" -ModifyPresent

$LocalDisk = $bootpol  | Add-UcsLsbootStorage -ModifyPresent -Order "2"

$AddLocalDisk = $LocalDisk  | Add-UcsLsbootLocalStorage -ModifyPresent

Complete-UcsTransaction

I looked at the help and did not see any extra cmdlets to specify USB or SD. How do I specify the boot order for these new devises?

[paul.mancuso]

I am having a hard time getting consistent results where the Convertto-UCSCmdLet generates the script cmdlets after performing an action within UCSM.

Is there anything more to using this tool than the following steps:

1. Set up UCSPE in VM Workstation

2. Open up a PowerTools session

3. Run the .ps1 script version 1.4 to provide the connection to UCSM and runs the Convertto-UCSCmdLet.

When creating most objects, Service Profiles, SP Templates, etc, I generate nothing?

I create a VSAN or a VLAN, no problems, that script shows up? What is there to do to get scripts generated for all of the tasks?

Thanks!

Paul

[vaibjain]

Hi Paul,

Please share UCS PE and JRE versions.

Regards,

Vaibhav

[paul.mancuso]

I was using UCSPE version 2.2(1bPE1) and Java 1.7u45 and 1.7u51. I have found by going back to Java 1.7u25 the ConvertTo-UCSCmdLet will generate the scripts but for some reason i am once again unable to get scripts to generate? I checked and noticed on that system, on the 64-bit version was installed. I installed the 32-bit Java 1.7u25 and once again cmdlets were generated.

Paul

[sushant.gulati]

Team,

Congratulations for the amazing set of cmdlets provided by Cisco.

However, I have a few concerns.

1. I am using Cisco IMC Powertool and have not been able to find any clear reference documentation regarding the cmdlets. One needs to find the relevant cmdlet (add/set/get) using brute force which takes a lot of time. Is there any document which describes which setting is modified by which cmdlet etc.?

2. Another question, I am not able to find cmdlets to set "Send Alerts" for Platform Event Filters, or add boot table entries for the vHBAs in case of a Cisco VIC 12xx series cards and other such settings. I tried using the ConvertTo-ImcCmdlet but still there seems to be no existing cmdlet that takes care of this function.

Can you guys please help out with this? I would love to contribute more to the community with Sample scripts etc.

Thanks again.

[Jeffrey Foster]

Hi Sushant,

Thank you for your feedback! Answers to your questions...

Question #1: I am using Cisco IMC Powertool and have not been able to find any clear reference documentation regarding the cmdlets. One needs to find the relevant cmdlet (add/set/get) using brute force which takes a lot of time. Is there any document which describes which setting is modified by which cmdlet etc.?

Answer: We do have the IMC PowerTool User Guide here:

Cisco UCS C-Series PowerTool, Release 1.0 User Guide - Cisco

Additionally, there is a lot of good built in documentation available via Get-Help and if for instance, you find a noun with some functionality you are looking for, you can use the Get-ImcCmdletMeta cmdlet to understand more about this. For example:

PS C:\> Get-ImcCmdletMeta -Noun ImcLocalUser

ClassId                   : AaaUser

Noun                      : ImcLocalUser

Verb                      : Get, Add, Set, Clear

PipelineClassId           : {}

LimitScopePipelineClassId : {}

MoMeta                    : Cisco.Imc.UcsMoMeta

Question #2: Another question, I am not able to find cmdlets to set "Send Alerts" for Platform Event Filters, or add boot table entries for the vHBAs in case of a Cisco VIC 12xx series cards and other such settings. I tried using the ConvertTo-ImcCmdlet but still there seems to be no existing cmdlet that takes care of this function.

Answer: We do not support enabling Platform Event Filters (Sed Alerts) via the XML API. I am looking into the ability to Set the Boot Table (which is supported via the XML API). I will keep you up to date on this.

Cheers!

Jeff

[brrood]

Can someone send a way to "get" inventory for a bunch of C-series that are integrated into UCSM with how many HDD are in the current inventory?

I've been striking out a lot and this would really help. Either a ServiceProfile or RackUnit type command.

Thanks

Bryan

[secure24inc]

Did you find the cmdlets for SD boot?

[keithjohnson1]

Has about else had an issue getting Get-UcsCcoImageList to work through a proxy? no matter what i try i get a 401 error.

Keith

[ericwill]

Keith:

I've not seen this issue in the past.  Can you send me the commands you are running, and the error messages you are getting?

Eric    

[ericwill]

For blades:  Get-UcsBlade -slot 1 -Chassis 1 | Get-UcsComputeBoard | Get-UcsStorageController | Get-UcsStorageLocalDisk

Chassis = Chassis ID in UCSM

Slot = Slot ID of the blade within the chassis in UCSM

For Rackmounts:   get-ucsrackunit -id 1 |  Get-UcsComputeBoard | Get-UcsStorageController | Get-UcsStorageLocalDisk

ID = Identifier given for rack unit within UCSM

[keithjohnson1]

Hi Eric, thanks for responding.

                I get a 401 unauthorized error. I spoke to our firewall guys yesterday, it looks like the app isn’t responding correctly when it gets the 201 response.  It works fine from home, so I know my CCO ID works. Here is the powershell output. I can send if from fiddler as well if you like.

PS C:\git\ps\ucs> Get-UcsCcoImageList

cmdlet Get-UcsCcoImageList at command pipeline position 1

Supply values for the following parameters:

Credential

Get-UcsCcoImageList : The remote server returned an error: (401) Unauthorized.

At line:1 char:1

+ Get-UcsCcoImageList

+ ~~~~~~~~~~~~~~~~~~~

    + CategoryInfo          : NotSpecified: ( , WebException

    + FullyQualifiedErrorId : System.Net.WebException,Cisco.Ucs.Cmdlets.GetUcsCcoImageList

PS C:\git\ps\ucs> Get-UcsCcoImageList

Keith Johnson

[clbarnett99]

I'm looking for a way to reboot a C-Series CIMC via PowerTool. Has anyone found a way to do this?  I want to restart the CIMC, not the underlying OS.