HPECOMCmdlets

Author(s)

• Lionel Jullien (HPE)

Tags

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

Functions

Add-HPECOMApplianceToGroup Add-HPECOMApprovalPolicyToGroup Add-HPECOMServerToGroup Add-HPEGLDeviceCompute Add-HPEGLDeviceNetwork Add-HPEGLDeviceStorage Add-HPEGLDeviceTagToDevice Add-HPEGLDeviceToService Add-HPEGLRoleToUser Add-HPEGLRoleToUserGroup Add-HPEGLSubscriptionToDevice Add-HPEGLUserToUserGroup Add-HPEGLWebhookSubscription Confirm-HPEGLLocation Confirm-HPEGLWebhookEndpoint Connect-HPECOMSecureGatewayDiscoveredServer Connect-HPEGL Connect-HPEGLDeviceComputeiLOtoCOM Connect-HPEGLWorkspace Connect-HPEOnepass Copy-HPECOMGroupApplianceServerProfileTemplate Copy-HPEGLScopeGroup Disable-HPECOMDataCollection Disable-HPECOMEmailNotificationPolicy Disable-HPECOMIloIgnoreRiskSetting Disable-HPECOMMetricsConfiguration Disable-HPECOMServerAutoiLOFirmwareUpdate Disable-HPECOMServerMaintenanceMode Disable-HPEGLDevice Disconnect-HPEGL Enable-HPECOMDataCollection Enable-HPECOMEmailNotificationPolicy Enable-HPECOMIloIgnoreRiskSetting Enable-HPECOMMetricsConfiguration Enable-HPECOMServerAutoiLOFirmwareUpdate Enable-HPECOMServerMaintenanceMode Enable-HPEGLDevice Get-HPECOMActivity Get-HPECOMAlert Get-HPECOMAppliance Get-HPECOMApplianceFirmwareBundle Get-HPECOMApprovalPolicy Get-HPECOMApprovalRequest Get-HPECOMEmailNotificationPolicy Get-HPECOMExternalService Get-HPECOMFilter Get-HPECOMFirmwareBaseline Get-HPECOMGroup Get-HPECOMGroupServerFirmwareCompliance Get-HPECOMGroupServeriLOConfigurationCompliance Get-HPECOMIloSecuritySatus Get-HPECOMJob Get-HPECOMJobTemplate Get-HPECOMMetricsConfiguration Get-HPECOMOneViewServerProfileTemplate Get-HPECOMReport Get-HPECOMSchedule Get-HPECOMSecureGatewayServerDiscovery Get-HPECOMServer Get-HPECOMServerActivationKey Get-HPECOMServerFirmwareDownloadReport Get-HPECOMServeriLOSSO Get-HPECOMServerInventory Get-HPECOMServerLogs Get-HPECOMServerUtilizationInsights Get-HPECOMSetting Get-HPECOMSustainabilityInsights Get-HPECOMWebhook Get-HPEGLAPIcredential Get-HPEGLAuditLog Get-HPEGLDevice Get-HPEGLDeviceAutoReassignSubscription Get-HPEGLDeviceAutoSubscription Get-HPEGLDomain Get-HPEGLJWTDetails Get-HPEGLLocation Get-HPEGLOrganization Get-HPEGLRegion Get-HPEGLRole Get-HPEGLScopeGroup Get-HPEGLService Get-HPEGLServiceResourceRestrictionPolicy Get-HPEGLServiceScopeFilter Get-HPEGLSSOAuthenticationPolicy Get-HPEGLSSOConnection Get-HPEGLSubscription Get-HPEGLTenantWorkspace Get-HPEGLUser Get-HPEGLUserAccountDetails Get-HPEGLUserGroup Get-HPEGLUserGroupMembership Get-HPEGLUserPreference Get-HPEGLUserRole Get-HPEGLWebhook Get-HPEGLWebhookSubscription Get-HPEGLWorkspace Get-HPEGLWorkspaceSAMLSSODomain Invoke-HPECOMApplianceRefreshSettings Invoke-HPECOMExternalServiceVCenterFirmwareBaselineSync Invoke-HPECOMGroupApplianceSettings Invoke-HPECOMGroupServerBiosConfiguration Invoke-HPECOMGroupServerExternalStorageComplianceCheck Invoke-HPECOMGroupServerExternalStorageConfiguration Invoke-HPECOMGroupServerFirmwareComplianceCheck Invoke-HPECOMGroupServerFirmwareDownload Invoke-HPECOMGroupServeriLOConfiguration Invoke-HPECOMGroupServeriLOConfigurationCompliance Invoke-HPECOMGroupServerInternalStorageConfiguration Invoke-HPECOMGroupServerOSInstallation Invoke-HPECOMSecureGatewayServerDiscovery Invoke-HPECOMServerExternalStorage Invoke-HPECOMServerFirmwareDownload Invoke-HPECOMWebRequest Invoke-HPEGLAutoReconnect Invoke-HPEGLWebhookDeliveryRetry Invoke-HPEGLWebRequest Join-HPEGLOrganization New-HPECOMAppliance New-HPECOMApprovalPolicy New-HPECOMExternalService New-HPECOMFilter New-HPECOMGroup New-HPECOMServerActivationKey New-HPECOMServerInventory New-HPECOMSettingiLOSettings New-HPECOMSettingOneViewAppliance New-HPECOMSettingOneViewApplianceSoftware New-HPECOMSettingOneViewServerProfileTemplate New-HPECOMSettingOneViewSynergyAppliance New-HPECOMSettingServerBios New-HPECOMSettingServerExternalStorage New-HPECOMSettingServerFirmware New-HPECOMSettingServerInternalStorage New-HPECOMSettingServerInternalStorageVolume New-HPECOMSettingServerOSImage New-HPECOMWebhook New-HPEGLAPIcredential New-HPEGLDomain New-HPEGLLocation New-HPEGLOrganization New-HPEGLScopeGroup New-HPEGLService New-HPEGLSSOAuthenticationPolicy New-HPEGLSSOConnection New-HPEGLSubscription New-HPEGLUser New-HPEGLUserGroup New-HPEGLWebhook New-HPEGLWorkspace New-HPEGLWorkspaceSAMLSSODomain Remove-HPECOMAppliance Remove-HPECOMApplianceFromGroup Remove-HPECOMApprovalPolicy Remove-HPECOMApprovalPolicyFromGroup Remove-HPECOMExternalService Remove-HPECOMFilter Remove-HPECOMGroup Remove-HPECOMOneViewServerLocation Remove-HPECOMSchedule Remove-HPECOMServerActivationKey Remove-HPECOMServerFromGroup Remove-HPECOMSetting Remove-HPECOMWebhook Remove-HPEGLAPICredential Remove-HPEGLDevice Remove-HPEGLDeviceAutoReassignSubscription Remove-HPEGLDeviceAutoSubscription Remove-HPEGLDeviceFromService Remove-HPEGLDeviceLocation Remove-HPEGLDeviceServiceDeliveryContact Remove-HPEGLDeviceTagFromDevice Remove-HPEGLDomain Remove-HPEGLLocation Remove-HPEGLRoleFromUser Remove-HPEGLRoleFromUserGroup Remove-HPEGLScopeGroup Remove-HPEGLService Remove-HPEGLSSOAuthenticationPolicy Remove-HPEGLSSOConnection Remove-HPEGLSubscription Remove-HPEGLSubscriptionFromDevice Remove-HPEGLUser Remove-HPEGLUserFromUserGroup Remove-HPEGLUserGroup Remove-HPEGLWebhook Remove-HPEGLWebhookSubscription Remove-HPEGLWorkspace Remove-HPEGLWorkspaceSAMLSSODomain Resolve-HPECOMApprovalRequest Restart-HPECOMAppliance Restart-HPECOMserver Restore-HPEGLSession Save-HPEGLSession Send-HPECOMWebhookTest Send-HPEGLUserInvitation Send-HPEGLWebhookTest Send-HPEGLWorkspaceSAMLSSODomainNotifications Set-HPECOMApprovalPolicy Set-HPECOMExternalService Set-HPECOMFilter Set-HPECOMGroup Set-HPECOMOneViewServerLocation Set-HPECOMSchedule Set-HPECOMServerUIDIndicator Set-HPECOMSettingiLOSettings Set-HPECOMSettingOneViewAppliance Set-HPECOMSettingOneViewApplianceSoftware Set-HPECOMSettingOneViewServerProfileTemplate Set-HPECOMSettingOneViewSynergyAppliance Set-HPECOMSettingServerBios Set-HPECOMSettingServerExternalStorage Set-HPECOMSettingServerFirmware Set-HPECOMSettingServerInternalStorage Set-HPECOMSettingServerOSImage Set-HPECOMWebhook Set-HPEGLDeviceAutoReassignSubscription Set-HPEGLDeviceAutoSubscription Set-HPEGLDeviceLocation Set-HPEGLDeviceServiceDeliveryContact Set-HPEGLLocation Set-HPEGLOrganization Set-HPEGLScopeGroup Set-HPEGLSSOAuthenticationPolicy Set-HPEGLSSOConnection Set-HPEGLUserAccountDetails Set-HPEGLUserAccountPassword Set-HPEGLUserGroup Set-HPEGLUserPreference Set-HPEGLUserRole Set-HPEGLWebhook Set-HPEGLWorkspace Set-HPEGLWorkspaceSAMLSSODomain Start-HPECOMserver Stop-HPECOMGroupServerFirmware Stop-HPECOMserver Test-HPECOMExternalService Test-HPEGLDomain Update-HPECOMApplianceFirmware Update-HPECOMGroupApplianceFirmware Update-HPECOMGroupServerFirmware Update-HPECOMServerFirmware Update-HPECOMServeriLOFirmware Wait-HPECOMJobComplete

PSEditions

Core

Dependencies

This module has no dependencies.

Release Notes

What's New in v1.0.26

Full release notes: https://github.com/jullienl/HPE-COM-PowerShell-Library/releases/tag/v1.0.26



CRITICAL FIX - SIGN-IN RESTORED AFTER HPE'S AUTH-FLOW CHANGE

Upgrading to v1.0.26 is required to keep connecting to HPE GreenLake. HPE switched their GreenLake sign-in to a new authentication workflow (v1alpha1 -> v1alpha2), which broke Connect-HPEGL for everyone - both federated (SSO) and standard accounts. This release reworks the login flow to detect and follow the new HPE broker, so authentication works again with no script changes. See BUG FIXES below for details.



HEADLINE FEATURE - PASSWORD-BASED SSO AUTHENTICATION

- Connect-HPEGL (password-based SSO): -Credential now supports password-based authentication for federated IdPs (Okta, Microsoft Entra ID, PingIdentity). When the email domain is configured for SAML SSO in HPE GreenLake, authentication is automatically routed to the Identity Provider for password validation. Supports password-only and password + MFA step-up (Okta: push/TOTP; Entra ID: push with number matching; PingID: push/TOTP). Federation is detected automatically - no additional parameters required.

- Connect-HPEGL (-PasswordlessSSOEmail parameter rename): The -SSOEmail parameter has been renamed to -PasswordlessSSOEmail to distinguish the fully passwordless flow (push/TOTP) from the new password-based SSO flow. The original -SSOEmail name is retained as a backward-compatible alias - existing scripts continue to work unchanged.

- Connect-HPEGL (clear handling of password requirements): When -PasswordlessSSOEmail is used but the IdP requires a password, the cmdlet returns a clear error instructing you to use -Credential, and never prompts interactively (so automation does not hang). When -Credential is used but the account is passwordless-only, the password is ignored and the push/TOTP flow proceeds with a warning.


TELEMETRY & PRIVACY

- Connect-HPEGL (anonymous usage telemetry): Optional, anonymous usage telemetry to help prioritise testing, features, and fixes. OFF by default (opt-in) - nothing is collected or sent unless you run Enable-HPECOMDataCollection. No personally identifiable information is ever collected (no usernames, emails, passwords, tokens, IPs, workspace, or server names). When opted in, a single anonymous event is sent on each successful connection (module/PowerShell/OS version, auth method, workspace count, COM regions, environment, CI/CD, etc.). Opt in for the session only via $env:HPE_COM_ENABLE_TELEMETRY = '1'; opt out with Disable-HPECOMDataCollection. See https://github.com/jullienl/HPE-COM-PowerShell-Library#telemetry.

- Connect-HPEGL (SSO failure & unsupported-IdP detection): When opted in, Connect-HPEGL also records (anonymously, with no usernames, hosts, or error details) when an SSO sign-in is rejected or fails (unsupported federation, wrong password, denied/timed-out MFA), and which identity provider is involved when a workspace uses an unsupported OIDC federation instead of SAML 2.0. The same opt-out disables all telemetry.


NEW CMDLETS

- Remove-HPEGLDevice: New cmdlet to permanently remove (unclaim) one or more devices from the HPE GreenLake workspace. Warns about the irreversible impact and prompts for confirmation; use -Force to suppress the prompt. Supports pipeline input from Get-HPEGLDevice and direct serial number input.

- Disable-HPECOMDataCollection: New cmdlet to opt out of the anonymous usage telemetry (OFF by default; also suppresses the one-time invitation notice, or turns collection back off after opting in). Creates a persistent opt-out marker file (~/.config/HPECOMCmdlets/telemetry-disabled) and sets $env:HPE_COM_NO_TELEMETRY = '1' for the session. No telemetry is sent after running it, even after restarting PowerShell.

- Enable-HPECOMDataCollection: New cmdlet to opt in to anonymous usage data collection (OFF by default). Creates a persistent opt-in marker file (~/.config/HPECOMCmdlets/telemetry-enabled) and sets $env:HPE_COM_ENABLE_TELEMETRY = '1' for the session. Anonymous telemetry is then sent on each successful connection, even after restarting PowerShell.

- Invoke-HPECOMSecureGatewayServerDiscovery / Get-HPECOMSecureGatewayServerDiscovery: New cmdlets to discover and retrieve servers reachable through an HPE Secure Gateway appliance. Invoke- runs a network discovery from the gateway to detect HPE iLO devices not yet connected to Compute Ops Management (warns about the active scan unless -Force is used; supports immediate, -Async, and -ScheduleTime/-Interval scheduling). Get- returns the servers found by the most recent discovery. Both report each server's IP, iLO generation, iLO firmware version, whether an iLO firmware update is required, and certificate fingerprint, and can be piped to Connect-HPEGLDeviceComputeiLOtoCOM.

- Connect-HPECOMSecureGatewayDiscoveredServer: New cmdlet to onboard servers discovered behind an HPE Secure Gateway appliance to Compute Ops Management - the automated equivalent of the "add multiple servers via Secure Gateway" UI wizard. It submits a single batch request per Secure Gateway; Compute Ops Management generates the activation key automatically, updates iLO firmware on servers reporting iLOUpdateRequired = Yes (minimum iLO 5 v3.09, iLO 6 v1.64, iLO 7 v1.12.00), onboards those reporting No without an update, and skips those reporting Unknown with a warning. Accepts discovered servers piped from Get-HPECOMSecureGatewayServerDiscovery, optionally configures DNS/NTP and assigns a subscription, location, contact and tags. Supports a shared -IloCredential or a per-iLO IloCredential property. Use -Async to return the job immediately.

- Enable-HPECOMServerMaintenanceMode / Disable-HPECOMServerMaintenanceMode: New cmdlets to turn a server's maintenance mode on and off. While enabled, Compute Ops Management suspends automatic support case creation, ServiceNow incident creation, and email notifications for the server - avoiding unwanted tickets and noise during planned maintenance windows. Both accept a server by name or serial number (including from the pipeline via Get-HPECOMServer), support -WhatIf, run immediately or return the job with -Async, and support -ScheduleTime/-Interval. The current state is exposed by the maintenanceMode property from Get-HPECOMServer, which also gains a -InMaintenanceMode switch to list servers currently in maintenance mode.


BUG FIXES

- Connect-HPEGL (sign-in, CRITICAL FIX): HPE switched their GreenLake sign-in to a new authentication workflow (v1alpha1 -> v1alpha2), changing the broker used by all account types and breaking Connect-HPEGL for everyone - both federated SSO (Entra ID, Okta, PingID) and standard accounts. Connect-HPEGL now detects and follows HPE's new broker automatically (while remaining compatible with the previous one), so sign-in works again for all account types - with both -PasswordlessSSOEmail and -Credential - with no script changes. Upgrading to v1.0.26 is required to keep connecting.

- Set-HPEGLUserAccountPassword (workspace session regression): Fixed Set-HPEGLUserAccountPassword incorrectly requiring an active workspace session before it could run. The cmdlet is designed to work immediately after Connect-HPEGL without selecting a workspace, and now does so.

- Set-HPEGLUserAccountPassword (plaintext passwords in verbose output): Fixed Set-HPEGLUserAccountPassword exposing password values in plaintext with -Verbose. Password values are now fully redacted in verbose output.

- GLP-Organizations.psm1 (Get-HPEGLOrganization -ShowCurrent — member workspace detection): Fixed Get-HPEGLOrganization -ShowCurrent (and the organization detection run by Connect-HPEGL) returning no result when the connected workspace is a member workspace of an organization. The current organization is now correctly identified and the Current column properly set to True.

- $HPECOMLastJobResult: Fixed $HPECOMLastJobResult remaining $null after running any job cmdlet (Set-HPECOMServerUIDIndicator, Start/Stop/Restart-HPECOMServer, Update-HPECOMServerFirmware, Update-HPECOMServeriLOFirmware, Restart-HPECOMAppliance, the AI Insights report cmdlets, and others). It is now correctly populated after every job cmdlet.


IMPROVEMENTS

- Module import welcome banner: Importing the module now displays a short, one-time welcome banner pointing to the first step (Connect-HPEGL), the getting-started help topic (Get-Help about_HPECOMCmdlets), and the project documentation. It is shown only in interactive PowerShell hosts and suppressed in CI/CD and non-interactive sessions, so it never pollutes automation output. Hide it permanently with $env:HPECOMCMDLETS_NO_BANNER = '1'. A new about_HPECOMCmdlets help topic is also included.

- Dynamic country list: The country list used by New-HPEGLLocation, Set-HPEGLLocation, New-HPEGLWorkspace, Set-HPEGLWorkspace, and Set-HPEGLUserAccountDetails is now fetched directly from HPE GreenLake instead of being hardcoded, eliminating errors caused by country name mismatches (e.g., "South Korea" vs "Korea, Republic of"). It is refreshed automatically on every connection.

- Connect-HPEGL (automatic retry on rate-limit errors): Connect-HPEGL now automatically retries up to 3 times with increasing delays when a rate-limit response is received from the authentication endpoint. Any other error fails immediately.

- Connect-HPEGLDeviceComputeiLOtoCOM (-WhatIf support): Now supports -WhatIf. It contacts the iLO read-only to gather its identity, proxy state and external manager status, runs all validation checks, then returns a step-by-step report (validation results and planned operations) without changing the iLO. It surfaces actionable warnings when a blocker is detected, such as a leftover proxy on a direct connection (-RemoveExistingiLOProxySettings) or an iLO managed by HPE OneView (-DisconnectiLOfromOneView). Useful to preview a connection or migration, including bulk pipeline operations, before running it for real.

- Connect-HPEGLDeviceComputeiLOtoCOM (automatic Secure Gateway routing from the pipeline): Now accepts a SecureGateway value from the pipeline. When the output of Get-HPECOMSecureGatewayServerDiscovery is piped to it, each iLO connection is automatically routed through the Secure Gateway the server was discovered behind, using the default port (8080) - no need to specify -IloProxyServer / -IloProxyPort. -SecureGateway has its own parameter set; for a web proxy or custom port, use -IloProxyServer / -IloProxyPort instead.