Get-SecureBootUEFI
Get-SecureBootUEFI
Gets the UEFI variable values related to Secure Boot such as the SetupMode, SecureBoot, KEK, PK, SignatureDatabase, and forbidden SignatureDatabase.
Syntax
Parameter Set: __AllParameterSets
Get-SecureBootUEFI [-Name] <String> [-OutputFilePath <String> ] [ <CommonParameters>]
Detailed Description
The Get-SecureBootUEFI cmdlet gets the UEFI variable values related to Secure Boot which are: SetupMode, SecureBoot, KEK, PK, SignatureDatabase (DB), and forbidden SignatureDatabase (DBX).
If the computer does not support Secure Boot or is a BIOS (non-UEFI) computer, then this cmdlet will return an error displaying the following: Cmdlet not supported on this platform.
If the variable does not exist, then this cmdlet will return an error displaying the following: Variable is currently undefined.
If Windows PowerShell® is not run in administrator mode, then this cmdlet will return an error displaying the following: Unable to set proper privileges. Access was denied.
Parameters
-Name<String>
Specifies the name of the UEFI environment variable.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-OutputFilePath<String>
Specifies the output file path of the UEFI environment variable.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
System.String
The String object represents the UEFI variable name.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.SecureBoot.Commands.UEFIEnvironmentVariable
The UEFIEnvironmentVariable object contains the following properties:
-- Name
-- Bytes
-- Attributes
Examples
EXAMPLE 1
Grabs information about the PK from the UEFI variable.
PS C:\> Get-SecureBootUefi –Name PK | Format-List