Support

Get-DbatoolsError

Chrissy LeMaire (@cl)

Get-DbatoolsError View Source Chrissy LeMaire (@cl) Windows, Linux, macOS 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. By default, it returns only the most recent dbatools error, but can retrieve all historical dbatools errors for pattern analysis or support requests.

Get-DbatoolsLog

Friedrich Weinmann (@FredWeinmann)

Get-DbatoolsLog View Source Friedrich Weinmann (@FredWeinmann) Windows, Linux, macOS 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. The function can filter logs by specific functions, modules, targets, execution history, or message levels, making it easier to isolate issues during SQL Server automation tasks.

Invoke-DbatoolsFormatter

Simone Bizzotto

Invoke-DbatoolsFormatter View Source Simone Bizzotto Windows, Linux, macOS 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. Files are saved without BOM encoding and with proper line ending handling for cross-platform compatibility.

Measure-DbatoolsImport

Chrissy LeMaire (@cl), netnerds.net

Measure-DbatoolsImport View Source Chrissy LeMaire (@cl), netnerds.net Windows, Linux, macOS Synopsis Measures and displays detailed timing metrics for dbatools module import operations Description Returns performance data collected during the dbatools module import process, showing the duration of each import step. This function helps troubleshoot slow module loading times by identifying which components take the longest to initialize. The timing data includes loading the dbatools library, type aliases, internal commands, external commands, and other initialization steps.

New-DbatoolsSupportPackage

Friedrich Weinmann (@FredWeinmann)

New-DbatoolsSupportPackage View Source Friedrich Weinmann (@FredWeinmann) Windows, Linux, macOS Synopsis Creates a comprehensive diagnostic package for troubleshooting dbatools module issues and bugs. Description This function creates an extensive diagnostic package specifically designed to help the dbatools team troubleshoot module-related issues, bugs, or unexpected behavior. When you encounter problems with dbatools commands or need to submit a bug report, this package provides all the environmental and runtime information needed for effective debugging.