Get-PfxCertificate
Gets information about PFX certificate files on the computer.
Syntax
Get-PfxCertificate
[-FilePath] <String[]>
[-Password <SecureString>]
[-NoPromptForPassword]
[<CommonParameters>]
Get-PfxCertificate
-LiteralPath <String[]>
[-Password <SecureString>]
[-NoPromptForPassword]
[<CommonParameters>]
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.
Examples
Example 1: Get a PFX certificate
Get-PfxCertificate -FilePath "C:\windows\system32\Test.pfx"
Password: ******
Signer Certificate: David Chew (Self Certificate)
Time Certificate:
Time Stamp:
Path: C:\windows\system32\zap.pfx
This command gets information about the Test.pfx certificate file on the system.
Example 2: Get a PFX certificate from a remote computer
Invoke-Command -ComputerName "Server01" -ScriptBlock {Get-PfxCertificate -FilePath "C:\Text\TestNoPassword.pfx"} -Authentication CredSSP
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.
Parameters
-FilePath
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.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
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 PowerShell not to interpret any characters as escape sequences.
Type: | String[] |
Aliases: | PSPath |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NoPromptForPassword
Suppresses prompting for a password.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Password
Specifies a password required to access a .pfx
certificate file.
This parameter was introduced in PowerShell 6.1.
Note
For more information about SecureString data protection, see How secure is SecureString?.
Type: | SecureString |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
You can pipe a string that contains a file path to Get-PfxCertificate
.
Outputs
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.