Get-PfxCertificate

Get-PfxCertificate

Gets information about .pfx certificate files on the computer.

Syntax

Parameter Set: ByPath
Get-PfxCertificate [-FilePath] <String[]> [ <CommonParameters>]

Parameter Set: ByLiteralPath
Get-PfxCertificate -LiteralPath <String[]> [ <CommonParameters>]




Detailed Description

The Get-PfxCertificate cmdlet gets an object representing each specified .pfx certificate file. A .pfx file includes both the certificate and a private key.

Parameters

-FilePath<String[]>

Specifies the full path to the .pfx file of the secured file. If you specify a value for this parameter, it is not necessary to type -FilePath at the command line.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-LiteralPath<String[]>

The full path to the .pfx file of the secured file. Unlike FilePath, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

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 contains a file path to Get-PfxCertificate.


Outputs

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

  • System.Security.Cryptography.X509Certificates.X509Certificate2

    Get-PfxCertificate returns an object for each certificate that it gets.


Notes

  • When using the Invoke-Command cmdlet to run a Get-PfxCertificate command remotely, and the .pfx certificate file is not password protected, the value of the Authentication parameter of Invoke-Command must be CredSSP.

Examples

Example 1: Get a .pfx certificate

This command gets information about the Test.pfx certificate on the system.


PS C:\> Get-PfxCertificate -FilePath "C:\windows\system32\Test.pfx"

Example 2: Get a .pfx certificate from a remote computer

This command gets a .pfx certificate file from the Server01 remote computer. It uses Invoke-Command to run a Get-PfxCertificate command remotely.

When the .pfx certificate file is not password-protected, the value of the Authentication parameter of Invoke-Command must be CredSSP.


PS C:\> Invoke-Command -ComputerName "Server01" -ScriptBlock {Get-PfxCertificate -FilePath "C:\Text\TestNoPassword.pfx}" -authentication CredSSP

Related topics

Community Additions

ADD
Show: