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-HPEGL Connect-HPEGLDeviceComputeiLOtoCOM Connect-HPEGLWorkspace Connect-HPEOnepass Copy-HPECOMGroupApplianceServerProfileTemplate Copy-HPEGLScopeGroup 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-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-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-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-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.23

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



38 x NEW CMDLETS

Save-HPEGLSession / Restore-HPEGLSession
Save and restore workspace sessions for multi-workspace automation without re-authenticating. Automatic token refresh on restore.

Invoke-HPECOMExternalServiceVCenterFirmwareBaselineSync
Trigger a firmware baseline sync job for a VMware vCenter external service. Supports -Async and -ScheduleTime/-Interval.

Confirm-HPEGLLocation
Revalidate expired locations and reset the validation cycle to 6, 12 (default), or 18 months.

Restart-HPECOMAppliance
Trigger an OS reboot of an HPE Secure Gateway appliance. Supports -Async.

Add-HPECOMApprovalPolicyToGroup / Remove-HPECOMApprovalPolicyFromGroup
Attach or detach an approval policy from a group.

Get-HPECOMApprovalRequest
Retrieve pending or historical job approval requests. Filter by state (PENDING, APPROVED, DECLINED).

Resolve-HPECOMApprovalRequest
Approve or decline a pending job approval request. Supports optional -Remarks.

Get-HPECOMOneViewServerProfileTemplate
Retrieve server profile templates from OneView appliances registered in COM. Supports -ApplianceName and -ShowAttributes.

New-HPECOMSettingOneViewAppliance / Set-HPECOMSettingOneViewAppliance
Create and update OneView VM appliance settings (22 parameters across 8 categories).

New-HPECOMSettingOneViewSynergyAppliance / Set-HPECOMSettingOneViewSynergyAppliance
Create and update Synergy Composer appliance settings.

New-HPECOMSettingOneViewServerProfileTemplate / Set-HPECOMSettingOneViewServerProfileTemplate
Capture a server profile template from a OneView appliance and manage it as a COM setting.

New-HPECOMSettingOneViewApplianceSoftware / Set-HPECOMSettingOneViewApplianceSoftware
Define the target OneView firmware version for managed OVE appliances.

Add-HPECOMApplianceToGroup / Remove-HPECOMApplianceFromGroup
Manage OVE appliance group membership. Use -All on Remove- to clear all members.

Update-HPECOMGroupApplianceFirmware
Trigger firmware updates for all appliances in an OVE group. Supports -Force and -Wait.

Invoke-HPECOMGroupApplianceSettings
Apply the OneView appliance settings assigned to a group to all member appliances. Supports -Async.

Copy-HPECOMGroupApplianceServerProfileTemplate
Push server profile templates from the group's template setting to all member appliances. Supports -Async.

Invoke-HPECOMApplianceRefreshSettings
Pull the latest configuration from a OneView appliance into COM. Supports -Async, -ScheduleTime, -Interval.

Set-HPECOMServerUIDIndicator
Turn the server UID indicator light on or off to physically locate a server in the data center.

Get-HPEGLWebhook / New-HPEGLWebhook / Set-HPEGLWebhook / Send-HPEGLWebhookTest / Remove-HPEGLWebhook / Confirm-HPEGLWebhookEndpoint / Invoke-HPEGLWebhookDeliveryRetry
Full lifecycle management for HPE GreenLake platform webhook endpoints including delivery retry and endpoint verification.

Get-HPEGLWebhookSubscription / Add-HPEGLWebhookSubscription / Remove-HPEGLWebhookSubscription
Manage event type subscriptions linking HPE GreenLake event types to webhook endpoints. Supports OData -EventFilter.

Invoke-HPECOMServerFirmwareDownload
Stage a firmware bundle on a server without installing it. Supports -Async, -ScheduleTime, and -AllowFirmwareDowngrade.

Invoke-HPECOMGroupServerFirmwareDownload
Stage firmware on all servers in a group. Pipeline input from Get-HPECOMServer -ShowGroupMembership enables subset targeting.

Get-HPECOMServerFirmwareDownloadReport
Retrieve the firmware download status report showing which components are staged and ready for installation.


RENAMED CMDLETS — BACKWARD-COMPATIBLE ALIASES

12 cmdlets renamed; old names kept as aliases — no script changes required.

 Update-HPECOMGroupFirmware                       -> Update-HPECOMGroupServerFirmware
 Stop-HPECOMGroupFirmware                         -> Stop-HPECOMGroupServerFirmware
 Invoke-HPECOMGroupFirmwareComplianceCheck        -> Invoke-HPECOMGroupServerFirmwareComplianceCheck
 Get-HPECOMGroupFirmwareCompliance                -> Get-HPECOMGroupServerFirmwareCompliance
 Invoke-HPECOMGroupInternalStorageConfiguration   -> Invoke-HPECOMGroupServerInternalStorageConfiguration
 Invoke-HPECOMGroupOSInstallation                 -> Invoke-HPECOMGroupServerOSInstallation
 Invoke-HPECOMGroupBiosConfiguration              -> Invoke-HPECOMGroupServerBiosConfiguration
 Invoke-HPECOMGroupiLOConfiguration               -> Invoke-HPECOMGroupServeriLOConfiguration
 Invoke-HPECOMGroupiLOConfigurationCompliance     -> Invoke-HPECOMGroupServeriLOConfigurationCompliance
 Get-HPECOMGroupiLOConfigurationCompliance        -> Get-HPECOMGroupServeriLOConfigurationCompliance
 Invoke-HPECOMGroupExternalStorageConfiguration   -> Invoke-HPECOMGroupServerExternalStorageConfiguration
 Invoke-HPECOMGroupExternalStorageComplianceCheck -> Invoke-HPECOMGroupServerExternalStorageComplianceCheck


ENHANCEMENTS

Get-HPECOMAppliance: new serverCount and groupName output fields; new -ShowAssociatedServers, -ShowCertificate (Secure Gateway only), and -ShowSettings parameters.

Get-HPECOMSetting: 6 new OneView -Category values (ONE_VIEW_APPLIANCE_SOFTWARE, ONE_VIEW_APPLIANCE, ONE_VIEW_SYNERGY_APPLIANCE, ONE_VIEW_SERVER_PROFILE_TEMPLATE, SERVER_FIRMWARE, FIRMWARE_BUNDLE); new -ShowSection for reading specific config sections.

New-HPECOMGroup: -OneViewVMAppliances and -OneViewSynergyAppliances parameters for OVE appliance groups.

Get-HPECOMGroup: -ShowDeviceType filter (DIRECT_CONNECT_SERVER, OVE_APPLIANCE_VM, OVE_APPLIANCE_SYNERGY, OVE_APPLIANCE); -ShowApprovalPolicy to display the attached approval policy.

Case-insensitive name matching: Get-HPECOMGroup, Get-HPECOMApprovalPolicy, Get-HPECOMSetting, Get-HPECOMSchedule, Get-HPECOMWebhook, Get-HPEGLWebhook, Get-HPECOMGroupServerFirmwareCompliance, Get-HPECOMGroupServeriLOConfigurationCompliance.

Wait-HPECOMJobComplete: detects pending approval state and warns rather than timing out silently.

Approvable cmdlets: warns after job submission when job is pending approval, pointing to Get-HPECOMApprovalRequest and Resolve-HPECOMApprovalRequest.

Parameter rename (-ServerSerialNumber/-SerialNumber -> -Name, aliases kept): 16 single-server cmdlets including Start/Stop/Restart-HPECOMServer and Update-HPECOMServerFirmware.

Parameter rename (-ServerSerialNumber -> -ServerName, alias kept): 12 group cmdlets including Update-HPECOMGroupServerFirmware and Invoke-HPECOMGroupServeriLOConfiguration.

Get-HPECOMSchedule: new State column; NextStartAt and -ShowPendingSchedules handle approval-pending schedules correctly.

Get-HPECOMJob: new Resource column; 5 new state filter parameters: -ShowComplete, -ShowApprovalPending, -ShowError, -ShowHalted, -ShowStalled (join existing -ShowRunning, -ShowPending).

Update-HPECOMApplianceFirmware: now non-blocking by default; appliances with jobs in progress are skipped.

Get-HPECOMServer -ShowFibreChannelDetails: retrieve FC HBA port details (WWPNs, speed, boot config) for SAN zoning without an iLO login.

Remove-HPEGLWorkspace -ValidatePrerequisites: check prerequisites before deletion — returns a validation object with blocking resources.

VMware vCenter and Aruba Central added as new external service types via Get/New/Set/Remove-HPECOMExternalService.

New-HPEGLLocation / Set-HPEGLLocation: -Tags, -RemoveTags, and -RemoveAllTags parameters for location tag management.

Set-HPECOMExternalService: DSCC update support via -DSCCRegion; 6 new ServiceNow incident scope parameters.

Connect-HPEGLDeviceComputeiLOtoCOM -Force: force reconnection of an already-connected iLO (supports Direct <-> Secure Gateway migration).

$Global:HPECOMLastJobResult: all job-initiating cmdlets save their last result for post-hoc inspection. Cleared on Disconnect-HPEGL.

Get-HPECOMServer: new -ShowUIDIndicator and -ShowAppliance parameters.

Pipeline input from Get-HPECOMServer -ShowGroupMembership: 12 group job cmdlets now accept it, enabling filtered subset targeting.


BUG FIXES

* New-HPECOMAppliance -OneView: fixed incorrect API endpoint for OneView registration.
* Refresh token expiry now produces a clear message instead of a raw JSON error.
* Get-HPEGLUser: fixed empty table for single-user workspaces.
* Workspace listings no longer include workspaces being deleted.
* Connect-HPEGL: HTML maintenance/outage pages produce a clear error instead of a JSON parse failure.
* COM connection no longer blocks GLP access for users without COM permissions.
* Set-HPECOMExternalService: fixed crash on vCenter certificate retrieval failure; fixed credential validation being silently overwritten.
* Set-HPEGLLocation: fixed validation errors on contact and address update.
* Add/Remove-HPECOMServerToGroup, Invoke-HPECOMGroupServerFirmwareDownload, Get-HPECOMServer: warning messages now correctly display server name.
* Add-HPECOMServerToGroup: fixed incorrect duplicate server detection.
* Get-HPECOMServer -ShowGroupMembership: now returns all servers even before any group has members.
* Get-HPECOMFirmwareBaseline -LatestVersion: now returns exactly one result per generation.
* New-HPECOMSettingServerFirmware: clear error when multiple baselines are accidentally piped in.
* Set-HPECOMSettingServerFirmware: Gen12 baseline no longer silently dropped; existing baselines preserved when not overridden.
* New-HPECOMServerActivationKey: clear error when the 10-key limit is reached.
* Connect-HPEGLDeviceComputeiLOtoCOM: -ResetiLOIfProxyErrorPersists now fires inside the monitoring loop; direct pipeline from Get-HPECOMServer via iLOIPAddress alias.


CODE QUALITY

Pre-validation failures consistently return Warning (not Failed) across all modules. Failed is reserved for actual API errors. Uniform error handling and consistent error details throughout.