Summary
Creates a payload to configure HP Sure Recover OS or Recovery image failover
Syntax
New-HPSureRecoverFailoverConfigurationPayload [-SigningKeyFile] <FileInfo> [[-SigningKeyPassword] <String>] [[-Image] <String>] [[-Version] <UInt16>] [[-Username] <String>] [[-Password] <String>] [-Url] <Uri> [[-Nonce] <UInt32>] [[-OutputFile] <FileInfo>] [<CommonParameters>]
New-HPSureRecoverFailoverConfigurationPayload [-SigningKeyCertificate] <X509Certificate2> [[-Image] <String>] [[-Version] <UInt16>] [[-Username] <String>] [[-Password] <String>] [-Url] <Uri> [[-Nonce] <UInt32>] [[-OutputFile] <FileInfo>] [<CommonParameters>]
New-HPSureRecoverFailoverConfigurationPayload [[-Image] <String>] [[-Version] <UInt16>] [[-Username] <String>] [[-Password] <String>] [-Url] <Uri> [[-Nonce] <UInt32>] [[-OutputFile] <FileInfo>] [-RemoteSigningServiceKeyID] <String> [-RemoteSigningServiceURL] <String> [[-CacheAccessToken]] [<CommonParameters>]
Description
This command creates a payload to configure HP Sure Recover OS or Recovery image failover. There are three signing options to choose from: - Signing Key File (and Password) using -SigningKeyFile and -SigningKeyPassword parameters - Signing Key Certificate using -SigningKeyCertificate parameter - Remote Signing using -RemoteSigningServiceKeyID and -RemoteSigningServiceURL parameters
Please note that using a Key File with Password in PFX format is recommended over using an X509 Certificate object because a private key in a certificate is not password protected.
This command writes the created payload to the pipeline or to the file specified in the OutputFile parameter. This payload can then be passed to the Set-HPSecurePlatformPayload command.
Security note: Payloads should only be created on secure servers. Once created, the payload may be transferred to a client and applied via the Set-HPSecurePlatformPayload command. Creating the payload and passing it to the Set-HPSecurePlatformPayload command via the pipeline is not a recommended production pattern.
Parameters
| Name | Argument | Description |
|---|---|---|
| SigningKeyFile | <FileInfo> | Specifies the path to the Secure Platform Management signing key, as a PFX file. If the PFX file is protected by a password (recommended), the SigningKeyPassword parameter should also be provided. |
| SigningKeyCertificate | <X509Certificate2> | Specifies the Secure Platform Management signing key certificate as an X509Certificate object. |
| SigningKeyPassword | <String> | Specifies the Secure Platform Management signing key file password, if required. |
| Image | <String> | Specifies whether this command will create a configuration payload for a Recovery Agent image or a Recovery OS image. For now, only 'os' is supported. |
| Version | <UInt16> | Specifies the operation version. Each new configuration payload must increment the last operation payload version, as available in the Get-HPSureRecoverFailoverConfiguration. If this parameter is not provided, this command will read from current system and increment it automatically. |
| Username | <String> | Specifies the username for accessing the url specified in the Url parameter, if any. |
| Password | <String> | Specifies the password for accessing the url specified in the Url parameter, if any. |
| Url | <Uri> | Specifies the URL from where to download the image. An empty URL can be specified to deprovision Failover. |
| Nonce | <UInt32> | Specifies a Nonce. If nonce is specified, the Secure Platform Management subsystem will only accept commands with a nonce greater or equal to the last nonce sent. This approach helps to prevent replay attacks. If not specified, the nonce is inferred from the current local time. The current local time as the nonce works in most cases. However, this approach has a resolution of seconds, so when performing parallel operations or a high volume of operations, it is possible for the same counter to be interpreted for more than one command. In these cases, the caller should use its own nonce derivation and provide it through this parameter. |
| OutputFile | <FileInfo> | Specifies the file to write output to instead of writing the output to the pipelineing output to the specified file, instead of writing it to the pipeline. |
| RemoteSigningServiceKeyID | <String> | Specifies the Signing Key ID to be used |
| RemoteSigningServiceURL | <String> | Specifies the (Key Management Service) KMS server URL (I.e.: https:// |
| CacheAccessToken | If specified, the access token is cached in msalcache.dat file and user credentials will not be asked again until the credentials expire. This parameter should be specified for caching the access token when performing multiple operations on the KMS server. If access token is not cached, the user must re-enter credentials on each call of this command. |
Notes
- Requires HP BIOS with HP Sure Recover support
Examples
PS C:\> New-HPSureRecoverFailoverConfigurationPayload -SigningKeyFile sk.pfx -Version 1 -Url ''
PS C:\> New-HPSureRecoverFailoverConfigurationPayload -SigningKeyFile sk.pfx -Image os -Version 1 -Nonce 2 -Url 'http://url.com/' -Username 'user' -Password 123