Firmware

This module provides functionality for interfacing with HP BIOS firmware, HP Secure Platform Management, HP Sure Recover, HP Sure View, and HP Sure Admin.

Some functionalities may not be available on all platforms or on all generations of a platform.


Firmware update

Function Description
Update-HPFirmware Updates the system firmware from a capsule or BIOS binary file


Legacy BIOS password

Function Description
Write-HPFirmwarePasswordFile Creates a password file compatible with HP BIOS Configuration Utility (BCU)


Firmware logs

Function Description
Get-HPFirmwareAuditLog Retrieves firmware log entries


Boot logo

Function Description
Get-HPFirmwareBootLogoIsActive Checks if a custom logo is currently active
Clear-HPFirmwareBootLogo Removes any active custom boot logo
Set-HPFirmwareBootLogo Sets the logo on reboot


HP Secure Platform Management

Function Description
Get-HPSecurePlatformState Retrieves the HP Secure Platform Management state
New-HPSecurePlatformEndorsementKeyProvisioningPayload Creates an HP Secure Platform Management payload to provision a Key Endorsement key
New-HPSecurePlatformSigningKeyProvisioningPayload Creates an HP Secure Platform Management payload to provision a Signing Key key
New-HPSecurePlatformDeprovisioningPayload Creates a deprovisioning payload
Set-HPSecurePlatformPayload Applies a payload to HP Secure Platform Management


HP Sure Recover

Function Description
Get-HPSureRecoverState Retrieves the current state of the HP Sure Recover feature
Get-HPSureRecoverReimagingDeviceDetails Retrieves information about the HP Sure Recover embedded reimaging device
New-HPSureRecoverConfigurationPayload Creates a payload to configure HP Sure Recover
New-HPSureRecoverImageConfigurationPayload Creates a payload to configure the HP Sure Recover OS or Recovery image
New-HPSureRecoverSchedulePayload Creates a payload to configure the HP Sure Recover schedule
New-HPSureRecoverTriggerRecoveryPayload Creates a payload to trigger HP Sure Recover events
New-HPSureRecoverDeprovisionPayload Creates a payload to deprovision HP Sure Recover
Invoke-HPSureRecoverTriggerUpdate Triggers the embedded reimaging device for update
New-HPSureRecoverFailoverConfigurationPayload Creates a payload to configure HP Sure Recover OS or Recovery image failover
Get-HPSureRecoverFailoverConfiguration Retrieves the current HP Sure Recover failover configuration


HP Sure View

Function Description
Get-HPSureViewState Retrieves the state of the HP Sure View electronic privacy filter if available
Test-HPSureViewIsSupported Checks if HP Sure View is supported
Set-HPSureViewState Sets HP Sure View State


HP Sure Admin

Function Description
Get-HPSureAdminState Retrieves the current state of the HP Sure Admin feature
New-HPSureAdminEnablePayload Creates a payload for enabling the HP Sure Admin feature
New-HPSureAdminDisablePayload Creates a payload for disabling the HP Sure Admin feature
Send-HPSureAdminLocalAccessKeyToKMS Sends a local access key in PFX format to HP Sure Admin Key Management Service (KMS)
Clear-HPSureAdminKMSAccessToken Clears the HP Sure Admin Key Management Service (KMS) access token
Convert-HPSureAdminCertToQRCode Creates a QR-Code for transferring the private key from a certificate file to the HP Sure Admin phone app
New-HPSureAdminBIOSSettingValuePayload Creates a payload for authorizing a single BIOS setting change
New-HPSureAdminBIOSSettingsListPayload Creates a payload for authorizing multiple BIOS setting changes
New-HPSureAdminFirmwareUpdatePayload Creates a payload for authorizing a firmware update
New-HPSureAdminLocalAccessKeyProvisioningPayload Creates a payload for provisioning a local access key
New-HPSureAdminSettingDefaultsPayload Creates a payload for resetting BIOS settings to default values
Get-HPSureAdminKMSCapabilities Retrieves the HP Sure Admin Key Management Service (KMS) server capabilities
Get-HPSureAdminKeyId Extracts the key id from a certificate
Add-HPSureAdminSigningKeyToKMS Adds a signing key in PFX format to HP Sure Admin Key Management Service (KMS)
Remove-HPSureAdminSigningKeyFromKMS Removes a signing key from HP Sure Admin Key Management Service (KMS)
Add-HPSureAdminEndorsementKeyToKMS Adds an endorsement key in PFX format to HP Sure Admin Key Management Service (KMS)
Remove-HPSureAdminEndorsementKeyFromKMS Removes an endorsement key from HP Sure Admin Key Management Service (KMS)
Add-HPSureAdminDevicePermissions Adds one device permissions to HP Sure Admin Key Management Service (KMS)
Get-HPSureAdminDevicePermissions Retrieves the device permissions from the HP Sure Admin Key Management Service (KMS)
Edit-HPSureAdminDevicePermissions Edits existing device permissions to HP Sure Admin Key Management Service (KMS)
Remove-HPSureAdminDevicePermissions Removes a device permission from the HP Sure Admin Key Management Service (KMS)
Search-HPSureAdminDevicePermissions Searches device permissions on HP Sure Admin Key Management Service (KMS)
Set-HPSureAdminDevicePermissions Sets one or multiple device permissions on the HP Sure Admin Key Management Service (KMS)