Skip to main content

Check out Interactive Visual Stories to gain hands-on experience with the SSE product features. Click here.

Skyhigh Security

Retrieve Hardware Status Using the SuperDoctor5 (SD5) Tool

  1. Last updated
  2. Save as PDF

Secure Web Gateway version 12.2 or later supports the Supermicro SuperDoctor5 (SD5) tool to retrieve the appliance status for F models.

If SD5 is enabled, hardware status information is available under the SNMP protocol. For SNMP setup details, click here.

An overview of the available information is then provided in Management Information Base (MIB) files, which are located in the file system of the monitored appliance. The path to these files is /opt/supermicro/sd5/mibs. Management Information Base (MIB) files can be exported and browsed through any MIB browsers.

To enable the SD5 tool:

  1. Log in to the appliance using the SSH console.

  2. Run the sd-enable command.

    SuperDoctor5 (SD5) is enabled.

    You can disable the tool with the sd-disable command.

When running SD5, you cannot use the Remote Management Module (RMM) to retrieve hardware status information simultaneously.

NOTE: Skyhigh recommends to add a timeout of two minutes in the SNMP client browser to access Supermicro Object IDs (OIDs) using the SD5 tool.

Terminating SuperDoctor5 before Running the RMM

If you enter the rmm-show command to start the Remote Management Module (RMM) while SuperDoctor5 (SD5) is running, you are prompted to terminate SD5 first. 

If you select yes after the prompt, SD5 is stopped. RMM commands are then executed. SD5 restarts when execution of the RMM commands is completed. If you select no, SD5 keeps running, RMM commands are not executed, and RMM exits.

Output after selecting yes:

[root@mwgappl sum]#
[root@mwgappl sum]# rmm-show
SuperDoctor5 service must be stopped to configure RMM
Please confirm that SuperDoctor5 can be stopped temporarily. [yes] yes
Redirecting to /bin/systemctl stop sd5.service
LAN Channel             : rmm (1)
IP Address Source       : Static Address
IP Address              : 10.213.231.18
Subnet Mask             : 255.255.255.0
Default Gateway IP      : 10.213.231.252
Enabled users channel 1 : 2

Output after selecting no:

[root@mwgappl sum]#
[root@mwgappl sum]# rmm-show
SuperDoctor5 service must be stopped to configure RMM
Please confirm that SuperDoctor5 can be stopped temporarily. [yes] no
Exiting on user request.
[root@mwgappl mibs]#

 Accessing SD5 Web Interface

SD5 is Supermicro's proprietary tool and an agent system that runs on SWG hosts designed by Supermicro to provide local system health and information. SD5 supports a web-based interface program and a command-line interface program for server management and monitoring.

Web interface for SD5 can be accessed on SWG using https://<SWG IP>:8444, with the default credentials root/webgateway.

When SD5 is enabled using sd-enable, it opens up the following ports on all interfaces that are required to run the SD5 service:

  • Binds TCP port 8444 for HTTPS UI access of SD5
  • Binds TCP ports 5333, 5666, and 5999 for NRPE 
  • Binds for internal communications TCP port 7777 and a free TCP port between 31000-32999
  • SNMP GET sent on UDP 161
  • SNMP Trap sent on UDP 162

NOTE: Since SD5 cannot be configured to listen to specific IPs, it is recommended to use IP tables or firewalls to block designated IPs and eliminate packets directed towards the SD5 service port.

SD5 UI is accessed using https://<SWG IP>:8444 with default credentials root/webgateway. Additionally, the passwords can be changed from the SD5 UI.

 To change the password:

  1. Access the SD5 UI using https://<SWG IP>:8444 with default credentials.
  2. Navigate to Configuration > Account Setting. 
  3. Change the password. 

    SD5 Web Interface.png

Users can also disable the UI access for SD5.

To enable or disable the UI access for SD5: 

  1. Stop the SD5 service using sd-disable.
  2. Add the line enableHttps=false/true in the file /opt/supermicro/sd5/config/agentweb.properties to disable/enable the UI access.
  3. Start the SD5 service using the sd-enable command.

NOTE: To ensure that the SD5 responds with Supermicro OIDs (1.3.6.1.4.1.10876) and the SNMP query works, the user must add the community string in the SWG SNMP configuration tab that will be used to query the OIDs. This is necessary because the SNMP query must be routed through the SWG agent (SNMPD) to reach the SD5, as there is no independent listener on the SD5 for direct access.

 

Additional Information on TRAP Services for SWG F Models

The SWG F model supports two types of TRAP configurations for receiving hardware event alerts:

  1. SD5 TRAPs – Motherboard-specific TRAPs configurable through the SD5 UI.
  2. BMC TRAPs – BMC (RMM) TRAPs reports only hardware-related events, configurable through the RMM UI.

NOTE: SD5 and BMC TRAPs OIDs are not available for direct querying. The respective TRAP services generate alerts and deliver them to the configured receiver only when the corresponding event occurs on the appliance. To monitor the appliance hardware status, use SD5 OIDs (.1.3.6.1.4.1.10876.100.1) instead of TRAP OIDs (.1.3.6.1.4.1.10876.100.3).

Retrieve smHealthMonitorName

The following table lists the smHealthMonitor names and its types:

Index smHealthMonitorName Type Description
  OID: .1.3.6.1.4.1.10876.2.1.1.1.1.2    
smHealthMonitorName.1 CPU1 Temp Temperature Temperature of the first Central Processing Unit.
smHealthMonitorName.2 CPU2 Temp Temperature Temperature of the second Central Processing Unit.
smHealthMonitorName.3 Inlet Temp Temperature Temperature of the air entering the system chassis.
smHealthMonitorName.4 PCH Temp Temperature Temperature of the Platform Controller Hub chipset.
smHealthMonitorName.5 System Temp Temperature Overall system temperature, often from a sensor on the motherboard.
smHealthMonitorName.6 Peripheral Temp Temperature Temperature of general peripheral components within the system.
smHealthMonitorName.7 CPU1_VRMIN Temp Temperature Temperature of the Voltage Regulator Module (VRM) for CPU1 (minimum point).
smHealthMonitorName.8 CPU1_VRMON Temp Temperature Temperature of the Voltage Regulator Module (VRM) for CPU1 (monitoring point).
smHealthMonitorName.9 CPU1_VRMHV Temp Temperature Temperature of the Voltage Regulator Module (VRM) for CPU1 (high voltage point).
smHealthMonitorName.10 CPU2_VRMIN Temp Temperature Temperature of the Voltage Regulator Module (VRM) for CPU2 (minimum point).
smHealthMonitorName.11 CPU2_VRMON Temp Temperature Temperature of the Voltage Regulator Module (VRM) for CPU2 (monitoring point).
smHealthMonitorName.12 CPU2_VRMHV Temp Temperature Temperature of the Voltage Regulator Module (VRM) for CPU2 (high voltage point).
smHealthMonitorName.13 CPU1_VCCIN Voltage Core voltage input for CPU1.
smHealthMonitorName.14 CPU1_VCCON Voltage Controller voltage for CPU1.
smHealthMonitorName.15 CPU2_VCCIN Voltage Core voltage input for CPU2.
smHealthMonitorName.16 CPU2_VCCON Voltage Controller voltage for CPU2.
smHealthMonitorName.17 CPU1_VCCHV Voltage High voltage supply for CPU1.
smHealthMonitorName.18 CPU2_VCCHV Voltage High voltage supply for CPU2.
smHealthMonitorName.19 P1_DIMMA~D Temp Temperature Temperature of DIMM modules A through D on Processor 1.
smHealthMonitorName.20 P1_DIMME~H Temp Temperature Temperature of DIMM modules E through H on Processor 1.
smHealthMonitorName.21 P2_DIMMA~D Temp Temperature Temperature of DIMM modules A through D on Processor 2.
smHealthMonitorName.22 P2_DIMME~H Temp Temperature Temperature of DIMM modules E through H on Processor 2.
smHealthMonitorName.23 M2SSD1 Temp Temperature Temperature of the first M.2 Solid State Drive.
smHealthMonitorName.24 M2SSD2 Temp Temperature Temperature of the second M.2 Solid State Drive.
smHealthMonitorName.25 FAN1 Fan Speed Rotational speed of Fan 1.
smHealthMonitorName.26 FAN2 Fan Speed Rotational speed of Fan 2.
smHealthMonitorName.27 FAN3 Fan Speed Rotational speed of Fan 3.
smHealthMonitorName.28 FAN4 Fan Speed Rotational speed of Fan 4.
smHealthMonitorName.29 FAN5 Fan Speed Rotational speed of Fan 5.
smHealthMonitorName.30 FAN6 Fan Speed Rotational speed of Fan 6.
smHealthMonitorName.31 12V Voltage System's 12-volt power rail.
smHealthMonitorName.32 5VCC Voltage System's 5-volt power rail (common collector).
smHealthMonitorName.33 3.3VCC Voltage System's 3.3-volt power rail (common collector).
smHealthMonitorName.34 VBAT Voltage Voltage of the CMOS battery.
smHealthMonitorName.35 5VSB Voltage 5-volt standby power rail.
smHealthMonitorName.36 3.3VSB Voltage 3.3-volt standby power rail.
smHealthMonitorName.37 2.5V BMC Voltage 2.5-volt power supply for the Baseboard Management Controller.
smHealthMonitorName.38 1.8V BMC Voltage 1.8-volt power supply for the Baseboard Management Controller.
smHealthMonitorName.39 1.2V BMC Voltage 1.2-volt power supply for the Baseboard Management Controller.
smHealthMonitorName.40 1.0V BMC Voltage 1.0-volt power supply for the Baseboard Management Controller.
smHealthMonitorName.41 1.8V PCH Voltage 1.8-volt power supply for the Platform Controller Hub.
smHealthMonitorName.42 PVNN PCH Voltage Core voltage for the Platform Controller Hub (often a variable voltage).
smHealthMonitorName.43 1.05V PCH Voltage 1.05-volt power supply for the Platform Controller Hub.
smHealthMonitorName.44 Chassis Intru Status Indicates whether the chassis has been opened or tampered with.
smHealthMonitorName.45 PS1 Status Status Operational status of Power Supply Unit 1.
smHealthMonitorName.46 PS2 Status Status Operational status of Power Supply Unit 2.
smHealthMonitorName.47 AIOM_NIC1 Temp Temperature Temperature of the first AIOM (Advanced I/O Module) Network Interface Card.
smHealthMonitorName.48 AOC_NIC1 Temp Temperature Temperature of the first AOC (Add-on Card) Network Interface Card.
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Article type
    Topic
  2. Tags
    This page has no tags.