Kernel::System::SupportBundleGenerator - support bundle generator
All support bundle generator functions.
Don't use the constructor directly, use the ObjectManager instead:
my $SupportBundleGeneratorObject = $Kernel::OM->Get('Kernel::System::SupportBundleGenerator');
Generates a support bundle .tar
or .tar.gz
with the following contents: Registration Information, Support Data, Installed Packages, and another .tar
or .tar.gz
with all changed or new files in the OTRS installation directory.
my $Result = $SupportBundleGeneratorObject->Generate();
Returns:
$Result = { Success => 1, # Or false, in case of an error Data => { Filecontent => \$Tar, # Outer tar content reference Filename => 'SupportBundle.tar', # The outer tar filename Filesize => 123 # The size of the file in mega bytes },
Generates a .tar
or .tar.gz
file with all eligible changed or added files taking the ARCHIVE file as a reference
my ( $Content, $Filename ) = $SupportBundleGeneratorObject->GenerateCustomFilesArchive();
Returns:
$Content = $FileContentsRef; $Filename = 'application.tar'; # or 'application.tar.gz'
Generates a .csv file with all installed packages
my ( $Content, $Filename ) = $SupportBundleGeneratorObject->GeneratePackageList();
Returns: $Content = $FileContentsRef; $Filename = 'InstalledPackages.csv';
Generates a .json
file with the otrs system registration information
my ( $Content, $Filename ) = $SupportBundleGeneratorObject->GenerateRegistrationInfo();
Returns:
$Content = $FileContentsRef; $Filename = 'RegistrationInfo.json';
Generates a <.yml> file with the otrs system registration information
my ( $Content, $Filename ) = $SupportBundleGeneratorObject->GenerateConfigurationDump();
Returns: $Content = $FileContentsRef; $Filename = <'ModifiedSettings.yml'>;
Generates a .json
file with the support data
my ( $Content, $Filename ) = $SupportBundleGeneratorObject->GenerateSupportData();
Returns:
$Content = $FileContentsRef; $Filename = 'GenerateSupportData.json';
This software is part of the OTRS project (https://otrs.org/).
This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (GPL). If you did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.