< Back
Get-DbaServerRole
Post
NAME Get-DbaServerRole
SYNOPSIS
Gets the list of server-level roles.
SYNTAX
Get-DbaServerRole [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-ServerRole] <System.String[]>] [[-ExcludeServerRole] <System.String[]>] [-ExcludeFixedRole
<Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets the list of server-level roles for SQL Server instance.
PARAMETERS
-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
-ExcludeFixedRole [<Switch>]
Filter the fixed server-level roles. Only applies to SQL Server 2017 that supports creation of server-level
roles.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeServerRole [<System.String[]>]
Server-Level role to exclude from results.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ServerRole [<System.String[]>]
Server-Level role to filter results to that role only.
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 2005 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: ServerRole, Security
Author: Shawn Melton (@wsmelton)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaServerRole -SqlInstance sql2016a
Outputs list of server-level roles for sql2016a instance.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaServerRole -SqlInstance sql2017a -ExcludeFixedRole
Outputs the server-level role(s) that are not fixed roles on sql2017a instance.
RELATED LINKS
https://dbatools.io/Get-DbaServerRole
SYNOPSIS
Gets the list of server-level roles.
SYNTAX
Get-DbaServerRole [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-ServerRole] <System.String[]>] [[-ExcludeServerRole] <System.String[]>] [-ExcludeFixedRole
<Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets the list of server-level roles for SQL Server instance.
PARAMETERS
-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
-ExcludeFixedRole [<Switch>]
Filter the fixed server-level roles. Only applies to SQL Server 2017 that supports creation of server-level
roles.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeServerRole [<System.String[]>]
Server-Level role to exclude from results.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ServerRole [<System.String[]>]
Server-Level role to filter results to that role only.
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 2005 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: ServerRole, Security
Author: Shawn Melton (@wsmelton)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaServerRole -SqlInstance sql2016a
Outputs list of server-level roles for sql2016a instance.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaServerRole -SqlInstance sql2017a -ExcludeFixedRole
Outputs the server-level role(s) that are not fixed roles on sql2017a instance.
RELATED LINKS
https://dbatools.io/Get-DbaServerRole