Export (0) Print
Expand All

Export-PfxCertificate

Windows Server 2012 R2 and Windows 8.1

Updated: March 3, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Export-PfxCertificate

Exports a certificate or a PFXData object to a Personal Information Exchange (PFX) file.

Syntax

Parameter Set: NormalCert
Export-PfxCertificate [-Cert] <Certificate> [-FilePath] <String> [-ChainOption <ExportChainOption> ] [-Force] [-NoClobber] [-NoProperties] [-Password <SecureString> ] [-ProtectTo <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: PfxCert
Export-PfxCertificate [-PFXData] <PfxData> [-FilePath] <String> [-ChainOption <ExportChainOption> ] [-Force] [-NoClobber] [-NoProperties] [-Password <SecureString> ] [-ProtectTo <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed 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.

Parameters

-Cert<Certificate>

Specifies the path to the certificate to be exported.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ChainOption<ExportChainOption>

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.


Aliases

none

Required?

false

Position?

named

Default Value

BuildChain

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FilePath<String>

Specifies the path for the PFX file to be exported.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

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.


Aliases

none

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NoClobber

Specifies that if the PFX file already exists, it should not be over written. 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.


Aliases

none

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

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.


Aliases

none

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PFXData<PfxData>

Specifies a PFXData object that contains one or more certificates from a PFX file.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Password<SecureString>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ProtectTo<String>

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 domain controller. Either the Password or this parameter must be specified, or an error will be displayed.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

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

  • System.Security.Cryptography.X509Certificates.X509Certificate2[]

    The X509Certificate2[] object is an array of certificate objects.


Outputs

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

  • System.IO.FileInfo

    The FileInfo object contains the information about the PFX file.


Examples

EXAMPLE 1

This example exports a certificate from the local machine store to a PFX file which includes the entire chain and all external properties.


 

PS C:\> $mypwd = ConvertTo-SecureString -String "1234" -Force –AsPlainText

 

PS C:\> Get-ChildItem -Path cert:\localMachine\my\5F98EBBFE735CDDAE00E33E0FD69050EF9220254 | Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd

EXAMPLE 2

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.


 

PS C:\> $mypwd = ConvertTo-SecureString -String "1234" -Force –AsPlainText

 

PS C:\> Get-ChildItem -Path cert:\LocalMachine\my | Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd

EXAMPLE 3

This example exports a certificate from the current user store with no chain and no external properties


 

PS C:\> $mypwd = ConvertTo-SecureString -String "1234" -Force –AsPlainText

 

PS C:\> Export-PfxCertificate –Cert cert:\currentuser\my\5F98EBBFE735CDDAE00E33E0FD69050EF9220254 –FilePath c:\myexport.pfx -ChainOption EndEntityCertOnly -NoProperties -Password $mypwd

EXAMPLE 4

This example exports a certificate from the current machine store. Both user accounts, contos\billb99 and contos\johnj99, can access this PFX with no password. A Windows® 8 DC for key distribution is required.


PS C:\> $a = Get-ChildItem -Path cert:\localMachine\my 
Export-PfxCertificate –Cert $a[1] –FilePath C:\myexport.pfx -ProtectTo "contoso\billb99, contoso\johnj99"

EXAMPLE 5

This example exports a certificate from the current 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 8 DC for key distribution is required.


 

PS C:\> $a = Get-ChildItem -Path cert:\localMachine\my

 

PS C:\> $mypwd = ConvertTo-SecureString -String "1234" -Force –AsPlainText

 

PS C:\> Export-PfxCertificate –Cert $a[1] –FilePath C:\myexport.pfx -ProtectTo "contoso\billb99, contoso\johnj99" -Password $mypwd

EXAMPLE 6

This example changes an existing password for a PFX file from $OldPwd to $NewPwd.


 

PS C:\> $NewPwd = ConvertTo-SecureString -String "abcd" -Force –AsPlainText

 

PS C:\> $mypfx = Get-PfxData –FilePath C:\mypfx.pfx -Password $Oldpwd

 

PS C:\> Export-PfxCertificate -PFXData $mypfx –FilePath C:\mypfx2.pfx -Password $NewPwd

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft