GIGABYTE GSM Agent
Installation & Features Guide
User's Manual - Version: 1.0
1. About GSM Agent
GSM Agent is part of the GSM (GIGABYTE Server Management) software suite. It is a software program to compliment and assist the remote monitoring and management of GIGABYTE servers. GSM Agent should be installed locally on each GIGABYTE server node. It collects node information (CPU / memory / HDD / PCIe devices) from the operating system and shares this information with the local BMC. This information can then be used and displayed by GSM Server, GSM's remote monitoring and management software platform. GSM Agent can be used with both Linux & Windows operating systems.
Diagram Description: Diagram illustrating the GIGABYTE Server Management (GSM) architecture, showing GSM Server, GSM CLI, GSM Plugin, and GSM APP components interacting via LAN/WAN with servers equipped with GSM Agent and BMC. It also depicts a remote management view connecting to GSM Server, which interfaces with VMware vCenter.
2. Installation / Startup / Uninstallation
2.1 Installation
2.1.1 OS: Ubuntu
Before installation, please ensure packages sudo and ufw are already installed. Otherwise, GSM Agent installation will fail. Commands: sudo apt-get install sudo ufw and sudo dpkg -i gsmagent_x.x_all.deb.
2.1.2 OS: Fedora / RHEL / CentOS
Before installation, please ensure packages sudo and ufw are already installed. Otherwise, GSM Agent installation will fail. Commands: sudo yum install sudo firewalld and sudo rpm -ivh GSM_agent-x.x-1.x86_64.rpm.
2.1.3 OS: Windows Server
Execute GSM_Agent_x.x.exe.
2.2 Startup
GSM Agent starts automatically when the system boots each time. For Windows systems, the user needs to add port 8080 and 8443 to firewall exceptions. For Ubuntu or Linux systems, if /dev/ipmi0 doesn't exist, the user should use the command modprobe ipmi_devintf.
2.3 Uninstallation
2.3.1 OS: Ubuntu
Command: sudo dpkg -r gsmagent.
2.3.2 OS: Fedora / RHEL / CentOS
Command: sudo rpm -e GSM_agent-x.x-1.x86_64.
2.3.3 OS: Windows Server
Navigate via System > Control Panel > GSM Agent Installer.
3. Using GSM Agent
3.1 Logging in
Connect using http://localhost:8080/GSM_Agent/. Default username: admin. Default password: password.
3.2 Main Dashboard
The Main Dashboard provides an overview of system status. It includes a Main Function Bar for navigation (Monitor, Notification, Preference, Help) and a Logout option. The central area displays system information, including CPU usage graphs for multiple cores over time, indicating 'Usage' and 'Free' percentages. System information is displayed on the OS side.
Diagram Description: A graphical representation of CPU usage over time, showing 'Usage' (orange) and 'Free' (green) for each CPU core (Cpu 0 to Cpu 5). The x-axis represents time, and the y-axis represents percentage.
3.3 Monitor Functions
3.3.1 System: CPU
Displays idle/usage information about CPUs or cores. It shows a detailed graph of CPU usage over time for each core, and a table with 'CPU Information' including User, System, Idle, Total values for each CPU core.
Diagram Description: Detailed CPU usage graphs for multiple cores (Cpu 0 to Cpu 31) over time, showing 'Usage' and 'Free' percentages. A table titled 'CPU Information' lists 'CPU', 'User', 'System', 'Idle', and 'Total' values for each core.
3.3.2 System: Memory
Displays usage status of memory, virtual memory, and huge pages. It includes a graph showing memory usage over time and a table with 'Memory Information' detailing Total Memory, Free Memory, Virtual Memory Total, Virtual Memory Used, Huge Pages Total, and Huge Pages Free.
Diagram Description: A graph illustrating memory usage over time, with 'Usage' (orange) and 'Free' (green) memory. A table provides 'Memory Information' including Total Memory (15914.05 MB), Free Memory (11141.45 MB), Virtual Memory Total (33554432 MB), and other related metrics.
3.3.3 System: Log
GSM Agent records events from the system and BMC on this page. The 'Log Information' table displays events with columns for Priority, Date, Time, and Information.
Diagram Description: A table listing system and BMC events. Columns include 'Priority', 'Date', 'Time', and 'Information'. Entries show timestamps and event details, such as systemd-timesyncd timeouts or CRON job executions.
3.3.4 System: NIC
This page displays information about the system's network configuration including IP address, MAC address, and interface name. The 'NIC Information' table shows IPv4, IPv6, MAC address, and Description for the network interface (e.g., eth2).
Diagram Description: A table labeled 'NIC Information' for interface eth2, showing IPv4 address (10.1.7.56), IPv6 address, MAC address (74:D4:35:8C:3B:E9), and Description.
3.3.5 System: Information
This page displays system information about the OS, CPU, Memory, Hostname, BMC Version, and BMC IP. The 'Information' table lists OS version (Ubuntu 16.04), CPU information (Intel Xeon), Memory information (Samsung DDR4), Hostname, BMC version, and BMC IP.
Diagram Description: A table titled 'Information' detailing OS version, CPU information, Memory information, Hostname, BMC version (4.55), and BMC IP (10.1.27.162).
3.3.6 System: PCI
This page displays information about PCIe devices installed in the system. The 'PCI Information' table lists Description, Manufacturer, and Type for various Intel Corporation system peripherals related to Xeon processors.
Diagram Description: A table labeled 'PCI Information' listing various PCIe devices, their manufacturers (Intel Corporation), and types (System peripheral), associated with Intel Xeon processors.
3.3.7 Storage: RAID
This page lists RAID health data from logical and physical layers, including hardware and software RAID. It provides details on RAID level, array size, state, number of disks, spare disks, and chunk size for both Software RAID (e.g., md127) and Hardware RAID (e.g., md0). Disk status (e.g., 'active sync', 'Online, Spun Up') is also shown.
Diagram Description: Tables detailing Software RAID and Hardware RAID configurations. For Software RAID, it shows Level (md127), Array Size (480.11GB), State (clean), Number of Disks (2), Spare Disks (0), and Chunk Size (512K). A 'Disks' table lists Slot Number and State. For Hardware RAID, it shows similar details for md0 with Array Size (223.062 GB), State (Optimal), Number of Disks (2), Spare Disks (0), and Chunk Size (256 KB).
3.3.8 Storage: S.M.A.R.T.
The S.M.A.R.T. page lists the current health state of each disk. The 'S.M.A.R.T Information' table displays attributes like Raw Read Error Rate, Spin Up Time, Power On Hours, Power Cycle Count, and others, along with their status (e.g., PASSED).
Diagram Description: A table titled 'S.M.A.R.T Information' for disk sdd. It lists various SMART attributes such as 'Raw Read Error Rate', 'Spin Up Time', 'Power On Hours' (295.0), 'Power Cycle Count' (257.0), and their 'PASSED' status.
3.4 Notification Function
Notification allows users to set upper limits for CPU and memory usage. When usage reaches or exceeds these limits, GSM Agent sends an alert to the user. The interface includes sliders for setting 'CPU Usage' and 'Memory Usage' thresholds.
Diagram Description: The Notification settings interface shows sliders to configure 'CPU Usage' and 'Memory Usage' thresholds, ranging from 0% to 100%.
3.5 Preference Functions
3.5.1 Language
Select the language setting for GSM Agent. A dropdown menu allows choosing the desired language.
Diagram Description: A dropdown menu labeled 'Language' for selecting the interface language.
3.5.2 Scan Period
Select the scan period setting for retrieval of system information. Users can set the interval in minutes.
Diagram Description: An input field to set the 'Scan Period' in minutes, with a default value of 3.
3.5.3 Log Amount
Set the default number of entries to display on the Monitor: System: Log page. A dropdown allows selecting the number of entries.
Diagram Description: A dropdown menu labeled 'Log Amount' to set the default number of log entries displayed.
3.5.4 SMTP
Configure SMTP information to send an email when the system is abnormal. The 'SMTP' table allows input for Server Host, Server Port, Account, Password, and Email Address.
Diagram Description: An SMTP configuration table with fields for Server Host, Server Port, Account, Password, and Email Address. Example entries include 192.168.0.1 for Server Host and agent_user@gigabyte.com for Email Address.
3.5.5 SNMP
Configure SNMP trap IP to receive events when the system is abnormal. The 'SNMP' table allows configuration of Server Host, IP Address, Event Level, and other parameters.
Diagram Description: An SNMP configuration table with fields for Server Host, IP Address (192.168.0.2), Event Level, and other settings.
3.5.6 LDAP
Configure LDAP server for LDAP authentication. Input fields are provided for LDAP Host and Port.
Diagram Description: Input fields for 'LDAP Host' and 'Port' for LDAP server configuration.
3.5.7 Change Password
Change GSM Agent login password. Fields are available for Username, Old Password, New Password, and Confirm Password.
Diagram Description: A form to change the GSM Agent login password, with fields for Username, Old Password, New Password, and Confirm Password.
3.5.8 Update
Update GSM Agent software version (.war file). Users can select a file and initiate the update process.
Diagram Description: An interface to update the GSM Agent software, showing the 'Current Version' and a button to 'Choose File' and 'Update'.
3.6 Help
Provides basic visual help guidance for each function within GSM Agent, similar to the contents of this user guide.
