< Back
Export-DbaCredential
Post
NAME Export-DbaCredential
SYNOPSIS
Exports credentials INCLUDING PASSWORDS, unless specified otherwise, to sql file.
SYNTAX
Export-DbaCredential [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-Identity]
<System.String[]>] [[-SqlCredential] <Pscredential>] [[-Credential] <Pscredential>] [[-Path] <String>]
[[-FilePath] <String>] [-ExcludePassword <Switch>] [-Append <Switch>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.Credential[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Exports credentials 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 credentials. 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 SQL credential without any sensitive information.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-FilePath [<String>]
The specific path to a file which will contain the output.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Identity [<System.String[]>]
The credentials to export. If unspecified, all credentials will be exported.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Credential[]>]
Allow credentials to be piped in from Get-DbaCredential
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
The path to the directory that will contain the exported sql file.
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.
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: Credential
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-DbaCredential -SqlInstance sql2017 -Path C:\\temp\\cred.sql
Exports credentials, including passwords, from sql2017 to the file C:\\temp\\cred.sql
RELATED LINKS
SYNOPSIS
Exports credentials INCLUDING PASSWORDS, unless specified otherwise, to sql file.
SYNTAX
Export-DbaCredential [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-Identity]
<System.String[]>] [[-SqlCredential] <Pscredential>] [[-Credential] <Pscredential>] [[-Path] <String>]
[[-FilePath] <String>] [-ExcludePassword <Switch>] [-Append <Switch>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.Credential[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Exports credentials 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 credentials. 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 SQL credential without any sensitive information.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-FilePath [<String>]
The specific path to a file which will contain the output.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Identity [<System.String[]>]
The credentials to export. If unspecified, all credentials will be exported.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Credential[]>]
Allow credentials to be piped in from Get-DbaCredential
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
The path to the directory that will contain the exported sql file.
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.
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: Credential
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-DbaCredential -SqlInstance sql2017 -Path C:\\temp\\cred.sql
Exports credentials, including passwords, from sql2017 to the file C:\\temp\\cred.sql
RELATED LINKS