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 |
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, |
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
andsynced_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 a1
/0
values; -
the column
org_id
has been replaced byorganization
, 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 calledsystem_id
.
For report specific changes, see List of available reports.
If this changed behavior causes trouble, the new option |
For more information about hub reporting, see Hub Reporting.
3. List of available reports
This table lists the available reports:
Report | Invoked as | Description | Uses reporting database | Specific differences |
---|---|---|---|---|
Actions |
|
All actions. |
Yes |
The column |
Activation Keys |
|
All activation keys, and the entitlements, channels, configuration channels, system groups, and packages associated with them. |
No |
|
Activation Keys: Channels |
|
All activation keys and the entities associated with each key. |
No |
|
Activation Keys: Configuration |
|
All activation keys and the configuration channels associated with each key. |
No |
|
Activation Keys: Server Groups |
|
All activation keys and the system groups associated with each key. |
No |
|
Activation Keys: Packages |
|
All activation keys and the packages each key can deploy. |
No |
|
Channel Packages |
|
All packages in a channel. |
Yes |
|
Channel Report |
|
Detailed report of a given channel. |
Yes |
|
Cloned Channel Report |
|
Detailed report of cloned channels. |
Yes |
|
Configuration Files |
|
All configuration file revisions for all organizations, including file contents and file information. |
No |
|
Latest Configuration Files |
|
The most recent configuration file revisions for all organizations, including file contents and file information. |
No |
|
Custom Channels |
|
Channel metadata for all channels owned by specific organizations. |
Yes |
The column |
Custom Info |
|
Client custom information. |
Yes |
|
Patches in Channels |
|
All patches in channels. |
Yes |
|
Patches Details |
|
All patches that affect registered clients. |
Yes |
|
All patches |
|
All patches. |
No |
|
Patches for Clients |
|
Applicable patches and any registered clients that are affected. |
Yes |
|
Host Guests |
|
Host and guests mapping. |
Yes |
|
Inactive Clients |
|
Inactive clients. |
Yes |
The mandatory parameter is now called |
System Inventory |
|
Clients registered to the server, together with hardware and software information. |
Yes |
The column |
Kickstart Scripts |
|
All kickstart scripts, with details. |
No |
|
Kickstart Trees |
|
Kickstartable trees. |
No |
" |
All Upgradable Versions |
|
All newer package versions that can be upgraded. |
Yes |
|
Newest Upgradable Version |
|
Newest package versions that can be upgraded. |
Yes |
|
Proxy Overview |
|
All proxies and the clients registered to each. |
Yes |
|
Repositories |
|
All repositories, with their associated SSL details, and any filters. |
No |
|
Result of SCAP |
|
Result of OpenSCAP |
Yes |
|
Result of SCAP |
|
Result of OpenSCAP |
Yes |
|
System Data |
|
Client data needed for splice integration. |
No |
|
System Currency |
|
Number of available patches for each registered client. |
No |
|
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. |
Yes |
|
Activation Keys for System Groups |
|
Activation keys for system groups. |
No |
|
Systems in System Groups |
|
Clients in system groups. |
Yes |
|
System Groups Users |
|
System groups and users that have permissions on them. |
No |
|
History: System |
|
Event history for each client. |
Yes |
|
History: Channels |
|
Channel event history. |
Yes |
|
History: Configuration |
|
Configuration event history. |
Yes |
The column |
History: Entitlements |
|
System entitlement event history. |
Yes |
|
History: Errata |
|
Errata event history. |
Yes |
The column |
History: Kickstart |
|
Kickstart event history. |
Yes |
The column |
History: Packages |
|
Package event history. |
Yes |
The column |
History: SCAP |
|
OpenSCAP event history. |
Yes |
The column |
MD5 Certificates |
|
All registered clients using certificates with an MD5 checksum. |
No |
|
Installed Packages |
|
Packages installed on clients. |
Yes |
|
System Profiles |
|
All clients registered to the server, with software and system group information. |
No |
|
Users |
|
All users registered to SUSE Manager. |
Yes |
The column |
MD5 Users |
|
All users for all organizations using MD5 encrypted passwords, with their details and roles. |
Yes |
The column |
Systems administered |
|
Clients that individual users can administer. |
Yes |
The column |
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.