Resource Type: dsc_xcertificateexport

Defined in:

lib/puppet/type/dsc_xcertificateexport.rb

Providers:

powershell

Overview

The DSC xCertificateExport resource type. Automatically generated from ‘xCertificate/DSCResources/MSFT_xCertificateExport/MSFT_xCertificateExport.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_allowexpired

  AllowExpired - Allow an expired certificate to be exported. Certificate selector parameter.

  Supported values:

  • true
  • false
• dsc_chainoption

  ChainOption - Specifies the options for building a chain when exporting a PFX certificate. Valid values are BuildChain, EndEntityCertOnly.

• dsc_dnsname

  DNSName - The subject alternative name of the certificate to export must contain these values. Certificate selector parameter.

• dsc_enhancedkeyusage

  EnhancedKeyUsage - The enhanced key usage of the certificate to export must contain these values. Certificate selector parameter.

• dsc_friendlyname

  FriendlyName - The friendly name of the certificate to export. Certificate selector parameter.

• dsc_isexported

  IsExported - Returns true if the certificate file already exists and therefore has been exported.

  Supported values:

  • true
  • false
• dsc_issuer

  Issuer - The issuer of the certificate to export. Certificate selector parameter.

• dsc_keyusage

  KeyUsage - The key usage of the certificate to export must contain these values. Certificate selector parameter.

• dsc_matchsource

  MatchSource - Causes an existing exported certificate to be compared with the certificate identified for export and re-exported if it does not match.

  Supported values:

  • true
  • false
• dsc_password

  Password - Specifies the password used to protect an exported PFX file.

• dsc_path

  Path - The path to the file you that will contain the exported certificate.

• dsc_protectto

  ProtectTo - Specifies an array of strings for the username or group name that can access the private key of an exported PFX file without any password.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_store

  Store - The Windows Certificate Store Name to search for the certificate to export from. Certificate selector parameter. Defaults to ‘My’.

• dsc_subject

  Subject - The subject of the certificate to export. Certificate selector parameter.

• dsc_thumbprint

  Thumbprint - The thumbprint of the certificate to export. Certificate selector parameter.

• dsc_type

  Type - Specifies the type of certificate to export. Valid values are Cert, P7B, SST, PFX.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xcertificateexport` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.