commands

^

Get-DbaLinkedServerLogin

Author Adam Lancaster https://github.com/lancasteradam
Availability Windows, Linux, macOS

 

Synopsis

Obtains linked server login(s).

Description

Obtains linked server login(s).

Syntax

Get-DbaLinkedServerLogin
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-LinkedServer] <String[]>]
    [[-LocalLogin] <String[]>]
    [[-ExcludeLocalLogin] <String[]>]
    [[-InputObject] <Object[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaLinkedServerLogin -SqlInstance sql01 -LinkedServer linkedServer1 -LocalLogin login1

Gets the linked server login "login1" from the linked server "linkedServer1" on sql01.

Example: 2
PS C:\> Get-DbaLinkedServerLogin -SqlInstance sql01 -LinkedServer linkedServer1 -ExcludeLocalLogin login2

Gets the linked server login(s) from the linked server "linkedServer1" on sql01 and excludes the login2 linked server login.

Example: 3
PS C:\> (Get-DbaLinkedServer -SqlInstance sql01 -LinkedServer linkedServer1) | Get-DbaLinkedServerLogin -LocalLogin login1

Gets the linked server login "login1" from the linked server "linkedServer1" on sql01 using a pipeline with the linked server passed in.

Example: 4
PS C:\> (Connect-DbaInstance -SqlInstance sql01) | Get-DbaLinkedServerLogin -LinkedServer linkedServer1 -LocalLogin login1

Gets the linked server login "login1" from the linked server "linkedServer1" on sql01 using a pipeline with the instance passed in.

Optional 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 False
Pipeline false
Default Value
-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
Required False
Pipeline false
Default Value
-LinkedServer

The name(s) of the linked server(s).

Alias
Required False
Pipeline false
Default Value
-LocalLogin

The name(s) of the linked server login(s) to include.

Alias
Required False
Pipeline false
Default Value
-ExcludeLocalLogin

The name(s) of the linked server login(s) to exclude

Alias
Required False
Pipeline false
Default Value
-InputObject

Allows piping from Connect-DbaInstance and Get-DbaLinkedServer

Alias
Required False
Pipeline true (ByValue)
Default Value
-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
-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command.

Alias cf
Required False
Pipeline false
Default Value

 

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