Resource Type: dsc_xcertreq

Defined in:

lib/puppet/type/dsc_xcertreq.rb

Providers:

powershell

Overview

The DSC xCertReq resource type. Automatically generated from ‘xCertificate/DSCResources/MSFT_xCertReq/MSFT_xCertReq.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_autorenew

  AutoRenew - Determines if the resource will also renew a certificate within 7 days of expiration.

  Supported values:

  • true
  • false
• dsc_carootname

  CARootName - The name of the certificate authority, by default this will be in format domain-servername-ca. Leave empty to automatically locate.

• dsc_caserverfqdn

  CAServerFQDN - The FQDN of the Active Directory Certificate Authority on the local area network. Leave empty to automatically locate.

• dsc_catype

  CAType - The type of CA in use, Standalone/Enterprise.

• dsc_cepurl

  CepURL - The URL to the Certification Enrollment Policy Service.

• dsc_certificatetemplate

  CertificateTemplate - The template used for the definition of the certificate.

• dsc_cesurl

  CesURL - The URL to the Certification Enrollment Service.

• dsc_credential

  Credential - The ‘PSCredential` object containing the credentials that will be used to access the template in the Certificate Authority.

• dsc_exportable

  Exportable - The option to allow the certificate to be exportable, by default it will be true.

  Supported values:

  • true
  • false
• dsc_friendlyname

  FriendlyName - Specifies a friendly name for the certificate.

• dsc_keylength

  KeyLength - The bit length of the encryption key to be used. Defaults to 2048. Valid values are 1024, 2048, 4096, 8192.

• dsc_keyusage

  KeyUsage - The Keyusage is a restriction method that determines what a certificate can be used for.

• dsc_oid

  OID - The Object Identifier that is used to name the object.

• dsc_providername

  ProviderName - The selection of provider for the type of encryption to be used.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_subject

  Subject - Provide the text string to use as the subject of the certificate.

• dsc_subjectaltname

  SubjectAltName - The subject alternative name used to create the certificate.

• dsc_usemachinecontext

  UseMachineContext - Indicates whether or not the flag -adminforcemachine will be used when requesting certificates. Necessary for certain templates like e.g. DomainControllerAuthentication

  Supported values:

  • true
  • false
• name (namevar)
• provider

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