Resource Type: dsc_xexchexchangecertificate

Defined in:

lib/puppet/type/dsc_xexchexchangecertificate.rb

Providers:

powershell

Overview

The DSC xExchExchangeCertificate resource type. Automatically generated from ‘xExchange/DSCResources/MSFT_xExchExchangeCertificate/MSFT_xExchExchangeCertificate.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
  • absent

Parameters

• dsc_allowextraservices

  AllowExtraServices - Get-ExchangeCertificate sometimes displays more services than are actually enabled. Setting this to true allows tests to pass in that situation as long as the requested services are present.

  Supported values:

  • true
  • false
• dsc_certcreds

  CertCreds - Credentials containing the password to the .pfx file in CertFilePath.

• dsc_certfilepath

  CertFilePath - The file path to the certificate .pfx file that should be imported.

• dsc_credential

  Credential - Credentials used to establish a remote PowerShell session to Exchange.

• dsc_domaincontroller

  DomainController - The DomainController parameter specifies the domain controller that’s used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

• dsc_donotrequiressl

  DoNotRequireSsl - Setting DoNotRequireSsl to True prevents DSC from enabling the Require SSL setting on the Default Web Site when you enable the certificate for IIS. Defaults to False.

  Supported values:

  • true
  • false
• dsc_ensure

  Ensure - Whether the certificate should be present or not. Valid values are Present, Absent.

• dsc_networkserviceallowed

  NetworkServiceAllowed - Setting NetworkServiceAllowed to True gives the built-in Network Service account permission to read the certificate’s private key without enabling the certificate for SMTP. Defaults to False.

  Supported values:

  • true
  • false
• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_services

  Services - The Services parameter specifies the Exchange services that the certificate is enabled for.

• dsc_thumbprint

  Thumbprint - Thumbprint of the certificate to work on.

• name (namevar)
• provider

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