commands

^

Get-DbatoolsConfig

Author Friedrich Weinmann (@FredWeinmann)
Availability Windows, Linux, macOS

 

Synopsis

Retrieves configuration elements by name.

Description

Retrieves configuration elements by name. Can be used to search the existing configuration list.

Syntax

Get-DbatoolsConfig
    [[-FullName] <String>]
    [-Force]
    [<CommonParameters>]

Get-DbatoolsConfig
    [[-Name] <String>]
    [[-Module] <String>]
    [-Force]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbatoolsConfig 'Mail.To'

Retrieves the configuration element for the key "Mail.To"

Example: 2
PS C:\> Get-DbatoolsConfig -Force

Retrieve all configuration elements from all modules, even hidden ones.

Optional Parameters

-FullName

Default: "*" Search for configurations using the full name

Alias
Required False
Pipeline false
Default Value *
-Name

Default: "*" The name of the configuration element(s) to retrieve. May be any string, supports wildcards.

Alias
Required False
Pipeline false
Default Value *
-Module

Default: "*" Search configuration by module.

Alias
Required False
Pipeline false
Default Value *
-Force

Overrides the default behavior and also displays hidden configuration values.

Alias
Required False
Pipeline false
Default Value False

 

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