commands

^

Get-DbaServerRoleMember

Author Klaas Vandenberghe (@PowerDBAKlaas)
Availability Windows, Linux, macOS

 

Synopsis

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

Description

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

Syntax

Get-DbaServerRoleMember
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-ServerRole] <String[]>]
    [[-ExcludeServerRole] <String[]>]
    [[-Login] <Object[]>]
    [-ExcludeFixedRole]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

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.

Required Parameters

-SqlInstance

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.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-SqlCredential

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.

Alias Credential
Required False
Pipeline false
Default Value
-ServerRole

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

Alias
Required False
Pipeline false
Default Value
-ExcludeServerRole

The role(s) to exclude.

Alias
Required False
Pipeline false
Default Value
-Login

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

Alias
Required False
Pipeline false
Default Value
-ExcludeFixedRole

Filter the fixed server-level roles. Only applies to SQL Server 2017 that supports creation of server-level roles.

Alias
Required False
Pipeline false
Default Value False
-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.

Alias
Required False
Pipeline false
Default Value False

 

Want to see the source code for this command? Check out Get-DbaServerRoleMember on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaServerRoleMember.