Import-DbatoolsConfig

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

Synopsis

Imports a json configuration file into the configuration system.

Description

Imports a json configuration file into the configuration system.

Syntax

Import-DbatoolsConfig -Path <String[]>
    [-IncludeFilter <String[]>]
    [-ExcludeFilter <String[]>]
    [-Peek]
    [-EnableException]
    [<CommonParameters>]

Import-DbatoolsConfig -ModuleName <String>
    [-ModuleVersion <Int32>]
    [-Scope {UserDefault | UserMandatory | SystemDefault | SystemMandatory | FileUserLocal | FileUserShared | FileSystem}]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Import-DbatoolsConfig -Path '.\config.json'

Imports the configuration stored in '.\config.json'

Example: 2

PS C:\> Import-DbatoolsConfig -ModuleName message

Imports all the module specific settings that have been persisted in any of the default file system paths.

Required Parameters

-Path

The path to the json file to import.

-ModuleName

Import configuration items specific to a module from the default configuration paths.

Optional Parameters

-ModuleVersion

The configuration version of the module-settings to load.

-Scope

Where to import the module specific configuration items form. Only file-based scopes are supported for this. By default, all locations are queried, with user settings beating system settings.

-IncludeFilter

If specified, only elements with names that are similar (-like) to names in this list will be imported.

-ExcludeFilter

Elements that are similar (-like) to names in this list will not be imported.

-Peek

Rather than applying the setting, return the configuration items that would have been applied.

-EnableException

This parameters disables user-friendly warnings and enables the throwing of exceptions. This is less user friendly, but allows catching exceptions in calling scripts.