Resource Type: dsc_xexchimapsettings

Defined in:
lib/puppet/type/dsc_xexchimapsettings.rb
Providers:
powershell

Overview

The DSC xExchImapSettings resource type. Automatically generated from ‘xExchange/DSCResources/MSFT_xExchImapSettings/MSFT_xExchImapSettings.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_allowservicerestart

    AllowServiceRestart - Whether it is OK to restart the IMAP services after making changes. Defaults to $false.

    Supported values:
    • true
    • false
  • 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_externalconnectionsettings

    ExternalConnectionSettings - The ExternalConnectionSettings parameter specifies the host name, port, and encryption method that’s used by external IMAP4 clients (IMAP4 connections from outside your corporate network).

  • dsc_logintype

    LoginType - The LoginType parameter specifies the authentication method for IMAP4 connections. Valid values are PlainTextLogin, PlainTextAuthentication, SecureLogin.

  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_server

    Server - The IMAP server to configure.

  • dsc_x509certificatename

    X509CertificateName - The X509CertificateName parameter specifies the certificate that’s used for encrypting IMAP4 client connections.

  • name (namevar)
  • provider

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