Resource Type: dsc_xexchmailboxdatabasecopy

Defined in:

lib/puppet/type/dsc_xexchmailboxdatabasecopy.rb

Providers:

powershell

Overview

The DSC xExchMailboxDatabaseCopy resource type. Automatically generated from ‘xExchange/DSCResources/MSFT_xExchMailboxDatabaseCopy/MSFT_xExchMailboxDatabaseCopy.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_activationpreference

  ActivationPreference - 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

  AdServerSettingsPreferredServer - An optional domain controller to pass to Set-AdServerSettings -PreferredServer.

• dsc_allowservicerestart

  AllowServiceRestart - Whether it is OK to restart Information Store after adding copy.

  Supported values:

  • true
  • false
• dsc_credential

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

• dsc_domaincontroller

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

• dsc_identity

  Identity - The Identity parameter specifies the name of the database whose copy is being modified.

• dsc_mailboxserver

  MailboxServer - The MailboxServer parameter specifies the name of the server that will host the database copy.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_replaylagmaxdelay

  ReplayLagMaxDelay - The ReplayLagMaxDelay parameter specifies the maximum delay for lagged database copy play down.

• dsc_replaylagtime

  ReplayLagTime - 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

  SeedingPostponed - The SeedingPostponed switch specifies that the task doesn’t seed the database copy, so you need to explicitly seed the database copy.

  Supported values:

  • true
  • false
• dsc_truncationlagtime

  TruncationLagTime - 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.

• name (namevar)
• provider

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