Get-DbaDbccUserOption

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

Synopsis

Execution of Database Console Command DBCC USEROPTIONS

Description

Returns the results of DBCC USEROPTIONS

Read more:
- https://docs.microsoft.com/en-us/sql/t-sql/database-console-commands/dbcc-useroptions-transact-sql

Syntax

Get-DbaDbccUserOption
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Option] <String[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaDbccUserOption -SqlInstance Server1

Get results of DBCC USEROPTIONS for Instance Server1

Example: 2

PS C:\> 'Sql1','Sql2/sqlexpress' | Get-DbaDbccUserOption

Get results of DBCC USEROPTIONS for Instances Sql1 and Sql2/sqlexpress

Example: 3

PS C:\> $cred = Get-Credential sqladmin
PS C:\> Get-DbaDbccUserOption -SqlInstance Server1 -SqlCredential $cred

Connects using sqladmin credential and gets results of DBCC USEROPTIONS for Instance Server1

Example: 4

PS C:\> Get-DbaDbccUserOption -SqlInstance Server1 -Option ansi_nulls, ansi_warnings, datefirst

Gets results of DBCC USEROPTIONS for Instance Server1. Only display results for the options ansi_nulls, ansi_warnings, datefirst

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

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.

-Option

Return only specific options. Returns all results if not specified.
Accepts any values in set 'ansi_null_dflt_on', 'ansi_nulls', 'ansi_padding', 'ansi_warnings', 'arithabort', 'concat_null_yields_null', 'datefirst', 'dateformat', 'isolation level', 'language',
'lock_timeout', 'quoted_identifier', 'textsize'

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