Export-DbaRepServerSetting


Author	Chrissy LeMaire (@cl), netnerds.net
Availability	Windows, Linux, macOS

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

Synopsis

Exports replication server settings to file.

Description

Exports replication server settings to file.

All replication commands need SQL Server Management Studio installed and are therefore currently not supported. Have a look at this issue to get more information: https://github.com/dataplat/dbatools/issues/7428

Syntax

Export-DbaRepServerSetting
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Path] <String>]
    [[-FilePath] <String>]
    [[-ScriptOption] <Object[]>]
    [[-InputObject] <Object[]>]
    [[-Encoding] <String>]
    [-Passthru]
    [-NoClobber]
    [-Append]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Export-DbaRepServerSetting -SqlInstance sql2017 -Path C:\temp\replication.sql

Exports the replication settings on sql2017 to the file C:\temp\replication.sql

Example: 2

PS C:\> Get-DbaRepServer -SqlInstance sql2017 | Export-DbaRepServerSettings -Path C:\temp\replication.sql

Exports the replication settings on sql2017 to the file C:\temp\replication.sql

Optional Parameters

-SqlInstance

The target SQL Server instance or 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

-Path

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


Alias
Required	False
Pipeline	false
Default Value	(Get-DbatoolsConfigValue -FullName 'Path.DbatoolsExport')

-FilePath

Specifies the full file path of the output file.


Alias	OutFile,FileName
Required	False
Pipeline	false
Default Value

-ScriptOption

Not real sure how to use this yet


Alias
Required	False
Pipeline	false
Default Value

-InputObject

Allows piping from Get-DbaRepServer


Alias
Required	False
Pipeline	true (ByValue)
Default Value

-Encoding

Specifies the file encoding. The default is UTF8. Valid values are: -- ASCII: Uses the encoding for the ASCII (7-bit) character set. -- BigEndianUnicode: Encodes in UTF-16 format using the big-endian byte order. -- Byte: Encodes a set of characters into a sequence of bytes. -- String: Uses the encoding type for a string. -- Unicode: Encodes in UTF-16 format using the little-endian byte order. -- UTF7: Encodes in UTF-7 format. -- UTF8: Encodes in UTF-8 format. -- Unknown: The encoding type is unknown or invalid. The data can be treated as binary.


Alias
Required	False
Pipeline	false
Default Value	UTF8
Accepted Values	ASCII,BigEndianUnicode,Byte,String,Unicode,UTF7,UTF8,Unknown

-Passthru

Output script to console


Alias
Required	False
Pipeline	false
Default Value	False

-NoClobber

Do not overwrite file


Alias
Required	False
Pipeline	false
Default Value	False

-Append

Append to file


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