functions/Remove-DbaAgReplica.ps1
|
#ValidationTags#Messaging,FlowControl,Pipeline,CodeStyle# function Remove-DbaAgReplica { <# .SYNOPSIS Removes availability group replicas from availability groups. .DESCRIPTION Removes availability group replicas from availability groups. .PARAMETER SqlInstance The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher. .PARAMETER SqlCredential Login to the SqlInstance instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .PARAMETER AvailabilityGroup The specific availability group to query. .PARAMETER Replica The replica to remove. .PARAMETER InputObject Enables piped input from Get-DbaAgReplica. .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: AG, HA, AvailabilityGroup, Replica 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/Remove-DbaAgReplica .EXAMPLE PS C:\> Remove-DbaAgReplica -SqlInstance sql2017a -AvailabilityGroup SharePoint -Replica sp1 Removes the sp1 replica from the SharePoint ag on sql2017a. Prompts for confirmation. .EXAMPLE PS C:\> Remove-DbaAgReplica -SqlInstance sql2017a | Select-Object * Returns full object properties on all availability group replicas found on sql2017a #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [DbaInstanceParameter[]]$SqlInstance, [PSCredential]$SqlCredential, [string[]]$AvailabilityGroup, [string[]]$Replica, [parameter(ValueFromPipeline)] [Microsoft.SqlServer.Management.Smo.AvailabilityReplica[]]$InputObject, [switch]$EnableException ) process { if ($SqlInstance -and -not $Replica) { Stop-Function -Message "You must specify a replica when using the SqlInstance parameter." return } if ($SqlInstance) { $InputObject += Get-DbaAgReplica -SqlInstance $SqlInstance -SqlCredential $SqlCredential -Replica $Replica -AvailabilityGroup $AvailabilityGroup } foreach ($agreplica in $InputObject) { if ($Pscmdlet.ShouldProcess($agreplica.Parent.Parent.Name, "Removing availability group replica $agreplica")) { try { $agreplica.Drop() [pscustomobject]@{ ComputerName = $agreplica.ComputerName InstanceName = $agreplica.InstanceName SqlInstance = $agreplica.SqlInstance AvailabilityGroup = $agreplica.Parent.Name Replica = $agreplica.Name Status = "Removed" } } catch { Stop-Function -Message "Failure" -ErrorRecord $_ -Continue } } } } } |