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.10.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.10.0.0. The PowerShell module describes itself like this:
This DSC Module allows you to configure many different properties of Exchange 2013 servers, including individual server properties, databases and mount points, and Database Availability Groups.
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.10.0.0dsc_xexchantimalwarescanning
: The DSC xExchAntiMalwareScanning resource type. Automatically generated from version 1.10.0.0dsc_xexchautodiscovervirtualdirectory
: The DSC xExchAutodiscoverVirtualDirectory resource type. Automatically generated from version 1.10.0.0dsc_xexchautomountpoint
: The DSC xExchAutoMountPoint resource type. Automatically generated from version 1.10.0.0dsc_xexchclientaccessserver
: The DSC xExchClientAccessServer resource type. Automatically generated from version 1.10.0.0dsc_xexchdatabaseavailabilitygroup
: The DSC xExchDatabaseAvailabilityGroup resource type. Automatically generated from version 1.10.0.0dsc_xexchdatabaseavailabilitygroupmember
: The DSC xExchDatabaseAvailabilityGroupMember resource type. Automatically generated from version 1.10.0.0dsc_xexchdatabaseavailabilitygroupnetwork
: The DSC xExchDatabaseAvailabilityGroupNetwork resource type. Automatically generated from version 1.10.0.0dsc_xexchecpvirtualdirectory
: The DSC xExchEcpVirtualDirectory resource type. Automatically generated from version 1.10.0.0dsc_xexcheventloglevel
: The DSC xExchEventLogLevel resource type. Automatically generated from version 1.10.0.0dsc_xexchexchangecertificate
: The DSC xExchExchangeCertificate resource type. Automatically generated from version 1.10.0.0dsc_xexchexchangeserver
: The DSC xExchExchangeServer resource type. Automatically generated from version 1.10.0.0dsc_xexchimapsettings
: The DSC xExchImapSettings resource type. Automatically generated from version 1.10.0.0dsc_xexchinstall
: The DSC xExchInstall resource type. Automatically generated from version 1.10.0.0dsc_xexchjetstress
: The DSC xExchJetstress resource type. Automatically generated from version 1.10.0.0dsc_xexchjetstresscleanup
: The DSC xExchJetstressCleanup resource type. Automatically generated from version 1.10.0.0dsc_xexchmailboxdatabase
: The DSC xExchMailboxDatabase resource type. Automatically generated from version 1.10.0.0dsc_xexchmailboxdatabasecopy
: The DSC xExchMailboxDatabaseCopy resource type. Automatically generated from version 1.10.0.0dsc_xexchmailboxserver
: The DSC xExchMailboxServer resource type. Automatically generated from version 1.10.0.0dsc_xexchmailboxtransportservice
: The DSC xExchMailboxTransportService resource type. Automatically generated from version 1.10.0.0dsc_xexchmaintenancemode
: The DSC xExchMaintenanceMode resource type. Automatically generated from version 1.10.0.0dsc_xexchmapivirtualdirectory
: The DSC xExchMapiVirtualDirectory resource type. Automatically generated from version 1.10.0.0dsc_xexchoabvirtualdirectory
: The DSC xExchOabVirtualDirectory resource type. Automatically generated from version 1.10.0.0dsc_xexchoutlookanywhere
: The DSC xExchOutlookAnywhere resource type. Automatically generated from version 1.10.0.0dsc_xexchowavirtualdirectory
: The DSC xExchOwaVirtualDirectory resource type. Automatically generated from version 1.10.0.0dsc_xexchpopsettings
: The DSC xExchPopSettings resource type. Automatically generated from version 1.10.0.0dsc_xexchpowershellvirtualdirectory
: The DSC xExchPowerShellVirtualDirectory resource type. Automatically generated from version 1.10.0.0dsc_xexchreceiveconnector
: The DSC xExchReceiveConnector resource type. Automatically generated from version 1.10.0.0dsc_xexchtransportservice
: The DSC xExchTransportService resource type. Automatically generated from version 1.10.0.0dsc_xexchumcallroutersettings
: The DSC xExchUMCallRouterSettings resource type. Automatically generated from version 1.10.0.0dsc_xexchumservice
: The DSC xExchUMService resource type. Automatically generated from version 1.10.0.0dsc_xexchwaitforadprep
: The DSC xExchWaitForADPrep resource type. Automatically generated from version 1.10.0.0dsc_xexchwaitfordag
: The DSC xExchWaitForDAG resource type. Automatically generated from version 1.10.0.0dsc_xexchwaitformailboxdatabase
: The DSC xExchWaitForMailboxDatabase resource type. Automatically generated from version 1.10.0.0dsc_xexchwebservicesvirtualdirectory
: The DSC xExchWebServicesVirtualDirectory resource type. Automatically generated from version 1.10.0.0
Resource types
dsc_xexchactivesyncvirtualdirectory
The DSC xExchActiveSyncVirtualDirectory resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchactivesyncvirtualdirectory
type.
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_basicauthenabled
Data type: Optional[Boolean]
dsc_clientcertauth
Data type: Optional[Enum['Ignore', 'Allowed', 'Required']]
dsc_compressionenabled
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_externalauthenticationmethods
Data type: Optional[Array[String]]
dsc_externalurl
Data type: Optional[String]
dsc_internalauthenticationmethods
Data type: Optional[Array[String]]
dsc_internalurl
Data type: Optional[String]
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.10.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.10.0.0
Properties
The following properties are available in the dsc_xexchautodiscovervirtualdirectory
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_basicauthentication
Data type: Optional[Boolean]
dsc_digestauthentication
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_windowsauthentication
Data type: Optional[Boolean]
dsc_wssecurityauthentication
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchautodiscovervirtualdirectory
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_xexchautomountpoint
The DSC xExchAutoMountPoint resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchautomountpoint
type.
dsc_autodagdatabasesrootfolderpath
Data type: String
dsc_autodagvolumesrootfolderpath
Data type: String
dsc_createsubfolders
Data type: Optional[Boolean]
dsc_disktodbmap
Data type: Array[String]
dsc_ensureexchangevolumemountpointislast
Data type: Optional[Boolean]
dsc_filesystem
Data type: Optional[Enum['NTFS', 'REFS']]
dsc_mindisksize
Data type: Optional[String]
dsc_partitioningscheme
Data type: Optional[Enum['MBR', 'GPT']]
dsc_sparevolumecount
Data type: Integer[0, 4294967295]
dsc_unitsize
Data type: Optional[String]
dsc_volumeprefix
Data type: Optional[String]
Parameters
The following parameters are available in the dsc_xexchautomountpoint
type.
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_xexchclientaccessserver
The DSC xExchClientAccessServer resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchclientaccessserver
type.
dsc_autodiscoverserviceinternaluri
Data type: Optional[String]
dsc_autodiscoversitescope
Data type: Optional[Array[String]]
dsc_domaincontroller
Data type: Optional[String]
Parameters
The following parameters are available in the dsc_xexchclientaccessserver
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_xexchdatabaseavailabilitygroup
The DSC xExchDatabaseAvailabilityGroup resource type. Automatically generated from version 1.10.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_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_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.10.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.10.0.0
Properties
The following properties are available in the dsc_xexchdatabaseavailabilitygroupnetwork
type.
dsc_databaseavailabilitygroup
Data type: String
dsc_domaincontroller
Data type: Optional[String]
dsc_ensure
Data type: Enum['Present', 'Absent']
dsc_ignorenetwork
Data type: Optional[Boolean]
dsc_replicationenabled
Data type: Optional[Boolean]
dsc_subnets
Data type: Optional[Array[String]]
Parameters
The following parameters are available in the dsc_xexchdatabaseavailabilitygroupnetwork
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_xexchecpvirtualdirectory
The DSC xExchEcpVirtualDirectory resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchecpvirtualdirectory
type.
dsc_adfsauthentication
Data type: Optional[Boolean]
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_basicauthentication
Data type: Optional[Boolean]
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_internalurl
Data type: Optional[String]
dsc_windowsauthentication
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchecpvirtualdirectory
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_xexcheventloglevel
The DSC xExchEventLogLevel resource type. Automatically generated from version 1.10.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.10.0.0
Properties
The following properties are available in the dsc_xexchexchangecertificate
type.
dsc_allowextraservices
Data type: Optional[Boolean]
dsc_certfilepath
Data type: Optional[String]
dsc_domaincontroller
Data type: Optional[String]
dsc_ensure
Data type: Enum['Present', 'Absent']
dsc_services
Data type: Optional[Array[String]]
Parameters
The following parameters are available in the dsc_xexchexchangecertificate
type.
dsc_certcreds
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
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_thumbprint
namevar
Data type: String
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.10.0.0
Properties
The following properties are available in the dsc_xexchexchangeserver
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_customerfeedbackenabled
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_internetwebproxy
Data type: Optional[String]
dsc_monitoringgroup
Data type: Optional[String]
dsc_productkey
Data type: Optional[String]
dsc_workloadmanagementpolicy
Data type: Optional[String]
Parameters
The following parameters are available in the dsc_xexchexchangeserver
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_xexchimapsettings
The DSC xExchImapSettings resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchimapsettings
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_xexchimapsettings
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_xexchinstall
The DSC xExchInstall resource type. Automatically generated from version 1.10.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.10.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.10.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.10.0.0
Properties
The following properties are available in the dsc_xexchmailboxdatabase
type.
dsc_adserversettingspreferredserver
Data type: Optional[String]
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_autodagexcludefrommonitoring
Data type: Optional[Boolean]
dsc_backgrounddatabasemaintenance
Data type: Optional[Boolean]
dsc_calendarloggingquota
Data type: Optional[String]
dsc_circularloggingenabled
Data type: Optional[Boolean]
dsc_databasecopycount
Data type: Integer[0, 4294967295]
dsc_datamovereplicationconstraint
Data type: Optional[Enum['None', 'SecondCopy', 'SecondDatacenter', 'AllDatacenters', 'AllCopies']]
dsc_deleteditemretention
Data type: Optional[String]
dsc_domaincontroller
Data type: Optional[String]
dsc_edbfilepath
Data type: String
dsc_eventhistoryretentionperiod
Data type: Optional[String]
dsc_indexenabled
Data type: Optional[Boolean]
dsc_isexcludedfromprovisioning
Data type: Optional[Boolean]
dsc_isexcludedfromprovisioningreason
Data type: Optional[String]
dsc_issuewarningquota
Data type: Optional[String]
dsc_issuspendedfromprovisioning
Data type: Optional[Boolean]
dsc_journalrecipient
Data type: Optional[String]
dsc_logfolderpath
Data type: String
dsc_mailboxretention
Data type: Optional[String]
dsc_mountatstartup
Data type: Optional[Boolean]
dsc_offlineaddressbook
Data type: Optional[String]
dsc_prohibitsendquota
Data type: Optional[String]
dsc_prohibitsendreceivequota
Data type: Optional[String]
dsc_recoverableitemsquota
Data type: Optional[String]
dsc_recoverableitemswarningquota
Data type: Optional[String]
dsc_retaindeleteditemsuntilbackup
Data type: Optional[Boolean]
dsc_server
Data type: String
dsc_skipinitialdatabasemount
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchmailboxdatabase
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_xexchmailboxdatabasecopy
The DSC xExchMailboxDatabaseCopy resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchmailboxdatabasecopy
type.
dsc_activationpreference
Data type: Optional[Integer[0, 4294967295]]
dsc_adserversettingspreferredserver
Data type: Optional[String]
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_mailboxserver
Data type: String
dsc_replaylagtime
Data type: Optional[String]
dsc_seedingpostponed
Data type: Optional[Boolean]
dsc_truncationlagtime
Data type: Optional[String]
Parameters
The following parameters are available in the dsc_xexchmailboxdatabasecopy
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_xexchmailboxserver
The DSC xExchMailboxServer resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchmailboxserver
type.
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_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_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.10.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.10.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_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_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.10.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.10.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_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.10.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.10.0.0
Properties
The following properties are available in the dsc_xexchowavirtualdirectory
type.
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_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_windowsauthentication
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.10.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.10.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.10.0.0
Properties
The following properties are available in the dsc_xexchreceiveconnector
type.
dsc_advertiseclientsettings
Data type: Optional[Boolean]
dsc_authmechanism
Data type: Optional[Array[String]]
dsc_banner
Data type: Optional[String]
dsc_barelinefeedrejectionenabled
Data type: Optional[Boolean]
dsc_binarymimeenabled
Data type: Optional[Boolean]
dsc_bindings
Data type: Optional[Array[String]]
dsc_chunkingenabled
Data type: Optional[Boolean]
dsc_comment
Data type: Optional[String]
dsc_connectioninactivitytimeout
Data type: Optional[String]
dsc_connectiontimeout
Data type: Optional[String]
dsc_defaultdomain
Data type: Optional[String]
dsc_deliverystatusnotificationenabled
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_domainsecureenabled
Data type: Optional[Boolean]
dsc_eightbitmimeenabled
Data type: Optional[Boolean]
dsc_enableauthgssapi
Data type: Optional[Boolean]
dsc_enabled
Data type: Optional[Boolean]
dsc_enhancedstatuscodesenabled
Data type: Optional[Boolean]
dsc_ensure
Data type: Enum['Present', 'Absent']
dsc_extendedprotectionpolicy
Data type: Optional[Enum['None', 'Allow', 'Require']]
dsc_extendedrightallowentries
Data type: Optional[Array[Struct[{ key => Optional[String], value => Optional[String], }]]]
dsc_extendedrightdenyentries
Data type: Optional[Array[Struct[{ key => Optional[String], value => Optional[String], }]]]
dsc_fqdn
Data type: Optional[String]
dsc_longaddressesenabled
Data type: Optional[Boolean]
dsc_maxacknowledgementdelay
Data type: Optional[String]
dsc_maxheadersize
Data type: Optional[String]
dsc_maxhopcount
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_maxinboundconnection
Data type: Optional[String]
dsc_maxinboundconnectionpercentagepersource
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_maxinboundconnectionpersource
Data type: Optional[String]
dsc_maxlocalhopcount
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_maxlogonfailures
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_maxmessagesize
Data type: Optional[String]
dsc_maxprotocolerrors
Data type: Optional[String]
dsc_maxrecipientspermessage
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_messageratelimit
Data type: Optional[String]
dsc_messageratesource
Data type: Optional[Enum['None', 'IPAddress', 'User', 'All']]
dsc_orarenabled
Data type: Optional[Boolean]
dsc_permissiongroups
Data type: Optional[Array[String]]
dsc_pipeliningenabled
Data type: Optional[Boolean]
dsc_protocollogginglevel
Data type: Optional[Enum['None', 'Verbose']]
dsc_remoteipranges
Data type: Optional[Array[String]]
dsc_requireehlodomain
Data type: Optional[Boolean]
dsc_requiretls
Data type: Optional[Boolean]
dsc_servicediscoveryfqdn
Data type: Optional[String]
dsc_sizeenabled
Data type: Optional[Enum['Enabled', 'Disabled', 'EnabledWithoutValue']]
dsc_suppressxanonymoustls
Data type: Optional[Boolean]
dsc_tarpitinterval
Data type: Optional[String]
dsc_tlscertificatename
Data type: Optional[String]
dsc_tlsdomaincapabilities
Data type: Optional[Array[String]]
dsc_transportrole
Data type: Optional[Enum['FrontendTransport', 'HubTransport']]
dsc_usage
Data type: Optional[Enum['Client', 'Internal', 'Internet', 'Partner', 'Custom']]
Parameters
The following parameters are available in the dsc_xexchreceiveconnector
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_xexchtransportservice
The DSC xExchTransportService resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchtransportservice
type.
dsc_activeuserstatisticslogmaxage
Data type: Optional[String]
dsc_activeuserstatisticslogmaxdirectorysize
Data type: Optional[String]
dsc_activeuserstatisticslogmaxfilesize
Data type: Optional[String]
dsc_activeuserstatisticslogpath
Data type: Optional[String]
dsc_agentlogenabled
Data type: Optional[Boolean]
dsc_agentlogmaxage
Data type: Optional[String]
dsc_agentlogmaxdirectorysize
Data type: Optional[String]
dsc_agentlogmaxfilesize
Data type: Optional[String]
dsc_agentlogpath
Data type: Optional[String]
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_delaynotificationtimeout
Data type: Optional[String]
dsc_dnslogenabled
Data type: Optional[Boolean]
dsc_dnslogmaxage
Data type: Optional[String]
dsc_dnslogmaxdirectorysize
Data type: Optional[String]
dsc_dnslogmaxfilesize
Data type: Optional[String]
dsc_dnslogpath
Data type: Optional[String]
dsc_externaldnsadapterenabled
Data type: Optional[Boolean]
dsc_externaldnsadapterguid
Data type: Optional[String]
dsc_externaldnsprotocoloption
Data type: Optional[Enum['Any', 'UseTcpOnly', 'UseUdpOnly']]
dsc_externaldnsservers
Data type: Optional[Array[String]]
dsc_externalipaddress
Data type: Optional[String]
dsc_internaldnsadapterenabled
Data type: Optional[Boolean]
dsc_internaldnsadapterguid
Data type: Optional[String]
dsc_internaldnsprotocoloption
Data type: Optional[Enum['Any', 'UseTcpOnly', 'UseUdpOnly']]
dsc_internaldnsservers
Data type: Optional[Array[String]]
dsc_intraorgconnectorprotocollogginglevel
Data type: Optional[Enum['None', 'Verbose']]
dsc_intraorgconnectorsmtpmaxmessagesperconnection
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_irmlogenabled
Data type: Optional[Boolean]
dsc_irmlogmaxage
Data type: Optional[String]
dsc_irmlogmaxdirectorysize
Data type: Optional[String]
dsc_irmlogmaxfilesize
Data type: Optional[String]
dsc_irmlogpath
Data type: Optional[String]
dsc_maxconcurrentmailboxdeliveries
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_maxconcurrentmailboxsubmissions
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_maxconnectionrateperminute
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_maxoutboundconnections
Data type: Optional[String]
dsc_maxperdomainoutboundconnections
Data type: Optional[String]
dsc_messageexpirationtimeout
Data type: Optional[String]
dsc_messageretryinterval
Data type: Optional[String]
dsc_messagetrackinglogenabled
Data type: Optional[Boolean]
dsc_messagetrackinglogmaxage
Data type: Optional[String]
dsc_messagetrackinglogmaxdirectorysize
Data type: Optional[String]
dsc_messagetrackinglogmaxfilesize
Data type: Optional[String]
dsc_messagetrackinglogpath
Data type: Optional[String]
dsc_messagetrackinglogsubjectloggingenabled
Data type: Optional[Boolean]
dsc_outboundconnectionfailureretryinterval
Data type: Optional[String]
dsc_pickupdirectorymaxheadersize
Data type: Optional[String]
dsc_pickupdirectorymaxmessagesperminute
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_pickupdirectorymaxrecipientspermessage
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_pickupdirectorypath
Data type: Optional[String]
dsc_pipelinetracingenabled
Data type: Optional[Boolean]
dsc_pipelinetracingpath
Data type: Optional[String]
dsc_pipelinetracingsenderaddress
Data type: Optional[String]
dsc_poisonmessagedetectionenabled
Data type: Optional[Boolean]
dsc_poisonthreshold
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_queuelogmaxage
Data type: Optional[String]
dsc_queuelogmaxdirectorysize
Data type: Optional[String]
dsc_queuelogmaxfilesize
Data type: Optional[String]
dsc_queuelogpath
Data type: Optional[String]
dsc_queuemaxidletime
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_recipientvalidationcacheenabled
Data type: Optional[Boolean]
dsc_replaydirectorypath
Data type: Optional[String]
dsc_rootdropdirectorypath
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]
dsc_serverstatisticslogmaxage
Data type: Optional[String]
dsc_serverstatisticslogmaxdirectorysize
Data type: Optional[String]
dsc_serverstatisticslogmaxfilesize
Data type: Optional[String]
dsc_serverstatisticslogpath
Data type: Optional[String]
dsc_transientfailureretrycount
Data type: Optional[Integer[-2147483648, 2147483647]]
dsc_transientfailureretryinterval
Data type: Optional[String]
dsc_usedowngradedexchangeserverauth
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchtransportservice
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_xexchumcallroutersettings
The DSC xExchUMCallRouterSettings resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchumcallroutersettings
type.
dsc_domaincontroller
Data type: Optional[String]
Optional Domain Controller to connect to
dsc_umstartupmode
Data type: Enum['TCP', 'TLS', 'Dual']
UMStartupMode for the UM call router
Parameters
The following parameters are available in the dsc_xexchumcallroutersettings
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
Hostname of the UM server to configure
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xexchumservice
The DSC xExchUMService resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchumservice
type.
dsc_dialplans
Data type: Optional[Array[String]]
dsc_domaincontroller
Data type: Optional[String]
dsc_umstartupmode
Data type: Enum['TCP', 'TLS', 'Dual']
Parameters
The following parameters are available in the dsc_xexchumservice
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_xexchwaitforadprep
The DSC xExchWaitForADPrep resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchwaitforadprep
type.
dsc_domainversion
Data type: Optional[Integer[-2147483648, 2147483647]]
Specifies that the domain containing the target Exchange 2013 server was prepared using setup /PrepareAD, /PrepareDomain, or /PrepareAllDomains, and should be at the specified version
dsc_exchangedomains
Data type: Optional[Array[String]]
The FQDN's of domains that should be checked for DomainVersion in addition to the domain that this Exchange server belongs to
dsc_organizationversion
Data type: Optional[Integer[-2147483648, 2147483647]]
Specifies that the Exchange Organization should have been prepared using Exchange 2013 'setup /PrepareAD', and should be at the specified version
dsc_retrycount
Data type: Optional[Integer[0, 4294967295]]
How many retry attempts should be made to see if AD has been prepped before an exception is thrown. Defaults to 30.
dsc_retryintervalsec
Data type: Optional[Integer[0, 4294967295]]
How many seconds to wait between retries when checking whether AD has been prepped. Defaults to 60.
dsc_schemaversion
Data type: Optional[Integer[-2147483648, 2147483647]]
Specifies that the Active Directory schema should have been prepared using Exchange 2013 'setup /PrepareSchema', and should be at the specified version
Parameters
The following parameters are available in the dsc_xexchwaitforadprep
type.
dsc_credential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credentials used to perform Active Directory lookups against the Schema, Configuration, and Domain naming contexts
dsc_identity
namevar
Data type: String
Not actually used. Enter anything, as long as it's not null
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_xexchwaitfordag
The DSC xExchWaitForDAG resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchwaitfordag
type.
dsc_domaincontroller
Data type: Optional[String]
dsc_retrycount
Data type: Optional[Integer[0, 4294967295]]
dsc_retryintervalsec
Data type: Optional[Integer[0, 4294967295]]
Parameters
The following parameters are available in the dsc_xexchwaitfordag
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_xexchwaitformailboxdatabase
The DSC xExchWaitForMailboxDatabase resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchwaitformailboxdatabase
type.
dsc_adserversettingspreferredserver
Data type: Optional[String]
dsc_domaincontroller
Data type: Optional[String]
dsc_retrycount
Data type: Optional[Integer[0, 4294967295]]
dsc_retryintervalsec
Data type: Optional[Integer[0, 4294967295]]
Parameters
The following parameters are available in the dsc_xexchwaitformailboxdatabase
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_xexchwebservicesvirtualdirectory
The DSC xExchWebServicesVirtualDirectory resource type. Automatically generated from version 1.10.0.0
Properties
The following properties are available in the dsc_xexchwebservicesvirtualdirectory
type.
dsc_allowservicerestart
Data type: Optional[Boolean]
dsc_basicauthentication
Data type: Optional[Boolean]
dsc_certificateauthentication
Data type: Optional[Boolean]
dsc_digestauthentication
Data type: Optional[Boolean]
dsc_domaincontroller
Data type: Optional[String]
dsc_externalurl
Data type: Optional[String]
dsc_internalnlbbypassurl
Data type: Optional[String]
dsc_internalurl
Data type: Optional[String]
dsc_oauthauthentication
Data type: Optional[Boolean]
dsc_windowsauthentication
Data type: Optional[Boolean]
dsc_wssecurityauthentication
Data type: Optional[Boolean]
Parameters
The following parameters are available in the dsc_xexchwebservicesvirtualdirectory
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.
- xExchAutoMountPoint: Fix malformed dash/hyphen characters
- Fix PSPossibleIncorrectComparisonWithNull issues from PowerShell Script Analyzer
- Suppress PSDSCUseVerboseMessageInDSCResource Warnings from PowerShell Script Analyzer
Dependencies
- puppetlabs/pwshlib (>= 0.7.0 < 2.0.0)