Get-SecureBootUEFI

Get-SecureBootUEFI

Gets the UEFI variable values related to Secure Boot.

Syntax

Parameter Set: Default
Get-SecureBootUEFI [-Name] <System.String> {PK | KEK | db | dbx | SetupMode | SecureBoot | PKDefault | KEKDefault | dbDefault | dbxDefault | dbt | dbtDefault} [-OutputFilePath <System.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, this cmdlet displays the following:

Cmdlet not supported on this platform.

If the variable does not exist, this cmdlet displays the following:

Variable is currently undefined.

If Windows PowerShell® is not run in administrator mode, this cmdlet displays the following:

Unable to set proper privileges. Access was denied.

Parameters

-Name<System.String>

Specifies the name of the UEFI environment variable.


Aliases

n

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true(ByValue)

Accept Wildcard Characters?

false

-OutputFilePath<System.String>

Specifies the output file path of the UEFI environment variable.


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.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    You can pipe a string that represents the UEFI variable name to this cmdlet.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.SecureBoot.Commands.UEFIEnvironmentVariable

    This cmdlet returns a UEFIEnvironmentVariable object that contains the following properties:

    -- Name
    -- Bytes
    -- Attributes


Examples

Example 1: Get information about PK

This command gets information about PK from the UEFI variable.


PS C:\> Get-SecureBootUefi –Name PK | Format-List

Related topics

Community Additions

ADD
Show: