Using Device Modules Estimated Reading Time: 7 Minutes Device modules add functions to the device pages in Ubersmith, for example bandwidth graphs, power control, or server statistics. Each module shows a box on the device page. To use a device module: Add the module to a device type or a device type group. For more information, refer to the articles "Adding Device Group and Device Type Modules" and "Managing Device Group and Device Type Modules". On the Config tab of the module, set the settings of the module. Most modules collect data through an Ubersmith appliance, so you select an Appliance. For more information, refer to the article "Adding Appliances". On each device, complete the settings that the module needs, for example the switch port or the IP address. If a module needs settings, the module box shows "Module Not Configured" until you complete them. SNMP connections are supported with IPv4 and IPv6. Modules Network Module What it does Bandwidth Monitoring Shows bandwidth graphs for the switch ports of a server, an uplink, or another device. If the parent switch allows it, you can enable and disable the switch ports. For more information, refer to the article "Reading Bandwidth Graphs". Switch Information Shows the ports of a switch, router, or other network device, with the status of each port and the devices that use the port. NetFlow Server and NetFlow Bandwidth Collect bandwidth data with pmacct, for example from NetFlow, sFlow, or IPFIX. See NetFlow. Load Balancer Information Shows the connections of a load balancer, and monitors them against a minimum and a maximum. Virtual IP Monitoring Monitors the virtual IPs (VIPs) and real servers of a load balancer. The supported load balancers are Foundry ServerIron 4G and Zeus / Stingray. SNMP Monitor Monitors SNMP OIDs of any SNMP device. You can check each value with a regular expression or limits. This module is available when you add a monitor. TLS/SSL certificate Monitor Monitors the TLS/SSL certificate of a device. The monitor shows a warning or a failure when the certificate expires within the number of days that you set. If the device uses a self-signed certificate, set Verify certificate chain to No. Power and environment Module What it does Rebooter Information Shows the power draw of a managed PDU, and the outlets with their status and the devices that use them. Reboot Control Lets you reboot, power off, and power on a device through its PDU outlet or IPMI. It can also monitor the power draw. Clients can use it in the client portal if the Client Access of the module allows it. Power Panel Connects to power panel management software. Ubersmith supports WebCTRL. Power Circuit Monitors a power circuit on a power panel. It is used for power circuit billing. For more information, refer to the article "Configuring Power Circuit Billing". Environmental Monitoring Shows the temperature and humidity of an environmental monitoring unit, and of some PDUs. The Device Manager dashboard shows the average for each facility. Servers and services Module What it does Server Metrics Shows graphs of CPU, load, memory, disk, and I/O for servers that support net-snmp or the Windows SNMP service. IPMI Information Shows and monitors the baseboard management controller (BMC) of a device with IPMI, and opens KVM and Serial over LAN (SOL) consoles for some providers. See IPMI Information. Webserver Status Monitors the activity and the connections of Apache, nginx, and lighttpd web servers. For more information, refer to the article "Configuring Web Server Status Device Modules". MySQL Status Monitors the activity and the connections of a MySQL database server. For more information, refer to the article "Configuring MySQL Status Device Modules". Memcache Status Monitors the statistics, connections, hit rate, and usage of a memcached server. Varnish Status Monitors the connections, threads, and cache hits and misses of a Varnish server. Command Monitor Runs an operating system command or script, and checks the output with a regular expression or a range. Syslog NG Connects to the database of a php-syslog-ng server and shows the last log entries of the device. For more information, refer to the article "Configuring Syslog-NG Device Modules". NAS Information and NAS Filesystem Monitoring Monitor a network attached storage (NAS) device. These modules support Parascale devices. Hosting and virtualization Module What it does Control Panel Host Connects a cPanel or DirectAdmin server so that Ubersmith can create and manage hosting accounts on it. For more information, refer to the article "Configuring a Control Panel Host". Control Panel License Management Manages control panel licenses with your licensing username and password. VM Host and Virtual Machine Manage virtualization platforms. These modules support Virtuozzo and SolusVM. vCloud + vCenter Chargeback Gets usage data from VMware vCloud and vCenter Chargeback. For more information, refer to the article "Configuring vCloud and vCenter Chargeback Device Modules". R1Soft CDP 3.0 Enterprise Server and R1Soft CDP 3.0 Agent Monitor an R1Soft Enterprise Server and its agents. They are also used with the Backup Billing service module. Configuration management and other Module What it does Chef Node Control Connects to a Chef server. You can create nodes, change their roles, bootstrap them, and send custom data groups to the Chef server. Puppet Node Control Lets a Puppet master get the configuration of a device as an external node. You can set the Puppet modules and the environment of the device. Ubersmith also sends the custom device fields as Puppet parameters. Service Link Copies the label of the device to the description of the service that the device is associated with. The device must have a label. Tag Categories Lets you select a tag for the device from a category of tags that you set in the module. Virtual switches and virtual PDUs A virtual switch is a group of ports from one or more switches. A virtual PDU is a group of outlets from one or more PDUs. Use them to give a client control of only some ports or outlets, for example in a colocation environment. You can then assign the virtual switch or virtual PDU to the client. In the port list of the virtual device, type one port on each line: Virtual switch: switchname/portname Virtual PDU: pduname/outletnumber. Optional: type a label in parentheses after the outlet. If a virtual switch is associated with a service, Ubersmith uses all ports of the virtual switch for bandwidth billing. IPMI Information To use the IPMI Information module, complete the IP address, the IPMI username, and the IPMI password of the device. If you also add the Reboot Control module to the device, Reboot Control uses IPMI to control the power of the device. The module runs the freeipmi tools on the Ubersmith server. You need freeipmi version 1.0.7 or later, with the ipmi-sensors, ipmiping, bmc-info, and ipmipower tools. Proxy the VNC connections You can send the VNC connections to your IPMI devices through a proxy host. Then you do not have to give public IP addresses to your out-of-band devices. In the module configuration, set Proxy VNC connections and the proxy settings, for example Start Proxy TCP Port Range. Copy the file cron/proxy.php from Ubersmith to the proxy host. Install PHP, PHP CLI, and PHP Process on the proxy host. Troubleshoot IPMI Information Message Cause and solution Could not find 'bmc-info' utility, is freeipmi installed? freeipmi is not installed, or Ubersmith cannot find the tool. Install freeipmi 1.0.7 or later on the Ubersmith server. Minimum required version of freeipmi is 1.0.7 The installed freeipmi is too old. Install a newer version. ipmictxopen_outofband: internal error A permission or firewall problem stops the connection to the device. Make sure that outgoing connections to UDP port 623 are allowed. bmc-info: connection timeout The Ubersmith server cannot connect to the BMC of the device. Ask your network administrator to allow the connection. NetFlow The NetFlow Server and NetFlow Bandwidth modules use the network monitoring tool pmacct. pmacct can collect data from libpcap, Netlink/ULOG, NetFlow v1/v5/v7/v8/v9, sFlow v2/v4/v5, and IPFIX. You need a host that runs pmacct. This can be your Ubersmith appliance or a different host. Create your own device modules You can write your own device modules. For more information, refer to the article "Managing Device Group and Device Type Modules". For examples, refer to Ubersmith Device Module Examples.