< Back

Get-DbaServerRoleMember

Mon Jan 13, 2020 11:38 am

NAME Get-DbaServerRoleMember



SYNOPSIS

Get members of server roles for each instance(s) of SQL Server.





SYNTAX

Get-DbaServerRoleMember [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>

[[-SqlCredential] <Pscredential>] [[-ServerRole] <System.String[]>] [[-ExcludeServerRole] <System.String[]>]

[[-Login] <System.Object[]>] [-ExcludeFixedRole <Switch>] [-EnableException <Switch>] [<CommonParameters>]





DESCRIPTION

The Get-DbaServerRoleMember returns connected SMO object for server roles for each instance(s) of SQL Server.





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[]>]

The role(s) to exclude.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Login [<System.Object[]>]

The login(s) to process. If unspecified, all logins will be processed.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-ServerRole [<System.String[]>]

The role(s) to process. If unspecified, all roles will be processed.



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. This can be a collection and receive pipeline input to allow the

function to be executed against multiple SQL Server instances.



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, Login

Author: Klaas Vandenberghe (@PowerDBAKlaas)



Website: https://dbatools.io

Copyright: (c) 2018 by dbatools, licensed under MIT

License: MIT https://opensource.org/licenses/MIT



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-DbaServerRoleMember -SqlInstance localhost



Returns all members of all server roles on the local default SQL Server instance

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-DbaServerRoleMember -SqlInstance localhost, sql2016



Returns all members of all server roles on the local and sql2016 SQL Server instances

-------------------------- EXAMPLE 3 --------------------------



PS C:\\>$servers = Get-Content C:\\servers.txt



PS C:\\> $servers | Get-DbaServerRoleMember



Returns all members of all server roles for every server in C:\\servers.txt

-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-DbaServerRoleMember -SqlInstance localhost -ServerRole 'sysadmin', 'dbcreator'



Returns all members of the sysadmin or dbcreator roles on localhost.

-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-DbaServerRoleMember -SqlInstance localhost -ExcludeServerRole 'sysadmin'



Returns all members of server-level roles other than sysadmin.

-------------------------- EXAMPLE 6 --------------------------



PS C:\\>Get-DbaServerRoleMember -SqlInstance sql2017a -ExcludeFixedRole



Returns all members of server-level role(s) that are not fixed roles on sql2017a instance.

-------------------------- EXAMPLE 7 --------------------------



PS C:\\>Get-DbaServerRoleMember -SqlInstance localhost -Login 'MyFriendlyDeveloper'



Returns all server-level role(s) for the MyFriendlyDeveloper login on localhost.



RELATED LINKS

https://dbatools.io/Get-DbaServerRoleMember