Documentation > Server > Reports

Reports & PDF Generation

Comprehensive reporting system with real-time HTML viewing and professional PDF generation capabilities.

Overview

SysManage includes a powerful reporting system that generates comprehensive reports about your infrastructure. The system supports both real-time HTML viewing and professional PDF generation for documentation and compliance purposes.

📊 Real-time HTML Reports

Interactive reports with responsive design that update in real-time as your infrastructure changes.

📋 Professional PDF Generation

High-quality PDF reports suitable for documentation, compliance, and executive summaries.

🔍 Multiple Report Types

Host inventories, user management reports, and system analytics across your entire fleet.

🌍 Internationalized Content

Reports generated in your preferred language with full localization support.

Available Report Types

📋 Registered Hosts Report

Description: Complete listing of all registered hosts showing basic information and operating system details.

  • Hostname and FQDN information
  • IP addresses (IPv4 and IPv6)
  • Operating system and version details
  • Host status and last access times
  • Platform-specific information

Use Cases: Infrastructure inventory, compliance auditing, asset management

🏷️ Hosts with Tags Report

Description: Shows all registered hosts along with their assigned tags for easy categorization and filtering.

  • Host identification and basic details
  • All assigned tags and categories
  • Tag-based grouping and organization
  • Environment and department classifications

Use Cases: Environment management, departmental reporting, resource allocation

👥 SysManage Users Report

Description: Comprehensive list of all SysManage users showing their profiles, roles, and account status.

  • User profiles and contact information
  • Account creation and last login times
  • Account status and security information
  • Failed login attempts and account locks
  • Role and permission assignments

Use Cases: User management, security auditing, access control review

Accessing Reports

Web Interface

  1. Navigate to the Reports section in the SysManage web interface
  2. Use the tabs to switch between Hosts and Users report categories
  3. Use the search functionality to filter reports by name or description
  4. Click "View Report" for real-time HTML viewing
  5. Click "Generate PDF" to download a PDF version

API Access

Reports can also be accessed programmatically via the REST API:

HTML Report Generation

GET /api/reports/view/{report_type}
Authorization: Bearer <your_jwt_token>
Content-Type: text/html

Available report types:
- registered-hosts
- hosts-with-tags
- users-list

PDF Report Generation

GET /api/reports/generate/{report_type}
Authorization: Bearer <your_jwt_token>
Accept: application/pdf

Response:
- Content-Type: application/pdf
- Content-Disposition: attachment; filename="report_name.pdf"

PDF Generation Requirements

Dependencies

PDF generation requires the ReportLab library to be installed. This is included in the standard SysManage installation.

# Install PDF generation dependencies
pip install reportlab

Configuration

PDF generation is automatically enabled when ReportLab is available. No additional configuration is required.

💡 Note

If ReportLab is not available, the PDF generation endpoints will return a 500 error with the message "PDF generation is not available". HTML reports will continue to work normally.

Report Content & Formatting

HTML Reports

  • Responsive Design: Reports adapt to different screen sizes and devices
  • Interactive Elements: Sortable tables and expandable sections
  • Real-time Data: Content reflects the current state of your infrastructure
  • Localized Content: All text appears in your selected language

PDF Reports

  • Professional Layout: Clean, printable format suitable for presentations
  • Structured Content: Organized tables with proper headers and formatting
  • Metadata: Report generation timestamp and summary information
  • Consistent Branding: SysManage styling and formatting throughout

Security & Permissions

Authentication

All report endpoints require valid JWT authentication. Users must be logged in to access any reporting functionality.

Authorization

Report access is controlled by the standard SysManage RBAC system:

  • Host Reports: Users need read access to host data
  • User Reports: Administrative privileges may be required for sensitive user information
  • API Access: Same permissions apply to both web interface and API endpoints

⚠️ Data Privacy

Reports may contain sensitive information about your infrastructure and users. Ensure appropriate access controls are in place and follow your organization's data handling policies.

Troubleshooting

Common Issues

PDF Generation Fails

Symptoms: "PDF generation is not available" error

Solution: Ensure ReportLab is installed: pip install reportlab

Empty Reports

Symptoms: Reports show "No data available" messages

Solution: Verify that hosts are registered and agents are connected

Slow Report Generation

Symptoms: Reports take a long time to load or generate

Solution: Check database performance and consider indexing for large datasets

Permission Denied

Symptoms: 403 Forbidden errors when accessing reports

Solution: Verify user permissions and RBAC configuration

API Reference

For complete API documentation including request/response examples and error codes, visit the interactive API documentation at:

  • Swagger UI: http://your-server:6443/docs
  • ReDoc: http://your-server:6443/redoc

The reports API endpoints are documented under the "Reports" section of the API documentation.