HPECOMCmdlets

Author(s)

• Lionel Jullien (HPE)

Tags

Compute-Ops-Management COM GLP Hewlett-Packard-Enterprise HPE GreenLake HPEGreenLake

Functions

Add-HPECOMServerToGroup Add-HPEGLDeviceCompute Add-HPEGLDeviceNetwork Add-HPEGLDeviceStorage Add-HPEGLDeviceTagToDevice Add-HPEGLDeviceToService Add-HPEGLRoleToUser Add-HPEGLSubscriptionToDevice Connect-HPEGL Connect-HPEGLDeviceComputeiLOtoCOM Connect-HPEGLWorkspace Connect-HPEOnepass Convert-HPEGLWorkspaceToV2 Disable-HPECOMEmailNotificationPolicy Disable-HPECOMIloIgnoreRiskSetting Disable-HPECOMMetricsConfiguration Disable-HPECOMServerAutoiLOFirmwareUpdate Disable-HPEGLDevice Disconnect-HPEGL Enable-HPECOMEmailNotificationPolicy Enable-HPECOMIloIgnoreRiskSetting Enable-HPECOMMetricsConfiguration Enable-HPECOMServerAutoiLOFirmwareUpdate Enable-HPEGLDevice Get-HPECOMActivity Get-HPECOMAppliance Get-HPECOMApplianceFirmwareBundle Get-HPECOMEmailNotificationPolicy Get-HPECOMExternalService Get-HPECOMFilter Get-HPECOMFirmwareBundle Get-HPECOMGroup Get-HPECOMGroupFirmwareCompliance Get-HPECOMGroupiLOConfigurationCompliance Get-HPECOMIloSecuritySatus Get-HPECOMJob Get-HPECOMJobTemplate Get-HPECOMMetricsConfiguration Get-HPECOMReport Get-HPECOMSchedule Get-HPECOMServer Get-HPECOMServerActivationKey Get-HPECOMServeriLOSSO Get-HPECOMServerInventory Get-HPECOMServerUtilizationInsights Get-HPECOMSetting Get-HPECOMSustainabilityInsights Get-HPECOMWebhook Get-HPEGLAPIcredential Get-HPEGLAuditLog Get-HPEGLDevice Get-HPEGLDeviceAutoReassignSubscription Get-HPEGLDeviceAutoSubscription Get-HPEGLJWTDetails Get-HPEGLLocation Get-HPEGLOrganization Get-HPEGLRegion Get-HPEGLResourceRestrictionPolicy Get-HPEGLRole Get-HPEGLService Get-HPEGLServiceResourceRestrictionPolicy Get-HPEGLSubscription Get-HPEGLUser Get-HPEGLUserAccountDetails Get-HPEGLUserPreference Get-HPEGLUserRole Get-HPEGLWorkspace Get-HPEGLWorkspaceSAMLSSODomain Invoke-HPECOMGroupBiosConfiguration Invoke-HPECOMGroupExternalStorageComplianceCheck Invoke-HPECOMGroupExternalStorageConfiguration Invoke-HPECOMGroupFirmwareComplianceCheck Invoke-HPECOMGroupiLOConfiguration Invoke-HPECOMGroupiLOConfigurationCompliance Invoke-HPECOMGroupInternalStorageConfiguration Invoke-HPECOMGroupOSInstallation Invoke-HPECOMServerExternalStorage Invoke-HPECOMWebRequest Invoke-HPEGLAutoReconnect Invoke-HPEGLWebRequest New-HPECOMAppliance New-HPECOMExternalService New-HPECOMFilter New-HPECOMGroup New-HPECOMServerActivationKey New-HPECOMServerInventory New-HPECOMSettingiLOSettings New-HPECOMSettingServerBios New-HPECOMSettingServerExternalStorage New-HPECOMSettingServerFirmware New-HPECOMSettingServerInternalStorage New-HPECOMSettingServerInternalStorageVolume New-HPECOMSettingServerOSImage New-HPECOMWebhook New-HPEGLAPIcredential New-HPEGLLocation New-HPEGLResourceRestrictionPolicy New-HPEGLService New-HPEGLSubscription New-HPEGLWorkspace New-HPEGLWorkspaceSAMLSSODomain Remove-HPECOMAppliance Remove-HPECOMExternalService Remove-HPECOMFilter Remove-HPECOMGroup Remove-HPECOMOneViewServerLocation Remove-HPECOMSchedule Remove-HPECOMServerActivationKey Remove-HPECOMServerFromGroup Remove-HPECOMSetting Remove-HPECOMWebhook Remove-HPEGLAPICredential Remove-HPEGLDeviceAutoReassignSubscription Remove-HPEGLDeviceAutoSubscription Remove-HPEGLDeviceFromService Remove-HPEGLDeviceLocation Remove-HPEGLDeviceServiceDeliveryContact Remove-HPEGLDeviceTagFromDevice Remove-HPEGLLocation Remove-HPEGLResourceRestrictionPolicy Remove-HPEGLRoleFromUser Remove-HPEGLService Remove-HPEGLSubscription Remove-HPEGLSubscriptionFromDevice Remove-HPEGLUser Remove-HPEGLWorkspace Remove-HPEGLWorkspaceSAMLSSODomain Restart-HPECOMserver Send-HPECOMWebhookTest Send-HPEGLUserInvitation Send-HPEGLWorkspaceSAMLSSODomainNotifications Set-HPECOMExternalService Set-HPECOMFilter Set-HPECOMGroup Set-HPECOMOneViewServerLocation Set-HPECOMSchedule Set-HPECOMSettingiLOSettings Set-HPECOMSettingServerBios Set-HPECOMSettingServerExternalStorage Set-HPECOMSettingServerFirmware Set-HPECOMSettingServerInternalStorage Set-HPECOMSettingServerOSImage Set-HPECOMWebhook Set-HPEGLDeviceAutoReassignSubscription Set-HPEGLDeviceAutoSubscription Set-HPEGLDeviceLocation Set-HPEGLDeviceServiceDeliveryContact Set-HPEGLLocation Set-HPEGLUserAccountDetails Set-HPEGLUserAccountPassword Set-HPEGLUserPreference Set-HPEGLWorkspace Set-HPEGLWorkspaceSAMLSSODomain Start-HPECOMserver Stop-HPECOMGroupFirmware Stop-HPECOMserver Test-HPECOMExternalService Update-HPECOMApplianceFirmware Update-HPECOMGroupFirmware Update-HPECOMServerFirmware Update-HPECOMServeriLOFirmware Wait-HPECOMJobComplete

PSEditions

Core

Dependencies

This module has no dependencies.

Release Notes

Release Notes: HPE GreenLake PowerShell Module

Bug Fixes
- [CRITICAL] Resolved authentication failures in Connect-HPEGL caused by updates to Okta endpoints (auth.hpe.com), which broke all authentication methods across published module versions.
 - Affected scenarios included MFA with push notifications, MFA with OTP codes, SSO, and single-factor authentication.
 - Users encountered "Invalid username or password" errors despite valid credentials, preventing connections to HPE GreenLake services.
 - Resolution: Updated library to use the OIDC/IDX OAuth flow, aligning with HPE GreenLake's recommended authentication and authorization standards.
- Fixed Get-HPECOMServer -ShowGroupFirmwareCompliance to handle servers not assigned to any group.
- Corrected Get-HPECOMActivity to properly return activity dates.
- Resolved incorrect WorkloadProfile definitions in New-HPECOMSettingServerBios and Set-HPECOMSettingServerBios, adding support for the 'custom' profile option.
- Added warning in Add-HPECOMServerToGroup when the server is already a member of another group.
- Restored functionality in Get-HPECOMServeriLOSSO via a temporary workaround using legacy COM API endpoints, pending full implementation of new endpoints.
- Fixed Test-HPECOMExternalService to accurately detect test completion, addressing typos, procedural errors, and changes in activity source names.
- Improved Invoke-HPEGLAutoReconnect to detect expired tokens and return appropriate errors.
- Updated Get-HPECOMAppliance to handle cases with no valid Compute Ops Management - OneView Edition subscription without error messages.
- Numerous additional minor bug fixes and enhancements for overall stability.

New Cmdlets
- New-HPECOMSettingiLOSettings and Set-HPECOMSettingiLOSettings
 - Enable creation and configuration of iLO settings.
 - Support key areas like account services, network protocols, SNMP, and security services.
 - Updated New-HPECOMGroup and Set-HPECOMGroup to apply iLO settings at the group level.
- Invoke-HPECOMGroupiLOConfiguration
 - Triggers iLO configuration updates for some or all members of a server group.
- Get-HPECOMGroupiLOConfigurationCompliance
 - Reports iLO configuration compliance status for servers in a group.
 - Aids in monitoring and enforcing consistent iLO settings across the group.
- Get-HPECOMSustainabilityInsights
 - Fetches sustainability metrics for COM-managed servers, including energy use, CO2 emissions, and cost savings.
 - Facilitates environmental impact tracking and optimization.
 - Replaces the deprecated Get-HPECOMSustainabilityReport.
- Get-HPECOMServerUtilizationInsights
 - Provides utilization data for COM-managed servers (CPU, memory bus, I/O bus).
 - Supports proactive performance monitoring and infrastructure management.
- Get-HPEGLOrganization
 - First cmdlet to interact with HPE GreenLake organizational resources.
 - Retrieves information about HPE GreenLake organizations.
 - Provides insights into organizational structure, resource allocation, and compliance.
- Remove-HPEGLWorkspace
 - Deletes the connected workspace in HPE GreenLake.
 - Includes -NotifyAllWorkspaceUsersByEmail to alert all users via email.
 - Streamlines cleanup of unused workspaces; note that deletion disconnects the session—reconnect via Connect-HPEGL -Workspace <workspace_name>.

Improvements
- Enhanced Security in Verbose Logging
 - Automatically redacts sensitive data (e.g., stateHandle tokens, SAMLRequest payloads, okta_key parameters, passwords) in authentication functions like Connect-HPEGL and Connect-HPEGLDeviceComputeiLOtoCOM, as well as -WhatIf scenarios.
 - Masks values as [REDACTED] to prevent exposure in debug transcripts, shared logs, or CI/CD pipelines while maintaining log utility.
 - No impact on core functionality or non-verbose output.
- Get-HPECOMServer
 - Added -ShowSubscriptionDetails parameter for detailed subscription info.
 - Enhanced Get-HPECOMServer -ShowServersWithRecentSupportCases output with support case counts and details.
- Invoke-HPECOMWebRequest
 - Dynamically adjusts JSON conversion depth based on response size for better performance.
- Get-HPEGLSubscription
 - Added -ShowAssignedServers to list servers tied to a subscription key.
- Get-HPEGLLocation
 - Added -ShowServers to display servers assigned to a location.
- Invoke-HPECOMGroupInternalStorageConfiguration
 - Now supports volume name renaming.
- New-HPEGLWorkspace
 - Defaults to creating workspaces with the latest IAMv2 (Identity and Access Management) and organizational governance.
 - Added -EnableIAMv1Workspace switch for legacy IAMv1 compatibility.
- Connect-HPEGLDeviceComputeiLOtoCOM
 - Added -RemoveExistingiLOProxySettings to clear outdated proxy or Secure Gateway configurations.
 - Removed -SerialNumber parameter; now auto-retrieves from iLO for simplicity.
 - Introduced wait periods post-proxy changes to ensure reliable iLO-to-COM connections.
 - Enhanced output with detailed status updates on proxy modifications and connection progress.
 - Improved verbose logging by masking iLO passwords for added security.
- Broad performance and reliability enhancements across various cmdlets.

Module Restructuring
- Refactored into nested submodules to boost performance, maintainability, and modularity.
- Previously, a monolithic .psm1 file complicated maintenance, debugging, and extensions while risking scoping issues.
- Benefits include easier dependency management, clearer code organization, and streamlined future updates—no breaking changes.

Cmdlets Migrated to Public APIs
- Add-HPEGLDeviceToService and Remove-HPEGLDeviceFromService
- Add-HPEGLSubscriptionFromDevice and Remove-HPEGLSubscriptionFromDevice
- Get-HPEGLDevice (partial migration)

These updates leverage stable public APIs for improved reliability and future-proofing.

Cmdlets Removed
- Get-HPECOMSustainabilityReport
- New-HPECOMSustainabilityReport

These have been replaced by AI-driven insights cmdlets: Get-HPECOMSustainabilityInsights, Get-HPECOMMetricsConfiguration, Enable-HPECOMMetricsConfiguration, and Disable-HPECOMMetricsConfiguration.

Cmdlets Renamed
- Get-HPEGLServiceResourceRestrictionPolicyFilter → Get-HPEGLServiceResourceRestrictionPolicy
 - Renamed for clarity; retrieves resource restriction policies for HPE GreenLake services, including applied policy details.