Resource Type: dsc_xexchimapsettings

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

Overview

The DSC xExchImapSettings resource type. Automatically generated from version 1.33.0

Properties

  • dsc_allowservicerestart

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

  • dsc_authenticatedconnectiontimeout

    The AuthenticatedConnectionTimeout parameter specifies the period of time to wait before closing an idle authenticated connection.

  • dsc_banner

    The Banner parameter specifies the text string that’s displayed to connecting IMAP4 clients.

  • dsc_calendaritemretrievaloption

    The CalendarItemRetrievalOption parameter specifies how calendar items are presented to IMAP4 clients.

  • dsc_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_enableexactrfc822size

    The EnableExactRFC822Size parameter specifies how message sizes are presented to IMAP4 clients.

  • dsc_enablegssapiandntlmauth

    The EnableGSSAPIAndNTLMAuth parameter specifies whether connections can use Integrated Windows authentication (NTLM) using the Generic Security Services application programming interface (GSSAPI). This setting applies to connections where Transport Layer Security (TLS) is disabled.

  • dsc_enforcecertificateerrors

    The EnforceCertificateErrors parameter specifies whether to enforce valid Secure Sockets Layer (SSL) certificate validation failures.

  • dsc_extendedprotectionpolicy

    The ExtendedProtectionPolicy parameter specifies how Extended Protection for Authentication is used.

  • dsc_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_internalconnectionsettings

    The InternalConnectionSettings parameter specifies the host name, port, and encryption method that’s used by internal IMAP4 clients (IMAP4 connections from inside your corporate network).

  • dsc_logfilelocation

    The LogFileLocation parameter specifies the location for the IMAP4 protocol log files.

  • dsc_logfilerolloversettings

    The LogFileRollOverSettings parameter specifies how frequently IMAP4 protocol logging creates a new log file.

  • dsc_logintype

    The LoginType parameter specifies the authentication method for IMAP4 connections.

  • dsc_logperfilesizequota

    The LogPerFileSizeQuota parameter specifies the maximum size of a IMAP4 protocol log file.

  • dsc_maxcommandsize

    The MaxCommandSize parameter specifies the maximum size in bytes of a single IMAP4 command.

  • dsc_maxconnectionfromsingleip

    The MaxConnectionFromSingleIP parameter specifies the maximum number of IMAP4 connections that are accepted by the Exchange server from a single IP address.

  • dsc_maxconnections

    The MaxConnections parameter specifies the maximum number of IMAP4 connections that are accepted by the Exchange server.

  • dsc_maxconnectionsperuser

    The MaxConnectionsPerUser parameter specifies the maximum number of IMAP4 connections that are allowed for each user.

  • dsc_messageretrievalmimeformat

    The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages.

  • dsc_owaserverurl

    The OwaServerUrl parameter specifies the URL that’s used to retrieve calendar information for instances of custom Outlook on the web calendar items.

  • dsc_preauthenticatedconnectiontimeout

    The PreAuthenticatedConnectionTimeout parameter specifies the period of time to wait before closing an idle IMAP4 connection that isn’t authenticated.

  • dsc_protocollogenabled

    The ProtocolLogEnabled parameter specifies whether to enable protocol logging for IMAP4.

  • dsc_proxytargetport

    The ProxyTargetPort parameter specifies the port on the Microsoft Exchange IMAP4 Backend service that listens for client connections that are proxied from the Microsoft Exchange IMAP4 service.

  • dsc_showhiddenfoldersenabled

    The ShowHiddenFoldersEnabled parameter specifies whether hidden mailbox folders are visible.

  • dsc_sslbindings

    The SSLBindings parameter specifies the IP address and TCP port that’s used for IMAP4 connection that’s always encrypted by SSL/TLS. This parameter uses the syntax <IPv4OrIPv6Address>:<Port>.

  • dsc_suppressreadreceipt

    The SuppressReadReceipt parameter specifies whether to stop duplicate read receipts from being sent to IMAP4 clients that have the Send read receipts for messages I send setting configured in their IMAP4 email program.

  • dsc_unencryptedortlsbindings

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

  • dsc_x509certificatename

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

Parameters

  • dsc_credential

    Credentials used to establish a remote PowerShell session to Exchange.

  • dsc_psdscrunascredential
  • dsc_server (namevar)

    The IMAP server to configure.

  • name (namevar)

    Description of the purpose for this resource declaration.

  • validation_mode (defaults to: property)

    Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).