On this page: Synopsis · Description · Syntax · Examples · Parameters · Outputs
Sets configuration entries.
This function creates or changes configuration values. These can be used to provide dynamic configuration information outside the PowerShell variable system.
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>]
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>
-FullName Property Value Alias Required True Pipeline false Default Value
-Name Property Value Alias Required True Pipeline false Default Value
-PersistedValue Property Value Alias Required True Pipeline false Default Value
-Default Property Value Alias Required False Pipeline false Default Value
-Description Property Value Alias Required False Pipeline false Default Value
-DisableHandler Property Value Alias Required False Pipeline false Default Value
-DisableValidation Property Value Alias Required False Pipeline false Default Value
-EnableException Property Value Alias Required False Pipeline false Default Value
-Handler Property Value Alias Required False Pipeline false Default Value
-Hidden Property Value Alias Required False Pipeline false Default Value
-Initialize Property Value Alias Required False Pipeline false Default Value
-Module Property Value Alias Required False Pipeline false Default Value
-ModuleExport Property Value Alias Required False Pipeline false Default Value
-PassThru Property Value Alias Required False Pipeline false Default Value
-PersistedType Property Value Alias Required False Pipeline false Default Value
-Register Property Value Alias Required False Pipeline false Default Value
-SimpleExport Property Value Alias Required False Pipeline false Default Value
-Validation Property Value Alias Required False Pipeline false Default Value
-Value Property Value Alias Required False Pipeline false Default Value
returnValue
———– @{type=}
dbatools