Skip to content

Latest commit

 

History

History
109 lines (76 loc) · 3.03 KB

Get-SecureBootUEFI.md

File metadata and controls

109 lines (76 loc) · 3.03 KB
Raw
external help file Module Name ms.date online version schema title
Microsoft.SecureBoot.Commands.dll-Help.xml
SecureBoot
10/29/2017
2.0.0
Get-SecureBootUEFI

Get-SecureBootUEFI

SYNOPSIS

Gets the UEFI variable values related to Secure Boot such as the SetupMode, SecureBoot, KEK, PK, SignatureDatabase, and forbidden SignatureDatabase.

SYNTAX

Get-SecureBootUEFI [-Name] <String> [-OutputFilePath <String>] [<CommonParameters>]

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.

EXAMPLES

EXAMPLE 1

PS C:\>Get-SecureBootUefi -Name PK | Format-List
Name       : PK 
Bytes      : {161, 89, 192, 165...} 
Attributes : NON VOLATILE 
             BOOTSERVICE ACCESS 
             RUNTIME ACCESS 
             TIME BASED AUTHENTICATED WRITE ACCESS

This example gets information about PK from the UEFI variable.

PARAMETERS

-Name

Specifies the name of the UEFI environment variable.

Type: String
Parameter Sets: (All)
Aliases: n
Accepted values: PK, KEK, db, dbx, SetupMode, SecureBoot, PKDefault, KEKDefault, dbDefault, dbxDefault, dbt, dbtDefault

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OutputFilePath

Specifies the output file path of the UEFI environment variable.

Type: String
Parameter Sets: (All)
Aliases: f

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

The String object represents the UEFI variable name.

OUTPUTS

Microsoft.SecureBoot.Commands.UEFIEnvironmentVariable

The UEFIEnvironmentVariable object contains the following properties:

-- Name

-- Bytes

-- Attributes

NOTES

RELATED LINKS

Confirm-SecureBootUEFI

Format-SecureBootUEFI

Get-SecureBootPolicy

Set-SecureBootUEFI