Get‑SqlDscConfigurationOption

SYNOPSIS

Get server configuration option.

SYNTAX

Get-SqlDscConfigurationOption [-ServerObject] <Server> [[-Name] <String>] [-Refresh]
 [<CommonParameters>]

DESCRIPTION

This command gets the available configuration options from a SQL Server Database Engine instance.

EXAMPLES

EXAMPLE 1

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$sqlServerObject | Get-SqlDscConfigurationOption

Get all the available configuration options.

EXAMPLE 2

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$sqlServerObject | Get-SqlDscConfigurationOption -Name '*threshold*'

Get the configuration options that contains the word threshold.

PARAMETERS

-Name

Specifies the name of the configuration option to get.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Refresh

Specifies that the ServerObject's configuration property should be refreshed before trying get the available configuration options. This is helpful when run values or configuration values have been modified outside of the specified ServerObject.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ServerObject

Specifies current server connection object.

Type: Server
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

[Microsoft.SqlServer.Management.Smo.ConfigProperty[]]

NOTES

RELATED LINKS