Skip to content
CA Spectrum - 10.2 to 10.2.3
Documentation powered by DocOps

Configure User-Defined Device Attribute Polling

Last update September 17, 2018

Contents

The Spectrum Report Manager historical device management feature polls devices for well-known attributes, such as device name and network address. However, you can pull more data from devices, such as vendor-specific data, or settings that are applicable to a business environment. Therefore, Spectrum Report Manager enables you to tailor the device polling behavior.


Custom device polling is organized by model type, and then by attributes within the model type. The polling supports a maximum of ten (10) additional attributes per model type, in three attribute type areas. You can verify the following list for the attribute type and the associated CA Spectrum type mappings.

Type
Supported CA Spectrum Type Mapping
Maximum Number of Attributes
(per type)
Varchar-based All character-based and numeric types 4
Integer-based Numeric, scalar types 4
Date/Time Timestamp, time period types 2

Mapping Polled Attributes to Storage

If you are interested in storing the additional device attributes, you can determine the attributes to store. You can accomplish this task in the OneClick Attribute Editor view of a given device. Locate the desired attributes, and note the hexa-based attribute IDs (for example, 0x1006e) and the corresponding Type (for example, Integer, Text String).

You can select the attributes and can assign them to one of the open storage locations. The mapping occurs in an XML file, which is at:

<SPECROOT>/tomcat/webapps/
	spectrum/WEB-INF/repmgr/config/devicemodel-polling.xml

For a model type, each attribute id is mapped to a storage location. Consider the following example, for the model type 'Rtr_Cisco', that maps the attribute ID '0x118b8' to string storage location '1':

<devicemodel-polling ...>
    <user-defined-poll modelType="Rtr_Cisco">
        <!-- Company name attribute -->
        <poll-attribute attrId="0x118b8">
            <varchar-storage id="1"/>
        </poll-attribute>
    </user-defined-poll>
</devicemodel-polling>

Next, consider the following example that maps several attributes, across several model types:

<devicemodel-polling ...>
    <user-defined-poll modelType="Rtr_Cisco">
        <!-- Company name attribute -->
        <poll-attribute attrId="0x118b8">
            <varchar-storage id="1"/>
        </poll-attribute>
        <!-- Disposable precedence attribute -->
        <poll-attribute attrId="0x114e2">
            <int-storage id="4"/>
        </poll-attribute>
    </user-defined-poll>
    <user-defined-poll modelType="JuniperJUNOSRtr">
        <!-- Company name attribute -->
        <poll-attribute attrId="0x118b8">
            <varchar-storage id="2"/>
        </poll-attribute>
        <!-- Create time now attribute -->
        <poll-attribute attrId="0x11b41">
            <datetime-storage id="1"/>
        </poll-attribute>
    </user-defined-poll>
</devicemodel-polling>

In the previous example, two model types are configured for custom attribute polling. For 'Rtr_Cisco' devices, the company name attribute is stored at string storage '1' and the disposable precedence attribute is stored at long storage '4'. For 'JuniperJUNOSRtr' devices, the company name attribute is storage at string storage '2' (note the difference from the 'Rtr_Cisco' configuration) and the create time attribute is stored at date/time storage '1'.

A full example XML file can be found at:

<SPECROOT>/tomcat/webapps/
	spectrum/WEB-INF/repmgr/config/devicemodel-polling-example.xml

Note: The newly created attributes are updated in Spectrum Report Manager database during device polling which is scheduled for every 24 hours.

Reporting Labels

You can retrieve the attributes that are stored in the database, and can identify the attributes that are stored in 'varchar storage 1' for the 'Rtr_Cisco' model type. The reporting label lets you describe the purpose of an attribute and user-oriented interfaces.

The reporting label is configured in the following example:

<devicemodel-polling ...>
    <user-defined-poll modelType="Rtr_Cisco">
        <!-- Company name attribute -->
        <poll-attribute attrId="0x118b8">
            <varchar-storage id="1"/>
		<reports label="Company Name" />
        </poll-attribute>
    </user-defined-poll>
</devicemodel-polling>

If you require to display the user-defined device attribute, the label text can be used to identify the attributes purpose.

Displaying Attributes in Reports

You can display the user-defined attributes as part of a Business Objects WEBI document using the CA Spectrum Universe. You can browse for subfolders that are prefixed with 'User Specified Device Attributes', while selecting result objects for the WEBI Document query.

For example, consider the following location:

Asset/Additional Device Information/User Specified Device Attributes - Asset.

For each polled attribute, the following objects and their source location are available in the folder:

  • Attribute ID - configured in .xml file
  • Label - configured in .xml file
  • Value - polled from device

You can drag the desired result objects to the relevant WEBI panel to incorporate the objects into the query.

Polling Behavior:

When a device is polled, only the current user-defined polling configuration is applied. Therefore, if a configuration change is made, a device is polled again. The attributes and storage locations reflect the current configuration. Attributes of the devices that are polled before the configuration change and the old storage locations are cleared before storing the current attribute values.

Was this helpful?

Please log in to post comments.

  1. ICS Supportteam
    2018-07-05 11:36

    Please add a note telling that it might take up to 24 hours to see the new attributes and / or a link to the chapter where that is explained: https://docops.ca.com/ca-spectrum/10-2-3/en/installing-and-upgrading/install-report-manager/cabi-boxi/report-manager-architecture

    1. Vijaya Kumar Gonela
      2018-09-17 02:44

      Hi ICS Supportteam,

      Sorry for the delayed response.
      We have updated this page with a note as per your suggestion.
      Regards,
      Team DocOps

  2. Shane Ryan
    2018-07-27 11:25

    Can you verify if that is a max of 10 attributes in total for all model types or 10 per model type?

    "Custom device polling is organized by model type, and then by attributes within the model type. The polling supports a maximum of ten additional attributes, in three attribute type areas."

    1. Vijaya Kumar Gonela
      2018-09-17 01:31

      Hi Shane Ryan,

      Sorry for the delay in response.
      The engineering team has confirmed that the 10 attributes are per model type.
      We have updated this page accordingly.
      Regards,
      Team DocOps