< Back

Export-DbaLinkedServer

Mon Jan 13, 2020 9:55 am

NAME Export-DbaLinkedServer



SYNOPSIS

Exports linked servers INCLUDING PASSWORDS, unless specified otherwise, to sql file.





SYNTAX

Export-DbaLinkedServer [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>

[[-LinkedServer] <System.String[]>] [[-SqlCredential] <Pscredential>] [[-Credential] <Pscredential>] [[-Path]

<String>] [[-FilePath] <String>] [-ExcludePassword <Switch>] [-Append <Switch>] [[-InputObject]

<Microsoft.SqlServer.Management.Smo.LinkedServer[]>] [-EnableException <Switch>] [<CommonParameters>]





DESCRIPTION

Exports linked servers INCLUDING PASSWORDS, unless specified otherwise, to sql file.



Requires remote Windows access if exporting the password.





PARAMETERS

-Append [<Switch>]

Append to Path



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Credential [<Pscredential>]

Login to the target OS using alternative linked servers. Accepts credential objects (Get-Credential)



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



-ExcludePassword [<Switch>]

Exports the linked server without any sensitive information.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-FilePath [<String>]

Specifies the full file path of the output file.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-InputObject [<Microsoft.SqlServer.Management.Smo.LinkedServer[]>]

Allow credentials to be piped in from Get-DbaLinkedServer



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-LinkedServer [<System.String[]>]

The linked server(s) to export. If unspecified, all linked servers will be processed.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Path [<String>]

Specifies the directory where the file or files will be exported.



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

Source SQL Server. You must have sysadmin access and 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: LinkedServer

Author: Chrissy LeMaire (@cl), netnerds.net



Website: https://dbatools.io

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

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



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



PS C:\\>Export-DbaLinkedServer -SqlInstance sql2017 -Path C:\\temp\\ls.sql



Exports the linked servers, including passwords, from sql2017 to the file C:\\temp\\ls.sql

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



PS C:\\>Export-DbaLinkedServer -SqlInstance sql2017 -Path C:\\temp\\ls.sql -ExcludePassword



Exports the linked servers, without passwords, from sql2017 to the file C:\\temp\\ls.sql



RELATED LINKS