Configuration

Set-sqmConfig

Persists one or more sqmSQLTool module configuration values, log path, output path, Ola job names, TSM management classes, HPU domain group map, SSRS installer path, and more, to a JSON file in the user profile. Read back at runtime by Get-sqmConfig.

Module: sqmSQLTool

Requires: none

ShouldProcess: No

Output: PSCustomObject

Execution Flow

Only supplied parameters overwrite existing values, unspecified keys are preserved from the current config. Read the active configuration with Get-sqmConfig. The config file is stored per-user in %USERPROFILE%\.sqmSQLTool\config.json.

Parameters

Parameter	Type	Required	Description
-LogPath	String	Optional	Directory for log files used by `Invoke-sqmLogging`.
-OutputPath	String	Optional	Default output directory for reports.
-CentralPath	String	Optional	Optional central storage for additional report copies.
-OlaJobNameFull	String	Optional	Name of the Ola FULL backup job for user databases.
-OlaJobNameDiff	String	Optional	Name of the Ola DIFF backup job for user databases.
-OlaJobNameLog	String	Optional	Name of the Ola LOG backup job for user databases.
-OlaJobNameIndexOpt	String	Optional	Name of the Ola IndexOptimize job.
-OlaJobNameIntUserDb	String	Optional	Name of the Ola IntegrityCheck (user databases) job.
-OlaJobNameIntSysDb	String	Optional	Name of the Ola IntegrityCheck (system databases) job.
-OlaJobNameSysDbBackup	String	Optional	Name of the Ola system database FULL backup job.
-TsmManagementClasses	String[]	Optional	Valid TSM management class names (e.g. `MC_B_NL.NL_42.42.NA`).
-HpuDomainGroupMap	PSCustomObject[]	Optional	Array of `{DomainPattern, GroupNamePattern}` objects evaluated in order by `Get-sqmHpuAllowGroup`.
-SsrsInstallerPath	String	Optional	UNC or local path to the SSRS installer, used as default by `Install-sqmSsrsReportServer`.
-AutoUpdate	bool	Optional	See Set-sqmConfig -? for details.
-CheckCostThresholdMin	int	Optional	Mindestwert fuer Cost Threshold for Parallelism im Setup-Check. Standard: 50
-CheckDiskBlockSize	int	Optional	Empfohlene NTFS-Blockgroesse in Bytes fuer Get-sqmDiskBlockSize. Standard: 65536 (64 KB)
-CheckProfile	string	Optional	Check-Profil fuer Invoke-sqmSetupReport und verwandte Checks. Auto = FI-TS-Checks nur wenn sqmIsFitsEnvironment erkannt (Standard) FiTs = FI-TS-Checks immer erzwingen (auch ausserhalb der Domaene) Generic = nur Standard-Checks, keine FI-TS-spezifischen Pruefungen
-CheckTempDbMaxFiles	int	Optional	Maximale TempDB-Dateianzahl im Setup-Check. Standard: 8
-DefaultPolicy	string	Optional	See Set-sqmConfig -? for details.
-DiskFreeSpaceThresholdPct	int	Optional	Schwellwert (in Prozent) fuer den freien Speicherplatz auf Laufwerken. Laufwerke unterhalb dieses Schwellwerts werden als kritisch markiert und die benoetigte Erweiterung wird automatisch berechnet. Standard: 10 (10 %)
-InstallSourcePath	string	Optional	Locator zur Installationsquelle: Repository-Name (PSGallery), UNC-Pfad, 'owner/repo' (GitHub) bzw. lokaler Pfad (LocalDir).
-InstallSourceType	string	Optional	Typ der zuletzt verwendeten Installationsquelle fuer das Auto-Update: 'PSGallery' \| 'UNC' \| 'GitHub' \| 'LocalDir'. Wird normalerweise von Install.ps1 automatisch gesetzt. Das quellenbewusste Auto-Update bevorzugt diese Quelle.
-Language	string	Optional	Output language of the module. Allowed values: de-DE, en-US. Default: de-DE. Example: Set-sqmConfig -Language en-US
-PassThru	switch	Optional	Returns the updated configuration as an object.
-UpdateRepository	string	Optional	See Set-sqmConfig -? for details.

Return Value

Returns a PSCustomObject representing the full saved configuration after applying the supplied changes.

Examples

Example 1, Set log and output paths

Set-sqmConfig -LogPath "C:\Logs\sqmSQLTool" -OutputPath "C:\Reports"

Example 2, Override Ola job names

Set-sqmConfig -OlaJobNameFull "OlaHH-FULL" -OlaJobNameLog "OlaHH-LOG"

Example 3, Configure HPU domain group mapping

Set-sqmConfig -HpuDomainGroupMap @(
    [PSCustomObject]@{ DomainPattern = 'firma.de';   GroupNamePattern = 'Fg_DC_AllowAudit_Mod' },
    [PSCustomObject]@{ DomainPattern = '*';           GroupNamePattern = 'Rg_DC_AllowAudit_Mod' }
)

⬆ Index

All Commands