Set-DatabaseAvailabilityGroup

 

Applies to: Exchange Server 2016

Topic Last Modified: 2016-09-21

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Set-DatabaseAvailabilityGroup cmdlet to configure properties of a database availability group (DAG).

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-DatabaseAvailabilityGroup -Identity <DatabaseAvailabilityGroupIdParameter> [-ActivityState <NewDeployment | DotBuildUpgrade | Decom | PendingDotBuildUpgrade | DecomRemoveMailboxes | DecomNoUpgrades | Discovered | Allocated | ReadyForAllocation | Spare>] [-AllowCrossSiteRpcClientAccess <SwitchParameter>] [-AlternateWitnessDirectory <NonRootLocalLongFullPath>] [-AlternateWitnessServer <FileShareWitnessServerName>] [-AutoDagAllServersInstalled <$true | $false>] [-AutoDagAutoRedistributeEnabled <$true | $false>] [-AutoDagAutoReseedEnabled <$true | $false>] [-AutoDagBitlockerEnabled <$true | $false>] [-AutoDagDatabaseCopiesPerDatabase <Int32>] [-AutoDagDatabaseCopiesPerVolume <Int32>] [-AutoDagDatabasesRootFolderPath <NonRootLocalLongFullPath>] [-AutoDagDiskReclaimerEnabled <$true | $false>] [-AutoDagFIPSCompliant <$true | $false>] [-AutoDagSIPEnabled <$true | $false>] [-AutoDagTotalNumberOfDatabases <Int32>] [-AutoDagTotalNumberOfServers <Int32>] [-AutoDagVolumesRootFolderPath <NonRootLocalLongFullPath>] [-Confirm [<SwitchParameter>]] [-DagConfiguration <DatabaseAvailabilityGroupConfigurationIdParameter>] [-DatabaseAvailabilityGroupIpAddresses <IPAddress[]>] [-DatacenterActivationMode <Off | DagOnly>] [-DiscoverNetworks <SwitchParameter>] [-DomainController <Fqdn>] [-DxStoreSpareServers <String>] [-DxStoreWitnessServers <String>] [-FileSystem <NTFS | ReFS>] [-ForceSyncDistributedStoreSettings <SwitchParameter>] [-IgnoreClusterErrors <SwitchParameter>] [-MailboxLoadBalanceComputeCapacity <Int32>] [-MailboxLoadBalanceEnabled <$true | $false>] [-MailboxLoadBalanceOverloadedThreshold <Int32>] [-MailboxLoadBalanceRelativeLoadCapacity <Int32>] [-MailboxLoadBalanceUnderloadedThreshold <Int32>] [-ManualDagNetworkConfiguration <$true | $false>] [-NetworkCompression <Disabled | Enabled | InterSubnetOnly | SeedOnly>] [-NetworkEncryption <Disabled | Enabled | InterSubnetOnly | SeedOnly>] [-PreferenceMoveFrequency <TimeSpan>] [-ReplayLagManagerEnabled <$true | $false>] [-ReplicationPort <UInt16>] [-RequestedDistributedStoreConfig <String>] [-SiloName <String>] [-SkipDagValidation <SwitchParameter>] [-WhatIf [<SwitchParameter>]] [-WitnessDirectory <NonRootLocalLongFullPath>] [-WitnessServer <FileShareWitnessServerName>]

This example sets the witness directory to C:\DAG1DIR for the DAG DAG1.

Set-DatabaseAvailabilityGroup -Identity DAG1 -WitnessDirectory C:\DAG1DIR

This example preconfigures an alternate witness server of CAS3 and an alternate witness directory of C:\DAGFileShareWitnesses\DAG1.contoso.com for the DAG DAG1.

Set-DatabaseAvailabilityGroup -Identity DAG1 -AlternateWitnessDirectory C:\DAGFileShareWitnesses\DAG1.contoso.com -AlternateWitnessServer CAS3

This example configures the DAG DAG1 to use DHCP to obtain an IP address.

Set-DatabaseAvailabilityGroup -Identity DAG1 -DatabaseAvailabilityGroupIpAddresses 0.0.0.0

This example configures the DAG DAG1 to use a static IP address of 10.0.0.8.

Set-DatabaseAvailabilityGroup -Identity DAG1 -DatabaseAvailabilityGroupIpAddresses 10.0.0.8

This example configures the multi-subnet DAG DAG1 with multiple static IP addresses.

Set-DatabaseAvailabilityGroup -Identity DAG1 -DatabaseAvailabilityGroupIpAddresses 10.0.0.8,10.0.1.8

This example configures TCP port 63132 as the port used by replication for the DAG DAG1.

Set-DatabaseAvailabilityGroup -Identity DAG1 -ReplicationPort 63132
noteNote:
After changing the default replication port for a DAG, you must manually modify the Windows Firewall exceptions on each member of the DAG to allow communication to occur over the specified port.

This example configures the DAG DAG1 for DAC mode.

Set-DatabaseAvailabilityGroup -Identity DAG1 -DatacenterActivationMode DagOnly

This example configures the DAG DAG1 for AutoReseed using custom mount point paths and 4 databases per volume.

Set-DatabaseAvailabilityGroup -Identity DAG1 -AutoDagVolumesRootFolderPath C:\ExchVols -AutoDagDatabasesRootFolderPath C:\ExchDBs -AutoDagDatabaseCopiesPerVolume 4

The Set-DatabaseAvailabilityGroup cmdlet enables you to manage DAG properties that can't be managed from the Exchange admin center (EAC), such as configuring network discovery, selecting the TCP port used for replication, and enabling datacenter activation coordination (DAC) mode.

DAG property values are stored in both Active Directory and the cluster database. Because some properties are stored in the cluster database, the underlying cluster for the DAG must have quorum to set the properties for:

  • ReplicationPort

  • NetworkCompression

  • NetworkEncryption

  • DiscoverNetworks

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the"Database availability groups" entry in the High availability and site resilience permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.DatabaseAvailabilityGroupIdParameter

The Identity parameter specifies the name of the DAG that you want to modify.

ActivityState

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DatabaseAvailabilityGroup+ActivityStateOption

PARAMVALUE: NewDeployment | DotBuildUpgrade | Decom | PendingDotBuildUpgrade | DecomRemoveMailboxes | DecomNoUpgrades | Discovered | Allocated | ReadyForAllocation | Spare

AllowCrossSiteRpcClientAccess

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

AlternateWitnessDirectory

Optional

Microsoft.Exchange.Data.NonRootLocalLongFullPath

The AlternateWitnessDirectory parameter specifies the name of an alternate directory that's used to store file share witness data. The specified directory must not be in use by any other DAGs or used for any other purpose. This parameter is used only as part of a datacenter switchover process. If the DAG is extended across multiple datacenters in a site resilience configuration, we recommend preconfiguring the alternate witness server and directory.

AlternateWitnessServer

Optional

Microsoft.Exchange.Data.FileShareWitnessServerName

The AlternateWitnessServer parameter specifies the name of an alternate server that's used to store file share witness data. The specified server must not be a member of the DAG that's configured to use it. This parameter is used only as part of a datacenter switchover process. If the DAG is extended across multiple datacenters in a site resilience configuration, we recommend preconfiguring the alternate witness server and directory.

AutoDagAllServersInstalled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

AutoDagAutoRedistributeEnabled

Optional

System.Boolean

PARAMVALUE: $true | $false

AutoDagAutoReseedEnabled

Optional

System.Boolean

The AutoDagAutoReseedEnabled is used to enable or disable Autoreseed. The default value is $true (enabled).

AutoDagBitlockerEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

AutoDagDatabaseCopiesPerDatabase

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

AutoDagDatabaseCopiesPerVolume

Optional

System.Int32

The AutoDagDatabaseCopiesPerVolume parameter is used to specify the configured number of database copies per volume. This parameter is used only with AutoReseed.

AutoDagDatabasesRootFolderPath

Optional

Microsoft.Exchange.Data.NonRootLocalLongFullPath

The AutoDagDatabasesRootFolderPath parameter specifies the directory containing the database mount points when using AutoReseed. This parameter is required when using AutoReseed. AutoReseed uses a default path of C:\ExchangeDatabases.

AutoDagDiskReclaimerEnabled

Optional

System.Boolean

The AutoDagDiskReclaimerEnabled is used to enable or disable the volume formatting functions used by Autoreseed. The default value is $true (enabled). If you set this to $false, you will need to manually format the volume before the database(s) can be reseeded.

AutoDagFIPSCompliant

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

AutoDagSIPEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

AutoDagTotalNumberOfDatabases

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

AutoDagTotalNumberOfServers

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

AutoDagVolumesRootFolderPath

Optional

Microsoft.Exchange.Data.NonRootLocalLongFullPath

The AutoDagVolumesRootFolderPath parameter specifies the volume containing the mount points for all disks, including spare disks, when using the AutoReseed feature of the DAG. This parameter is required when using AutoReseed. AutoReseed uses a default path of C:\ExchangeVolumes.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DagConfiguration

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseAvailabilityGroupConfigurationIdParameter

This parameter is reserved for internal Microsoft use.

DatabaseAvailabilityGroupIpAddresses

Optional

System.Net.IPAddress[]

The DatabaseAvailabilityGroupIpAddresses parameter specifies one or more static IP addresses to the DAG when a Mailbox server is added to a DAG. If you omit the DatabaseAvailabilityGroupIpAddresses parameter when creating a DAG, the system attempts to lease one or more IP addresses from a Dynamic Host Configuration Protocol (DHCP) server in your organization to assign to the DAG. You must specify this parameter each time an additional IP address is added to the DAG, such as in the case of multi-subnet DAGs. You must also specify all IP addresses previously assigned to the DAG each time the DatabaseAvailabilityGroupIpAddresses parameter is used. Setting the DatabaseAvailabilityGroupIpAddresses parameter to a value of 0.0.0.0 automatically configures the DAG to use DHCP.

DatacenterActivationMode

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DatacenterActivationModeOption

The DatacenterActivationMode parameter specifies the datacenter activation mode for the DAG. Valid values are:

  • Off   Datacenter activation mode is disabled.

  • DagOnly   Datacenter activation mode is enabled.

DiscoverNetworks

Optional

System.Management.Automation.SwitchParameter

The DiscoverNetworksswitch specifies whether to force a rediscovery of the network and network interfaces. You don't need to specify a value with this switch.

By default, internal network heartbeats are sent between DAG members on the same subnet. If there's no response to the heartbeats, network discovery is performed automatically by the system. If you add or remove networks or change DAG network subnets, you can force rediscovery of all DAG networks by using the DiscoverNetworksswitch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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.

DxStoreSpareServers

Optional

System.String

This parameter is reserved for internal Microsoft use.

DxStoreWitnessServers

Optional

System.String

This parameter is reserved for internal Microsoft use.

FileSystem

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DatabaseAvailabilityGroup+FileSystemMode

PARAMVALUE: NTFS | ReFS

ForceSyncDistributedStoreSettings

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

IgnoreClusterErrors

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

MailboxLoadBalanceComputeCapacity

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

MailboxLoadBalanceEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

MailboxLoadBalanceOverloadedThreshold

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

MailboxLoadBalanceRelativeLoadCapacity

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

MailboxLoadBalanceUnderloadedThreshold

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

ManualDagNetworkConfiguration

Optional

System.Boolean

The ManualDagNetworkConfiguration parameter specifies whether DAG networks should be automatically configured. If this parameter is set to $false, DAG networks are automatically configured. If this parameter is set to $true, you must manually configure DAG networks.

NetworkCompression

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DatabaseAvailabilityGroup+NetworkOption

The NetworkCompression parameter specifies the network compression option for the DAG. Valid values are:

  • Disabled   Network compression is disabled on all networks.

  • Enabled   Network compression is enabled on all networks.

  • InterSubnetOnly   Network compression is enabled only for inter-subnet communication.

  • SeedOnly   Network compression is enabled only for seeding.

NetworkEncryption

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DatabaseAvailabilityGroup+NetworkOption

The NetworkEncryption parameter specifies the network encryption option for the DAG. Valid values are:

  • Disabled   Network encryption is disabled on all networks.

  • Enabled   Network encryption is enabled on all networks.

  • InterSubnetOnly   Network encryption is enabled only for inter-subnet communication.

  • SeedOnly   Network encryption is enabled only for seeding.

PreferenceMoveFrequency

Optional

System.TimeSpan

The PreferenceMoveFrequency parameter specifies how frequently the Microsoft Exchange Replication service inspects and automatically rebalances the database copies. If the most preferred database copy (ActivationPreference value of 1) isn't the active copy, the most preferred database copy is activated by performing a lossless switchover.

To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds.

The default value is 01:00:00 (1 hour). To disable this feature, specify the value ([System.Threading.Timeout]::InfiniteTimeSpan).

ReplayLagManagerEnabled

Optional

System.Boolean

The ReplayLagManagerEnabled parameter specifies whether to disable the automatic playdown of log files for a lagged database copy.

ReplicationPort

Optional

System.UInt16

The ReplicationPort parameter specifies a Transmission Control Protocol (TCP) port for replication (log shipping and seeding) activity. If this parameter isn't specified, the default port for replication is TCP 64327.

RequestedDistributedStoreConfig

Optional

System.String

This parameter is reserved for internal Microsoft use.

SiloName

Optional

System.String

This parameter is reserved for internal Microsoft use.

SkipDagValidation

Optional

System.Management.Automation.SwitchParameter

The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when configuring the DAG. You don't need to specify a value with this switch.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

WitnessDirectory

Optional

Microsoft.Exchange.Data.NonRootLocalLongFullPath

The WitnessDirectory parameter specifies the name of the directory on the server that's used to store file share witness data. The specified directory must not be in use by any other DAGs.

WitnessServer

Optional

Microsoft.Exchange.Data.FileShareWitnessServerName

The WitnessServer parameter specifies the name of a server that will act as a witness for the DAG. The server specified can't be a member of the DAG.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: