OneClick Attribute Editor
The Attribute Editor is an advanced
CA Spectrumutility used to configure management ‘policies’ that govern how
CA Spectrummanages network devices and their components. It is best suited for performing bulk attribute changes on multiple devices models.
You can change attribute values for one or more selected models in a view. The Attribute Editor dialog groups attributes into categories. You can edit the default settings provided within these categories, or you can define additional attributes to edit within the User Defined category.
Open Attribute Editor
You can open the Attribute Editor in OneClick by right-clicking any model and selecting Tools, Utilities, Attribute Editor.
You can also launch the Attribute Editor from anywhere in OneClick where you can select a model, including the List tab, the Explorer tab, Interfaces tab in Component Details panel, the Locator Results tab, or from the Tools menu.
Open Attribute Editor with Device Context
You can open the Attribute Editor within the context of selected models. Select a model or multiple models in the List tab, the Explorer tab, or the Interfaces tab. Then right-click and select Utilities, Attribute Editor. The Attribute Editor opens with the context of the selected models.
Any changes that you make apply to the selected models. If you select Set as Default, the changes are applied to the
CA Spectrummodeling catalog for the selected models.
Attribute Editor Dialog
The Attribute Editor includes a right and left panel. The left panel groups attributes in a tree display. The right panel provides an editing area to view current attribute values and make changes.
Task-Oriented Attribute Groupings
The left panel of the Attribute Editor provides attributes grouped by tasks you perform on devices and by categories of attribute types. The SNMP Communications folder groups attributes related to tuning SNMP communications between the
SpectroSERVERand a device.
Filter Attribute Categories
You can type text in the Filter text box to locate attributes in the attribute categories in the Attribute Editor left panel. When you type text in the Filter text box, attribute categories that do not contain an attribute that matches the filter appear as bullets, becoming inaccessible. All attribute categories that contain an attribute that matches the filter appear as folders that you can expand and you can select the subcategories within to move into the right panel for editing.
For example, if you want to find attributes related to alarms, type
alarmin the Filter text box.
Attribute Edit Panel
To edit attribute values, select the attribute category from the left panel, then click the right facing arrow to place the attributes in the Editor panel. An attribute that has been placed in the Editor panel appears in
italicsin the left panel.
Note: Tooltips are available for some attributes when they appear in the right panel for editing.
The Attribute Editor provides the following options:
- No Change:The No Change setting appears to the left of most attribute input fields. When No Change is selected, the input value, if any, is not written when you click Apply or OK. When you make changes to the attribute value by selecting a value or by clicking in the input field, No Change is automatically cleared. Clear No Change or click in the input field to makes the attribute value editable.
- Set as Default:This option appears to the right of most attribute input fields in the Editor panel. If you select Set as Default, the value is written to the model types in theCA Spectrummodeling catalog when you click Apply or OK. All future models that use these model types inherit the new value.The changes are made to the modeling catalog. As a result, existing models that use the current default value(s), and any new models that are created in the future inherit these new values. The type of device that they represent is irrelevant. Changing the default value affects existing models that you did not explicitly select, but these changes might not take effect until after a server restart. Existing models that use different value(s) are not changed.A model is an instance of a model type. The model type has default values for every attribute. When the model is created, every attribute that is not explicitly set inherits the default that is set on the model type.Once you create an instance of that model type, the new model can have its own values for every attribute. By default, it does not have a value for the ifModelNameOption. When you edit the model to change the ifModelNameOption, the model has its own value for that attribute and no longer uses the default that is set in the model type. From that point on, the new model only uses its own value and does not use the default setting of the model type.You can also edit the model and enable the option that sets this new value as the default. The new default then affects all of the following:
For example, assume that you use the Attribute Editor to change Model A to use ifAlias (11f7e). You then change Model B to use ifAlias and enable the Set As Default option. All models that use that model type will then use ifAlias. If you then change Model B and the default value to use ifDesc (1134b), all modelsexcept forModel A will use that new value. Model A does not use it because it already has its own value for that attribute, set to ifAlias. Models C, D, and E also had their own values set when you changed Model B and designated ifAlias as the default. Therefore, Models C, D, and E are similarly unchanged.
- This new model.
- The model type (which now has a new default for that attribute).
- All existing models of that model type that lack their own default value. They now use the new default because they still point to the model type value.
- All new models of that model type. These models also use that model type default value.
- Load Attribute Values:You view the current value for a set of selected attributes when you have launched the Attribute Editor in the context of a specific model. After populating the edit panel, click Load Attribute Values to view the current values for the attributes. If the selected models do not use or have a value for an attribute, no value displays when you click Load Attribute Values.
If you have launched Attribute Editor in the context of multiple model types, they can have different values for the same attribute. If this occurs, the Select Model dialog opens when you click Load Attribute Values. Select the model for which to load attribute values, and click OK.
When you click Apply or OK in the Attribute Editor,
CA Spectrumattempts to write the new attribute values and displays the Attribute Edit Results dialog.
Attribute Edit Results Dialog
The results of attribute value changes appear in the Attribute Edit Results dialog. Each item in the table represents the result of a single attribute written to a model. The Result column indicates whether the write operation succeeded or failed. The Old Value and New Value columns show the original value and the last written value. If the write operation failed or the previous value could not be obtained, the corresponding field will display N/A. If the write operation failed, for example, if the device did not respond, you can select the item in the table and click Retry.
Click the Undo button to undo the selected successful attribute value change in results list if necessary.
In the Attribute Editor dialog, you can create a list of attributes that display when you expand the User Defined category. After you create this list, you can access the user-defined attributes. You can at any time remove the user defined attributes.
Create User-Defined Attributes
Each OneClick user can create a unique set of user-defined attributes. You can select user-defined attributes using the Attribute Selector dialog.
Follow these steps:
- In the left panel of the Attribute Editor dialog, next to the User Defined folder, click Add.The Attribute Selector dialog opens.
- If you have more than one model type selected, select the model type whose attributes you want to edit from the left pane of the Attribute Selector dialog.The attributes for the selected model type appear in the right pane of the Attribute Selector dialog.
- Select the attribute to edit from the list, and click OK.Use the Filter text box to quickly locate an attribute or model type in the list.The attribute that you selected appears in the User Defined category in the Attribute Editor dialog. You can only add attribute at a time to the User Defined category.
- Repeat this process to select additional user-defined attributes.Remove user-defined attributes by clicking the remove link next to the attribute that you want to remove.
Change Attributes in Conjunction with Search
You can use the Attribute Editor feature in conjunction with the Search feature in the Locater tab (Locater Search). By using the Locater Search feature with the Attribute Editor feature you can locate all models meeting certain criteria and attempt to change the attribute values on those matching models.
The following example combines ‘creating and running a new search’ with ‘changing attributes through the Attribute Editor.’ It walks you through adding user-defined attributes and writing changes to the component (that is,
SpectroSERVER, devices, interfaces) meeting the search criteria.
For more information about using the Search feature in the Locater tab, see the
Example Define a Search to Create an Attribute for Editing
This example demonstrates how to create and run a search to locate the GlobalConfig model on the
SpectroSERVER. It then shows how to use the Attribute Editor to add the HibernationCommSuccessTries attribute to the User Defined category so that you can update the value as needed.
The value for HibernationCommSuccessTries determines the number of successful attempts the
SpectroSERVERmust make to devices in hibernation mode before the devices can resume normal management communication. By default, the value of this attribute is 3.
To define a search to create a user-defined attribute for edit
- In the OneClick Locater tab, click (Create a new search).The Create Search dialog opens.
- Select ‘Model Type Name (0x10000)’ from the Attribute drop-down list.
- Select ‘Equal To’ from the Comparison Type drop-down list.
- TypeGlobalConfigin the Attribute Value field.
- Click Save As, type a name for the search (for example, ‘Hibernation attempts’), and click OK.
- Click OK in the Create Search dialog.
- Select the search you just created (‘Hibernation attempts’) in the Locater tab and click (Launch the selected search).The Select Landscape to Search dialog opens.
- Select the landscapes to search and click OK.The search results appear in the Results tab.
- Right-click the GlobalConfig entry and select Utilities, Attribute Editor.The Attribute Editor dialog opens.
- Click the add link in the left panel of the Attribute Editor dialog, next to the User Defined folder.The Attribute Selector dialog opens.
- Click the folder named Other in the left panel of the Attribute Selector dialog.
- In the Filter text box (below the left panel) typeGlobalConfigand select the GlobalConfig entry under the ‘Other’folder.
- In the Filter text box under the right panel of the Attribute Selector dialog, typeHibernationCommSuccessTries.The HibernationCommSuccessTries attribute appears in the Attribute for GlobalConfig list in right panel.
- Double-click the HibernationCommSuccessTries entry in the list to add it to the User Defined category.
- In the Attribute Editor dialog, edit the user-defined attribute value by selecting it in the left panel and clicking the right arrow button to move its associated attribute fields to the editing panel.
- In the right panel, edit the attribute values as desired then click Apply to write the changes to the component.The Attribute Edit Results dialog opens listing the results of the changes made.
Edit Attributes for Specific Devices or for Model Types
This section provides examples for changing an attribute value for a specific model type, or for a specific set of devices.
Example 1: Edit Interface_Polling_Interval for Cisco Devices Supporting IPsec
Cisco IPSec tunnel interface management is available in
CA Spectrumfor Cisco devices that support the IPSec related MIBs. Once modeled, the tunnel models are updated every hour. If your environment requires less or more frequent updates to the tunnel models, use the Attribute Editor to change the polling interval.
The attribute Interface_Polling_Interval defines how frequently
CA Spectrummonitors the MIB associated with the tunnel interface models so that the modeling is up to date. To disable this monitoring, set the Interface_Polling_Interval attribute to 0. To change the frequency at which
CA Spectrummonitors these MIBs, change the value for the attribute to the desired number of seconds between polling cycles.
Edit the Interface_Polling_Interval attribute for Cisco devices.
Follow these steps:
- Locate the Cisco routers on your network by creating a new Global Collection of Cisco routers that have the Interface_Polling_Interval set to 3600 seconds.
- Select the Cisco routers whoseInterface_Polling_Int erval value you want to edit from the Global Collection.
- Right-click and select Utilities, Attribute Editor.
- Add the Interface_Polling_Interval to the User Defined attributes list, as described in Create User-Defined Attributes.
- Move the Interface_Polling_Interval attribute into the right panel for editing.
- Enter the value in seconds of the polling interval.
- Click OK.The Attribute Edit Results dialog displays the results for each device whose attribute value you attempted to change.
- If the change failed on any of the selected devices, select them and click Retry.
- Close the Attribute Edit Results dialog, and click OK to close the Attribute Editor.
Example 2: Edit the DeviceTypeDiscEnable Attribute for Specific Devices
The DeviceTypeDiscEnable attribute is used to allow or prevent changes to the device type name value for device models and model types. You can modify the value for this attribute.
To edit DeviceTypeDiscEnable for specific models, you first must add the DeviceTypeDiscEnable attribute to the User Defined category. Once you have done that you can begin to select the devices on which you want to prevent device type name customizations, as described in the following procedure.
Edit DeviceTypeDiscEnable for specific device models.
Follow these steps:
- Add the DeviceTypeDiscEnable attribute to the User Defined category using the procedure described in using the procedure described in Create User-Defined Attributes.
- Select the Locater tab in the Navigation panel.
- Expand the Devices folder and double-click By Model Name.The Search dialog opens.
- Enter the name of the device type model on which you want to prevent device type name customizations; select all applicable landscapes as necessary and click OK.The devices using the device type model specified appear in the Lists tab.
- Select the specific devices on which you want to prevent customizations.
- Right-click and select Utilities, Attribute Editor to launch the Attribute Editor.
- Expand the User Defined folder, select DeviceTypeDiscEnable, and click the right arrow to place the attribute in the right-side editing panel.
- Set the attribute value to No and click Apply.
- Verify that ‘Set as Default’ is not selected.The Attribute Edit Results dialog opens and displays the results of the edit, either successful or unsuccessful. If successful, the DeviceTypeDiscEnable attribute is now set to false, or no, on the devices you selected in Step 5.
Example 3: Edit DeviceTypeDiscEnable for a Model Type
You can set an attribute value and apply it to the model type in the
CA Spectrummodeling catalog and to all device models. Also, all device models created in the future using the model type will use the attribute value that you set in this manner.
Edit DeviceTypeDiscEnable for a model type.
Follow these steps:
- Add the DeviceTypeDiscEnable attribute to the User Defined category using the procedure described in Create User-Defined Attributes.
- Create a search using the Locater tab in the Explorer that finds some or all the device models that use the new custom model type.
- Select one of the device models using the new custom model type in the search results list, right-click it and select Utilities, Attribute Editor.The Attribute Editor opens with the context of the select device.
- In the Attribute Editor, select the DeviceTypeDiscEnable attribute in the User Defined category and move it to the Attribute Editing panel by clicking the right arrow.
- Set the attribute value to No.
- Select Set as Default to apply this change to theCA Spectrumcatalog for the model type used by the device model selected in Step 3.
- Click Apply.A warning message appears.
- Click Yes.This action sets the attribute value for all the device models using the model type, and applies it to the model type in theCA Spectrummodeling catalog and to all device models. All future device models created using this model type will have the DeviceTypeDiscEnable attribute set to No, and the Device Type Attribute cannot be overwritten.
Model Type Reevaluation
In cases where devices have been replaced on your network, IP addresses may be assigned to new devices without your knowledge. Therefore, device models periodically verify that they are modeled using the correct model type. If the model type no longer matches the device identify, an alarm is generated on the model.
By default, this reevaluation of model types occurs every 24 hours. You can change this setting for all models.
Edit the Model Type Reevaluation Interval
You can modify the interval for model type reevaluation. The MTypeVerifyInterval attribute on the VNM model determines the reevaluation interval, which is every 24 hours by default. Set this value to 0 to disable model type reevaluation.
Follow these steps:
- Select the VNM model and click the Attributes tab in the Component Detail panel.The available attributes for the VNM model appear on the left side of the panel.
- Locate the MTypeVerifyInterval attribute by typing it in the Filter field.The MTypeVerifyInterval attribute appears on the left side of the panel.
- Double-click the MTypeVerifyInterval attribute.The MTypeVerifyInterval attribute and its value appear on the right side of the panel.
- Double-click the MTypeVerifyInterval attribute on the right side of the panel.The Edit dialog opens.
- Clear the ‘No Change’ check box in the Edit dialog and type0in the field.The attribute value is changed to 0.The Attribute Edit Results dialog indicates whether the modification succeeded.
- Click Close.The Attribute Edit Results dialog closes; model type reevaluation has been disabled for all models.