Export-DbatoolsConfig View Source Friedrich Weinmann (@FredWeinmann) Windows, Linux, macOS On this page: Synopsis · Description · Syntax · Examples · Parameters · Outputs Synopsis Exports dbatools module configuration settings to a JSON file for backup or migration.
Description Exports dbatools configuration settings to a JSON file, allowing you to backup your current settings or migrate them to other machines. This function captures customized settings like connection timeouts, default database paths, and other module preferences that have been changed from their default values.
Find-DbaCommand View Source Simone Bizzotto (@niphlod) Windows, Linux, macOS On this page: Synopsis · Description · Syntax · Examples · Parameters · Outputs Synopsis Finds dbatools commands searching through the inline help text
Description Finds dbatools commands searching through the inline help text, building a consolidated json index and querying it because Get-Help is too slow
Syntax Find-DbaCommand [[-Pattern] <String>] [[-Tag] <String[]>] [[-Author] <String>] [[-MinimumVersion] <String>] [[-MaximumVersion] <String>] [-Rebuild] [-EnableException] [-WhatIf] [-Confirm] [<CommonParameters>] Examples Example: 1 PS C:\> Find-DbaCommand "snapshot" For lazy typers: finds all commands searching the entire help for “snapshot”
Get-DbatoolsChangeLog View Source Chrissy LeMaire (@cl), netnerds.net Windows, Linux, macOS On this page: Synopsis · Description · Syntax · Examples · Parameters · Outputs Synopsis Opens the dbatools release changelog in your default browser
Description Launches your default browser to view the dbatools release changelog on GitHub. This provides access to version history, new features, bug fixes, and breaking changes for the dbatools PowerShell module. Useful for staying current with module updates or troubleshooting issues that may be related to recent changes.
Get-DbatoolsConfig View Source Friedrich Weinmann (@FredWeinmann) Windows, Linux, macOS On this page: Synopsis · Description · Syntax · Examples · Parameters · Outputs Synopsis Retrieves dbatools module configuration settings and preferences.
Description Retrieves dbatools module configuration settings that control how dbatools functions behave. These settings include connection timeouts, default paths, email configurations, and other module preferences that affect dbatools operations. Use this command to view current settings, troubleshoot dbatools behavior, or identify what configurations are available for customization with Set-DbatoolsConfig.
Get-DbatoolsConfigValue View Source Friedrich Weinmann (@FredWeinmann) Windows, Linux, macOS On this page: Synopsis · Description · Syntax · Examples · Parameters · Outputs Synopsis Retrieves a specific dbatools configuration value by its exact name.
Description Retrieves the actual value stored in a specific dbatools configuration setting using its full name (Module.Name format). This function is primarily used internally by dbatools functions to access their configuration settings, but can also be used by DBAs in custom scripts to retrieve specific module preferences like connection timeouts, default file paths, or email settings.
Get-DbatoolsError View Source Chrissy LeMaire (@cl) Windows, Linux, macOS On this page: Synopsis · Description · Syntax · Examples · Parameters · Outputs Synopsis Retrieves detailed error information from failed dbatools commands for troubleshooting
Description Retrieves detailed error information specifically from dbatools command failures, filtering the PowerShell error collection to show only dbatools-related errors. This provides comprehensive diagnostic details including exception messages, stack traces, and invocation information that help troubleshoot SQL Server connection issues, permission problems, or command syntax errors.
Get-DbatoolsLog View Source Friedrich Weinmann (@FredWeinmann) Windows, Linux, macOS On this page: Synopsis · Description · Syntax · Examples · Parameters · Outputs Synopsis Retrieves internal log entries and error messages from dbatools module execution
Description Retrieves log entries from dbatools’ internal logging system, allowing you to troubleshoot command execution and track what happened during script runs. Use this when dbatools commands aren’t behaving as expected or when you need to see detailed execution information for debugging purposes.
Invoke-DbatoolsFormatter View Source Simone Bizzotto Windows, Linux, macOS On this page: Synopsis · Description · Syntax · Examples · Parameters · Outputs Synopsis Formats PowerShell function files to dbatools coding standards
Description Applies consistent code formatting to PowerShell files using PSScriptAnalyzer’s Invoke-Formatter with OTBS (One True Brace Style) settings. This function standardizes indentation, brace placement, and whitespace handling across all dbatools module files, ensuring code consistency for contributors and maintainers.
Invoke-DbatoolsRenameHelper View Source Chrissy LeMaire (@cl), netnerds.net Windows, Linux, macOS On this page: Synopsis · Description · Syntax · Examples · Parameters · Outputs Synopsis Updates PowerShell scripts to replace deprecated dbatools command and parameter names with current equivalents.
Description Automatically scans and updates PowerShell script files to replace old dbatools command names and parameter names that have been renamed over time. This function searches through your scripts for over 200 deprecated command names and dozens of parameter renames, then updates the file content with the current naming conventions.
dbatools