HPEiLOCmdlets

2.0.0.0

Scripting Tools for Windows PowerShell : iLO Cmdlets uses the RIBCL and Redfish interface to communicate to iLO. These cmdlets can be used to configure and manage iLO on HPE ProLiant Gen8, Gen9 or Gen10 servers.

Minimum PowerShell version

3.0

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name HPEiLOCmdlets -RequiredVersion 2.0.0.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deloy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Author(s)

Hewlett Packard Enterprise Co.

Copyright

� Copyright 2013-2018 Hewlett Packard Enterprise Development, L.P. All rights reserved.

Owners

Tags

Hewlett Packard Enterprise HPEiLOCmdlets HPE iLO iLOCmdlets ProLiant RIBCL Redfish

Cmdlets

Add-HPEiLODirectoryGroup Add-HPEiLOFederationGroup Add-HPEiLOInstallationQueueWaitTask Add-HPEiLOInstallSet Add-HPEiLOLanguagePack Add-HPEiLORepositoryComponent Add-HPEiLOSNMPAlertDestination Add-HPEiLOSNMPv3User Add-HPEiLOSSORecord Add-HPEiLOUser Backup-HPEiLOSetting Clear-HPEiLOAHSData Clear-HPEiLOESKMLog Clear-HPEiLOEventLog Clear-HPEiLOIML Clear-HPEiLOInstallationTaskQueue Clear-HPEiLOInstallSet Clear-HPEiLOPowerOnTime Clear-HPEiLORestAPIState Clear-HPEiLOSSORecord Clear-HPEiLOUnlockedRepositoryComponent Connect-HPEiLO Disable-HPEiLOFunctionality Disable-HPEiLOMCTP Disconnect-HPEiLO Dismount-HPEiLOVirtualMedia Enable-HPEiLOMCTP Find-HPEiLO Get-HPEiLOAccessSetting Get-HPEiLOAHSStatus Get-HPEiLOAlertMailSetting Get-HPEiLOAssetTag Get-HPEiLOBatteryBackUpUnit Get-HPEiLOBootMode Get-HPEiLOBrownout Get-HPEiLOCACSmartCardAuthentication Get-HPEiLOCertificateSigningRequest Get-HPEiLOComputerLockConfiguration Get-HPEiLOCriticalTemperatureAction Get-HPEiLODeviceDiscoveryStatus Get-HPEiLODeviceInventory Get-HPEiLODirectoryGroup Get-HPEiLODirectorySetting Get-HPEiLODirectorySettingTestResult Get-HPEiLOEmbeddedMedia Get-HPEiLOEncryptionSetting Get-HPEiLOESKMSetting Get-HPEiLOEventLog Get-HPEiLOFan Get-HPEiLOFederationGroup Get-HPEiLOFederationMulticast Get-HPEiLOFirmwareInventory Get-HPEiLOFirmwareVerificationLastScanResult Get-HPEiLOFirmwareVerificationScanSetting Get-HPEiLOFirmwareVersion Get-HPEiLOHealthSummary Get-HPEiLOHostData Get-HPEiLOHotKeyConfig Get-HPEiLOIML Get-HPEiLOInstallationTaskQueue Get-HPEiLOInstallSet Get-HPEiLOIntelligentProvisioningInfo Get-HPEiLOIPv4NetworkSetting Get-HPEiLOIPv6NetworkSetting Get-HPEiLOKerberosConfig Get-HPEiLOLanguage Get-HPEiLOLicense Get-HPEiLOLoginSecurityBanner Get-HPEiLOMemoryInfo Get-HPEiLONICInfo Get-HPEiLOOAInfo Get-HPEiLOOneTimeBootOption Get-HPEiLOPCIDeviceInventory Get-HPEiLOPCISlot Get-HPEiLOPersistentBootOrder Get-HPEiLOPersistentMouseKeyboard Get-HPEiLOPhysicalSecurity Get-HPEiLOPostSetting Get-HPEiLOPowerCapSetting Get-HPEiLOPowerOnTime Get-HPEiLOPowerReading Get-HPEiLOPowerRegulatorSetting Get-HPEiLOPowerSupply Get-HPEiLOProcessor Get-HPEiLOProcessorJitterControl Get-HPEiLOProfile Get-HPEiLOProfileApplyResult Get-HPEiLORackSetting Get-HPEiLORedfishMessageInfo Get-HPEiLORemoteSupportSetting Get-HPEiLORemoteSyslog Get-HPEiLORepositoryComponent Get-HPEiLORestAPIState Get-HPEiLOSecureBoot Get-HPEiLOSelfTestResult Get-HPEiLOServerInfo Get-HPEiLOServerPower Get-HPEiLOServerPowerRestoreSetting Get-HPEiLOServerSoftwareInventory Get-HPEiLOServicePort Get-HPEiLOSessionInfo Get-HPEiLOSmartArrayStorageController Get-HPEiLOSmartStorageBattery Get-HPEiLOSMHFQDN Get-HPEiLOSNMPAlertDestination Get-HPEiLOSNMPAlertSetting Get-HPEiLOSNMPPowerAlertThreshold Get-HPEiLOSNMPSetting Get-HPEiLOSNMPv3Setting Get-HPEiLOSNMPv3User Get-HPEiLOSNTPSetting Get-HPEiLOSpatial Get-HPEiLOSSLCertificateInfo Get-HPEiLOSSOSetting Get-HPEiLOSystemMaintenanceSwitch Get-HPEiLOTemperature Get-HPEiLOTPMStatus Get-HPEiLOUIDStatus Get-HPEiLOUSBDevice Get-HPEiLOUser Get-HPEiLOUserCertificateMapping Get-HPEiLOVirtualMediaStatus Import-HPEiLOCertificate Import-HPEiLOUserSSHKey Invoke-HPEiLOFirmwareVerificationScan Invoke-HPEiLOInstallSet Invoke-HPEiLOProfileApply Invoke-HPEiLOProfileDownload Invoke-HPEiLORepositoryComponent Invoke-HPEiLOSNMPTestTrap Mount-HPEiLOVirtualMedia Register-HPEiLORemoteSupportSetting Remove-HPEiLOFederationGroup Remove-HPEiLOInstallationTaskQueue Remove-HPEiLOInstallSet Remove-HPEiLOLanguagePack Remove-HPEiLOProfile Remove-HPEiLORepositoryComponent Remove-HPEiLOSNMPAlertDestination Remove-HPEiLOSNMPv3User Remove-HPEiLOSSORecord Remove-HPEiLOUser Remove-HPEiLOUserSSHKey Reset-HPEiLO Reset-HPEiLOSecureBootKey Restore-HPEiLOSetting Send-HPEiLORemoteSupportAHSSubmission Send-HPEiLORemoteSupportDataCollectionInfo Send-HPEiLORemoteSupportTestEvent Send-HPEiLORemoteSyslog Send-HPEiLOSystemRecoveryEvent Send-HPEiLOTestAlertMail Set-HPEiLOAccessSetting Set-HPEiLOAdministratorPassword Set-HPEiLOAHSStatus Set-HPEiLOAlertMailSetting Set-HPEiLOAssetTag Set-HPEiLOBatteryBackUpUnit Set-HPEiLOBootMode Set-HPEiLOBrownout Set-HPEiLOComputerLockConfiguration Set-HPEiLOCriticalTemperatureAction Set-HPEiLODirectoryGroup Set-HPEiLODirectorySetting Set-HPEiLOEncryptionSetting Set-HPEiLOESKMSetting Set-HPEiLOFactoryDefault Set-HPEiLOFederationGroup Set-HPEiLOFederationMulticast Set-HPEiLOFirmwareVerificationScanSetting Set-HPEiLOHotKeyConfig Set-HPEiLOIPv4NetworkSetting Set-HPEiLOIPv6NetworkSetting Set-HPEiLOKerberosConfig Set-HPEiLOLanguage Set-HPEiLOLicense Set-HPEiLOLoginSecurityBanner Set-HPEiLOOneTimeBootOption Set-HPEiLOPersistentBootOrder Set-HPEiLOPersistentMouseKeyboard Set-HPEiLOPostSetting Set-HPEiLOPowerCapSetting Set-HPEiLOPowerRegulatorSetting Set-HPEiLOProcessorJitterControl Set-HPEiLORemoteSupportSetting Set-HPEiLORemoteSyslog Set-HPEiLOSecureBoot Set-HPEiLOServerPower Set-HPEiLOServerPowerRestoreSetting Set-HPEiLOServicePort Set-HPEiLOSMHFQDN Set-HPEiLOSNMPAlertDestination Set-HPEiLOSNMPAlertSetting Set-HPEiLOSNMPPowerAlertThreshold Set-HPEiLOSNMPSetting Set-HPEiLOSNMPv3Setting Set-HPEiLOSNMPv3User Set-HPEiLOSNTPSetting Set-HPEiLOSSOSetting Set-HPEiLOUIDStatus Set-HPEiLOUser Set-HPEiLOVirtualMediaStatus Start-HPEiLOCertificateSigningRequest Start-HPEiLODirectorySettingTest Stop-HPEiLODirectorySettingTest Test-HPEiLOConnection Test-HPEiLOESKMConnection Unregister-HPEiLORemoteSupportSetting Update-HPEiLOFirmware Clear-HPEiLOLog Disable-HPEiLOLog Enable-HPEiLOLog Get-HPEiLOModuleVersion Update-HPEiLOModuleVersion

Dependencies

This module has no dependencies.

Release Notes

HPEiLOCmdlets - Version 2.0.0.0

April, 2018

Enhancements
- Rebranded the module name from HPiLOCmdlets to HPEiLOCmdlets.
- Rebranded the cmdlet name from HPiLO to HPEiLO.
- HPEiLOcmdlets module has 214 cmdlets for configuring the iLO settings.
- Extended the supportability for Gen10 using Redfish interface.
- HPEiLOCmdlets enhanced to follow Connection based approach.
- Added 71 new cmdlets.
- Logging feature is added for the cmdlets that are executed in the PowerShell session.
- The cmdlet name has been revisited and the cmdlets have been regrouped to better match the functionality with the iLO GUI.
- The cmdlet output has been restructured for easier use.
- Error handling mechanism has been improvised.
- Get-HPEiLOStorageController cmdlet enhanced to provide Physical Drive details for unconifigured drives in iLO4.

Known issues
- The Set-HPEiLOBatteryBackUpUnit cmdlet will throw an error in case of absence of hardware battery backup unit in iLO 5 Gen10 servers.
- Get-HPEiLOPowerSupply does not return the PowerManagementControllerFirmwareVersion property for the XL170r machine.
- Get cmdlets with special characters input, for example Get-HPEiLOUser -UserLogin "#$Test",will not retrieve data on iLO 5 with firmware version 1.10 and 1.15.
- Special character "&" and "+" are not supported on iLO 5 for any parameter input.
- Invoke-HPEiLORepositoryComponent cmdlet, the redfish does not validate the Filename parameter passed to check whether the component with that particular filename exists in iLO repository currently.
- Setting OSControl in Set-HPEiLOPowerRegulatorSetting more than once does not return the ResetRequired message in iLO 5.
- When executed in a TPM-enabled machine, Invoke-HPEiLORepositoryComponent without TPMOverride parameter, redfish does not return the warning message: FWFlashTPMOVerrideRequired
- Set-HPEiLOIPv4NetworkSetting does not allow the IPv4Gateway parameter, when DHCP is enabled in iLO 4.
- Work around: The user is expected to set DHCP and Gateway in a single execution of cmdlet.
- The SNMPv1Trap parameter in Set-HPEiLOSNMPAlertSetting cannot be set to "Disabled" when SNMPPassThru is enabled in iLO 4.
- The SNMPv3 Engine ID in Set-HPEiLOSNMPAlertSetting does not set when SNMPPassThru is enabled in iLO 4.
- Get-HPEiLOIML, Get-HPEiLOEventLog and Get-HPEiLOUserCertificateMapping cmdlets are supported in iLO 5 from firmware version 1.20 onwards.
- In case, Set-HPEiLOProcessorJitterControl cmdlet throws internal error, Kindly check if MCTP is enabled using Get-HPEiLODeviceInventory cmdlet and if MCTP is not enabled, use Enable-HPEiLOMCTP cmdlet to enable the MCTP.

Usage Tip
- Use [System.GC]::Collect() to optimize memory consumption during script execution.

HPE PowerShell Information:
https://www.hpe.com/servers/powershell

User guide and Release Notes:
http://www.hpe.com/info/powershell/docs

Sample Scripts
https://github.com/HewlettPackard/PowerShell-ProLiant-SDK

Version History

Version Downloads Last updated
2.2.0.0 2,164 4/10/2019
2.1.0.0 3,377 10/22/2018
2.0.0.1 2,004 7/10/2018
2.0.0.0 (current version) 907 4/25/2018