Agent Documentation
Complete guide for installing, configuring, and managing SysManage agents across all supported platforms.
Overview
The SysManage agent is a lightweight, secure, cross-platform Python application that connects to the SysManage server via WebSocket for real-time system monitoring and management.
Supported Platforms
Key Features
- Auto-Discovery - Automatic server detection on the network
- Real-time Communication - WebSocket-based instant responsiveness
- Secure by Design - mTLS, certificate-based authentication, no inbound ports
- Cross-platform Package Management - Native support for all major package managers
- Multi-language Support - Native support for 14 languages
- Lightweight - Minimal resource footprint and dependencies
🚀 Installation
Platform-specific installation instructions for all supported operating systems.
- Prerequisites and system requirements
- Installation methods (source, packages)
- Virtual environment setup
- Service configuration
⚙️ Configuration
Agent configuration options including auto-discovery and manual setup.
- Auto-discovery setup (recommended)
- Manual server configuration
- Security and authentication options
- Logging and internationalization
🔐 Privileged Execution
Running agents with elevated privileges for package management and system administration.
- Cross-platform privileged execution
- Security considerations and best practices
- Service account configuration
- Automated privilege scripts
🌍 Cross-Platform Support
Platform-specific features, package managers, and system integration details.
- Linux distributions and package managers
- Windows service integration
- macOS launchd configuration
- BSD-specific considerations
🔧 Troubleshooting
Common issues, debugging techniques, and solutions for agent problems.
- Connection and network issues
- Permission and privilege problems
- Platform-specific troubleshooting
- Log analysis and debugging
🔒 Security
Agent security features, mTLS configuration, and security best practices.
- Mutual TLS (mTLS) authentication
- Certificate management
- Network security and communication
- Security scanning and validation
Agent Architecture
The agent operates as a persistent service with the following workflow:
- Auto-Discovery - Discovers SysManage servers on the network (if no configuration exists)
- Registration - Connects to server via secure WebSocket with authentication tokens
- Approval Process - Registers with system information and awaits administrator approval
- mTLS Setup - Retrieves client certificates after approval for enhanced security
- Monitoring - Monitors system health and sends periodic heartbeat messages
- Command Execution - Listens for and executes commands with validation and security controls
- Reporting - Reports command results and system status with message integrity