< Back
New-PSFSupportPackage
Post
NAME New-PSFSupportPackage
SYNOPSIS
Creates a package of troubleshooting information that can be used by developers to help debug issues.
SYNTAX
New-PSFSupportPackage [[-Path] <String>] [[-Include] {None | Message | ErrorMessage | Messages | Screenshot |
OperatingSystem | CPU | Ram | Environment | PSVersion | History | Module | SnapIns | Assemblies | PSResource |
Exceptions | Critical | ExtensionData | All}] [[-Exclude] {None | Message | ErrorMessage | Messages | Screenshot |
OperatingSystem | CPU | Ram | Environment | PSVersion | History | Module | SnapIns | Assemblies | PSResource |
Exceptions | Critical | ExtensionData | All}] [[-Variables] <String[]>] [-ExcludeError] [-EnableException]
[<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
-Path <String>
The folder where to place the output xml in.
Defaults to your desktop.
Required? false
Position? 1
Default value "$($env:USERPROFILE)\\Desktop"
Accept pipeline input? false
Accept wildcard characters? false
-Include
What to include in the export.
By default, all is included.
Required? false
Position? 2
Default value All
Accept pipeline input? false
Accept wildcard characters? false
-Exclude
Anything not to include in the export.
Use this to explicitly exclude content you do not wish to be part of the dump (for example for data protection
reasons).
Required? false
Position? 3
Default value None
Accept pipeline input? false
Accept wildcard characters? false
-Variables <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? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ExcludeError [<SwitchParameter>]
By default, the content of $Error is included, as it often can be helpful in debugging, even with error
handling using the message system.
However, there can be rare instances where this will explode the total export size to gigabytes, in which case
it becomes necessary to skip this.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableException [<SwitchParameter>]
This parameters disables user-friendly warnings and enables the throwing of exceptions.
This is less user friendly, but allows catching exceptions in calling scripts.
Required? false
Position? named
Default value False
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-PSFSupportPackage
Creates a large support pack in order to help us troubleshoot stuff.
RELATED LINKS
SYNOPSIS
Creates a package of troubleshooting information that can be used by developers to help debug issues.
SYNTAX
New-PSFSupportPackage [[-Path] <String>] [[-Include] {None | Message | ErrorMessage | Messages | Screenshot |
OperatingSystem | CPU | Ram | Environment | PSVersion | History | Module | SnapIns | Assemblies | PSResource |
Exceptions | Critical | ExtensionData | All}] [[-Exclude] {None | Message | ErrorMessage | Messages | Screenshot |
OperatingSystem | CPU | Ram | Environment | PSVersion | History | Module | SnapIns | Assemblies | PSResource |
Exceptions | Critical | ExtensionData | All}] [[-Variables] <String[]>] [-ExcludeError] [-EnableException]
[<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
-Path <String>
The folder where to place the output xml in.
Defaults to your desktop.
Required? false
Position? 1
Default value "$($env:USERPROFILE)\\Desktop"
Accept pipeline input? false
Accept wildcard characters? false
-Include
What to include in the export.
By default, all is included.
Required? false
Position? 2
Default value All
Accept pipeline input? false
Accept wildcard characters? false
-Exclude
Anything not to include in the export.
Use this to explicitly exclude content you do not wish to be part of the dump (for example for data protection
reasons).
Required? false
Position? 3
Default value None
Accept pipeline input? false
Accept wildcard characters? false
-Variables <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? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ExcludeError [<SwitchParameter>]
By default, the content of $Error is included, as it often can be helpful in debugging, even with error
handling using the message system.
However, there can be rare instances where this will explode the total export size to gigabytes, in which case
it becomes necessary to skip this.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableException [<SwitchParameter>]
This parameters disables user-friendly warnings and enables the throwing of exceptions.
This is less user friendly, but allows catching exceptions in calling scripts.
Required? false
Position? named
Default value False
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-PSFSupportPackage
Creates a large support pack in order to help us troubleshoot stuff.
RELATED LINKS