< Back
Get-DbatoolsConfig
Post
NAME Get-DbatoolsConfig
SYNOPSIS
Retrieves configuration elements by name.
SYNTAX
Get-DbatoolsConfig [[-FullName] <String>] [-Force <Switch>] [<CommonParameters>]
Get-DbatoolsConfig [[-Name] <String>] [[-Module] <String>] [-Force <Switch>] [<CommonParameters>]
DESCRIPTION
Retrieves configuration elements by name.
Can be used to search the existing configuration list.
PARAMETERS
-Force [<Switch>]
Overrides the default behavior and also displays hidden configuration values.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-FullName [<String>]
Default: "*"
Search for configurations using the full name
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Module [<String>]
Default: "*"
Search configuration by module.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<String>]
Default: "*"
The name of the configuration element(s) to retrieve.
May be any string, supports wildcards.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Module
Author: Friedrich Weinmann (@FredWeinmann)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
SYNOPSIS
Retrieves configuration elements by name.
SYNTAX
Get-DbatoolsConfig [[-FullName] <String>] [-Force <Switch>] [<CommonParameters>]
Get-DbatoolsConfig [[-Name] <String>] [[-Module] <String>] [-Force <Switch>] [<CommonParameters>]
DESCRIPTION
Retrieves configuration elements by name.
Can be used to search the existing configuration list.
PARAMETERS
-Force [<Switch>]
Overrides the default behavior and also displays hidden configuration values.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-FullName [<String>]
Default: "*"
Search for configurations using the full name
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Module [<String>]
Default: "*"
Search configuration by module.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<String>]
Default: "*"
The name of the configuration element(s) to retrieve.
May be any string, supports wildcards.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Module
Author: Friedrich Weinmann (@FredWeinmann)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS