Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-12
Use the Set-DatabaseAvailabilityGroupNetwork cmdlet to configure a network for a database availability group (DAG).
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Set-DatabaseAvailabilityGroupNetwork -Identity
<DatabaseAvailabilityGroupNetworkIdParameter> [-Confirm
[<SwitchParameter>]] [-Description <String>]
[-DomainController <Fqdn>] [-IgnoreNetwork <$true |
$false>] [-Name <String>] [-ReplicationEnabled <$true |
$false>] [-Subnets <DatabaseAvailabilityGroupSubnetId[]>]
[-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example enables the DAG network DAGNetwork01 in the DAG DAG1 for replication.
Copy Code | |
---|---|
Set-DatabaseAvailabilityGroupNetwork -Identity DAG1\DAGNetwork01 -ReplicationEnabled:$true |
EXAMPLE 2
This example disables the DAG network DAGNetwork02 in the DAG DAG2 for replication and configures the DAG to ignore the network.
Copy Code | |
---|---|
Set-DatabaseAvailabilityGroupNetwork -Identity DAG2\DAGNetwork02 -ReplicationEnabled:$false -IgnoreNetwork:$true |
Detailed Description
You can configure a variety of network properties, such as the name for the network, a description of the network, a list of one or more subnets that comprise the network, and whether the network is enabled for replication (log shipping and seeding).
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.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.DatabaseAvailabilityGroupNetworkIdParameter |
The Identity parameter specifies the DAG network being configured. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
Description |
Optional |
System.String |
The Description parameter specifies an optional description for the DAG network. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
IgnoreNetwork |
Optional |
System.Boolean |
The IgnoreNetwork parameter indicates that the specified network should be ignored and not used by the DAG. |
Name |
Optional |
System.String |
The Name parameter provides a name for the DAG network. |
ReplicationEnabled |
Optional |
System.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. |
Subnets |
Optional |
Microsoft.Exchange.Data.DatabaseAvailabilityGroupSubnetId[] |
The Subnets parameter specifies one or more subnets that are associated with the DAG network. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
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.
Return Types
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.