Generate Reports

SUSE Manager allows the user to produce a variety of reports. These reports can be helpful for taking inventory of your subscribed systems, users, and organizations. Using reports is often simpler than gathering information manually from the SUSE Manager Web UI, especially if you have many systems under management.

While the command line tool spacewalk-report can be used to generate pre-configured reports, with the introduction of the Hub Reporting it is also possible to generate fully customized reports. This can be achieved by connecting any reporting tool that supports the SQL language to the reporting database and extract the data directly. For more information about the data availability and structure, see the reporting database schema documentation.

1. Using spacewalk-report

Use mgrctl term before running steps inside the server container.

To generate reports, you must have the spacewalk-reports package installed. The spacewalk-report command allows you to organize and display reports about content, systems, and user resources across SUSE Manager.

Due to the introduction of Hub Reporting, spacewalk-report now gathers by default the data from the reporting database. See spacewalk-report and the reporting database for more information.

You can generate reports on:

System Inventory

List all the systems registered to SUSE Manager.

Patches

List all the patches relevant to the registered systems. You can sort patches by severity, as well as the systems that apply to a particular patch.

Users

List all registered users and any systems associated with a particular user.

To get the report in CSV format, run this command at the command prompt on the server:

spacewalk-report <report_name>

2. spacewalk-report and the reporting database

spacewalk-report uses by default the new reporting database to extract the data. This means that the new generated reports will have some differences in the structure and the format of the data. The differences common to all reports are:

  • the report data is not changing in real-time, but it’s updated only by the execution of a scheduled task;

  • data duplication has been removed and columns that were previously considered "multival" contain now multiple values separated by ;. This also means that the command line options --multival-on-rows and --multival-separator are no longer applicable to the new reports, as their behavior is now the default;

  • in all reports the new columns mgm_id and synced_date have been introduced to identify the management server in the hub scenario and the last time the information was updated from the application database;

  • all boolean values are now represented by the True/False and not by a 1/0 values;

  • the column org_id has been replaced by organization, which contains the organization name and not the numerical identifier;

  • The term "server" has been replaced by "system." So, for example, the column server_id is now called system_id.

For report specific changes, see List of available reports.

If this changed behavior causes trouble, the new option --legacy-report can be used to fall back to the old report, which is executed against the application database.

For more information about hub reporting, see Hub Reporting.

3. List of available reports

This table lists the available reports:

Table 1. spacewalk-report Reports
Report Invoked as Description Uses reporting database Specific differences

Actions

actions

All actions.

Yes

The column id is now called action_id

Activation Keys

activation-keys

All activation keys, and the entitlements, channels, configuration channels, system groups, and packages associated with them.

No

Activation Keys: Channels

activation-keys-channels

All activation keys and the entities associated with each key.

No

Activation Keys: Configuration

activation-keys-config

All activation keys and the configuration channels associated with each key.

No

Activation Keys: Server Groups

activation-keys-groups

All activation keys and the system groups associated with each key.

No

Activation Keys: Packages

activation-keys-packages

All activation keys and the packages each key can deploy.

No

Channel Packages

channel-packages

All packages in a channel.

Yes

Channel Report

channels

Detailed report of a given channel.

Yes

Cloned Channel Report

cloned-channels

Detailed report of cloned channels.

Yes

Configuration Files

config-files

All configuration file revisions for all organizations, including file contents and file information.

No

Latest Configuration Files

config-files-latest

The most recent configuration file revisions for all organizations, including file contents and file information.

No

Custom Channels

custom-channels

Channel metadata for all channels owned by specific organizations.

Yes

The column id is now called channel_id

Custom Info

custom-info

Client custom information.

Yes

Patches in Channels

errata-channels

All patches in channels.

Yes

Patches Details

errata-list

All patches that affect registered clients.

Yes

All patches

errata-list-all

All patches.

No

Patches for Clients

errata-systems

Applicable patches and any registered clients that are affected.

Yes

Host Guests

host-guests

Host and guests mapping.

Yes

Inactive Clients

inactive-systems

Inactive clients.

Yes

The mandatory parameter is now called threshold.

System Inventory

inventory

Clients registered to the server, together with hardware and software information.

Yes

The column osad_status has been removed.

Kickstart Scripts

kickstart-scripts

All kickstart scripts, with details.

No

Kickstart Trees

kickstartable-trees

Kickstartable trees.

No

"

All Upgradable Versions

packages-updates-all

All newer package versions that can be upgraded.

Yes

Newest Upgradable Version

packages-updates-newest

Newest package versions that can be upgraded.

Yes

Proxy Overview

proxies-overview

All proxies and the clients registered to each.

Yes

Repositories

repositories

All repositories, with their associated SSL details, and any filters.

No

Result of SCAP

scap-scan

Result of OpenSCAP sccdf evaluations.

Yes

Result of SCAP

scap-scan-results

Result of OpenSCAP sccdf evaluations, in a different format.

Yes

System Data

splice-export

Client data needed for splice integration.

No

System Currency

system-currency

Number of available patches for each registered client.

No

System Extra Packages

system-extra-packages

All packages installed on all clients that are not available from channels the client is subscribed to.

Yes

System Groups

system-groups

System groups.

Yes

Activation Keys for System Groups

system-groups-keys

Activation keys for system groups.

No

Systems in System Groups

system-groups-systems

Clients in system groups.

Yes

System Groups Users

system-groups-users

System groups and users that have permissions on them.

No

History: System

system-history

Event history for each client.

Yes

History: Channels

system-history-channels

Channel event history.

Yes

History: Configuration

system-history-configuration

Configuration event history.

Yes

The column created_date has been removed.

History: Entitlements

system-history-entitlements

System entitlement event history.

Yes

History: Errata

system-history-errata

Errata event history.

Yes

The column created_date has been removed.

History: Kickstart

system-history-kickstart

Kickstart event history.

Yes

The column created_date has been removed.

History: Packages

system-history-packages

Package event history.

Yes

The column created_date has been removed.

History: SCAP

system-history-scap

OpenSCAP event history.

Yes

The column created_date has been removed.

MD5 Certificates

system-md5-certificates

All registered clients using certificates with an MD5 checksum.

No

Installed Packages

system-packages-installed

Packages installed on clients.

Yes

System Profiles

system-profiles

All clients registered to the server, with software and system group information.

No

Users

users

All users registered to SUSE Manager.

Yes

The column organization_id has been removed.

MD5 Users

users-md5

All users for all organizations using MD5 encrypted passwords, with their details and roles.

Yes

The column organization_id has been removed.

Systems administered

users-systems

Clients that individual users can administer.

Yes

The column organization_id has been removed.

For more information about an individual report, run spacewalk-report with the option --info or --list-fields-info and the report name. This shows the description and list of possible fields in the report.

For further information on program invocation and options, see the spacewalk-report(8) man page as well as the --help parameter of the spacewalk-report command.