Data Collection with SPM s Custom Device Templates Feature (Part Number SPM-CDT)

Transcription

1 Data Collection with SPM s Custom Device Templates Feature (Part Number SPM-CDT) Purpose This technical note documents SPM s Custom Device Templates, the key-activated feature for data collection that allows communication, tracking, and reporting for any SNMP-enabled device you create to export data from within SPM. Overview The Custom Device Templates feature tracks a subset of the operational values for devices that are not otherwise in communication with SPM; for example, an unsupported PDU, UPS, or printer. You create a new custom template, configure the template values for specific device attributes, and then associate the template (by its name) to the custom device when you add the device to SPM. Once the template is associated with the custom device, values can be monitored in several places in the SPM interface. The Custom Device Templates feature has the capability of tracking data center power from within SPM using a single value in an unsupported device (like a UPS). In addition, the feature offers the convenience of letting you add individual infeeds and outlets directly to SPM one at a time as needed. Note: Thresholds can be a custom number but the threshold value will not be used to determine device alarms. Before You Begin To use the Custom Device Templates feature, you will need the following: Sentry Power Manager (SPM), version 5.3 or greater. A software license key for Custom Device Templates purchased from Server Technology. Requesting the SPM License Key Obtain the Custom Device Templates software license key by contacting your Server Technology representative at: (domestic), ++0 (1) (international), or at: sales@servertech.com When the license key has been entered in SPM through the Add License function, the Custom Device Template will be operational with an auto-enabled status. To verify the feature s enabled status, start SPM and go to Application Help > Product License page: Rev A (060513) 1 OF 10

2 The Product License box displays Custom Template Enabled, as highlighted in the following example: Creating a New Custom Device Template Once the feature is enabled, create a new template by following these steps: Step 1. Start SPM and go to System Setup > Custom Device Templates. The list displays any previously created custom device templates by name. Step 2. Click the New Custom Device Template icon in the toolbar. (Or, right-click a template in the list and from the drop-down menu, select the New Custom Device Template option.) New Custom Device Template option New Custom Device Template icon Rev A (060513) 2 OF 10

3 Step 3. The Configure Custom Device Template window displays. Identify the new template by completing the heading information fields at the top of the window. When you enter heading information and click Save, device attributes for the new template display in a list. For each device attribute (shown in the Attributes column) that you want to use for the custom device, select the Item Type option Constant or OID, and then edit Value (text definition), Conversion Rule, and Conversion Value. (The conversion rule and conversion value may or may not be needed, depending on the custom device. Do the following: a. (Required) Type a new template name. b. In the Enterprise OID field, provide the full Object Identifier (OID) required for SNMP; this is the returned OID from the MIB SysObjectID; the value entered must be numeric c. From the Version drop-down menu, select the version of SNMP (v1, v2c, v3). d. Type the (maximum) Bulkmax quantity for data retrieval (for SNMP). Bulkmax is the maximum number of OIDs from the device in one request; varies by device; not recommended to go beyond 40 for most devices. e. If you are creating the template for a conventional Power Distribution Unit (PDU), type the number of Total Infeeds and Total Outlets. If you are creating the template for a custom, non-pdu device (for example, a printer or a UPS), type 0 (zero) for the Total Infeeds and Total Outlets. f. Click the Save button. The new template displays in the Custom Device Templates list, as shown: Rev A (060513) 3 OF 10

4 Associating the Template with a New Custom Device The values from a custom device template are associated with a new device when the device is added to SPM using the New Device window. Note: The Device Discovery window cannot be used to associate a custom device template with a new custom device. Only the New Device window as shown in these instructions can be used for the association Rev A (060513) 4 OF 10

5 Configuring a Custom Device Template When you configure a custom device template, you are editing the settings that include text definitions for certain parameters, conversion rules, and conversion values that apply to a specific device attribute, shown in the Attribute column of the Configure Custom Device Template window (screen sample below). Important: Once a custom template is associated with a custom device (the association is made as you add the device to SPM and select the template by name), if you then edit values in the template (as shown in the template configuration instructions below), the revised template (because it changed) is disassociated from the custom device. To re-associate the revised template with the same custom device (apply changes made to that template for an existing device), you will need to: (1) delete the device from SPM, (2) re-add the device to SPM, and (3) select the revised template (any historical data will be lost). To edit the template: Step 1. Start SPM and go to System Setup > Custom Device Templates. The list displays any previously created custom device templates. Step 2. Select the template in the list you want to configure and click the Configure Device Template icon in the toolbar. (Or, right-click the template in the list and from the drop-down menu, select the New Custom Device Template option.) Configure values for the attributes of the custom device as displayed in the Attributes column. A green corner in a field indicates that the field can be edited by clicking into the field and typing a new value. As the changed value is saving, the corner briefly turns to red to show the edit is in process. Step 3. From the Item Type drop-down menu, select the None, Constant, or OID option: None: Leaves the device attribute blank and disables the Value, Conversion Rule, and Conversion Value fields. Constant: Uses the text string you type in the Value field and disables the Conversion Rule and Conversion Value fields. OID: Uses the OID string value from the MIB, makes the Value field available for entering the OID text string, and enables the Conversion Rule and Conversion Value fields Rev A (060513) 5 OF 10

6 Step 4. If you selected the Constant or OID option from the Item Type drop-down menu, click in the Value field to type a text string. Step 5. If you selected the Constant or OID option from the Item Type drop-down menu, the Conversion Rule and Conversion Value fields can be edited. Step 6. Click the Save button to save your edits. Supported Custom Device Values SPM supports three groups of values so you can apply a value that is unique to the custom device: Whole Device Level: Device model, version, serial number, power type, total power (watts), manufacturer custom text (any string value you want to track), and a maximum of three custom numeric fields (any numeric value you want to track). Infeed: Index, name, current(amps), power(watts), voltage(volts), apparent power(volt-amps), and power factor(%). Outlet: Index, name, current(amps), power(watts), voltage(volts), apparent power(volt-amps), and power factor(%). Converting Values Some values in a custom device may need to be converted to be correctly displayed in SPM; other values in that same device may not need conversion. Operational values will vary by product and manufacturer. Each custom device will have its own values and meaning, so there are no fixed rules for conversion. If conversion Is necessary, do the following: Step 1. Refer to the Value Conversion Table for the SPM screen value and the required converted value. Step 2. Go to System Setup > Custom Device Templates > select the custom device template in the list > Configure Custom Device Template window: Rev A (060513) 6 OF 10

7 Step 3. From the Item Type drop-down menu, select the Constant or OID option. Step 4. Click in the Value field and type the numeric value that will be converted. Step 5. For the attribute to convert, click in Conversion Rule and select the operand *, /, -, or +. Step 6. For the same attribute, click in Conversion Value and type the numeric factor for conversion, 10, 20, 30, etc. Step 7. Click Save. If the Item Type is Constant When you select Item Type Constant, enter a numeric Value (for example, 12755), and use the conversion rule to divide by 10, add a new custom device to SPM and associate the device with your custom template, when you view the device in the CDUs list and look at its infeeds, you will see the SPM-acceptable value of shown as the value. If the Item Type is OID When you select Item Type = OID, enter an OID Value (for example, or a similar sequence), the OID will obtain the device value through SNMP. If an OID needs to be converted using division, the extra data will be truncated. For example, if the device is reporting power as 32.9, the value will be shown in the OID as 329 (there are no decimal places in SNMP). To correctly represent the device s power in SPM, the value must be converted to a whole number. This means you will need to divide the OID by 10 (using the Conversion Rule field and the Conversion Value field as described in the previous screen example). The value displayed in SPM will show as 32. Notice the.9 was truncated and no rounding was performed. Note: Thresholds can be a custom number but the threshold value will not be used to determine device alarms. Value Conversion Table Description SPM Screen Value 1 Required Converted Value Current Voltage Power Apparent Power Power Factor Total Power = Value displayed in SPM; shows maximum decimal place supported Rev A (060513) 7 OF 10

8 Viewing Device Values CDUs List To view the values from a custom device template that were applied to a new device, enable the reporting fields on the CDUs list as instructed in the following graphic: Rev A (060513) 8 OF 10

9 CDU Device Summary The values for a custom device template display in the CDU Device Summary: Note: To view custom device values in the Device Summary (or in the CDUs list), the reporting fields must be enabled using the CDUs list as described in the previous section Rev A (060513) 9 OF 10

10 Custom Devices in User Reports Values for a custom device will also be reported in the SPM Inventory Report, shown as follows for the device IP Address: end Server Technology, Switched CDU, and CDU are trademarks of Server Technology, Inc., registered in the US. Sentry, Cabinet Distribution Units, and Remote Power Manager are trademarks of Server Technology, Inc. Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Server Technology, Inc. disclaims any proprietary interest in trademarks and trade names other than its own Rev A (060513) 10 OF 10