commands

^

New-DbatoolsSupportPackage

Author Friedrich Weinmann (@FredWeinmann)
Availability Windows only

 

Synopsis

Creates a package of troubleshooting information that can be used by dbatools to help debug issues.

Description

This function creates an extensive debugging package that can help with reproducing and fixing issues.

The file will be created on the desktop by default and will contain quite a bit of information:

  • OS Information
  • Hardware Information (CPU, Ram, things like that)
  • .NET Information
  • PowerShell Information
  • Your input history
  • The In-Memory message log
  • The In-Memory error log
  • Screenshot of the console buffer (Basically, everything written in your current console, even if you have to scroll upwards to see it.

Syntax

New-DbatoolsSupportPackage
    [[-Path] <String>]
    [[-Variables] <String[]>]
    [-PassThru]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> New-DbatoolsSupportPackage

Creates a large support pack in order to help us troubleshoot stuff.

Optional Parameters

-Path

The folder where to place the output xml in.

Alias
Required False
Pipeline false
Default Value "$($env:USERPROFILE)\Desktop"
-Variables

Name of additional variables to attach. This allows you to add the content of variables to the support package, if you believe them to be relevant to the case.

Alias
Required False
Pipeline false
Default Value
-PassThru

Returns file object that was created during execution.

Alias
Required False
Pipeline false
Default Value False
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Alias cf
Required False
Pipeline false
Default Value

 

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