functions/Add-DbaAgReplica.ps1
|
function Add-DbaAgReplica { <# .SYNOPSIS Adds a replica to an availability group on one or more SQL Server instances. .DESCRIPTION Adds a replica to an availability group on one or more SQL Server instances. Automatically creates database mirroring endpoints if required. .PARAMETER SqlInstance The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher. .PARAMETER SqlCredential Login to the target instances using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance. .PARAMETER Name The name of the replica. Defaults to the SQL Server instance name. This parameter is only supported if the replica is added to just one instance. .PARAMETER AvailabilityMode Sets the availability mode of the availability group replica. Options are: AsynchronousCommit and SynchronousCommit. SynchronousCommit is default. .PARAMETER FailoverMode Sets the failover mode of the availability group replica. Options are Automatic and Manual. Automatic is default. .PARAMETER BackupPriority Sets the backup priority availability group replica. Default is 50. .PARAMETER Endpoint By default, this command will attempt to find a DatabaseMirror endpoint. If one does not exist, it will create it. If an endpoint must be created, the name "hadr_endpoint" will be used. If an alternative is preferred, use Endpoint. .PARAMETER EndpointUrl By default, the property Fqdn of Get-DbaEndpoint is used as EndpointUrl. Use EndpointUrl if a different URL is required due to special network configurations. EndpointUrl has to be an array of strings in format 'TCP://system-address:port', one entry for every instance. See details at: https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/specify-endpoint-url-adding-or-modifying-availability-replica .PARAMETER Passthru Don't create the replica, just pass thru an object that can be further customized before creation. .PARAMETER InputObject Enables piping from Get-DbaAvailabilityGroup. .PARAMETER ConnectionModeInPrimaryRole Specifies the connection intent mode of an Availability Replica in primary role. AllowAllConnections by default. .PARAMETER ConnectionModeInSecondaryRole Specifies the connection intent mode of an Availability Replica in secondary role. AllowAllConnections by default. .PARAMETER ReadOnlyRoutingList Sets the read only routing ordered list of replica server names to use when redirecting read-only connections through this availability replica. This parameter is only supported if the replica is added to just one instance. .PARAMETER ReadonlyRoutingConnectionUrl Sets the read only routing connection url for the availability replica. This parameter is only supported if the replica is added to just one instance. .PARAMETER SeedingMode Specifies how the secondary replica will be initially seeded. Automatic enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. Manual requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. .PARAMETER Certificate Specifies that the endpoint is to authenticate the connection using the certificate specified by certificate_name to establish identity for authorization. The far endpoint must have a certificate with the public key matching the private key of the specified certificate. .PARAMETER ConfigureXESession Configure the AlwaysOn_health extended events session to start automatically as the SSMS wizard would do. https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/always-on-extended-events#BKMK_alwayson_health .PARAMETER WhatIf Shows what would happen if the command were to run. No actions are actually performed. .PARAMETER Confirm Prompts you for confirmation before executing any changing operations within the command. .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .NOTES Tags: AvailabilityGroup, HA, AG Author: Chrissy LeMaire (@cl), netnerds.net Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Add-DbaAgReplica .EXAMPLE PS C:\> Get-DbaAvailabilityGroup -SqlInstance sql2017a -AvailabilityGroup SharePoint | Add-DbaAgReplica -SqlInstance sql2017b Adds sql2017b to the SharePoint availability group on sql2017a .EXAMPLE PS C:\> Get-DbaAvailabilityGroup -SqlInstance sql2017a -AvailabilityGroup SharePoint | Add-DbaAgReplica -SqlInstance sql2017b -FailoverMode Manual Adds sql2017b to the SharePoint availability group on sql2017a with a manual failover mode. .EXAMPLE PS C:\> Get-DbaAvailabilityGroup -SqlInstance sql2017a -AvailabilityGroup SharePoint | Add-DbaAgReplica -SqlInstance sql2017b -EndpointUrl 'TCP://sql2017b.specialnet.local:5022' Adds sql2017b to the SharePoint availability group on sql2017a with a custom endpoint URL. #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Low')] param ( [parameter(Mandatory)] [DbaInstanceParameter[]]$SqlInstance, [PSCredential]$SqlCredential, [string]$Name, [ValidateSet('AsynchronousCommit', 'SynchronousCommit')] [string]$AvailabilityMode = "SynchronousCommit", [ValidateSet('Automatic', 'Manual', 'External')] [string]$FailoverMode = "Automatic", [int]$BackupPriority = 50, [ValidateSet('AllowAllConnections', 'AllowReadWriteConnections')] [string]$ConnectionModeInPrimaryRole = 'AllowAllConnections', [ValidateSet('AllowAllConnections', 'AllowNoConnections', 'AllowReadIntentConnectionsOnly')] [string]$ConnectionModeInSecondaryRole = 'AllowAllConnections', [ValidateSet('Automatic', 'Manual')] [string]$SeedingMode, [string]$Endpoint, [string[]]$EndpointUrl, [switch]$Passthru, [string[]]$ReadOnlyRoutingList, [string]$ReadonlyRoutingConnectionUrl, [string]$Certificate, [switch]$ConfigureXESession, [parameter(ValueFromPipeline, Mandatory)] [Microsoft.SqlServer.Management.Smo.AvailabilityGroup]$InputObject, [switch]$EnableException ) process { if ($EndpointUrl) { if ($EndpointUrl.Count -ne $SqlInstance.Count) { Stop-Function -Message "The number of elements in EndpointUrl is not correct" return } foreach ($epUrl in $EndpointUrl) { if ($epUrl -notmatch 'TCP://.+:\d+') { Stop-Function -Message "EndpointUrl '$epUrl' not in correct format 'TCP://system-address:port'" return } } } if ($ReadonlyRoutingConnectionUrl -and ($ReadonlyRoutingConnectionUrl -notmatch 'TCP://.+:\d+')) { Stop-Function -Message "ReadonlyRoutingConnectionUrl not in correct format 'TCP://system-address:port'" return } foreach ($instance in $SqlInstance) { try { $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $SqlCredential -MinimumVersion 11 } catch { Stop-Function -Message "Error occurred while establishing connection to $instance" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue } if ($Certificate) { $cert = Get-DbaDbCertificate -SqlInstance $server -Certificate $Certificate if (-not $cert) { Stop-Function -Message "Certificate $Certificate does not exist on $instance" -ErrorRecord $_ -Target $Certificate -Continue } } $ep = Get-DbaEndpoint -SqlInstance $server -Type DatabaseMirroring if (-not $ep) { if (-not $Endpoint) { $Endpoint = "hadr_endpoint" } if ($Pscmdlet.ShouldProcess($server.Name, "Adding endpoint named $Endpoint to $instance")) { $ep = New-DbaEndpoint -SqlInstance $server -Name $Endpoint -Type DatabaseMirroring -EndpointEncryption Supported -EncryptionAlgorithm Aes -Certificate $Certificate $null = $ep | Start-DbaEndpoint } } if ((Test-Bound -Not -ParameterName Name)) { $Name = $server.DomainInstanceName } if ($Pscmdlet.ShouldProcess($server.Name, "Creating a replica for $($InputObject.Name) named $Name")) { try { $replica = New-Object Microsoft.SqlServer.Management.Smo.AvailabilityReplica -ArgumentList $InputObject, $Name if ($EndpointUrl) { $epUrl, $EndpointUrl = $EndpointUrl $replica.EndpointUrl = $epUrl } else { $replica.EndpointUrl = $ep.Fqdn } $replica.FailoverMode = [Microsoft.SqlServer.Management.Smo.AvailabilityReplicaFailoverMode]::$FailoverMode $replica.AvailabilityMode = [Microsoft.SqlServer.Management.Smo.AvailabilityReplicaAvailabilityMode]::$AvailabilityMode if ($server.EngineEdition -ne "Standard") { $replica.ConnectionModeInPrimaryRole = [Microsoft.SqlServer.Management.Smo.AvailabilityReplicaConnectionModeInPrimaryRole]::$ConnectionModeInPrimaryRole $replica.ConnectionModeInSecondaryRole = [Microsoft.SqlServer.Management.Smo.AvailabilityReplicaConnectionModeInSecondaryRole]::$ConnectionModeInSecondaryRole } $replica.BackupPriority = $BackupPriority if ($ReadonlyRoutingList -and $server.VersionMajor -ge 13) { $replica.ReadonlyRoutingList = $ReadonlyRoutingList } if ($ReadonlyRoutingConnectionUrl -and $server.VersionMajor -ge 13) { $replica.ReadonlyRoutingConnectionUrl = $ReadonlyRoutingConnectionUrl } if ($SeedingMode -and $server.VersionMajor -ge 13) { $replica.SeedingMode = $SeedingMode } $serviceAccount = $server.ServiceAccount.Trim() $saName = ([DbaInstanceParameter]($server.DomainInstanceName)).ComputerName if ($serviceAccount) { if ($serviceAccount.StartsWith("NT ")) { $serviceAccount = "$saName`$" } if ($serviceAccount.StartsWith("$saName")) { $serviceAccount = "$saName`$" } if ($serviceAccount.StartsWith(".")) { $serviceAccount = "$saName`$" } } if (-not $serviceAccount) { $serviceAccount = "$saName`$" } if ($server.HostPlatform -ne "Linux") { if ($Pscmdlet.ShouldProcess($second.Name, "Granting Connect permission to service account: $serviceAccount")) { $null = Grant-DbaAgPermission -SqlInstance $server -Type AvailabilityGroup -AvailabilityGroup $InputObject.Name -Login $serviceAccount -Permission CreateAnyDatabase $null = Grant-DbaAgPermission -SqlInstance $server -Login $serviceAccount -Type Endpoint -Permission Connect } } if ($ConfigureXESession) { try { Write-Message -Level Debug -Message "Getting session 'AlwaysOn_health' on $instance." $xeSession = Get-DbaXESession -SqlInstance $server -Session AlwaysOn_health -EnableException if ($xeSession) { if (-not $xeSession.AutoStart) { Write-Message -Level Debug -Message "Setting autostart for session 'AlwaysOn_health' on $instance." $xeSession.AutoStart = $true $xeSession.Alter() } if (-not $xeSession.IsRunning) { Write-Message -Level Debug -Message "Starting session 'AlwaysOn_health' on $instance." $null = $xeSession | Start-DbaXESession -EnableException } Write-Message -Level Verbose -Message "ConfigureXESession was set, session 'AlwaysOn_health' is now configured and running on $instance." } else { Write-Message -Level Warning -Message "ConfigureXESession was set, but no session named 'AlwaysOn_health' was found on $instance." } } catch { Write-Message -Level Warning -Message "ConfigureXESession was set, but configuration failed on $instance with this error: $_" } } if ($Passthru) { return $replica } $defaults = 'ComputerName', 'InstanceName', 'SqlInstance', 'AvailabilityGroup', 'Name', 'Role', 'RollupSynchronizationState', 'AvailabilityMode', 'BackupPriority', 'EndpointUrl', 'SessionTimeout', 'FailoverMode', 'ReadonlyRoutingList' $InputObject.AvailabilityReplicas.Add($replica) $agreplica = $InputObject.AvailabilityReplicas[$Name] if ($InputObject.State -eq 'Existing') { Invoke-Create -Object $replica $null = Join-DbaAvailabilityGroup -SqlInstance $instance -SqlCredential $SqlCredential -AvailabilityGroup $InputObject.Name $agreplica.Alter() } Add-Member -Force -InputObject $agreplica -MemberType NoteProperty -Name ComputerName -Value $agreplica.Parent.ComputerName Add-Member -Force -InputObject $agreplica -MemberType NoteProperty -Name InstanceName -Value $agreplica.Parent.InstanceName Add-Member -Force -InputObject $agreplica -MemberType NoteProperty -Name SqlInstance -Value $agreplica.Parent.SqlInstance Add-Member -Force -InputObject $agreplica -MemberType NoteProperty -Name AvailabilityGroup -Value $agreplica.Parent.Name Add-Member -Force -InputObject $agreplica -MemberType NoteProperty -Name Replica -Value $agreplica.Name # backwards compat Select-DefaultView -InputObject $agreplica -Property $defaults } catch { $msg = $_.Exception.InnerException.InnerException.Message if (-not $msg) { $msg = $_ } Stop-Function -Message $msg -ErrorRecord $_ -Continue } } } } } |