To add a user defined polling component
2. Create the collector for the flash file name
3. To create the flash file size attribute, collector and events
4. To rename the UDComponent display name
Entuity includes 20 user defined object types that you can use to model components of network devices that are not part of the standard data model. These object types include 2 attributes:
- index.
- display name. This is configurable.
Create user defined attributes to model additional attributes of the object.
To add a user defined polling component
This example models a flash file object and its attributes. This example:
- uses the UDComponent02 object type.
- amends the UDComponent02 index attribute to use an integer attribute (ciscoFlashFileEntry) from the ciscoFlashFileTable table as an index to walk the table. The table index is not available (ciscoFlashFileIndex).
- amends the UDComponent02 name attribute to use the Flash File name.
- uses the User Defined Polling Wizard to configure a new attribute, Flash File Size.
- sets three levels of threshold events against the Flash File Size attribute.
- configures new collectors.
- uses the CISCO-FLASH-MIB to identify flash file attributes, for example:
.1.3.6.1.4.1.9.9.10.1.1.4.2.1.1.2 cisciFlashFileSize
You will also have to import to the server CISCO-SMI and CISCO-QOS-PIB-MIB (they do not require loading) before loading CISCO-FLASH-MIB.
The example instructions are split into 4 stages:
- create the collector for the flash file index.
- create the collector for the flash file name.
- create the user defined attribute and collector for flash file size.
- rename the UDComponent display name.
Please see this article for further help and information on managing MIB files and MIB definitions.
1. Create the collector for the flash file index:
- Navigate to the Collectors tab on the User Defined Polling page.
- Set the Server to the Entuity server on which you want to configure the collector. This is only required in multi-server environments.
- Set the Category to Object Attributes.
- Set the Object Type to UDComponent02.
- Click Add. In the Please select an example device search, select a device with a flashcard. Click Next.
- Entuity will default in the Object Type as UDComponent02 and Attribute as uDC02Index.
- In OID, click Browse.
- From the MIB Browser, enter the OID in the OID field. Alternatively, you can click Manage MIB and use the MIB Manager to import and then load (parse) required MIBs, i.e. CISCO-FLASH-MIB. You will also have to import to the server CISCO-SMI and CISCO-QOS-PIB-MIB (they do not require loading).
- You can shortcut the navigation by using the Find tool, for example by entering flash. Select ciscoFlashFileIndex and click Close to close the MIB Manager.
- Click OK to close the MIB Browser.
- From the MIB Browser, enter the OID in the OID field. Alternatively, you can click Manage MIB and use the MIB Manager to import and then load (parse) required MIBs, i.e. CISCO-FLASH-MIB. You will also have to import to the server CISCO-SMI and CISCO-QOS-PIB-MIB (they do not require loading).
- Define the rest of the collector. In:
- Name, enter the unique name of the collector, e.g. ud_FlashFileIndex.
- Description, enter a description of the attribute.
- Attribute, select the index attribute associated to the component object type, e.g.
UD02Index. - Object Type, select the component object type, e.g. UDComponent02.
- OID is the OID used by User Defined Polling as an index to the flash file table.
- Index is the index attribute, e.g. UD02Index.
- SNMP Version used to poll the device.
- Method is the instruction Entuity uses to poll for the attribute. For an index attribute you must change the:
- snmp_get command to snmp_get_indexes.
- index reference (UD02Index) to one that determines the maximum number of rows the snmp_get_indexes instruction can return, e.g. 500.
simple;snmp_get_indexes(snmpv2, ".1.3.6.1.4.1.9.9.10.1.1.4.2.1.1.2", 500)
- Filter, set the filter used to restrict creation of the object to devices that match the sysoid filter. You can set the Filter so the flash file configuration only applies to Cisco devices:
- Click Edit and in Expression change:
simple;true
to:
simple;sysoid_begins(".1.3.6.1.4.1.9")
You can type in the filter or highlight enterprise and click Add. Entuity displays the enterprise OIDs of devices under management. Click Select All to view all available enterprise OIDs. A filter can support multiple sysoids.
- Click Edit and in Expression change:
- Priority is the priority level used when comparing collectors associated to the same attribute. The higher the number the higher the priority. User Defined Polling collectors always have a higher priority than system collectors.
- Transform is the value used to interpret the data to usable information. It does not require
setting for indexes.
- Click OK to create the collector for the flash file index.
2. Create the collector for the flash file name:
- Navigate to the Collectors tab on the User Defined Polling page.
- Set the Server to the Entuity server on which you want to configure the collector. This is only required in multi-server environments.
- Set the Category to Object Attributes.
- Set the Object Type to UDComponent02.
- Click Add. In the Please select an example device search, select a device with a flashcard. Click Next.
- In OID, click Browse.
- From the MIB Browser, enter the OID in the OID field. Alternatively, you can click Manage MIB and use the MIB Manager to locate the flash file name (.1.3.6.1.4.1.9.9.10.1.1.4.2.1.1.5). Click Close to close the MIB Manager.
- Click OK to close the MIB Browser.
- Define the rest of the collector. In:
- Name, change to ud_flashFileName.
- Description, enter a meaningful description.
- Object Type, change to UDComponent02.
- Attribute, change to uDC02Name.
- Index, change to uDC02Index.
- SNMP Version used to poll the device.
- Keep the Method as default.
- Filter, click Edit and, in Expression change:
simple;true
to:
simple;sysoid_begins(".1.3.6.1.4.1.9")
You can type in the filter or highlight enterprise and click Add. Entuity displays the enterprise OIDs of devices under management. Click Select All to view all available enterprise OIDs. A filter can support multiple sysoids. - Priority, set the priority.
- Transform, leave as None.
- Click OK to create the collector for the flash file name.
3. To create the flash file size attribute, collector and events:
The above two collectors have been for object attributes that Entuity has provided with the UDComponent02 object type. This example adds an additional attribute (although you can add many more attributes.
- Navigate to the Collectors tab on the User Defined Polling page.
- Set the Server to the Entuity server on which you want to configure the collector. This is only required in multi-server environments.
- Set the Object Type to UDComponent02.
- Click Add. In the Please select an example device search, select a device with a flashcard. Click Next.
- Define the attribute under the Details tab. In:
- Name, change to ud_ciscoFlashFileSize.
- Display Name, change to cisco Flash File Size.
- Description, enter a meaningful description.
- Object Type, change to UDComponent02.
- Polling Interval, change to 5 Minutes.
- Retention Period, to 1 Day.
- Summary, tick the General Info box.
- Click the Events tab. Click the Threshold radio button and define three severity event levels.
- Click OK to save the attribute.
- Navigate to the Collectors tab on the User Defined Polling page and set the same parameters as above.
- In the OID field, set the file size OID (.1.3.6.1.4.1.9.9.10.1.1.4.2.1.1.2).
- Set the Index field to uDC01Index.
- Click OK to save the collector.
4. To rename the UDComponent display name:
When you want to update the display name of the component, you must make a change configuration file changes and then run configure. For example, if you have used UDComponent02 to model a flash file object, then to rename the display:
- copy entuity_home\etc\sw_user_defined_components.cfg to entuity_home\etc\sw_user_defined_components_site_specific.cfg.
- in entuity_home\etc\sw_site_specific.cfg include the component file:
!sw_user_defined_components_site_specific.cfg - open sw_user_defined_components_site_specific.cfg and amend the component name. For example, change:
[Type UDComponent02]
to:
ClientData+=\ndisplayName=UD Component 02\n
[Attribute uDComponents02]
ClientData+=\ndisplayName=UDComponents02\n
[Type UDComponent02]
ClientData+=\ndisplayName=Flash File\n
[Attribute uDComponents02]
ClientData+=\ndisplayName=Flash Files\n - to apply these changes you must stop Entuity, run configure and then restart Entuity. For example, from the command line enter:
entuity_home\bin\stopeye
entuity_home\install\configure defaults
entuity_home\bin\starteye
Comments
0 comments
Please sign in to leave a comment.