commands

Clear
^

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

 

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

Synopsis

Sets configuration entries.

Description

This function creates or changes configuration values. These can be used to provide dynamic configuration information outside the PowerShell variable system.

Syntax

Set-DbatoolsConfig -FullName <String>
    [-Value <Object>]
    [-Description <String>]
    [-Validation <String>]
    [-Handler <ScriptBlock>]           
    [-Hidden]
    [-Default]
    [-Initialize]
    [-DisableValidation]
    [-DisableHandler]
    [-EnableException]
    [-SimpleExport]
    [-ModuleExport]           
    [-PassThru]
    [-AllowDelete]
    [<CommonParameters>]            

Set-DbatoolsConfig -FullName <String>
    [-Description <String>]
    [-Validation <String>]
    [-Handler <ScriptBlock>]
    [-Hidden]           
    [-Default]
    [-Initialize]
    [-DisableValidation]
    [-DisableHandler]
    [-EnableException]
    -PersistedValue <String>
    [-PersistedType            <ConfigurationValueType>]
    [-SimpleExport]
    [-ModuleExport]
    [-PassThru]
    [-AllowDelete]
    [<CommonParameters>]            

Set-DbatoolsConfig -Name <String>
    [-Module <String>]
    [-Value <Object>]
    [-Description <String>]
    [-Validation <String>]
    [-Handler            <ScriptBlock>]
    [-Hidden]
    [-Default]
    [-Initialize]
    [-DisableValidation]
    [-DisableHandler]
    [-EnableException]
    [-SimpleExport]           
    [-ModuleExport]
    [-PassThru]
    [-AllowDelete]
    [<CommonParameters>]

 

Examples

 

Example 1: Simple
        C:\PS> Set-DbatoolsConfig -FullName Path.DbatoolsData -Value E:\temp\dbatools<br>
        Updates the configuration entry for Path.DbatoolsData to E:\temp\dbatools<br>

Required Parameters

-FullName
Alias
Required True
Pipeline false
Default Value
-Name
Alias
Required True
Pipeline false
Default Value
-PersistedValue
Alias
Required True
Pipeline false
Default Value

Optional Parameters

-Default
Alias
Required False
Pipeline false
Default Value
-Description
Alias
Required False
Pipeline false
Default Value
-DisableHandler
Alias
Required False
Pipeline false
Default Value
-DisableValidation
Alias
Required False
Pipeline false
Default Value
-EnableException
Alias
Required False
Pipeline false
Default Value
-Handler
Alias
Required False
Pipeline false
Default Value
-Hidden
Alias
Required False
Pipeline false
Default Value
-Initialize
Alias
Required False
Pipeline false
Default Value
-Module
Alias
Required False
Pipeline false
Default Value
-ModuleExport
Alias
Required False
Pipeline false
Default Value
-PassThru
Alias
Required False
Pipeline false
Default Value
-PersistedType
Alias
Required False
Pipeline false
Default Value
-Register
Alias
Required False
Pipeline false
Default Value
-SimpleExport
Alias
Required False
Pipeline false
Default Value
-Validation
Alias
Required False
Pipeline false
Default Value
-Value
Alias
Required False
Pipeline false
Default Value