User Defined Polling enables you to add user defined collectors that can be assigned to attributes.
A user defined collector is useful for instances when the ENA collectors are not collecting data on certain device attributes that are available from the device vendor's MIB.
The Collectors tab on the User Defined Polling page has a table displaying any user defined collectors already in existence. The table has the following columns:
|Column Name||Column Description|
|Object Type||StormWorks object type to which the attribute is assigned.|
|Attribute||user defined attribute name.|
|Name||name of the collector.|
|Description||description of the attribute. By default, this is derived from the OID.|
contains the appripriate OID for the collector definition within the method syntax, e.g.:
For index attributes you will amend the method, because ENA uses an SNMP table walk rather than a GET operation. Click Edit, then:
When you only require one item from the table you can amend the method so that it includes the index. For example to collect only the Cisco CPU busy percentage for the previous 5 seconds:
|Filter||StormWorks filter applied to the collector, e.g. to restrict polling to devices from a selected manufacturer.|
|Priority||all user defined collectors have a higher priority than system collectors. When you assign multiple collectors to the same attribute, the collector with the highest priority is applied first.|
|Transform||transforms are configurations used by ENA to convert polled data into meaningful values.|
To add a user defined collector:
- In the Main Menu, click Administration.
- Click User Defined Polling. This will open the User Defined Polling page.
- Using the Category and Object Type dropdown fields under the Collectors tab, you can check if there are any user defined collectors already in existence.
- To add a new user defined collector, click Add in the bottom left of the browser.
- A window titled Please select an example device will open. Here, you can select the example device against which you want to test your new defined collector. Enter a search term and click Search to find an example device to use while defining the collector. Select your preferred device and click Next, or Cancel to exit.
- In the User Defined Collector (User Defined Attribute) window, enter a name for the new attribute in the Name field. By default, ENA adds the prefix "ud_". You can amend or delete this prefix. However, this prefix is helpful to distinguish between system collector and user defined collectors, for example in the case of a future ENA upgrade that includes an collector with the same name as a user defined collector.
- Enter a description for the attribute in the Description field.
- Specify the StormWorks object type in the Object Type field.
- Specify the user defined attribute name from which the user defined collector will be polling in the Attribute field.
- Browse for the OID used to poll the attribute via Browse next to the OID field. This opens the MIB Browser window. Locate the OID and click OK.
- Select the index in the Index dropdown field. If the attribute is a scalar, you can leave the Index set to None.
- Specify the SNMP Version by clicking the appropriate radio button.
- If some manipulation needs performing to format it properly, you can do this by modifying the Method statement. Do this by clicking Edit to open the Collector Method window. Edit the expression as you desire, clicking Test to test the expression, OK to save or Cancel to cancel.
- Specify the Filter used to limit the collector to devices from a particular vendor. You can Edit this filter.
- Specify the Priority of the collector. This is only relevant when multiple user defined collectors are applied to the same attribute. The collector with the highest priority setting will be applied first. By default, this is set to 1000. If you only have one collector assigned to an attribute, then you do not need to change this setting.
- Select the Transform setting from the dropdown field, and click View to open the Transform Mapping window that shows you how the selected transform setting converts polled data into meaningful values. If you are creating a user defined collector for an OID that is not numerated, you can ignore the Transform setting.
- At the bottom of the window, click OK to save your user defined collector, Back to return to the search example device window, otherwise click Cancel. If you save the collector, it will take effect the next time the specified attribute is polled.