< Back
Export-DbaRegServer
Post
NAME Export-DbaRegServer
SYNOPSIS
Exports registered servers and registered server groups to file
SYNTAX
Export-DbaRegServer [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-InputObject] <System.Object[]>] [[-Path] <String>] [[-FilePath] <String>]
[[-CredentialPersistenceType] <String>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Exports registered servers and registered server groups to file
PARAMETERS
-CredentialPersistenceType [<String>]
Used to specify how the login and passwords are persisted. Valid values include None, PersistLoginName and
PersistLoginNameAndPassword.
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
-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 [<System.Object[]>]
Enables piping from Get-DbaRegServer, Get-DbaRegServerGroup, CSVs and other objects.
If importing from CSV or other object, a column named ServerName is required. Optional columns include Name,
Description and Group.
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[]>]
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: RegisteredServer, CMS
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-DbaRegServer -SqlInstance sql2008
Exports all Registered Server and Registered Server Groups on sql2008 to an automatically generated file name in
the current directory
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sql2008, sql2012 | Export-DbaRegServer
Exports all registered servers on sql2008 and sql2012. Warning - each one will have its own individual file.
Consider piping groups.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sql2008, sql2012 | Export-DbaRegServer
Exports all registered servers on sql2008 and sql2012, organized by group.
RELATED LINKS
https://dbatools.io/Export-DbaRegServer
SYNOPSIS
Exports registered servers and registered server groups to file
SYNTAX
Export-DbaRegServer [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-InputObject] <System.Object[]>] [[-Path] <String>] [[-FilePath] <String>]
[[-CredentialPersistenceType] <String>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Exports registered servers and registered server groups to file
PARAMETERS
-CredentialPersistenceType [<String>]
Used to specify how the login and passwords are persisted. Valid values include None, PersistLoginName and
PersistLoginNameAndPassword.
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
-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 [<System.Object[]>]
Enables piping from Get-DbaRegServer, Get-DbaRegServerGroup, CSVs and other objects.
If importing from CSV or other object, a column named ServerName is required. Optional columns include Name,
Description and Group.
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[]>]
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: RegisteredServer, CMS
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-DbaRegServer -SqlInstance sql2008
Exports all Registered Server and Registered Server Groups on sql2008 to an automatically generated file name in
the current directory
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sql2008, sql2012 | Export-DbaRegServer
Exports all registered servers on sql2008 and sql2012. Warning - each one will have its own individual file.
Consider piping groups.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sql2008, sql2012 | Export-DbaRegServer
Exports all registered servers on sql2008 and sql2012, organized by group.
RELATED LINKS
https://dbatools.io/Export-DbaRegServer