Export-DbaSpConfigure

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

Synopsis

Exports advanced sp_configure global configuration options to sql file.

Description

Exports advanced sp_configure global configuration options to sql file.

Syntax

Export-DbaSpConfigure
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Path] <String>]
    [[-FilePath] <String>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Export-DbaSpConfigure -SqlInstance sourceserver

Exports the SPConfigure settings on sourceserver. As no Path was defined outputs to My Documents folder with default name format of Servername-MMDDYYYYhhmmss-sp_configure.sql

Example: 2

PS C:\> Export-DbaSpConfigure -SqlInstance sourceserver -Path C:\temp

Exports the SPConfigure settings on sourceserver to the directory C:\temp using the default name format

Example: 3

PS C:\> $cred = Get-Credential sqladmin
PS C:\> Export-DbaSpConfigure -SqlInstance sourceserver -SqlCredential $cred -Path C:\temp\sp_configure.sql

Exports the SPConfigure settings on sourceserver to the file C:\temp\sp_configure.sql. Uses SQL Authentication to connect. Will require SysAdmin rights if needs to set 'show advanced options'

Example: 4

PS C:\> 'Server1', 'Server2' | Export-DbaSpConfigure -Path C:\temp\configure.sql

Exports the SPConfigure settings for Server1 and Server2 using pipeline. As more than 1 Server adds prefix of Servername and date to the file name and saves to file like
C:\temp\Servername-MMDDYYYYhhmmss-configure.sql

Required Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input.
You must have sysadmin access if needs to set 'show advanced options' to 1 and server version must be SQL Server version 2005 or higher.

Optional Parameters

-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.

-Path

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

-FilePath

Specifies the full file path of the output file.

-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.