Export-Certificate Cmdlet

Parameters   Output Objects   Configuration Settings  

The Export-Certificate component is used to export an X.509 certificate from a certificate store.

Syntax

Export-Certificate [parameters]

Remarks

This will save the certificate specified by CertStore, CertStoreType, CertStorePassword and Subject to a PFX file. The certificate and its private key are saved to the file specified by OutputFile in PKCS12 format. The file contents are protected by Password.

# export a certificate
export-certificate -CertStore Root -CertStoreType User -Subject $subject -OutputFile $file -Password $password

Parameter List


The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFileThe location of a file to which debug information is written.
CertStoreThe name of the certificate store for the client certificate.
CertStorePasswordThe password for the certificate store (if any).
CertStoreTypeThe type of certificate store for the client certificate.
ConfigSpecifies one or more configuration settings.
LogFileThe location of a file to which debug information is written.
OutputFileThe output file.
PasswordThe certificate's password.
PublicKeyOnlyWhether to export public key only.
SubjectSpecifies the subject of the certificate to get.

Output Objects


The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

ExportedCertThis object is returned for each certificate exported from a store.

Configuration Settings


The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.

CertificateOutputFormatThe format of the output certificate.
CertCommentA comment to include in a saved certificate.
CertCustomExtensionCountThe number of records in the CertCustomExtension arrays.
CertCustomExtensionCritical[i]Whether or not the extension is defined as critical.
CertCustomExtensionOID[i]The ASN of the extension at index 'i'.
CertCustomExtensionValue[i]The raw value of the extension at index 'i'.
CertExtendedKeyUsageThe extended key usage of the certificate.
CertKeyLengthThe public key length for created certificates and keys.
CertKeyTypeThe types of keys created for new certificates.
CertPublicKeyAlgorithmThe public key algorithm used when a certificate is created.
CertSignatureAlgorithmThe signature algorithm used when creating certificates.
CertSubjectAltNamesSubject Alternative Names for creating or issuing certificates.
CertUsageFlagsSets the flags indicating the usage of the created certificate.
CertValidityOffsetThe number of days until the certificate becomes valid.
CertValidityTimeThe validity period for the certificate.
CreatedKeyThe PKCS8 formatted private and public key pair created after calling CreateKey.
CSPThe Cryptographic Service Provider.
CSRIgnoredExtensionsExtensions to be ignorned when signing a CSR.
CSRKeyThe PKCS8 formatted private key to use when generating a CSR.
EncodeExportedCertWhether the certificate being exported to a string is encoded.
ImportCertActionSpecified the action to take if a matching certificate or a link to a matching certificate already exists.
ImportCertStoreTypeThe type of certificate store being specified for import.
JWKAlgorithmThe JWK algorithm.
JWKExportX5CWhether to export a certificate chain to the x5c parameter.
JWKKeyIdThe JWK key Id.
JWKKeyOpsThe JWK intended key operations list.
JWKUseThe JWK use parameter value.
KeyFormatHow the public and private key are formatted.
LogLevelThe level of detail that is logged.
ReplaceKeyWhether or not to replace an existing key when creating a new key.
RequestSubjectAltNamesSubject Alternative Names for a Certificate Signing Request.
X509AlgorithmPublic Key Algorithm OID.
X509SignatureAlgorithmSignature Algorithm OID.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
NetCmdlets 2020 - Version 20.0 [Build 8319]