Export-PfxCertificate
Exports a certificate or a PFXData object to a Personal Information Exchange (PFX) file.
Syntax
PfxCert
Export-PfxCertificate
[-FilePath] <String>
[-PFXData] <PfxData>
[-NoProperties]
[-NoClobber]
[-Force]
[-CryptoAlgorithmOption <CryptoAlgorithmOptions>]
[-ChainOption <ExportChainOption>]
[-ProtectTo <String[]>]
[-Password <SecureString>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
NormalCert
Export-PfxCertificate
[-FilePath] <String>
[-Cert] <Certificate>
[-NoProperties]
[-NoClobber]
[-Force]
[-CryptoAlgorithmOption <CryptoAlgorithmOptions>]
[-ChainOption <ExportChainOption>]
[-ProtectTo <String[]>]
[-Password <SecureString>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Export-PfxCertificate cmdlet exports a certificate or a PFXData object to a Personal
Information Exchange (PFX) file. By default, extended properties and the entire chain are exported.
Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing user configuration.
Examples
EXAMPLE 1
$mypwd = ConvertTo-SecureString -String '1234' -Force -AsPlainText
Get-ChildItem -Path Cert:\LocalMachine\My\5F98EBBFE735CDDAE00E33E0FD69050EF9220254 |
Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd
This example exports a certificate from the local machine store to a PFX file which includes the entire chain and all external properties.
EXAMPLE 2
$mypwd = ConvertTo-SecureString -String '1234' -Force -AsPlainText
Get-ChildItem -Path Cert:\LocalMachine\My |
Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd
This example exports all certificates under the My store for the machine account into one file named
mypfx.pfx. In order for this cmdlet to succeed, all keys need to be exportable.
EXAMPLE 3
$mypwd = ConvertTo-SecureString -String '1234' -Force -AsPlainText
$params = @{
Cert = 'Cert:\CurrentUser\My\5F98EBBFE735CDDAE00E33E0FD69050EF9220254'
FilePath = 'C:\myexport.pfx'
ChainOption = 'EndEntityCertOnly'
NoProperties = $true
Password = $mypwd
}
Export-PfxCertificate @params
This example exports a certificate from the current user store with no chain and no external properties
EXAMPLE 4
$a = Get-ChildItem -Path Cert:\LocalMachine\My
$params = @{
Cert = $a[1]
FilePath = 'C:\myexport.pfx'
ProtectTo = 'billb99', 'johnj99'
}
Export-PfxCertificate @params
This example exports a certificate from the local machine store. Both user accounts, billb99 and
johnj99, can access this PFX with no password. A Windows Server 2012 or later domain controller is
required for key distribution.
EXAMPLE 5
$a = Get-ChildItem -Path Cert:\LocalMachine\My
$mypwd = ConvertTo-SecureString -String '1234' -Force -AsPlainText
$params = @{
Cert = $a[1]
FilePath = 'C:\myexport.pfx'
ProtectTo = 'billb99', '\johnj99'
Password = $mypwd
}
Export-PfxCertificate @params
This example exports a certificate from the local machine store. Both user accounts, johnj99 and
billb99, can access this PFX file with no password. For everyone else, they need to use 1234 as a
password. A Windows Server 2012 or later domain controller is required for key distribution.
EXAMPLE 6
$NewPwd = ConvertTo-SecureString -String 'abcd' -Force -AsPlainText
$mypfx = Get-PfxData -FilePath C:\mypfx.pfx -Password $Oldpwd
Export-PfxCertificate -PFXData $mypfx -FilePath C:\mypfx2.pfx -Password $NewPwd
This example changes an existing password for a PFX file from $OldPwd to $NewPwd.
Parameters
-Cert
Specifies the path to the certificate to be exported.
Parameter properties
| Type: | Microsoft.CertificateServices.Commands.Certificate |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PsPath |
Parameter sets
NormalCert
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ChainOption
Specifies the options for building a chain when exporting certificates. The acceptable values for this parameter are:
BuildChain: Certificate chain for all end entity certificates will be built and included in the export. This option is valid for both PfxData and Cert parameters. In the case of PfxData parameter, the collection of all PFX certificates will be used as an additional store.EndEntityCertOnly: Only end entity certificates are exported without any chain. This option is valid for both the PfxData and the Cert parameters.PfxDataOnly: Certificates contained in PFXData objects will be exported with no chain building. This option is only valid when the PfxData parameter is used.
Parameter properties
| Type: | Microsoft.CertificateServices.Commands.ExportChainOption |
| Default value: | None |
| Accepted values: | BuildChain, EndEntityCertOnly, PfxDataOnly |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CryptoAlgorithmOption
Specifies the algorithm for encrypting private keys within the PFX file. If this parameter is not
specified, the default is TripleDES_SHA1. The acceptable values for this parameter are:
TripleDES_SHA1: Private keys will be encrypted in the PFX file using Triple DES encryption.AES256_SHA256: Private keys will be encrypted in the PFX file using AES-256 encryption.
Parameter properties
| Type: | Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions |
| Default value: | None |
| Accepted values: | TripleDES_SHA1, AES256_SHA256 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FilePath
Specifies the path for the PFX file to be exported.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Specifies that the provided PFX file should be overwritten, even if the Read-only attribute is set on the file. By default, this cmdlet overwrites existing PFX files without warning, unless the Read-only or hidden attribute is set or the NoClobber parameter is used in the cmdlet.
Parameter properties
| Type: | Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NoClobber
Specifies that if the PFX file already exists, it should not be overwritten. This parameter takes precedence over the Force parameter, which permits this cmdlet to overwrite a PFX file even if it has the Read-only attribute set.
Parameter properties
| Type: | Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NoProperties
Specifies whether the extended properties for a certificate are exported. If this parameter is specified, then extended properties are not included with the export. By default, all extended properties are included in the exported file.
Parameter properties
| Type: | Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Password
Specifies the password used to protect the exported PFX file. The password should be in the form of secure string. Either the ProtectTo or this parameter must be specified, or an error will be displayed.
Parameter properties
| Type: | System.SecureString |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PFXData
Specifies a PFXData object that contains one or more certificates from a PFX file.
Parameter properties
| Type: | PfxData |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PfxCert
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProtectTo
Specifies an array of strings for the username or group name that can access the private key of PFX file without any password. This requires a Windows Server 2012 or later domain controller. Either the Password or this parameter must be specified, or an error will be displayed.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
X509Certificate2
The X509Certificate2[] object is an array of certificate objects.
Outputs
FileInfo
The FileInfo object contains the information about the PFX file.