Share via

New-SqlAvailabilityGroup

Module:
SQLPS Module

Creates an availability group.

Syntax

ByPath (Default) 

New-SqlAvailabilityGroup
    [-Name] <String>
    [[-Path] <String>]
    -AvailabilityReplica <AvailabilityReplica[]>
    [-Database <String[]>]
    [-AutomatedBackupPreference <AvailabilityGroupAutomatedBackupPreference>]
    [-FailureConditionLevel <AvailabilityGroupFailureConditionLevel>]
    [-HealthCheckTimeout <Int32>]
    [-BasicAvailabilityGroup]
    [-DatabaseHealthTrigger]
    [-DtcSupportEnabled]
    [-Script]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObject 

New-SqlAvailabilityGroup
    [-Name] <String>
    [-InputObject] <Server>
    -AvailabilityReplica <AvailabilityReplica[]>
    [-Database <String[]>]
    [-AutomatedBackupPreference <AvailabilityGroupAutomatedBackupPreference>]
    [-FailureConditionLevel <AvailabilityGroupFailureConditionLevel>]
    [-HealthCheckTimeout <Int32>]
    [-BasicAvailabilityGroup]
    [-DatabaseHealthTrigger]
    [-DtcSupportEnabled]
    [-Script]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-SqlAvailabilityGroup cmdlet creates an availability group in AlwaysOn Availability Groups. The InputObject or Path parameter specifies the server that hosts the initial primary replica.

Examples

Example 1: Create an availability group

PS C:\> $PrimaryServer = Get-Item "SQLSERVER:\SQL\PrimaryServer\Instance22"
PS C:\> $SecondaryServer = Get-Item "SQLSERVER:\SQL\SecondaryServer\Instance22"
PS C:\> $PrimaryReplica = New-SqlAvailabilityReplica -Name "PrimaryServer\Instance22" -EndpointUrl "TCP://PrimaryServer.domain:5022" -FailoverMode "Automatic" -AvailabilityMode "SynchronousCommit" -AsTemplate -Version ($PrimaryServer.Version)
PS C:\> $SecondaryReplica = New-SqlAvailabilityReplica -Name "SecondaryServer\Instance22" -EndpointUrl "TCP://SecondaryServer.domain:5022" -FailoverMode "Automatic" -AvailabilityMode "SynchronousCommit" -AsTemplate -Version ($SecondaryServer.Version)
PS C:\> New-SqlAvailabilityGroup -InputObject $PrimaryServer -Name "MainAG" -AvailabilityReplica ($PrimaryReplica, $SecondaryReplica) -Database @("Database01","Database02")

The first command gets an instance of SQL Server on the primary server, and then stores it in the $PrimaryServer variable.

The second command gets an instance of SQL Server on the secondary server, and then stores it in the $SecondaryServer variable.

The third command creates a replica that includes the primary server instance by using the New-SqlAvailabilityReplica cmdlet, and then stores it in the $PrimaryReplica variable. The command specifies the version of the server instance by using the Version property of $PrimaryServer.

The fourth command creates a replica that includes the secondary server instance by using New-SqlAvailabilityReplica, and then stores it in the $SecondaryReplica variable. The command specifies the version of the server instance by using the Version property of $SecondaryServer.

The final command creates the availability group. It specifies the name, the primary server, the replicas, and other information.

Parameters

-AutomatedBackupPreference

Specifies the automated backup preference for the availability group. The acceptable values for this parameter are:

  • Primary. Specifies that the backups always occur on the primary replica. This option supports the use of features not available when backup runs on a secondary replica, such as differential backups.
  • SecondaryOnly. Specifies that backups are never performed on primary replicas. If the primary replica is the only replica online, the backup does not occur.
  • Secondary. Specifies that backups occur on secondary replicas, unless the primary replica is the only replica online. Then the backup occurs on the primary replica.
  • None. Specifies that the primary or secondary status is not taken into account when deciding which replica performs backups. Instead, backup priority and online status determine which replica performs backups.

Parameter properties

Type:AvailabilityGroupAutomatedBackupPreference
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AvailabilityReplica

Specifies an array of availability replicas that this cmdlet includes in the availability group. To obtain an AvailabilityReplica object, use the New-SqlAvailabilityReplica cmdlet. Specify the AsTemplate parameter.

Parameter properties

Type:

AvailabilityReplica[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BasicAvailabilityGroup

The New-SqlAvailabilityGroup cmdlet creates an availability group in AlwaysOn Availability Groups. The InputObject or Path parameter specifies the server that hosts the initial primary replica.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Database

Specifies an array of local, read/write user databases. These databases must use the full recovery model and must not use AUTO_CLOSE. These databases cannot belong to another availability group and cannot be configured for database mirroring. You must specify a value for this parameter.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DatabaseHealthTrigger

The New-SqlAvailabilityGroup cmdlet creates an availability group in AlwaysOn Availability Groups. The InputObject or Path parameter specifies the server that hosts the initial primary replica.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DtcSupportEnabled

The New-SqlAvailabilityGroup cmdlet creates an availability group in AlwaysOn Availability Groups. The InputObject or Path parameter specifies the server that hosts the initial primary replica.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FailureConditionLevel

Specifies the automatic failover behavior of the availability group. The acceptable values for this parameter are:

  • OnServerDown. Failover or restart if the SQL Server service stops.
  • OnServerUnresponsive. Failover or restart if any condition of lower value is satisfied, plus when the SQL Server service is connected to the cluster and the HealthCheckTimeout threshold is exceeded, or if the availability replica currently in primary role is in a failed state.
  • OnCriticalServerError. Failover or restart if any condition of lower value is satisfied, plus when an internal critical Server error occurs, which include out of memory condition, serious write-access violation, or too much dumping.
  • OnModerateServerError. Failover or restart if any condition of lower value is satisfied, plus if a moderate Server error occurs, which includes persistent out of memory condition.
  • OnAnyQualifiedFailureConditions. Failover or restart if any condition of lower value is satisfied, plus if a qualifying failure condition occurs, which includes engine worker thread exhaustion and unsolvable deadlock detected.

Parameter properties

Type:AvailabilityGroupFailureConditionLevel
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HealthCheckTimeout

Specifies the length of time, in milliseconds, after which AlwaysOn availability groups declare an unresponsive server to be unhealthy.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the instance of SQL Server that hosts the primary replica of the availability group that this cmdlet creates.

Parameter properties

Type:Server
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByObject
Position:3
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the availability group that this cmdlet creates.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Path

Specifies the path of the instance of SQL Server that hosts the initial primary replica of the availability group that this cmdlet creates. If you do not specify this parameter, this cmdlet uses current working location. If you specify a value, the path must currently exist.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByPath
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Script

Indicates that this cmdlet returns a Transact-SQL script that performs the task that this cmdlet performs.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.SqlServer.Management.Smo.Server

You can pass a server instance to this cmdlet.

Outputs

Microsoft.SqlServer.Management.Smo.AvailabilityGroup

This cmdlet returns an availability group.