< Back
New-DbatoolsSupportPackage
Post
NAME New-DbatoolsSupportPackage
SYNOPSIS
Creates a package of troubleshooting information that can be used by dbatools to help debug issues.
SYNTAX
New-DbatoolsSupportPackage [[-Path] <String>] [[-Variables] <System.String[]>] [-PassThru <Switch>]
[-EnableException <Switch>] [<CommonParameters>]
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.
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<Switch>]
Returns file object that was created during execution.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
The folder where to place the output xml in.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Variables [<System.String[]>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Module, Support
Author: Friedrich Weinmann (@FredWeinmann)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbatoolsSupportPackage
Creates a large support pack in order to help us troubleshoot stuff.
RELATED LINKS
https://dbatools.io/New-DbatoolsSupportPackage
SYNOPSIS
Creates a package of troubleshooting information that can be used by dbatools to help debug issues.
SYNTAX
New-DbatoolsSupportPackage [[-Path] <String>] [[-Variables] <System.String[]>] [-PassThru <Switch>]
[-EnableException <Switch>] [<CommonParameters>]
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.
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<Switch>]
Returns file object that was created during execution.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
The folder where to place the output xml in.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Variables [<System.String[]>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Module, Support
Author: Friedrich Weinmann (@FredWeinmann)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbatoolsSupportPackage
Creates a large support pack in order to help us troubleshoot stuff.
RELATED LINKS
https://dbatools.io/New-DbatoolsSupportPackage