xexchange
Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 8.0.0
Start using this module
Add this module to your Puppetfile:
mod 'dsc-xexchange', '1.28.0-0-1'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
Description
This is an auto-generated module, using the Puppet DSC Builder to vendor and expose the PowerShell module's DSC resources as Puppet resources. The functionality of this module comes entirely from the vendored PowerShell resources, which are pinned at v1.28.0.0. The PowerShell module describes itself like this:
Module with DSC Resources for deployment and configuration of Microsoft Exchange Server.
For information on troubleshooting to determine whether any encountered problems are with the Puppet wrapper or the DSC resource, see the troubleshooting section below.
Requirements
This module, like all auto-generated Puppetized DSC modules, relies on two important technologies in the Puppet stack: the Puppet Resource API and the puppetlabs/pwshlib Puppet module.
The Resource API provides a simplified option for writing types and providers and is responsible for how this module is structured. The Resource API ships inside of Puppet starting with version 6. While it is technically possible to add the Resource API functionality to Puppet 5.5.x, the DSC functionality has not been tested in this setup. For more information on the Resource API, review the documentation.
The module also depends on the pwshlib module. This Puppet module includes two important things: the ruby-pwsh library for running PowerShell code from ruby and the base provider for DSC resources, which this module leverages.
All of the actual work being done to call the DSC resources vendored with this module is in this file from the pwshlib module. This is important for troubleshooting and bug reporting, but doesn't impact your use of the module except that the end result will be that nothing works, as the dependency is not installed alongside this module!
Usage
You can specify any of the DSC resources from this module like a normal Puppet resource in your manifests. The examples below use DSC resources from from the PowerShellGet repository, regardless of what module you're looking at here; the syntax, not the specifics, is what's important.
For reference documentation about the DSC resources exposed in this module, see the Reference Forge tab, or the REFERENCE.md file.
# Include a meaningful title for your resource declaration
dsc_psrepository { 'Add team module repo':
dsc_name => 'foo',
dsc_ensure => present,
# This location is nonsense, can be any valid folder on your
# machine or in a share, any location the SourceLocation param
# for the DSC resource will accept.
dsc_sourcelocation => 'C:\Program Files',
# You must always pass an enum fully lower-cased;
# Puppet is case sensitive even when PowerShell isn't
dsc_installationpolicy => untrusted,
}
dsc_psrepository { 'Trust public gallery':
dsc_name => 'PSGallery',
dsc_ensure => present,
dsc_installationpolicy => trusted,
}
dsc_psmodule { 'Make Ruby manageable via uru':
dsc_name => 'RubyInstaller',
dsc_ensure => present,
}
For more information about using a built module, check out our narrative documentation.
Properties
Note that the only properties specified in a resource declaration which are passed to Invoke-Dsc are all prepended with dsc.
If a property does _not start with dsc_ it is used to control how Puppet interacts with DSC/other Puppet resources - for example,
specifying a unique name for the resource for Puppet to distinguish between declarations or Puppet metaparameters (notifies,
before, etc).
Troubleshooting
In general, there are three broad categories of problems:
- Problems with the way the underlying DSC resource works.
- Problems with the type definition, where you can't specify a valid set of properties for the DSC resource
- Problems with calling the underlying DSC resource - the parameters aren't being passed correctly or the resource can't be found
Unfortunately, problems with the way the underlying DSC resource works are something we can't help directly with. You'll need to file an issue with the upstream maintainers for the PowerShell module.
Problems with the type definition are when a value that should be valid according to the DSC resource's documentation and code is not accepted by the Puppet wrapper. If and when you run across one of these, please file an issue with the Puppet DSC Builder; this is where the conversion happens and once we know of a problem we can fix it and regenerate the Puppet modules. To help us identify the issue, please specify the DSC module, version, resource, property and values that are giving you issues. Once a fix is available we will regenerate and release updated versions of this Puppet wrapper.
Problems with calling the underlying DSC resource become apparent by comparing <value passed in in puppet>
with <value received by DSC>
.
In this case, please file an issue with the puppetlabs/pwshlib module, which is where the DSC base provider actually lives.
We'll investigate and prioritize a fix and update the puppetlabs/pwshlib module.
Updating to the pwshlib version with the fix will immediately take advantage of the improved functionality without waiting for this module to be reconverted and published.
For specific information on troubleshooting a generated module, check the troubleshooting guide for the puppet.dsc module.
Known Limitations
Currently, because of the way Puppet caches files on agents, use of the legacy puppetlabs-dsc
module is not compatible with this or any auto-generated DSC module.
Inclusion of both will lead to pluginsync conflicts.
Reference
Table of Contents
Resource types
dsc_xexchactivesyncvirtualdirectory
: The DSC xExchActiveSyncVirtualDirectory resource type. Automatically generated from version 1.28.0.0dsc_xexchantimalwarescanning
: The DSC xExchAntiMalwareScanning resource type. Automatically generated from version 1.28.0.0dsc_xexchautodiscovervirtualdirectory
: The DSC xExchAutodiscoverVirtualDirectory resource type. Automatically generated from version 1.28.0.0dsc_xexchautomountpoint
: The DSC xExchAutoMountPoint resource type. Automatically generated from version 1.28.0.0dsc_xexchclientaccessserver
: The DSC xExchClientAccessServer resource type. Automatically generated from version 1.28.0.0dsc_xexchdatabaseavailabilitygroup
: The DSC xExchDatabaseAvailabilityGroup resource type. Automatically generated from version 1.28.0.0dsc_xexchdatabaseavailabilitygroupmember
: The DSC xExchDatabaseAvailabilityGroupMember resource type. Automatically generated from version 1.28.0.0dsc_xexchdatabaseavailabilitygroupnetwork
: The DSC xExchDatabaseAvailabilityGroupNetwork resource type. Automatically generated from version 1.28.0.0dsc_xexchecpvirtualdirectory
: The DSC xExchEcpVirtualDirectory resource type. Automatically generated from version 1.28.0.0dsc_xexcheventloglevel
: The DSC xExchEventLogLevel resource type. Automatically generated from version 1.28.0.0dsc_xexchexchangecertificate
: The DSC xExchExchangeCertificate resource type. Automatically generated from version 1.28.0.0dsc_xexchexchangeserver
: The DSC xExchExchangeServer resource type. Automatically generated from version 1.28.0.0dsc_xexchfrontendtransportservice
: The DSC xExchFrontendTransportService resource type. Automatically generated from version 1.28.0.0dsc_xexchimapsettings
: The DSC xExchImapSettings resource type. Automatically generated from version 1.28.0.0dsc_xexchinstall
: The DSC xExchInstall resource type. Automatically generated from version 1.28.0.0dsc_xexchjetstress
: The DSC xExchJetstress resource type. Automatically generated from version 1.28.0.0dsc_xexchjetstresscleanup
: The DSC xExchJetstressCleanup resource type. Automatically generated from version 1.28.0.0dsc_xexchmailboxdatabase
: The DSC xExchMailboxDatabase resource type. Automatically generated from version 1.28.0.0dsc_xexchmailboxdatabasecopy
: The DSC xExchMailboxDatabaseCopy resource type. Automatically generated from version 1.28.0.0dsc_xexchmailboxserver
: The DSC xExchMailboxServer resource type. Automatically generated from version 1.28.0.0dsc_xexchmailboxtransportservice
: The DSC xExchMailboxTransportService resource type. Automatically generated from version 1.28.0.0dsc_xexchmaintenancemode
: The DSC xExchMaintenanceMode resource type. Automatically generated from version 1.28.0.0dsc_xexchmapivirtualdirectory
: The DSC xExchMapiVirtualDirectory resource type. Automatically generated from version 1.28.0.0dsc_xexchoabvirtualdirectory
: The DSC xExchOabVirtualDirectory resource type. Automatically generated from version 1.28.0.0dsc_xexchoutlookanywhere
: The DSC xExchOutlookAnywhere resource type. Automatically generated from version 1.28.0.0dsc_xexchowavirtualdirectory
: The DSC xExchOwaVirtualDirectory resource type. Automatically generated from version 1.28.0.0dsc_xexchpopsettings
: The DSC xExchPopSettings resource type. Automatically generated from version 1.28.0.0dsc_xexchpowershellvirtualdirectory
: The DSC xExchPowerShellVirtualDirectory resource type. Automatically generated from version 1.28.0.0dsc_xexchreceiveconnector
: The DSC xExchReceiveConnector resource type. Automatically generated from version 1.28.0.0dsc_xexchtransportservice
: The DSC xExchTransportService resource type. Automatically generated from version 1.28.0.0dsc_xexchumcallroutersettings
: The DSC xExchUMCallRouterSettings resource type. Automatically generated from version 1.28.0.0dsc_xexchumservice
: The DSC xExchUMService resource type. Automatically generated from version 1.28.0.0dsc_xexchwaitforadprep
: The DSC xExchWaitForADPrep resource type. Automatically generated from version 1.28.0.0dsc_xexchwaitfordag
: The DSC xExchWaitForDAG resource type. Automatically generated from version 1.28.0.0dsc_xexchwaitformailboxdatabase
: The DSC xExchWaitForMailboxDatabase resource type. Automatically generated from version 1.28.0.0dsc_xexchwebservicesvirtualdirectory
: The DSC xExchWebServicesVirtualDirectory resource type. Automatically generated from version 1.28.0.0
Resource types
dsc_xexchactivesyncvirtualdirectory
The DSC xExchActiveSyncVirtualDirectory resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchactivesyncvirtualdirectory
type.
dsc_activesyncserver
Data type: Optional[String]
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_autocertbasedauth
Data type: Optional[Boolean]
dsc_autocertbasedauthhttpsbindings
Data type: Optional[Array[String]]
dsc_autocertbasedauththumbprint
Data type: Optional[String]
dsc_baditemreportingenabled
Data type: Optional[Boolean]
dsc_basicauthenabled
Data type: Optional[Boolean]
dsc_clientcertauth
Data type: Optional[Enum['Ignore', 'Accepted', 'Required']]
dsc_compressionenabled
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_extendedprotectionflags
Data type: Optional[Array[Enum['None', 'Proxy', 'NoServiceNameCheck', 'AllowDotlessSpn', 'ProxyCohosting']]]
dsc_extendedprotectionspnlist
Data type: Optional[Array[String]]
dsc_extendedprotectiontokenchecking
Data type: Optional[Enum['None', 'Allow', 'Require']]
dsc_externalauthenticationmethods
Data type: Optional[Array[String]]
dsc_externalurl
Data type: Optional[String]
dsc_installisapifilter
Data type: Optional[Boolean]
dsc_internalauthenticationmethods
Data type: Optional[Array[String]]
dsc_internalurl
Data type: Optional[String]
dsc_mobileclientcertificateauthorityurl
Data type: Optional[String]
dsc_mobileclientcertificateprovisioningenabled
Data type: Optional[Boolean]
dsc_mobileclientcerttemplatename
Data type: Optional[String]
dsc_name
Data type: Optional[String]
dsc_remotedocumentsactionforunknownservers
Data type: Optional[Enum['Allow', 'Block']]
dsc_remotedocumentsallowedservers
Data type: Optional[Array[String]]
dsc_remotedocumentsblockedservers
Data type: Optional[Array[String]]
dsc_remotedocumentsinternaldomainsuffixlist
Data type: Optional[Array[String]]
dsc_sendwatsonreport
Data type: Optional[Boolean]
dsc_windowsauthenabled
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchactivesyncvirtualdirectory
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_identity
namevar
Data type: String
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchantimalwarescanning
The DSC xExchAntiMalwareScanning resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchantimalwarescanning
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
Whether the Transport services should be automatically restarted after a status change
Parameters
The following parameters are available in the dsc_xexchantimalwarescanning
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange
dsc_enabled
namevar
Data type: Boolean
Whether Exchange Anti-malware scanning should be Enabled
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchautodiscovervirtualdirectory
The DSC xExchAutodiscoverVirtualDirectory resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchautodiscovervirtualdirectory
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
Whether it is OK to recycle the app pool after making changes. Defaults to $true.
dsc_basicauthentication
Data type: Optional[Boolean]
Specifies whether Basic authentication is enabled on the virtual directory.
dsc_digestauthentication
Data type: Optional[Boolean]
Specifies whether Digest authentication is enabled on the virtual directory.
dsc_domaincontroller
Data type: Optional[String]
Specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory.
dsc_extendedprotectionflags
Data type: Optional[Array[Enum['None', 'Proxy', 'NoServiceNameCheck', 'AllowDotlessSpn', 'ProxyCohosting']]]
Specifies custom settings for Extended Protection for Authentication on the virtual directory.
dsc_extendedprotectionspnlist
Data type: Optional[Array[String]]
Specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory.
dsc_extendedprotectiontokenchecking
Data type: Optional[Enum['None', 'Allow', 'Require']]
Defines how you want to use Extended Protection for Authentication on the virtual directory.
dsc_oauthauthentication
Data type: Optional[Boolean]
Specifies whether OAuth authentication is enabled on the virtual directory.
dsc_windowsauthentication
Data type: Optional[Boolean]
Specifies whether Integrated Windows authentication is enabled on the virtual directory.
dsc_wssecurityauthentication
Data type: Optional[Boolean]
Specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory.
Parameters
The following parameters are available in the dsc_xexchautodiscovervirtualdirectory
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange.
dsc_identity
namevar
Data type: String
The Identity parameter specifies the Autodiscover virtual directory that you want to modify.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchautomountpoint
The DSC xExchAutoMountPoint resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchautomountpoint
type.
dsc_autodagdatabasesrootfolderpath
Data type: String
The parent folder for Exchange database mount point folders.
dsc_autodagvolumesrootfolderpath
Data type: String
The parent folder for Exchange volume mount point folders.
dsc_createsubfolders
Data type: Optional[Boolean]
If $true, specifies that DBNAME.db and DBNAME.log subfolders should be automatically created underneath the ExchangeDatabase mount points. Defaults to $false.
dsc_disktodbmap
Data type: Array[String]
An array of strings containing the databases for each disk. Databases on the same disk should be in the same string, and comma separated. Example: 'DB1,DB2','DB3,DB4'. This puts DB1 and DB2 on one disk, and DB3 and DB4 on another.
dsc_ensureexchangevolumemountpointislast
Data type: Optional[Boolean]
Whether the EXVOL mount point should be moved to be the last mount point listed on each disk. Defaults to $false.
dsc_filesystem
Data type: Optional[Enum['NTFS', 'REFS']]
The file system to use when formatting the volume. Defaults to NTFS.
dsc_mindisksize
Data type: Optional[String]
The minimum size of a disk to consider using. Defaults to none. Should be in a format like '1024MB' or '1TB'.
dsc_partitioningscheme
Data type: Optional[Enum['MBR', 'GPT']]
The partitioning scheme for the volume. Defaults to GPT.
dsc_sparevolumecount
Data type: Integer[0, 4294967295]
How many spare volumes will be available.
dsc_unitsize
Data type: Optional[String]
The unit size to use when formatting the disk. Defaults to 64k.
dsc_volumeprefix
Data type: Optional[String]
The prefix to give to Exchange Volume folders. Defaults to EXVOL.
Parameters
The following parameters are available in the dsc_xexchautomountpoint
type.
dsc_identity
namevar
Data type: String
The name of the server. Not actually used for anything.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchclientaccessserver
The DSC xExchClientAccessServer resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchclientaccessserver
type.
dsc_autodiscoverserviceinternaluri
Data type: Optional[String]
The AutoDiscoverServiceInternalUri parameter specifies the internal URL of the Autodiscover service.
dsc_autodiscoversitescope
Data type: Optional[Array[String]]
The AutoDiscoverSiteScope parameter specifies the Active Directory site that the Autodiscover service is authoritative for. Clients that connect to the Autodiscover service by using the internal URL need to exist in the specified site.
dsc_cleanupinvalidalternateserviceaccountcredentials
Data type: Optional[Boolean]
The CleanUpInvalidAlternateServiceAccountCredentialsswitch specifies whether to remove a previously configured alternate service account that's no longer valid.
dsc_domaincontroller
Data type: Optional[String]
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_removealternateserviceaccountcredentials
Data type: Optional[Boolean]
The RemoveAlternateServiceAccountCredentialsswitch specifies whether to remove a previously distributed alternate service account.
Parameters
The following parameters are available in the dsc_xexchclientaccessserver
type.
dsc_alternateserviceaccountcredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The AlternateServiceAccountCredential parameter specifies an alternative service account that'stypically used for Kerberos authentication.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange.
dsc_identity
namevar
Data type: String
The hostname of the Client Access Server.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchdatabaseavailabilitygroup
The DSC xExchDatabaseAvailabilityGroup resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchdatabaseavailabilitygroup
type.
dsc_alternatewitnessdirectory
Data type: Optional[String]
dsc_alternatewitnessserver
Data type: Optional[String]
dsc_autodagautoredistributeenabled
Data type: Optional[Boolean]
dsc_autodagautoreseedenabled
Data type: Optional[Boolean]
dsc_autodagdatabasecopiesperdatabase
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_autodagdatabasecopiespervolume
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_autodagdatabasesrootfolderpath
Data type: Optional[String]
dsc_autodagdiskreclaimerenabled
Data type: Optional[Boolean]
dsc_autodagtotalnumberofdatabases
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_autodagtotalnumberofservers
Data type: Integer[-2147483648, 2147483647]
dsc_autodagvolumesrootfolderpath
Data type: Optional[String]
dsc_databaseavailabilitygroupipaddresses
Data type: Optional[Array[String]]
dsc_datacenteractivationmode
Data type: Optional[Enum['Off', 'DagOnly']]
dsc_domaincontroller
Data type: Optional[String]
dsc_filesystem
Data type: Optional[Enum['NTFS', 'ReFS']]
dsc_manualdagnetworkconfiguration
Data type: Optional[Boolean]
dsc_networkcompression
Data type: Optional[Enum['Disabled', 'Enabled', 'InterSubnetOnly', 'SeedOnly']]
dsc_networkencryption
Data type: Optional[Enum['Disabled', 'Enabled', 'InterSubnetOnly', 'SeedOnly']]
dsc_preferencemovefrequency
Data type: Optional[String]
dsc_replaylagmanagerenabled
Data type: Optional[Boolean]
dsc_replicationport
Data type: Optional[Integer[0, 65535]]
dsc_skipdagvalidation
Data type: Optional[Boolean]
dsc_witnessdirectory
Data type: Optional[String]
dsc_witnessserver
Data type: Optional[String]
Parameters
The following parameters are available in the dsc_xexchdatabaseavailabilitygroup
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_name
namevar
Data type: String
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchdatabaseavailabilitygroupmember
The DSC xExchDatabaseAvailabilityGroupMember resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchdatabaseavailabilitygroupmember
type.
dsc_dagname
Data type: String
dsc_domaincontroller
Data type: Optional[String]
dsc_skipdagvalidation
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchdatabaseavailabilitygroupmember
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_mailboxserver
namevar
Data type: String
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchdatabaseavailabilitygroupnetwork
The DSC xExchDatabaseAvailabilityGroupNetwork resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchdatabaseavailabilitygroupnetwork
type.
dsc_databaseavailabilitygroup
Data type: String
The DAG where the network will live.
dsc_domaincontroller
Data type: Optional[String]
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_ensure
Data type: Enum['Present', 'Absent']
Whether the DAG network should exist or not.
dsc_ignorenetwork
Data type: Optional[Boolean]
The IgnoreNetwork parameter indicates that the specified network should be ignored and not used by the DAG.
dsc_replicationenabled
Data type: Optional[Boolean]
The ReplicationEnabled parameter specifies whether the network can be used for replication activity. If this parameter isn't specified, the default behavior is to enable the network for replication.
dsc_subnets
Data type: Optional[Array[String]]
The Subnets parameter specifies one or more subnets that are associated with the DAG network.
Parameters
The following parameters are available in the dsc_xexchdatabaseavailabilitygroupnetwork
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange.
dsc_name
namevar
Data type: String
The name of the DAG network.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchecpvirtualdirectory
The DSC xExchEcpVirtualDirectory resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchecpvirtualdirectory
type.
dsc_adfsauthentication
Data type: Optional[Boolean]
The AdfsAuthentication parameter specifies that the ECP virtual directory allows users to authenticate through Active Directory Federation Services (AD FS) authentication. This parameter accepts $true or $false. The default value is $false.
dsc_adminenabled
Data type: Optional[Boolean]
The AdminEnabled parameter specifies that the EAC isn't able to be accessed through the Internet.
dsc_allowservicerestart
Data type: Optional[Boolean]
Whether it is OK to recycle the app pool after making changes. Defaults to $true.
dsc_basicauthentication
Data type: Optional[Boolean]
The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory.
dsc_digestauthentication
Data type: Optional[Boolean]
The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory.
dsc_domaincontroller
Data type: Optional[String]
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_extendedprotectionflags
Data type: Optional[Array[Enum['None', 'Proxy', 'NoServiceNameCheck', 'AllowDotlessSpn', 'ProxyCohosting']]]
Specifies custom settings for Extended Protection for Authentication on the virtual directory.
dsc_extendedprotectionspnlist
Data type: Optional[Array[String]]
Specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory.
dsc_extendedprotectiontokenchecking
Data type: Optional[Enum['None', 'Allow', 'Require']]
Defines how you want to use Extended Protection for Authentication on the virtual directory.
dsc_externalauthenticationmethods
Data type: Optional[Array[String]]
The ExternalAuthenticationMethods parameter specifies the authentication methods supported on the Exchange server from outside the firewall.
dsc_externalurl
Data type: Optional[String]
The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall.
dsc_formsauthentication
Data type: Optional[Boolean]
The FormsAuthentication parameter specifies whether forms-based authentication is enabled on the ECP virtual directory.
dsc_gziplevel
Data type: Optional[Enum['Off', 'Low', 'High', 'Error']]
The GzipLevel parameter sets Gzip configuration information for the ECP virtual directory.
dsc_internalurl
Data type: Optional[String]
The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall.
dsc_owaoptionsenabled
Data type: Optional[Boolean]
Specifies that Outlook on the web Options is enabled for end users.
dsc_windowsauthentication
Data type: Optional[Boolean]
The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory.
Parameters
The following parameters are available in the dsc_xexchecpvirtualdirectory
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange.
dsc_identity
namevar
Data type: String
The Identity of the ECP Virtual Directory.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexcheventloglevel
The DSC xExchEventLogLevel resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexcheventloglevel
type.
dsc_level
Data type: Enum['Lowest', 'Low', 'Medium', 'High', 'Expert']
The Level parameter specifies the log level for the specific event logging category.
Parameters
The following parameters are available in the dsc_xexcheventloglevel
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange
dsc_identity
namevar
Data type: String
The Identity parameter specifies the name of the event logging category for which you want to set the event logging level.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchexchangecertificate
The DSC xExchExchangeCertificate resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchexchangecertificate
type.
dsc_allowextraservices
Data type: Optional[Boolean]
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.
dsc_certfilepath
Data type: Optional[String]
The file path to the certificate .pfx file that should be imported.
dsc_domaincontroller
Data type: Optional[String]
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
Data type: Optional[Boolean]
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.
dsc_ensure
Data type: Enum['Present', 'Absent']
Whether the certificate should be present or not.
dsc_networkserviceallowed
Data type: Optional[Boolean]
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.
dsc_services
Data type: Optional[Array[String]]
The Services parameter specifies the Exchange services that the certificate is enabled for.
Parameters
The following parameters are available in the dsc_xexchexchangecertificate
type.
dsc_certcreds
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials containing the password to the .pfx file in CertFilePath.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_thumbprint
namevar
Data type: String
Thumbprint of the certificate to work on.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchexchangeserver
The DSC xExchExchangeServer resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchexchangeserver
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
Whether it is OK to restart the Information Store service after licensing the server. Defaults to $false.
dsc_customerfeedbackenabled
Data type: Optional[Boolean]
The CustomerFeedbackEnabled parameter specifies whether the Exchange server is enrolled in the Microsoft Customer Experience Improvement Program (CEIP). The CEIP collects anonymous information about how you use Exchange and problems that you might encounter. If you decide not to participate in the CEIP, the servers are opted-out automatically.
dsc_domaincontroller
Data type: Optional[String]
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_errorreportingenabled
Data type: Optional[Boolean]
The ErrorReportingEnabled parameter specifies whether error reporting is enabled.
dsc_internetwebproxy
Data type: Optional[String]
The InternetWebProxy parameter specifies the web proxy server that the Exchange server uses to reach the internet. A valid value for this parameter is the URL of the web proxy server.
dsc_internetwebproxybypasslist
Data type: Optional[Array[String]]
The InternetWebProxyBypassList parameter specifies a list of servers that bypass the web proxy server specified by the InternetWebProxy parameter. You identify the servers by their FQDN (for example, server01.contoso.com).
dsc_monitoringgroup
Data type: Optional[String]
The MonitoringGroup parameter specifies how to add your Exchange servers to monitoring groups. You can add your servers to an existing group or create a monitoring group based on location or deployment, or to partition monitoring responsibility among your servers.
dsc_productkey
Data type: Optional[String]
The ProductKey parameter specifies the server product key.
dsc_staticconfigdomaincontroller
Data type: Optional[String]
The StaticConfigDomainController parameter specifies whether to configure a domain controller to be used by the server via Directory Service Access (DSAccess).
dsc_staticdomaincontrollers
Data type: Optional[Array[String]]
The StaticDomainControllers parameter specifies whether to configure a list of domain controllers to be used by the server via DSAccess.
dsc_staticexcludeddomaincontrollers
Data type: Optional[Array[String]]
The StaticExcludedDomainControllers parameter specifies whether to exclude a list of domain controllers from being used by the server.
dsc_staticglobalcatalogs
Data type: Optional[Array[String]]
The StaticGlobalCatalogs parameter specifies whether to configure a list of global catalogs to be used by the server via DSAccess.
dsc_workloadmanagementpolicy
Data type: Optional[String]
The -ResourcePolicy, -WorkloadManagementPolicy and *-WorkloadPolicy system workload management cmdlets have been deprecated. System workload management settings should be customized only under the direction of Microsoft Customer Service and Support.
Parameters
The following parameters are available in the dsc_xexchexchangeserver
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange.
dsc_identity
namevar
Data type: String
The Identity parameter specifies the GUID, distinguished name (DN), or name of the server.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchfrontendtransportservice
The DSC xExchFrontendTransportService resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchfrontendtransportservice
type.
dsc_agentlogenabled
Data type: Optional[Boolean]
The AgentLogEnabled parameter specifies whether the agent log is enabled. The default value is $true.
dsc_agentlogmaxage
Data type: Optional[String]
The AgentLogMaxAge parameter specifies the maximum age for the agent log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days.
dsc_agentlogmaxdirectorysize
Data type: Optional[String]
The AgentLogMaxDirectorySize parameter specifies the maximum size of all agent logs in the agent log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 MB.
dsc_agentlogmaxfilesize
Data type: Optional[String]
The AgentLogMaxFileSize parameter specifies the maximum size of each agent log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB.
dsc_agentlogpath
Data type: Optional[String]
The AgentLogPath parameter specifies the default agent log directory location.
dsc_allowservicerestart
Data type: Optional[Boolean]
Whether it is OK to restart the MSExchangeFrontEndTransport service after making changes. Defaults to $false.
dsc_antispamagentsenabled
Data type: Optional[Boolean]
The AntispamAgentsEnabled parameter specifies whether anti-spam agents are installed on the server specified with the Identity parameter. The default value is $false for the Front End Transport service.
dsc_connectivitylogenabled
Data type: Optional[Boolean]
The ConnectivityLogEnabled parameter specifies whether the connectivity log is enabled. The default value is $true.
dsc_connectivitylogmaxage
Data type: Optional[String]
The ConnectivityLogMaxAge parameter specifies the maximum age for the connectivity log file. Log files older than the specified value are deleted. The default value is 30 days.
dsc_connectivitylogmaxdirectorysize
Data type: Optional[String]
The ConnectivityLogMaxDirectorySize parameter specifies the maximum size of all connectivity logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 1000 MB.
dsc_connectivitylogmaxfilesize
Data type: Optional[String]
The ConnectivityLogMaxFileSize parameter specifies the maximum size of each connectivity log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB.
dsc_connectivitylogpath
Data type: Optional[String]
The ConnectivityLogPath parameter specifies the default connectivity log directory location.
dsc_dnslogenabled
Data type: Optional[Boolean]
The DnsLogEnabled parameter specifies whether the DNS log is enabled. The default value is $false.
dsc_dnslogmaxage
Data type: Optional[String]
The DnsLogMaxAge parameter specifies the maximum age for the DNS log file. Log files older than the specified value are deleted. The default value is 7.00:00:00 or 7 days.
dsc_dnslogmaxdirectorysize
Data type: Optional[String]
The DnsLogMaxDirectorySize parameter specifies the maximum size of all DNS logs in the DNS log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 100 MB.
dsc_dnslogmaxfilesize
Data type: Optional[String]
The DnsLogMaxFileSize parameter specifies the maximum size of each DNS log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB.
dsc_dnslogpath
Data type: Optional[String]
The DnsLogPath parameter specifies the DNS log directory location. The default value is blank ($null), which indicates no location is configured. If you enable DNS logging, you need to specify a local file path for the DNS log files by using this parameter.
dsc_externaldnsadapterenabled
Data type: Optional[Boolean]
The ExternalDNSAdapterEnabled parameter specifies one or more Domain Name System (DNS) servers that Exchange uses for external DNS lookups.
dsc_externaldnsadapterguid
Data type: Optional[String]
The ExternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of destinations that exist outside the Exchange organization.
dsc_externaldnsprotocoloption
Data type: Optional[Enum['Any', 'UseTcpOnly', 'UseUdpOnly']]
The ExternalDNSProtocolOption parameter specifies which protocol to use when querying external DNS servers. The valid options for this parameter are Any, UseTcpOnly, and UseUdpOnly. The default value is Any.
dsc_externaldnsservers
Data type: Optional[Array[String]]
The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. You must separate IP addresses by using commas. The default value is an empty list ({}).
dsc_externalipaddress
Data type: Optional[String]
The ExternalIPAddress parameter specifies the IP address used in the Received message header field for every message that travels through the Front End Transport service.
dsc_internaldnsadapterenabled
Data type: Optional[Boolean]
The InternalDNSAdapterEnabled parameter specifies one or more DNS servers that Exchange uses for internal DNS lookups.
dsc_internaldnsadapterguid
Data type: Optional[String]
The InternalDNSAdapterGuid parameter specifies the network adapter that has the DNS settings used for DNS lookups of servers that exist inside the Exchange organization.
dsc_internaldnsprotocoloption
Data type: Optional[Enum['Any', 'UseTcpOnly', 'UseUdpOnly']]
The InternalDNSProtocolOption parameter specifies which protocol to use when you query internal DNS servers. Valid options for this parameter are Any, UseTcpOnly, or UseUdpOnly. The default value is Any.
dsc_internaldnsservers
Data type: Optional[Array[String]]
The InternalDNSServers parameter specifies the list of DNS servers that should be used when resolving a domain name. DNS servers are specified by IP address and are separated by commas. The default value is any empty list ({}).
dsc_intraorgconnectorprotocollogginglevel
Data type: Optional[Enum['None', 'Verbose']]
The IntraOrgConnectorProtocolLoggingLevel parameter enables or disables SMTP protocol logging on the implicit and invisible intra-organization Send connector in the Front End Transport service.
dsc_maxconnectionrateperminute
Data type: Optional[Integer[-2147483648, 2147483647]]
The MaxConnectionRatePerMinute parameter specifies the maximum rate that connections are allowed to be opened with the transport service.
dsc_receiveprotocollogmaxage
Data type: Optional[String]
The ReceiveProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Receive connectors in the Transport service on the server. Log files that are older than the specified value are automatically deleted.
dsc_receiveprotocollogmaxdirectorysize
Data type: Optional[String]
The ReceiveProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Receive connectors in the Front End Transport service on the server. When the maximum directory size is reached, the server deletes the oldest log files first.
dsc_receiveprotocollogmaxfilesize
Data type: Optional[String]
The ReceiveProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all Receive connectors in the Front End Transport service on the server. When a log file reaches its maximum file size, a new log file is created.
dsc_receiveprotocollogpath
Data type: Optional[String]
The ReceiveProtocolLogPath parameter specifies the location of the protocol log directory for all Receive connectors in the Front End Transport service on the server.
dsc_routingtablelogmaxage
Data type: Optional[String]
The RoutingTableLogMaxAge parameter specifies the maximum routing table log age. Log files older than the specified value are deleted. The default value is 7 days.
dsc_routingtablelogmaxdirectorysize
Data type: Optional[String]
The RoutingTableLogMaxDirectorySize parameter specifies the maximum size of the routing table log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The default value is 250 MB.
dsc_routingtablelogpath
Data type: Optional[String]
The RoutingTableLogPath parameter specifies the directory location where routing table log files should be stored.
dsc_sendprotocollogmaxage
Data type: Optional[String]
The SendProtocolLogMaxAge parameter specifies the maximum age of a protocol log file that's shared by all Send connectors in the Front End Transport service that have this server configured as a source server. Log files that are older than the specified value are deleted.
dsc_sendprotocollogmaxdirectorysize
Data type: Optional[String]
The SendProtocolLogMaxDirectorySize parameter specifies the maximum size of the protocol log directory that's shared by all Send connectors in the Front End Transport service that have this server configured as a source server. When the maximum directory size is reached, the server deletes the oldest log files first.
dsc_sendprotocollogmaxfilesize
Data type: Optional[String]
The SendProtocolLogMaxFileSize parameter specifies the maximum size of a protocol log file that's shared by all the Send connectors in the Front End Transport service that have this server configured as a source server. When a log file reaches its maximum file size, a new log file is created.
dsc_sendprotocollogpath
Data type: Optional[String]
The SendProtocolLogPath parameter specifies the location of the protocol log directory for all Send connectors in the Front End Transport service that have this server configured as a source server.
dsc_transientfailureretrycount
Data type: Optional[Integer[-2147483648, 2147483647]]
The TransientFailureRetryCount parameter specifies the maximum number of immediate connection retries attempted when the server encounters a connection failure with a remote server. The default value is 6. The valid input range for this parameter is from 0 through 15. When the value of this parameter is set to 0, the server doesn't immediately attempt to retry an unsuccessful connection.
dsc_transientfailureretryinterval
Data type: Optional[String]
The TransientFailureRetryInterval parameter controls the connection interval between each connection attempt specified by the TransientFailureRetryCount parameter. For the Front End Transport service, the default value of the TransientFailureRetryInterval parameter is 5 minutes.
Parameters
The following parameters are available in the dsc_xexchfrontendtransportservice
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange.
dsc_identity
namevar
Data type: String
Hostname of the server to configure.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchimapsettings
The DSC xExchImapSettings resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchimapsettings
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
Whether it is OK to restart the IMAP services after making changes. Defaults to $false.
dsc_domaincontroller
Data type: Optional[String]
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
Data type: Optional[Array[String]]
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
Data type: Optional[Enum['PlainTextLogin', 'PlainTextAuthentication', 'SecureLogin']]
The LoginType parameter specifies the authentication method for IMAP4 connections.
dsc_x509certificatename
Data type: Optional[String]
The X509CertificateName parameter specifies the certificate that's used for encrypting IMAP4 client connections.
Parameters
The following parameters are available in the dsc_xexchimapsettings
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_server
namevar
Data type: String
The IMAP server to configure.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchinstall
The DSC xExchInstall resource type. Automatically generated from version 1.28.0.0
Parameters
The following parameters are available in the dsc_xexchinstall
type.
dsc_arguments
namevar
Data type: String
Command line arguments to pass to setup.exe
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The credentials to use to perform the installation
dsc_path
namevar
Data type: String
Full path to setup.exe in the Exchange 2013 setup directory
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchjetstress
The DSC xExchJetstress resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchjetstress
type.
dsc_jetstressparams
Data type: String
Command line parameters to pass into JetstressCmd.exe
dsc_jetstresspath
Data type: String
The path to the folder where Jetstress is installed, and which contains JetstressCmd.exe
dsc_maxwaitminutes
Data type: Optional[Integer[0, 4294967295]]
The maximum amount of time that the Scheduled Task which runs Jetstress can execute for. Defaults to 0, which means there is no time limit.
dsc_minachievediops
Data type: Optional[Integer[0, 4294967295]]
The minimum value reported in the Achieved Transactional I/O per Second section of the Jetstress report for the run to be considered successful. Defaults to 0.
Parameters
The following parameters are available in the dsc_xexchjetstress
type.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_type
namevar
Data type: Enum['Performance', 'Stress', 'DatabaseBackup', 'SoftRecovery']
Specifies the Type which was defined in the JetstressConfig.xml file. Valid values are Performance, Stress, DatabaseBackup, or SoftRecovery. Defaults to Performance.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchjetstresscleanup
The DSC xExchJetstressCleanup resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchjetstresscleanup
type.
dsc_configfilepath
Data type: Optional[String]
Either ConfigFilePath, or DatabasePaths AND LogPaths MUST be specified. ConfigFilePath takes precedence. This is the full path to the JetstressConfig.xml file. If ConfigFilePath is specified, the config file will be used to determine the database and log folders that need to be removed
dsc_databasepaths
Data type: Optional[Array[String]]
Either ConfigFilePath, or DatabasePaths AND LogPaths MUST be specified. DatabasePaths specifies the paths to database directories that should be cleaned up.
dsc_deleteassociatedmountpoints
Data type: Optional[Boolean]
Defaults to $false. If specified, indicates that mount points associated with the Jetstress database and log paths should be removed
dsc_logpaths
Data type: Optional[Array[String]]
Either ConfigFilePath, or DatabasePaths AND LogPaths MUST be specified. LogPaths specifies the paths to log directories that should be cleaned up.
dsc_outputsavelocation
Data type: Optional[String]
If RemoveBinaries is set to $true and Jetstress output was saved to the default location (the installation path of Jetstress), specifies the folder path to copy the Jetstress output files to.
dsc_removebinaries
Data type: Optional[Boolean]
Specifies that the files in the Jetstress installation directory should be removed
Parameters
The following parameters are available in the dsc_xexchjetstresscleanup
type.
dsc_jetstresspath
namevar
Data type: String
The path to the folder where Jetstress is installed, and which contains JetstressCmd.exe
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchmailboxdatabase
The DSC xExchMailboxDatabase resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchmailboxdatabase
type.
dsc_adserversettingspreferredserver
Data type: Optional[String]
An optional domain controller to pass to Set-AdServerSettings -PreferredServer
dsc_allowfilerestore
Data type: Optional[Boolean]
The AllowFileRestore parameter specifies whether to allow a database to be restored from a backup.
dsc_allowservicerestart
Data type: Optional[Boolean]
Whether it is okay to restart the Information Store Service after adding a database. Defaults to $false.
dsc_autodagexcludefrommonitoring
Data type: Optional[Boolean]
The AutoDagExcludedFromMonitoringparameter specifies whether to exclude the mailbox database from the ServerOneCopyMonitor, which alerts an administrator when a replicated database has only one healthy copy available.
dsc_backgrounddatabasemaintenance
Data type: Optional[Boolean]
The BackgroundDatabaseMaintenance parameter specifies whether the Extensible Storage Engine (ESE) performs database maintenance.
dsc_calendarloggingquota
Data type: Optional[String]
The CalendarLoggingQuota parameter specifies the maximum size of the log in the Recoverable Items folder of the mailbox that stores changes to calendar items.
dsc_circularloggingenabled
Data type: Optional[Boolean]
The CircularLoggingEnabled parameter specifies whether circular logging is enabled for the database.
dsc_databasecopycount
Data type: Integer[0, 4294967295]
The number of copies that the database will have once fully configured
dsc_datamovereplicationconstraint
Data type: Optional[Enum['None', 'SecondCopy', 'SecondDatacenter', 'AllDatacenters', 'AllCopies']]
The DataMoveReplicationConstraint parameter specifies the throttling behavior for high availability mailbox moves.
dsc_deleteditemretention
Data type: Optional[String]
The DeletedItemRetention parameter specifies the length of time to keep deleted items in the Recoverable Items\Deletions folder in mailboxes.
dsc_domaincontroller
Data type: Optional[String]
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_edbfilepath
Data type: String
The EdbFilePath parameter specifies the path to the database files.
dsc_eventhistoryretentionperiod
Data type: Optional[String]
The EventHistoryRetentionPeriod parameter specifies the length of time to keep event data.
dsc_indexenabled
Data type: Optional[Boolean]
The IndexEnabled parameter specifies whether Exchange Search indexes the mailbox database.
dsc_isexcludedfromprovisioning
Data type: Optional[Boolean]
The IsExcludedFromProvisioning parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases.
dsc_isexcludedfromprovisioningbyoperator
Data type: Optional[Boolean]
The IIsExcludedFromProvisioningByOperator parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases.
dsc_isexcludedfromprovisioningduetologicalcorruption
Data type: Optional[Boolean]
The IsExcludedFromProvisioningDueToLogicalCorruption parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases.
dsc_isexcludedfromprovisioningreason
Data type: Optional[String]
The IsExcludedFromProvisioningReason parameter specifies the reason why you excluded the mailbox database from the mailbox provisioning load balancer.
dsc_issuewarningquota
Data type: Optional[String]
The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox.
dsc_issuspendedfromprovisioning
Data type: Optional[Boolean]
The IsSuspendedFromProvisioning parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases.
dsc_journalrecipient
Data type: Optional[String]
The JournalRecipient parameter specifies the journal recipient to use for per-database journaling for all mailboxes on the database.
dsc_logfolderpath
Data type: String
The LogFolderPath parameter specifies the folder location for log files.
dsc_mailboxretention
Data type: Optional[String]
The MailboxRetention parameter specifies the length of time to keep deleted mailboxes before they are permanently deleted or purged.
dsc_metacachedatabasemaxcapacityinbytes
Data type: Optional[Integer[-9223372036854775808, 9223372036854775807]]
The MetaCacheDatabaseMaxCapacityInBytes parameter specifies the size of the metacache database in bytes. To convert gigabytes to bytes, multiply the value by 1024^3. For terabytes to bytes, multiply by 1024^4.
dsc_mountatstartup
Data type: Optional[Boolean]
The MountAtStartup parameter specifies whether to mount the mailbox database when the Microsoft Exchange Information Store service starts.
dsc_offlineaddressbook
Data type: Optional[String]
The OfflineAddressBook parameter specifies the offline address book that's associated with the mailbox database.
dsc_prohibitsendquota
Data type: Optional[String]
The ProhibitSendQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send new messages, and the user receives a descriptive warning message.
dsc_prohibitsendreceivequota
Data type: Optional[String]
The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox.
dsc_recoverableitemsquota
Data type: Optional[String]
The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder of the mailbox.
dsc_recoverableitemswarningquota
Data type: Optional[String]
The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for the mailbox.
dsc_retaindeleteditemsuntilbackup
Data type: Optional[Boolean]
The RetainDeletedItemsUntilBackup parameter specifies whether to keep items in the Recoverable Items\Deletions folder of the mailbox until the next database backup occurs.
dsc_server
Data type: String
The Server parameter specifies the server on which you want to create the database.
dsc_skipinitialdatabasemount
Data type: Optional[Boolean]
Whether the initial mount of databases should be skipped after database creation
Parameters
The following parameters are available in the dsc_xexchmailboxdatabase
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange
dsc_name
namevar
Data type: String
The Name parameter specifies the unique name of the mailbox database.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchmailboxdatabasecopy
The DSC xExchMailboxDatabaseCopy resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchmailboxdatabasecopy
type.
dsc_activationpreference
Data type: Optional[Integer[0, 4294967295]]
The ActivationPreference parameter value is used as part of Active Managers best copy selection process and to redistribute active mailbox databases throughout the database availability group (DAG) when using the RedistributeActiveDatabases.ps1 script.
dsc_adserversettingspreferredserver
Data type: Optional[String]
An optional domain controller to pass to Set-AdServerSettings -PreferredServer.
dsc_allowservicerestart
Data type: Optional[Boolean]
Whether it is OK to restart Information Store after adding copy.
dsc_domaincontroller
Data type: Optional[String]
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_mailboxserver
Data type: String
The MailboxServer parameter specifies the name of the server that will host the database copy.
dsc_replaylagmaxdelay
Data type: Optional[String]
The ReplayLagMaxDelay parameter specifies the maximum delay for lagged database copy play down.
dsc_replaylagtime
Data type: Optional[String]
The ReplayLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service should wait before replaying log files that have been copied to the passive database copy.
dsc_seedingpostponed
Data type: Optional[Boolean]
The SeedingPostponed switch specifies that the task doesn't seed the database copy, so you need to explicitly seed the database copy.
dsc_truncationlagtime
Data type: Optional[String]
The TruncationLagTime parameter specifies the amount of time that the Microsoft Exchange Replication service should wait before truncating log files that have replayed into the passive copy of the database.
Parameters
The following parameters are available in the dsc_xexchmailboxdatabasecopy
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange
dsc_identity
namevar
Data type: String
The Identity parameter specifies the name of the database whose copy is being modified.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchmailboxserver
The DSC xExchMailboxServer resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchmailboxserver
type.
dsc_autodatabasemountdial
Data type: Optional[Enum['BestAvailability', 'GoodAvailability', 'Lossless']]
The AutoDatabaseMountDial parameter specifies the automatic database mount behavior for a continuous replication environment after a database failover.
dsc_calendarrepairintervalendwindow
Data type: Optional[Integer[-2147483648, 2147483647]]
The CalendarRepairIntervalEndWindow parameter specifies the number of days into the future to repair calendars. For example, if this parameter is set to 90, the Calendar Repair Assistant repairs calendars on this Mailbox server 90 days from now.
dsc_calendarrepairlogdirectorysizelimit
Data type: Optional[String]
The CalendarRepairLogDirectorySizeLimit parameter specifies the size limit for all log files for the Calendar Repair Assistant. After the limit is reached, the oldest files are deleted.
dsc_calendarrepairlogenabled
Data type: Optional[Boolean]
The CalendarRepairLogEnabled parameter specifies whether the Calendar Repair Attendant logs items that it repairs. The repair log doesn't contain failed repair attempts.
dsc_calendarrepairlogfileagelimit
Data type: Optional[String]
The CalendarRepairLogFileAgeLimit parameter specifies how long to retain calendar repair logs. Log files that exceed the maximum retention period are deleted.
dsc_calendarrepairlogpath
Data type: Optional[String]
The CalendarRepairLogPath parameter specifies the location of the calendar repair log files on the Mailbox server.
dsc_calendarrepairlogsubjectloggingenabled
Data type: Optional[Boolean]
The CalendarRepairLogSubjectLoggingEnabled parameter specifies that the subject of the repaired calendar item is logged in the calendar repair log.
dsc_calendarrepairmissingitemfixdisabled
Data type: Optional[Boolean]
The CalendarRepairMissingItemFixDisabled parameter specifies that the Calendar Repair Assistant won't fix missing attendee calendar items for mailboxes homed on this Mailbox server.
dsc_calendarrepairmode
Data type: Optional[Enum['ValidateOnly', 'RepairAndValidate']]
The CalendarRepairMode parameter specifies the mode that the Calendar Repair Assistant will run in.
dsc_calendarrepairworkcycle
Data type: Optional[String]
The CalendarRepairWorkCycle parameter specifies the time span in which all mailboxes on the specified server will be scanned by the Calendar Repair Assistant. Calendars that have inconsistencies will be flagged and repaired according to the interval specified by the CalendarRepairWorkCycleCheckpoint parameter.
dsc_calendarrepairworkcyclecheckpoint
Data type: Optional[String]
The CalendarRepairWorkCycleCheckpoint parameter specifies the time span at which all mailboxes will be identified as needing work completed on them.
dsc_databasecopyactivationdisabledandmovenow
Data type: Optional[Boolean]
The DatabaseCopyActivationDisabledAndMoveNow parameter specifies whether to prevent databases from being mounted on this Mailbox server if there are other healthy copies of the databases on other Mailbox servers. It will also immediately move any mounted databases on the server to other servers if copies exist and are healthy.
dsc_databasecopyautoactivationpolicy
Data type: Optional[Enum['Blocked', 'IntrasiteOnly', 'Unrestricted']]
The DatabaseCopyAutoActivationPolicy parameter specifies the type of automatic activation available for mailbox database copies on the specified Mailbox server. Valid values are Blocked, IntrasiteOnly, and Unrestricted.
dsc_domaincontroller
Data type: Optional[String]
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
dsc_folderlogformanagedfoldersenabled
Data type: Optional[Boolean]
The FolderLogForManagedFoldersEnabled parameter specifies whether the folder log for managed folders is enabled for messages that were moved to managed folders.
dsc_forcegroupmetricsgeneration
Data type: Optional[Boolean]
The ForceGroupMetricsGeneration parameter specifies that group metrics information must be generated on the Mailbox server regardless of whether that server generates an offline address book (OAB). By default, group metrics are generated only on servers that generate OABs. Group metrics information is used by MailTips to inform senders about how many recipients their messages will be sent to. You need to use this parameter if your organization doesn't generate OABs and you want the group metrics data to be available.
dsc_isexcludedfromprovisioning
Data type: Optional[Boolean]
The IsExcludedFromProvisioning parameter specifies that the Mailbox server isn't considered by the OAB provisioning load balancer. If the IsExcludedFromProvisioning parameter is set to $true, the server won't be used for provisioning a new OAB or for moving existing OABs.
dsc_journalinglogformanagedfoldersenabled
Data type: Optional[Boolean]
The JournalingLogForManagedFoldersEnabled parameter specifies whether the log for managed folders is enabled for journaling. The two possible values for this parameter are $true or $false. If you specify $true, information about messages that were journaled is logged. The logs are located at the location you specify with the LogPathForManagedFolders parameter.
dsc_locale
Data type: Optional[Array[String]]
The Locale parameter specifies the locale. A locale is a collection of language-related user preferences such as writing system, calendar, and date format.
dsc_logdirectorysizelimitformanagedfolders
Data type: Optional[String]
The LogDirectorySizeLimitForManagedFolders parameter specifies the size limit for all managed folder log files from a single message database. After the limit is reached for a set of managed folder log files from a message database, the oldest files are deleted to make space for new files.
dsc_logfileagelimitformanagedfolders
Data type: Optional[String]
The LogFileAgeLimitForManagedFolders parameter specifies how long to retain managed folder logs. Log files that exceed the maximum retention period are deleted.
dsc_logfilesizelimitformanagedfolders
Data type: Optional[String]
The LogFileSizeLimitForManagedFolders parameter specifies the maximum size for each managed folder log file. When the log file size limit is reached, a new log file is created.
dsc_logpathformanagedfolders
Data type: Optional[String]
The LogPathForManagedFolders parameter specifies the path to the directory that stores the managed folder log files.
dsc_mailboxprocessorworkcycle
Data type: Optional[String]
The MailboxProcessorWorkCycle parameter specifies how often to scan for locked mailboxes.
dsc_managedfolderassistantschedule
Data type: Optional[Array[String]]
The ManagedFolderAssistantSchedule parameter specifies the intervals each week during which the Managed Folder Assistant applies messaging records management (MRM) settings to managed folders. The format is StartDay.Time-EndDay.
dsc_managedfolderworkcycle
Data type: Optional[String]
The ManagedFolderWorkCycle parameter specifies the time span in which all mailboxes on the specified server will be processed by the Managed Folder Assistant. The Managed Folder Assistant applies retention policies according to the ManagedFolderWorkCycleCheckpoint interval.
dsc_managedfolderworkcyclecheckpoint
Data type: Optional[String]
The ManagedFolderWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes so that new mailboxes that have been created or moved will be part of the work queue. Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.
dsc_mapiencryptionrequired
Data type: Optional[Boolean]
The MAPIEncryptionRequired parameter specifies whether Exchange blocks MAPI clients that don't use encrypted remote procedure calls (RPCs).
dsc_maximumactivedatabases
Data type: Optional[String]
The MaximumActiveDatabases parameter specifies the number of databases that can be mounted on this Mailbox server. This parameter accepts numeric values.
dsc_maximumpreferredactivedatabases
Data type: Optional[String]
The MaximumPreferredActiveDatabases parameter specifies a preferred maximum number of databases that a server should have. This value is different from the actual maximum, which is configured using the MaximumActiveDatabases parameter. The value of MaximumPreferredActiveDatabases is only honored during best copy and server selection, database and server switchovers, and when rebalancing the DAG.
dsc_oabgeneratorworkcycle
Data type: Optional[String]
The OABGeneratorWorkCycle parameter specifies the time span in which the OAB generation on the specified server will be processed.
dsc_oabgeneratorworkcyclecheckpoint
Data type: Optional[String]
The OABGeneratorWorkCycleCheckpoint parameter specifies the time span at which to run OAB generation.
dsc_publicfolderworkcycle
Data type: Optional[String]
The PublicFolderWorkCycle parameter is used by the public folder assistant to determine how often the mailboxes in a database are processed by the assistant.
dsc_publicfolderworkcyclecheckpoint
Data type: Optional[String]
The PublicFolderWorkCycleCheckpoint determines how often the mailbox list for a database is evaluated. The processing speed is also calculated.
dsc_retentionlogformanagedfoldersenabled
Data type: Optional[Boolean]
The RetentionLogForManagedFoldersEnabled parameter specifies whether the Managed Folder Assistant logs information about messages that have reached their retention limits.
dsc_sharingpolicyschedule
Data type: Optional[Array[String]]
The SharingPolicySchedule parameter specifies the intervals each week during which the sharing policy runs. The Sharing Policy Assistant checks permissions on shared calendar items and contact folders in users' mailboxes against the assigned sharing policy. The assistant lowers or removes permissions according to the policy. The format is StartDay.Time-EndDay.Time.
dsc_sharingpolicyworkcycle
Data type: Optional[String]
The SharingPolicyWorkCycle parameter specifies the time span in which all mailboxes on the specified server will be scanned by the Sharing Policy Assistant. The Sharing Policy Assistant scans all mailboxes and enables or disables sharing polices according to the interval specified by the SharingPolicyWorkCycle.
dsc_sharingpolicyworkcyclecheckpoint
Data type: Optional[String]
The SharingPolicyWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes so that new mailboxes that have been created or moved will be part of the work queue. Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.
dsc_sharingsyncworkcycle
Data type: Optional[String]
The SharingSyncWorkCycle parameter specifies the time span in which all mailboxes on the specified server will be synced to the cloud-based service by the Sharing Sync Assistant. Mailboxes that require syncing will be synced according to the interval specified by the SharingSyncWorkCycleCheckpoint parameter.
dsc_sharingsyncworkcyclecheckpoint
Data type: Optional[String]
The SharingSyncWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes so that new mailboxes that have been created or moved will be part of the work queue. Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.
dsc_sitemailboxworkcycle
Data type: Optional[String]
The SiteMailboxWorkCycle parameter specifies the time span in which the site mailbox information on the specified server will be processed.
dsc_sitemailboxworkcyclecheckpoint
Data type: Optional[String]
The SiteMailboxWorkCycleCheckpoint parameter specifies the time span at which to refresh the site mailbox workcycle.
dsc_subjectlogformanagedfoldersenabled
Data type: Optional[Boolean]
The SubjectLogForManagedFoldersEnabled parameter specifies whether the subject of messages is displayed in managed folder logs.
dsc_topnworkcycle
Data type: Optional[String]
The TopNWorkCycle parameter specifies the time span in which all mailboxes that have Unified Messaging on the specified server will be scanned by the TopN Words Assistant. The TopN Words Assistant scans voice mail for the most frequently used words to aid in transcription.
dsc_topnworkcyclecheckpoint
Data type: Optional[String]
The TopNWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes so that new mailboxes that have been created or moved will be part of the work queue. Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.
dsc_umreportingworkcycle
Data type: Optional[String]
The UMReportingWorkCycle parameter specifies the time span in which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} on the specified server will be scanned by the Unified Messaging Reporting Assistant. The Unified Messaging Reporting Assistant updates the Call Statistics reports by reading Unified Messaging call data records for an organization on a regular basis.
dsc_umreportingworkcyclecheckpoint
Data type: Optional[String]
The UMReportingWorkCycleCheckpoint parameter specifies the time span at which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} will be marked by processing.
dsc_wacdiscoveryendpoint
Data type: Optional[String]
The WacDiscoveryEndpoint parameter specifies the Office Online Server endpoint to use. Exchange 2016 only.
Parameters
The following parameters are available in the dsc_xexchmailboxserver
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange
dsc_identity
namevar
Data type: String
The Identity parameter specifies the Mailbox server that you want to modify.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchmailboxtransportservice
The DSC xExchMailboxTransportService resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchmailboxtransportservice
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_connectivitylogenabled
Data type: Optional[Boolean]
dsc_connectivitylogmaxage
Data type: Optional[String]
dsc_connectivitylogmaxdirectorysize
Data type: Optional[String]
dsc_connectivitylogmaxfilesize
Data type: Optional[String]
dsc_connectivitylogpath
Data type: Optional[String]
dsc_contentconversiontracingenabled
Data type: Optional[Boolean]
dsc_maxconcurrentmailboxdeliveries
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_maxconcurrentmailboxsubmissions
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_pipelinetracingenabled
Data type: Optional[Boolean]
dsc_pipelinetracingpath
Data type: Optional[String]
dsc_pipelinetracingsenderaddress
Data type: Optional[String]
dsc_receiveprotocollogmaxage
Data type: Optional[String]
dsc_receiveprotocollogmaxdirectorysize
Data type: Optional[String]
dsc_receiveprotocollogmaxfilesize
Data type: Optional[String]
dsc_receiveprotocollogpath
Data type: Optional[String]
dsc_routingtablelogmaxage
Data type: Optional[String]
dsc_routingtablelogmaxdirectorysize
Data type: Optional[String]
dsc_routingtablelogpath
Data type: Optional[String]
dsc_sendprotocollogmaxage
Data type: Optional[String]
dsc_sendprotocollogmaxdirectorysize
Data type: Optional[String]
dsc_sendprotocollogmaxfilesize
Data type: Optional[String]
dsc_sendprotocollogpath
Data type: Optional[String]
Parameters
The following parameters are available in the dsc_xexchmailboxtransportservice
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_identity
namevar
Data type: String
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchmaintenancemode
The DSC xExchMaintenanceMode resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchmaintenancemode
type.
dsc_additionalcomponentstoactivate
Data type: Optional[Array[String]]
When taking a server out of Maintenance Mode, the following components will be set to Active by default: ServerWideOffline, UMCallRouter, HighAvailability, Monitoring, RecoveryActionsEnabled. This parameter specifies an additional list of components to set to Active.
dsc_domaincontroller
Data type: Optional[String]
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
dsc_mountdialoverride
Data type: Optional[Enum['None', 'Lossless', 'GoodAvailability', 'BestAvailability', 'BestEffort']]
Used when moving databases back to the server after taking the server out of maintenance mode. The MountDialOverride parameter is used to override the auto database mount dial (AutoDatabaseMountDial) setting for the target server and specify an alternate setting. Defaults to None.
dsc_movepreferreddatabasesback
Data type: Optional[Boolean]
Whether to move back databases with an Activation Preference of one for this server after taking the server out of Maintenance Mode. Defaults to False.
dsc_setinactivecomponentsfromanyrequestertoactive
Data type: Optional[Boolean]
Whether components that were set to Inactive by outside Requesters should also be set to Active when exiting Maintenance Mode. Defaults to False.
dsc_skipactivecopychecks
Data type: Optional[Boolean]
Used when moving databases back to the server after taking the server out of maintenance mode. The SkipActiveCopyChecks switch specifies whether to skip checking the current active copy to see if it's currently a seeding source for any passive databases. Defaults to False.
dsc_skipallchecks
Data type: Optional[Boolean]
Exchange 2016 Only. Used when moving databases back to the server after taking the server out of maintenance mode. The SkipAllChecks switch specifies whether to skip all checks. This switch is equivalent to specifying all of the individual skip parameters that are available on this cmdlet. Defaults to False.
dsc_skipclientexperiencechecks
Data type: Optional[Boolean]
Used when moving databases back to the server after taking the server out of maintenance mode. The SkipClientExperienceChecks switch specifies whether to skip the search catalog (content index) state check to see if the search catalog is healthy and up to date. Defaults to False.
dsc_skipcpuchecks
Data type: Optional[Boolean]
Exchange 2016 Only. Used when moving databases back to the server after taking the server out of maintenance mode. The SkipCpuChecks switch specifies whether to skip the high CPU utilization checks. Defaults to False.
dsc_skiphealthchecks
Data type: Optional[Boolean]
Used when moving databases back to the server after taking the server out of maintenance mode. The SkipHealthChecks switch specifies whether to bypass passive copy health checks. Defaults to False.
dsc_skiplagchecks
Data type: Optional[Boolean]
Used when moving databases back to the server after taking the server out of maintenance mode. The SkipLagChecks switch specifies whether to allow a copy to be activated that has replay and copy queues outside of the configured criteria. Defaults to False.
dsc_skipmaximumactivedatabaseschecks
Data type: Optional[Boolean]
Used when moving databases back to the server after taking the server out of maintenance mode. The SkipMaximumActiveDatabasesChecks switch specifies whether to skip checking the value of MaximumPreferredActiveDatabases during the best copy and server selection (BCSS) process. Defaults to False.
dsc_skipmovesuppressionchecks
Data type: Optional[Boolean]
Exchange 2016 Only. Used when moving databases back to the server after taking the server out of maintenance mode. The SkipMoveSuppressionChecks switch specifies whether to skip the move suppression checks. Defaults to False.
dsc_upgradedserverversion
Data type: Optional[String]
Optional string to specify what the server version will be after applying a Cumulative Update. If the server is already at this version, requests to put the server in Maintenance Mode will be ignored. Version should be in the format ##.#.####.#, as in 15.0.1104.5.
Parameters
The following parameters are available in the dsc_xexchmaintenancemode
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to establish a remote PowerShell session to Exchange
dsc_enabled
namevar
Data type: Boolean
Whether the server should be put into Maintenance Mode. When Enabled is set to True, the server will be put in Maintenance Mode. If False, the server will be taken out of Maintenance Mode.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchmapivirtualdirectory
The DSC xExchMapiVirtualDirectory resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchmapivirtualdirectory
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_externalurl
Data type: Optional[String]
dsc_iisauthenticationmethods
Data type: Array[String]
dsc_internalurl
Data type: Optional[String]
Parameters
The following parameters are available in the dsc_xexchmapivirtualdirectory
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_identity
namevar
Data type: String
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchoabvirtualdirectory
The DSC xExchOabVirtualDirectory resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchoabvirtualdirectory
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_basicauthentication
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_extendedprotectionflags
Data type: Optional[Array[String]]
dsc_extendedprotectionspnlist
Data type: Optional[Array[String]]
dsc_extendedprotectiontokenchecking
Data type: Optional[Enum['None', 'Allow', 'Require']]
dsc_externalurl
Data type: Optional[String]
dsc_internalurl
Data type: Optional[String]
dsc_oabstodistribute
Data type: Optional[Array[String]]
dsc_oauthauthentication
Data type: Optional[Boolean]
dsc_pollinterval
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_requiressl
Data type: Optional[Boolean]
dsc_windowsauthentication
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchoabvirtualdirectory
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_identity
namevar
Data type: String
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchoutlookanywhere
The DSC xExchOutlookAnywhere resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchoutlookanywhere
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_extendedprotectionflags
Data type: Optional[Array[String]]
dsc_extendedprotectionspnlist
Data type: Optional[Array[String]]
dsc_extendedprotectiontokenchecking
Data type: Optional[Enum['Allow', 'None', 'Require']]
dsc_externalclientauthenticationmethod
Data type: Optional[Enum['Ntlm', 'Basic', 'Negotiate']]
dsc_externalclientsrequiressl
Data type: Optional[Boolean]
dsc_externalhostname
Data type: Optional[String]
dsc_iisauthenticationmethods
Data type: Optional[Array[String]]
dsc_internalclientauthenticationmethod
Data type: Optional[Enum['Ntlm', 'Basic', 'Negotiate']]
dsc_internalclientsrequiressl
Data type: Optional[Boolean]
dsc_internalhostname
Data type: Optional[String]
dsc_ssloffloading
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchoutlookanywhere
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_identity
namevar
Data type: String
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchowavirtualdirectory
The DSC xExchOwaVirtualDirectory resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchowavirtualdirectory
type.
dsc_actionforunknownfileandmimetypes
Data type: Optional[Enum['Allow', 'ForceSave', 'Block']]
dsc_adfsauthentication
Data type: Optional[Boolean]
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_basicauthentication
Data type: Optional[Boolean]
dsc_changepasswordenabled
Data type: Optional[Boolean]
dsc_defaultdomain
Data type: Optional[String]
dsc_digestauthentication
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_externalauthenticationmethods
Data type: Optional[Array[String]]
dsc_externalurl
Data type: Optional[String]
dsc_formsauthentication
Data type: Optional[Boolean]
dsc_gziplevel
Data type: Optional[Enum['Off', 'Low', 'High', 'Error']]
dsc_instantmessagingcertificatethumbprint
Data type: Optional[String]
dsc_instantmessagingenabled
Data type: Optional[Boolean]
dsc_instantmessagingservername
Data type: Optional[String]
dsc_instantmessagingtype
Data type: Optional[Enum['None', 'Ocs']]
dsc_internalurl
Data type: Optional[String]
dsc_logonformat
Data type: Optional[Enum['FullDomain', 'UserName', 'PrincipalName']]
dsc_logonpagelightselectionenabled
Data type: Optional[Boolean]
dsc_logonpagepublicprivateselectionenabled
Data type: Optional[Boolean]
dsc_uncaccessonprivatecomputersenabled
Data type: Optional[Boolean]
dsc_uncaccessonpubliccomputersenabled
Data type: Optional[Boolean]
dsc_windowsauthentication
Data type: Optional[Boolean]
dsc_wssaccessonprivatecomputersenabled
Data type: Optional[Boolean]
dsc_wssaccessonpubliccomputersenabled
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchowavirtualdirectory
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_identity
namevar
Data type: String
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchpopsettings
The DSC xExchPopSettings resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchpopsettings
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_externalconnectionsettings
Data type: Optional[Array[String]]
dsc_logintype
Data type: Optional[Enum['PlainTextLogin', 'PlainTextAuthentication', 'SecureLogin']]
dsc_x509certificatename
Data type: Optional[String]
Parameters
The following parameters are available in the dsc_xexchpopsettings
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_server
namevar
Data type: String
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchpowershellvirtualdirectory
The DSC xExchPowerShellVirtualDirectory resource type. Automatically generated from version 1.28.0.0
Properties
The following properties are available in the dsc_xexchpowershellvirtualdirectory
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_basicauthentication
Data type: Optional[Boolean]
dsc_certificateauthentication
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_externalurl
Data type: Optional[String]
dsc_internalurl
Data type: Optional[String]
dsc_requiressl
Data type: Optional[Boolean]
dsc_windowsauthentication
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchpowershellvirtualdirectory
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_identity
namevar
Data type: String
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchreceiveconnector
The DSC xExchReceiveConnector resource type. Automatically generated from version 1.28.0.0
Properties
Change log for xExchange
Unreleased
1.28.0.0
- Added MSFT_xExchFrontendTransportService resource, based on MSFT_xExchTransportService resource. Issue #283
- Added unit and integration tests to the MSFT_xExchFrontendTransportService resource.
- Added comment based help to the MSFT_xExchFrontendTransportService resource.
- Minor style fix in MSFT_xExchEcpVirtualDirectory to ensure new PowerShell Script Analyzer custom rules pass.
1.27.0.0
- Added additional parameters to the MSFT_xExchTransportService resource
- Added additional parameters to the MSFT_xExchEcpVirtualDirectory resource
- Added additional unit tests to the MSFT_xExchAutodiscoverVirutalDirectory resource
- Added additional parameters to the MSFT_xExchExchangeCertificate resource
- MSFT_xExchMailboxDatabase: Fixes issue with DataMoveReplicationConstraint parameter (#401)
- Added additional parameters and comment based help to the MSFT_xExchMailboxDatabase resource
- Move code that sets $global:DSCMachineStatus into a dedicated helper function. Issue #407
- Add missing parameters for xExchMailboxDatabaseCopy, adds comment based help, and adds remaining Unit tests.
1.26.0.0
- Add support for Exchange Server 2019
- Added additional parameters to the MSFT_xExchUMService resource
- Rename improperly named functions, and add comment based help in MSFT_xExchClientAccessServer, MSFT_xExchDatabaseAvailabilityGroupNetwork, MSFT_xExchEcpVirtualDirectory, MSFT_xExchExchangeCertificate, MSFT_xExchImapSettings.
- Added additional parameters to the MSFT_xExchUMCallRouterSettings resource
- Rename improper function names in MSFT_xExchDatabaseAvailabilityGroup, MSFT_xExchJetstress, MSFT_xExchJetstressCleanup, MSFT_xExchMailboxDatabase, MSFT_xExchMailboxDatabaseCopy, MSFT_xExchMailboxServer, MSFT_xExchMaintenanceMode, MSFT_xExchMapiVirtualDirectory, MSFT_xExchOabVirtualDirectory, MSFT_xExchOutlookAnywhere, MSFT_xExchOwaVirtualDirectory, MSFT_xExchPopSettings, MSFT_xExchPowershellVirtualDirectory, MSFT_xExchReceiveConnector, MSFT_xExchWaitForMailboxDatabase, and MSFT_xExchWebServicesVirtualDirectory.
- Add remaining unit and integration tests for MSFT_xExchExchangeServer.
1.25.0.0
- Opt-in for the common test flagged Script Analyzer rules (issue #234).
- Opt-in for the common test testing for relative path length.
- Removed the property
PSDscAllowPlainTextPassword
from all examples so the examples are secure by default. The propertyPSDscAllowPlainTextPassword
was previously needed to (test) compile the examples in the CI pipeline, but now the CI pipeline is using a certificate to compile the examples. - Opt-in for the common test that validates the markdown links.
- Fix typo of the word 'Certificate' in several example files.
- Add spaces between array members.
- Add initial set of Unit Tests (mostly Get-TargetResource tests) for all remaining resource files.
- Add WaitForComputerObject parameter to xExchWaitForDAG
- Add spaces between comment hashtags and comments.
- Add space between variable types and variables.
- Fixes issue where xExchMailboxDatabase fails to test for a Journal Recipient because the module did not load the Get-Recipient cmdlet (#335).
- Fixes broken Integration tests in MSFT_xExchMaintenanceMode.Integration.Tests.ps1 (#336).
- Fix issue where Get-ReceiveConnector against an Absent connector causes an error to be logged in the MSExchange Management log.
- Rename poorly named functions in xExchangeDiskPart.psm1 and MSFT_xExchAutoMountPoint.psm1, and add comment based help.
1.24.0.0
- xExchangeHelper.psm1: Renamed common functions to use proper Verb-Noun format. Also addresses many common style issues in functions in the file, as well as in calls to these functions from other files.
- MSFT_xExchTransportService: Removed functions that were duplicates of helper functions in xExchangeHelper.psm1.
- Fixes an issue where only objects of type Mailbox can be specified as a Journal Recipient. Now MailUser and MailContact types can be used as well.
- Update appveyor.yml to use the default template.
- Added default template files .codecov.yml, .gitattributes, and .gitignore, and .vscode folder.
- Add Unit Tests for xExchAntiMalwareScanning
- Add remaining Unit Tests for xExchInstall, and for most common setup functions
- Added ActionForUnknownFileAndMIMETypes,WSSAccessOnPublicComputersEnabled, WSSAccessOnPrivateComputersEnabled,UNCAccessOnPublicComputersEnabled UNCAccessOnPrivateComputersEnabled and GzipLevel to xExchOwaVirtualDirectory.
- Added GzipLevel and AdminEnabled to xExchEcpVirtualDirectory.
- Added OAuthAuthentication to xExchOabVirtualDirectory.
- Updated readme with the new parameters and removed a bad parameter from xExchOwaVirtualDirectory that did not actually exist.
- Updated .gitattributes to allow test .pfx files to be saved as binary
- Added Cumulative Update / Exchange update support to xExchInstall resource.
- Add remaining Unit Tests for all xExchangeHelper functions that don't require the loading of Exchange DLL's.
- Renamed and moved file Examples/HelperScripts/ExchangeConfigHelper.psm1 to Modules/xExchangeCalculatorHelper.psm1. Renamed functions within the module to conform to proper function naming standards. Added remaining Unit tests for module.
1.23.0.0
- Fixes issue with xExchMaintenanceMode on Exchange 2016 where the cluster does not get paused when going into maintenance mode. Also fixes issue where services fail to stop, start, pause, or resume.
- Explicitly cast member types in Get-DscConfiguration return hashtables to align with the types defined in the resource schemas. Fixes an issue where Get-DscConfiguration fails to return a value.
- xExchClientAccessServer: Fixes issue where AlternateServiceAccountConfiguration or RemoveAlternateServiceAccountCredentials parameters can't be used at the same time as other optional parameters.
- xExchInstall: Fixes issue where Test-TargetResource returns true if setup is running. Fixes issue where setup is not detected as having been successfully completed even if setup was successful. Adds initial set of unit tests for xExchInstall and related functions.
- Remove VerbosePreference from function parameters and update all calls to changed functions.
- Fixes multiple PSScriptAnalyzer issues. Specifically, fixes all instances of PSAvoidTrailingWhitespace, PSAvoidGlobalVars, PSAvoidUsingConvertToSecureStringWithPlainText, PSUseSingularNouns, and fixes many instances of PSUseDeclaredVarsMoreThanAssignments.
- Add support for Exchange Server 2019 - Preview
1.22.0.0
- Fixed issue in xExchInstall where winrm config command fails to execute
- Fixed issue in xExchInstall where a failed Exchange setup run is not reported, and subsequent DSC resources are allowed to run
- Fixed issue in xExchAutoMountPoint where Test-TargetResource fails after mount points have been successfully configured.
- Fixed issue in xExchAutoMountPoint where Set-TargetResource fails if EnsureExchangeVolumeMountPointIsLast parameter is specified.
- Updated xExchAutoMountPoint, xExchJetstressCleanup, and related DiskPart functions to not use global variables.
- Fixes broken tests in: MSFT_xExchDatabaseAvailabilityGroup.Integration.Tests.ps1, MSFT_xExchExchangeCertificate.Integration.Tests.ps1, MSFT_xExchOutlookAnywhere.Integration.Tests.ps1, MSFT_xExchPopSettings.Integration.Tests.ps1, xExchangeConfigHelper.Unit.Tests.ps1
- Update most Test-TargetResource functions to output all invalid settings, instead of just the first detected invalid setting
1.21.0.0
- Added CHANGELOG.md file
- Added .markdownlint.json file
- Updated README.md and CHANGELOG.md files to respect MD009, MD0013 and MD032 rules
- Added .MetaTestOptIn.json file
- Updated appveyor.yml file
- Added .codecov.yml file
- Renamed Test folder to Tests
- Updated README.md: Add codecov badges
- Fixed PSSA required rules in:
- xExchClientAccessServer.psm1
- xExchInstall.psm1
- xExchMaintenanceMode.psm1
- TransportMaintenance.psm1
- xExchTransportService.psm1
- Fixed Validate Example files in:
- ConfigureAutoMountPoints-FromCalculator.ps1
- ConfigureAutoMountPoints-Manual.ps1
- ConfigureDatabases-FromCalculator.ps1
- InternetFacingSite.ps1
- RegionalNamespaces.ps1
- SingleNamespace.ps1
- ConfigureVirtualDirectories.ps1
- CreateAndConfigureDAG.ps1
- EndToEndExample 1 to 10 files
- JetstressAutomation
- MaintenanceMode
- PostInstallationConfiguration.ps1
- InstallExchange.ps1
- QuickStartTemplate.ps1
- WaitForADPrep.ps1
- Remove default value for Switch Parameter in
TransportMaintenance.psm1 for functions:
- Clear-DiscardEvent
- LogIfRemain
- Wait-EmptyEntriesCompletion
- Update-EntriesTracker
- Remove-CompletedEntriesFromHashtable
- Fixed PSSA custom rules in:
- xExchActiveSyncVirtualDirectory.psm1
- xExchAntiMalwareScanning.psm1
- xExchAutodiscoverVirtualDirectory.psm1
- xExchAutoMountPoint.psm1
- xExchClientAccessServer.psm1
- xExchDatabaseAvailabilityGroup.psm1
- xExchDatabaseAvailabilityGroupMember.psm1
- xExchDatabaseAvailabilityGroupNetwork.psm1
- xExchEcpVirtualDirectory.psm1
- xExchEventLogLevel.psm1
- xExchExchangeCertificate.psm1
- xExchExchangeServer.psm1
- xExchImapSettings.psm1
- xExchInstall.psm1
- xExchJetstress.psm1
- xExchJetstressCleanup.psm1
- xExchMailboxDatabase.psm1
- xExchMailboxDatabaseCopy.psm1
- xExchMailboxServer.psm1
- xExchMailboxTransportService.psm1
- xExchMaintenanceMode.psm1
- xExchMapiVirtualDirectory.psm1
- xExchOabVirtualDirectory.psm1
- xExchOutlookAnywhere.psm1
- xExchOwaVirtualDirectory.psm1
- xExchPopSettings.psm1
- xExchPowerShellVirtualDirectory.psm1
- xExchReceiveConnector.psm1
- xExchUMCallRouterSettings.psm1
- xExchUMService.psm1
- xExchWaitForADPrep.psm1
- xExchWaitForDAG.psm1
- xExchWaitForMailboxDatabase.psm1
- xExchWebServicesVirtualDirectory.psm1
- Updated xExchange.psd1
- Added issue template file (ISSUE_TEMPLATE.md) for 'New Issue' and pull request template file (PULL_REQUEST_TEMPLATE.md) for 'New Pull Request'.
- Fix issue Diagnostics.CodeAnalysis.SuppressMessageAttribute best practices
- Renamed xExchangeCommon.psm1 to xExchangeHelper.psm1
- Renamed the folder MISC (that contains the helper) to Modules
- Added xExchangeHelper.psm1 in xExchange.psd1 (section NestedModules)
- Removed all lines with Import-Module xExchangeCommon.psm1
- Updated .MetaTestOptIn.json file with Custom Script Analyzer Rules
- Added Integration, TestHelpers and Unit folder
- Moved Data folder in Tests
- Moved Integration tests to Integration folder
- Moved Unit test to Unit folder
- Renamed xEchange.Tests.Common.psm1 to xExchangeTestHelper.psm1
- Renamed xEchangeCommon.Unit.Tests.ps1 to xExchangeCommon.Tests.ps1
- Renamed function PrepTestDAG to Initialize-TestForDAG
- Moved function Initialize-TestForDAG to xExchangeTestHelper.psm1
- Fix error-level PS Script Analyzer rules for TransportMaintenance.psm1
1.20.0.0
- Fix issue where test of type Microsoft.Exchange.Data.Unlimited fails
1.19.0.0
- Added missing parameters to xExchActiveSyncVirtualDirectory
- Added missing parameters to xExchAutoDiscoverVirtualDirectory
- Added missing parameters to xExchWebServicesVirtualDirectory
1.18.0.0
- Fix issue #203 and add additional test for invalid ASA account format
1.17.0.0
- Fix issue where test for Unlimited quota fails if quota is not already set at Unlimited
1.16.0.0
- Add missing parameters to xExchClientAccessServer
1.15.0.0
- xExchDatabaseAvailabilityGroupMember: Added check to ensure Failover-Clustering role is installed before adding server to DAG.
- xExchInstall: Remove parameter '-AllowImmediateReboot $AllowImmediateReboot' when calling CheckWSManConfig.
- xExchOutlookAnywhere: Add test for ExternalClientAuthenticationMethod.
- Test: Update OAB and UMService tests to create test OAB and UMDialPlans, respectively.
- Test: Update MailboxDatabase tests to use test OAB. Update DAG to skip DAG tests and write error if cluster feature not installed.
1.14.0.0
- xExchDatabaseAvailabilityGroup: Added parameter AutoDagAutoRedistributeEnabled, PreferenceMoveFrequency
1.13.0.0
- Fix function RemoveVersionSpecificParameters
- xExchMailboxServer: Added missing parameters except these, which are marked as 'This parameter is reserved for internal Microsoft use.'
1.12.0.0
- xExchangeCommon : In Start-ExchangeScheduledTask corrected throw error check to throw last error when errorRegister has more than 0 errors instead of throwing error if errorRegister was not null, which would otherwise always be true.
- Fix PSAvoidUsingWMICmdlet issues from PSScriptAnalyzer
- Fix PSUseSingularNouns issues from PSScriptAnalyzer
- Fix PSAvoidUsingCmdletAliases issues from PSScriptAnalyzer
- Fix PSUseApprovedVerbs issues from PSScriptAnalyzer
- Fix PSAvoidUsingEmptyCatchBlock issues from PSScriptAnalyzer
- Fix PSUsePSCredentialType issues from PSScriptAnalyzer
- Fix erroneous PSDSCDscTestsPresent issues from PSScriptAnalyzer for modules that do actually have tests in the root Tests folder
- Fix array comparison issues by removing check for if array is null
- Suppress PSDSCDscExamplesPresent PSScriptAnalyzer issues for resources that do have examples
- Fix PSUseDeclaredVarsMoreThanAssignments issues from PSScriptAnalyzer
- Remove requirements for second DAG member, or second Witness server, from MSFT_xExchDatabaseAvailabilityGroup.Integration.Tests
1.11.0.0
- xExchActiveSyncVirtualDirectory: Fix issue where ClientCertAuth parameter set to "Allowed" instead of "Accepted"
1.10.0.0
- xExchAutoMountPoint: Fix malformed dash/hyphen characters
- Fix PSPossibleIncorrectComparisonWithNull issues from PowerShell Script Analyzer
- Suppress PSDSCUseVerboseMessageInDSCResource Warnings from PowerShell Script Analyzer
1.9.0.0
- Converted appveyor.yml to install Pester from PSGallery instead of from Chocolatey.
- Added xExchMailboxTransportService resource
- xExchMailboxServer: Added WacDiscoveryEndpoint parameter
1.8.0.0
- Fixed PSSA issues in:
- MSFT_xExchClientAccessServer
- MSFT_xExchAntiMalwareScanning
- MSFT_xExchWaitForMailboxDatabase
- MSFT_xExchWebServicesVirtualDirectory
- MSFT_xExchExchangeCertificate
- MSFT_xExchWaitForDAG
- MSFT_xExchUMService
- MSFT_xExchUMCallRouterSettings
- MSFT_xExchReceiveConnector
- MSFT_xExchPowershellVirtualDirectory
- MSFT_xExchPopSettings
- MSFT_xExchOwaVirtualDirectory
- MSFT_xExchOutlookAnywhere
- MSFT_xExchOabVirtualDirectory
- MSFT_xExchMapiVirtualDirectory
- MSFT_xExchMailboxServer
- MSFT_xExchImapSettings
- MSFT_xExchExchangeServer
- MSFT_xExchEventLogLevel
- MSFT_xExchEcpVirtualDirectory
- MSFT_xExchDatabaseAvailabilityGroupNetwork
- MSFT_xExchDatabaseAvailabilityGroupMember
- MSFT_xExchDatabaseAvailabilityGroup
1.7.0.0
- xExchOwaVirtualDirectory
- Added
LogonFormat
parameter. - Added
DefaultDomain
parameter.
- Added
- Added FileSystem parameter to xExchDatabaseAvailabilityGroup
- Fixed PSSA issues in MSFT_xExchAutodiscoverVirtualDirectory and MSFT_xExchActiveSyncVirtualDirectory
- Updated xExchAutoMountPoint to disable Integrity Checking when formatting volumes as ReFS. This aligns with the latest version of DiskPart.ps1 from the Exchange Server Role Requirements Calculator.
1.6.0.0
- Added DialPlans parameter to xExchUMService
1.5.0.0
- Added support for Exchange 2016!
- Added Pester tests for the following resources:
- xExchActiveSyncVirtualDirectory,
- xExchAutodiscoverVirtualDirectory,
- xExchClientAccessServer,
- xExchDatabaseAvailabilityGroup,
- xExchDatabaseAvailabilityGroupMember,
- xExchEcpVirtualDirectory,
- xExchExchangeServer,
- xExchImapSettings,
- xExchMailboxDatabase,
- xExchMailboxDatabaseCopy,
- xExchMapiVirtualDirectory,
- xExchOabVirtualDirectory,
- xExchOutlookAnywhere,
- xExchOwaVirtualDirectory,
- xExchPopSettings,
- xExchPowershellVirtualDirectory,
- xExchUMCallRouterSettings,
- xExchUMService,
- xExchWebServicesVirtualDirectory
- Fixed minor Get-TargetResource issues in xExchAutodiscoverVirtualDirectory, xExchImapSettings, xExchPopSettings, xExchUMCallRouterSettings, and xExchWebServicesVirtualDirectory
- Added support for extended rights to resource xExchReceiveConnector (ExtendedRightAllowEntries/ExtendedRightDenyEntries)
- Fixed issue where Set-Targetresource is triggered each time consistency check runs in xExchReceiveConnector due to extended permissions on Receive Connector
- Added parameter MaximumActiveDatabases and MaximumPreferredActiveDatabases to resource xExchMailBoxServer
1.4.0.0
- Added following resources:
- xExchMaintenanceMode
- xExchMailboxServer
- xExchTransportService
- xExchEventLogLevel
- For all -ExchangeCertificate functions in xExchExchangeCertificate, added '-Server $env:COMPUTERNAME' switch. This will prevent the resource from configuring a certificate on an incorrect server.
- Fixed issue with reading MailboxDatabases.csv in xExchangeConfigHelper.psm1 caused by a column name changed introduced in v7.7 of the Exchange Server Role Requirements Calculator.
- Changed function Get-RemoteExchangeSession so that it will throw an exception if Exchange setup is in progress. This will prevent resources from trying to execute while setup is running.
- Fixed issue where VirtualDirectory resources would incorrectly try to restart a Back End Application Pool on a CAS role only server.
- Added support for the /AddUMLanguagePack parameter in xExchInstall
1.3.0.0
- MSFT_xExchWaitForADPrep: Removed obsolete VerbosePreference parameter from Test-TargetResource
- Fixed encoding
1.2.0.0
- xExchWaitForADPrep
- Removed
VerbosePreference
parameter of Test-TargetResource function to resolve schema mismatch error.
- Removed
- Added xExchAntiMalwareScanning resource
- xExchJetstress:
- Added fix for an issue where JetstressCmd.exe would not relaunch successfully after ESE initialization. If Jetstress doesn't restart, the resource will now require a reboot before proceeding.
- xExchOwaVirtualDirectory:
- Added
ChangePasswordEnabled
parameter - Added
LogonPagePublicPrivateSelectionEnabled
parameter - Added
LogonPageLightSelectionEnabled
parameter
- Added
- xExchImapSettings:
- Added
ExternalConnectionSettings
parameter - Added
X509CertificateName
parameter
- Added
- xExchPopSettings:
- Added
ExternalConnectionSettings
parameter - Added
X509CertificateName
parameter
- Added
- Added EndToEndExample
- Fixed bug where Start-ExchangeScheduledTask would throw an error message and fail to set ExecutionTimeLimit and Priority when using domain credentials
1.1.0.0
-
xExchAutoMountPoint: Added parameter
EnsureExchangeVolumeMountPointIsLast
-
xExchExchangeCertificate: Added error logging for the
Enable-ExchangeCertificate
cmdlet -
xExchExchangeServer: Added pre-check for deprecated Set-ExchangeServer parameter, WorkloadManagementPolicy
-
xExchJetstressCleanup: When OutputSaveLocation is specified, Stress- files will also now be saved
-
xExchMailboxDatabase:
- Added
AdServerSettingsPreferredServer
parameter - Added
SkipInitialDatabaseMount
parameter, which can help in an enviroments where databases need time to be able to mount successfully after creation - Added better error logging for
Mount-Database
- Databases will only be mounted at initial database creation
if
MountAtStartup
is$true
or not specified
- Added
-
xExchMailboxDatabaseCopy:
- Added
SeedingPostponed
parameter - Added
AdServerSettingsPreferredServer
parameter - Changed so that
ActivationPreference
will only be set if the number of existing copies for the database is greater than or equal to the specified ActivationPreference - Changed so that a seed of a new copy is only performed if
SeedingPostponed
is not specified or set to$false
- Added better error logging for
Add-MailboxDatabaseCopy
- Added missing tests for
EdbFilePath
andLogFolderPath
- Added
-
xExchOwaVirtualDirectory: Added missing test for
InstantMessagingServerName
-
xExchWaitForMailboxDatabase: Added
AdServerSettingsPreferredServer
parameter -
ExchangeConfigHelper.psm1: Updated
DBListFromMailboxDatabaseCopiesCsv
so that the DB copies that are returned are sorted by Activation Preference in ascending order.
1.0.3.11
- xExchJetstress Changes:
- Changed default for MaxWaitMinutes from 4320 to 0
- Added property MinAchievedIOPS
- Changed priority of the JetstressCmd.exe Scheduled Task from the default of 7 to 4
- xExchJetstressCleanup Changes:
- Fixed issue which caused the cleanup to not work properly when only a single database is used in JetstressConfig.xml
- xExchAutoMountPoint Changes:
- Updated resource to choose the next available EXVOL mount point to use for databases numerically by volume number instead of alphabetically by volume number (ie. EXVOL2 would be selected after EXVOL1 instead of EXVOL11, which is alphabetically closer).
1.0.3.6
- Added the following resources:
- xExchInstall
- xExchJetstress
- xExchJetstressCleanup
- xExchUMCallRouterSettings
- xExchWaitForADPrep
- xExchActiveSyncVirtualDirectory Changes:
- Fixed an issue where if AutoCertBasedAuth was being configured, it would result in an IISReset and an app pool recycle. Now only an IISReset will occur in this scenario.
- xExchAutoMountPoint Changes:
- Added CreateSubfolders parameter
- Moved many DiskPart functions into helper file Misc\xExchangeDiskPart.ps1
- Updated so that ExchangeVolume mount points will be listed AFTER ExchangeDatabase mount points on the same disk
- xExchExchangeCertificate Changes:
- Changed behavior so that if UM or UMCallRouter services are being enabled, the UM or UMCallRouter services will be stopped before the enablement, then restarted after the enablement.
- xExchMailboxDatabase Changes:
- Fixed an issue where the OfflineAddressBook property would not be tested properly depending on if a slash was specified or not at the beginning of the OAB name. Now the slash doesn't matter.
- xExchOutlookAnywhere Changes:
- Changed the test for ExternalClientsRequireSsl to only fire if ExternalHostname is also specified.
- xExchUMService Changes:
- Fixed issue that was preventing tests from evaluating properly.
- Example Updates:
- Added example folder InstallExchange
- Added example folder JetstressAutomation
- Added example folder WaitForADPrep
- Renamed EndToEndExample to PostInstallationConfiguration
- Updated Start-DscConfiguration commands in ConfigureDatabasesFromCalculator, ConfigureDatabasesManual, ConfigureVirtualDirectories, CreateAndConfigureDAG, and EndToEndExample, as they were missing a required space between parameters
1.0.1.0
- Updated all Examples with minor comment changes, and re-wrote the examples ConfigureAutoMountPoint-FromCalculator and ConfigureAutoMountPoints-Manual.
- Updated Exchange Server Role Requirement Calculator examples from version 6.3 to 6.6
1.0.0.0
- Initial release with the following resources:
- xExchActiveSyncVirtualDirectory
- xExchAutodiscoverVirtualDirectory
- xExchAutoMountPoint
- xExchClientAccessServer
- xExchDatabaseAvailabilityGroup
- xExchDatabaseAvailabilityGroupMember
- xExchDatabaseAvailabilityGroupNetwork
- xExchEcpVirtualDirectory
- xExchExchangeCertificate
- xExchExchangeServer
- xExchImapSettings
- xExchMailboxDatabase
- xExchMailboxDatabaseCopy
- xExchMapiVirtualDirectory
- xExchOabVirtualDirectory
- xExchOutlookAnywhere
- xExchOwaVirtualDirectory
- xExchPopSettings
- xExchPowerShellVirtualDirectory
- xExchReceiveConnector
- xExchUMService
- xExchWaitForDAG
- xExchWaitForMailboxDatabase
- xExchWebServicesVirtualDirectory
Dependencies
- puppetlabs/pwshlib (>= 0.7.0 < 2.0.0)