< Back
Get-DbaAgReplica
Post
NAME Get-DbaAgReplica
SYNOPSIS
Returns the availability group replica object found on the server.
SYNTAX
Get-DbaAgReplica [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-AvailabilityGroup] <System.String[]>] [[-Replica] <System.String[]>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Returns the availability group replica object found on the server.
PARAMETERS
-AvailabilityGroup [<System.String[]>]
Specify the availability groups to query.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>]
Enables piped input from Get-DbaAvailabilityGroup.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Replica [<System.String[]>]
Return only specific replicas.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance 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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: AvailabilityGroup, HA, AG
Author: Shawn Melton (@wsmelton) | Chrissy LeMaire (@cl)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaAgReplica -SqlInstance sql2017a
Returns basic information on all the availability group replicas found on sql2017a
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaAgReplica -SqlInstance sql2017a -AvailabilityGroup SharePoint
Shows basic information on the replicas found on availability group SharePoint on sql2017a
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaAgReplica -SqlInstance sql2017a | Select-Object *
Returns full object properties on all availability group replicas found on sql2017a
RELATED LINKS
https://dbatools.io/Get-DbaAgReplica
SYNOPSIS
Returns the availability group replica object found on the server.
SYNTAX
Get-DbaAgReplica [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-AvailabilityGroup] <System.String[]>] [[-Replica] <System.String[]>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Returns the availability group replica object found on the server.
PARAMETERS
-AvailabilityGroup [<System.String[]>]
Specify the availability groups to query.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>]
Enables piped input from Get-DbaAvailabilityGroup.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Replica [<System.String[]>]
Return only specific replicas.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance 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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: AvailabilityGroup, HA, AG
Author: Shawn Melton (@wsmelton) | Chrissy LeMaire (@cl)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaAgReplica -SqlInstance sql2017a
Returns basic information on all the availability group replicas found on sql2017a
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaAgReplica -SqlInstance sql2017a -AvailabilityGroup SharePoint
Shows basic information on the replicas found on availability group SharePoint on sql2017a
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaAgReplica -SqlInstance sql2017a | Select-Object *
Returns full object properties on all availability group replicas found on sql2017a
RELATED LINKS
https://dbatools.io/Get-DbaAgReplica