Table Of Contents
Getting Started
Opening the Cisco ANA Soft Properties Manager
Soft Properties Manager Window
Properties Panel
Element Properties Table
Soft Properties Manager Menu Bar
Soft Properties File Menu
Soft Properties Tools Menu
Soft Properties Toolbar
Soft Properties Manager Workflow
Creating or Editing a Soft Property
Editing a Soft Property
Defining the General Parameters
Defining the Parsing Parameters
Defining the Parsing Parameters of a Soft Property Table
Testing the Parsing Rules
Defining the TCA Alarms Parameters
Debugging the Soft Property
Viewing the Soft Property in the Inventory Window
Publishing the Soft Property
Deleting a Soft Property
Importing and Exporting a Soft Property
Closing the Cisco ANA Soft Properties Manager
Getting Started
This chapter describes the Cisco ANA Soft Properties Manager's working environment and how to access the Cisco ANA Soft Properties Manager's tools. In addition, it describes from creating to publishing a soft property:
•
Opening the Cisco ANA Soft Properties Manager—Describes how to open the Cisco ANA Soft Properties Manager.
•Soft Properties Manager Window—Describes the Soft Properties Manager, including, the toolbar and menu options.
•Soft Properties Manager Workflow—Describes the steps required to create a new soft property.
•Creating or Editing a Soft Property—Describes how to start creating a soft property. In addition, it describes how to edit a soft property.
•Defining the General Parameters—Describes how to define the general parameters of a soft property, including, a soft property table.
•Defining the Parsing Parameters—Describes how to define the parsing parameters of a soft property
•Testing the Parsing Rules—Describes how to test the parsing rules.
•Defining the TCA Alarms Parameters—Describes how to define the TCA alarms parameters of a soft property
•Debugging the Soft Property—Describes how to debug the soft property.
•Viewing the Soft Property in the Inventory Window—Describes how to view the newly created or edited soft property in the Inventory window.
•Publishing the Soft Property—Describes how to publish a soft property to one or more locations across the inheritance hierarchy.
•Deleting a Soft Property—Describes how to delete a soft property.
•Importing and Exporting a Soft Property—Describes how to export and import soft properties between Managed Elements.
•Closing the Cisco ANA Soft Properties Manager—Describes how to close the Soft Properties Manager.
Opening the Cisco ANA Soft Properties Manager
This section provides instructions for launching the Cisco ANA Soft Properties Manager. The Cisco ANA Soft Properties Manager is launched from a specific Network Element, which could be a Managed Element or a selected object within a Managed Element, such as a port. This Network Element will be used to develop and test the soft property. The content displayed in the Soft Properties Manager window is based on the location from which it is launched.
Once the soft property has been completed it can be published and attached to a wider scope of Managed Elements.
Note Initially the soft property only applies to the specific object that you are working on during runtime. Once the soft property has been published and the system has been restarted s it will be applied to all objects all objects of the same type, according to the location to which it is published.
To open the Cisco ANA Soft Properties Manager:
Step 1 Right-click on a Managed Element in the Cisco ANA NetworkVision window's Tree pane or Workspace to display a shortcut menu.
Note For more information about the Cisco ANA NetworkVision window, refer to the Cisco Active Network Abstraction NetworkVision User's Guide.
or
Open the Inventory window for the required Managed Element and right-click on the required object in the Network Element, for example, port or card.
Note For more information about the Inventory window, refer to the Cisco Active Network Abstraction NetworkVision User's Guide.
Step 2 Select Management | Soft Properties Management from the shortcut menu. The Soft Properties Manager window is displayed.
Soft Properties Manager Window
An example of the Soft Properties Manager window is displayed.
Figure 2-1 Soft Properties Manager Window
1
|
Menu bar
|
2
|
Toolbar
|
3
|
Properties Panel
|
4
|
Element Properties table
|
The Soft Properties Manager window displays a table of all of the existing soft properties according to the selected entity from which it has been launched. In addition, the applicable properties panels for the managed entity from which the Soft Properties Manager was launched are displayed. For example, for an ATM port the properties panels displayed are Location Information, ATM, and DS3.
Note No soft properties will be displayed in the Soft Properties Manager window for a Managed Element and/or required object in the Network Element when it is opened for the first time.
The Soft Properties Manager enables the user to:
•Add a new soft property.
•Edit an existing soft property.
•Delete a soft property.
•Import and/or export soft properties.
•Test a soft property on the selected Managed Element.
•Publish a soft property and attach it to a wider scope of Managed Elements.
The Soft Properties Manager consists of the following:
•Properties Panel
•Element Properties Table for the selected Managed Element or Network Element
•Soft Properties File Menu
•Soft Properties Tools Menu
Properties Panel
The Properties Panel is a dropdown list that contains a list of panels equivalent to the panels displayed in Cisco ANA NetworkVision for the selected Network Element from which the Soft Properties Manager was launched. For example, where an ATM port is selected as the launching point the Properties Panel contains Location Information, ATM and OC3 properties. The user can then select the panel to which to add the property.
Element Properties Table
The content displayed in the Element Properties table changes according to the selection made in the Properties Panel. The following information is displayed in the Element Properties table of the Soft Properties Manager window:
•Label—The name of the property as displayed in the GUI, for example, Port Type. For tables this is the table name displayed in the tab.
•Type—The soft property type, namely, Property or Table.
•Polling—The polling group specified for the property, for example, system or status.
•Enabled—Runs (true) or does not run (false) the command.
•Command Line—The command execution for this protocol that should be sent to the NE to retrieve the property. This command can be either a Telnet/SSH command or an SNMP get for a specific OID.
A table can be sorted:
•According to a column by clicking on the required column heading. The sort icon is displayed next to the selected column heading.
•In ascending or descending order by clicking on the column heading. A triangle is displayed next to the selected column heading.
Clicking on a red triangle displayed in a cell expands the cell to display all of the information in the cell.
The Location field displays the number of selected rows and the total number of rows in the table, for example, 2/16 Selected. In addition, it displays the location of the selected row(s) in the table, for example, Line 3.
Soft Properties Manager Menu Bar
This section provides a description of each option available in the Cisco ANA Soft Properties Manager menus. The following menus are available:
•The File menu
•The Tools menu
Soft Properties File Menu
The File menu is displayed and provides the following options:
•New Element—Enables the user to create a new soft property. For more information, see page 2-7.
•Edit Element—Enables the user to edit an existing soft property. For more information, see page 2-8.
•Delete Element—Enables the user to delete a soft property whether or not it has been published. For more information, see page 2-21.
Soft Properties Tools Menu
The Tools menu is displayed.
The Tools menu provides the following options:
•Export Element—Enables the user to save a soft property to a file that can later be imported to another Managed Element. For more information, see page 2-21.
•Import Element—Enables the user to copy a soft property from an exported file and import this soft property to another Managed Element. For more information, see page 2-21.
•Hierarchy Manager—Enables the user to move the soft property to a different location or change the scope of the soft property across the network hierarchy (publishing). For more information, see page 2-19.
Soft Properties Toolbar
The following buttons are displayed in the Soft Properties Manager:
Table 2-1 Soft Properties Manager Toolbar
|
New Element—Enables the user to create a new soft property. For more information, see page 2-7.
|
|
Edit Element—Enables the user to edit an existing soft property. For more information, see 2-8.
|
|
Delete Element—Enables the user to delete a soft property whether or not it has been published. . For more information, see page 2-21.
|
|
Export Element—Enables the user to save a soft property to a file that can later be imported to another Managed Element. For more information, see page 2-21.
|
|
Import Element—Enables the user to copy a soft property from an exported file and import this soft property to another Managed Element. For more information, see page 2-21.
|
|
Hierarchy Manager—Enables the user to move the soft property to a different location or change the scope of the soft property across the network hierarchy. For more information, see page 2-19.
|
The Close button closes the Soft Properties Manager window. For more information, see page 2-22.
Soft Properties Manager Workflow
The workflow below describes the steps required to define a new soft property definition using the Cisco ANA Soft Properties Manager and the order in which they must be performed.
Figure 2-2 Workflow
At any point after the soft property has been defined, it can be tested, and published to a wider scope of Managed Elements and/or Network Elements.
For more information:
•Creating or Editing a Soft Property
•Defining the General Parameters
•Defining the Parsing Parameters
•Testing the Parsing Rules
•Defining the TCA Alarms Parameters
•Debugging the Soft Property
•Viewing the Soft Property in the Inventory Window
•Publishing the Soft Property
•Deleting a Soft Property
•Importing and Exporting a Soft Property
Creating or Editing a Soft Property
The Soft Properties Manager enables the user to create or edit an existing soft property using the Add Soft Property dialog box. First the user must determine the Managed Element and/or selected object in the Network Element to which the soft property should be added.
To create a Soft Property
Step 1 Right-click on a Managed Element in the Cisco ANA NetworkVision window's Tree pane or Workspace to display a shortcut menu,
or
Open the Inventory window for the required Managed Element and right-click on the required object in the Network Element, for example, port or card. A shortcut menu is displayed.
Step 2 Select Management | Soft Properties Management from the shortcut menu. The Soft Properties Manager window is displayed.
Step 3 Click New Element in the toolbar of the Soft Properties Manager window.
or
Select New Element from the File menu or shortcut menu. The Add Soft Property dialog box is displayed.
The Add Soft Property dialog box is divided into the following tabs (configuration categories):
•General tab enables you to configure general definitions for the soft property. For more information about defining the General parameters, see page 2-8.
•Parsing tab enables you to configure parsing definitions for the soft property. For more information about defining the Parsing parameters, see page 2-10.
•TCA Alarms tab enables you to configure alarm threshold management for the soft property. For more information about defining the TCA Alarms parameters, see page 2-15.
Editing a Soft Property
The user can edit an existing soft property and the soft property that is edited will affect only the local instance. When an inherited soft property is edited, the new local instance overrides the generic soft property definition for the specific Managed Element.
To edit a soft property:
Step 1 Select the soft property that you want to edit in the table of the Soft Properties Manager window.
Step 2 Click Edit Element in the toolbar of the Soft Properties Manager window.
or
Select Edit Element from the File menu or shortcut menu.
The Hierarchy Manager table is displayed.
Note If user-friendly VNE names exist in the schema then the Hierarchy Manager table will display these user-friendly registry location names in the VNE Hierarchy Location column.
Step 3 Select the required version of the soft property from the hierarchy manager, and click OK. The Edit Soft Property dialog box is displayed for the selected soft property.
Step 4 Edit the soft property as required by changing the existing information using the Soft Properties Manager window.
Step 5 When the soft property has been successfully edited click OK in the Edit Soft Property dialog box to save the edited soft property. The edited soft property is supported and displayed in the Soft Properties Manager window.
For information about viewing the edited soft property in the Inventory window, see page 2-18.
For information about publishing the edited soft property, see page 2-19.
Defining the General Parameters
The General tab enables the user to configure general definitions for the soft property. The user can also configure just a single soft property field or an entire soft property table.
To define the General parameters:
Step 1 Select the General tab in the Add Soft Property dialog box. The General tab is displayed.
The following fields are displayed in the General tab of the Add Soft Property dialog box:
•Name—The soft property identifier, which is unique to the location and IMO scope. This field is mandatory.
Note A warning message is displayed if the name specified already exists. The user will be asked whether to override the existing soft property implementation.
•Label—The soft property name that is displayed in the GUI, which is unique to the location and IMO scope. For tables this is the table name that is displayed in the tab. This field is mandatory.
•Description—A description of the soft property.
The following dropdown lists are displayed in the General tab of the Add Soft Property dialog box:
•Type—The soft property type, namely, Property or Table. By default Property is selected. The fields displayed in the Parsing tab are dependent on the user's selection.
Note If Table is selected the TCA Alarms tab is not displayed in the Add Soft Property dialog box.
•Polling Rate—The polling rate group to which the soft property is assigned, namely one of the following:
–trapevent
–topo_unicast_pkts
–topo_I2
–buffering
–topo_I1
–configuration
–status
–system
The following checkbox is displayed in the General tab of the Add Soft Property dialog box:
•Enabled—Enables or disables Network Element registration. By default this option is enabled.
The following buttons are displayed in the Add Soft Property dialog box:
•OK—Validates the changes according to the field's rules, namely, the definitions defined in the General, Parsing and TCA Alarms tabs. If the validation is successful, the changes are saved and the Add Soft Property dialog box is closed.
Note A warning message is displayed if the validation is unsuccessful.
•Cancel—Closes the Add Soft Property dialog box without saving any changes.
•Debug—Opens the Debug Soft Property dialog box displaying the status of the soft property debug.
Step 2 Define the soft property's general parameters.
Note If you selected the soft property type Table proceed to Defining the Parsing Parameters of a Soft Property Table to continue creating the soft property.
Proceed to Defining the Parsing Parameters to define the parsing parameters of the soft property.
Defining the Parsing Parameters
The Parsing tab enables the user to configure, view and edit parsing definitions defined for the soft property.
To define the Parsing parameters:
Step 1 Select the Parsing tab in the Add Soft Property dialog box. The Parsing tab is displayed as shown below when the Property type is selected in the General tab.
Note If the Table type is selected in the General tab only the SNMP option is displayed. For more information about defining parsing parameters for a soft property table, see Defining the Parsing Parameters of a Soft Property Table.
The Parsing tab enables you to specify either a Telnet/SSH command or a MIB OID for an SNMP GET command.
The following radio buttons are displayed in the Parsing tab:
•Use SNMP get(OID)—The SNMP retrieval expression. The text field is enabled and mandatory when this option is selected. The expression can include environmental arguments.
Note When Use SNMP get(OID) is selected press Ctrl-Spacebar in the text box to open a selection list of the entire collection of parameters available for all of the protocols.
An example of the output presented when pressing Ctrl-Spacebar for a port is displayed below.
Figure 2-3 Output
Sometimes, when building a soft property the Telnet/SNMP command is context sensitive. A good example of this is when you want to retrieve some port related data through SNMP, "walk"ing all the ports to find the relevant port each time is not efficient and can greatly affect system performance. To solve this "Instrumentation Data" is available for the soft property. The instrumentation data is a variant between different elements in the system depending on the context object to which you want to add the soft property to.
In this example, the instrumentation data is the port ifIndex. In order to use the ifIndex in the OID, do the following "1.3.1.6......$ifIndex$.5.6.4". In order to ascertain what instrumentation data is available for your context object press Ctrl-Spacebar while the cursor is on the "command" field.
•Use Telnet/SSH—The Telnet/SSH retrieval expression. The text field is enabled and mandatory when this option is selected. The expression can include environmental.
Note When Use Telnet/SSH is selected press Ctrl-Spacebar in the text box to open a selection list of the entire collection of parameters available for all of the protocols.
The text area in the Parsing tab enables you to enter the command line of the protocol. For example, for SNMP enter the OID of the SNMP packet; and for Telnet enter the Telnet command line.
Note The SNMP OID should start with a dot, for example, if the user wants to retrieve the OID value of "1.3.6...." then the user should write ".1.3.6....".
The following columns are displayed in the table of the Parsing tab:
•Index—Displays the order of the parsing rules.
•Operation—Displays the parsing operator type selected in the Add/Edit Parsing Rule dialog box. For more information about parsing operators, see page A-1.
The following buttons are displayed in the Parsing tab:
•Add—Enables you to add a new operator. The Add/Edit Parsing Rule dialog box is displayed.
•Edit—Enables you to edit an existing operator. The Add/Edit Parsing Rule dialog box is displayed.
Note You can also edit an operator by double-clicking on the required operator in the table.
•Delete—Enables you to delete the selected operator from the table.
Note Delete an operator by selecting it in the table and clicking Delete.
•Test—Enables you to test the soft property parsing. The Test Parsing Rules dialog box is displayed. For more information, see page 2-14.
The reorder arrows enable you to move the rules up and down within the sequence in order to change the parsing order.
Step 2 Select one of the following options:
•Use SNMP get(OID) or
•Use Telnet/SSH or
Step 3 Click Add. The Add/Edit Parsing Rule dialog box is displayed.
Figure 2-4 Add/Edit Parsing Rule Dialog Box
1
|
Argument 1
|
2
|
Argument n
|
3
|
Source
|
4
|
Result
|
The Add/Edit Parsing Rule dialog box is used for adding, editing and testing of the parsing operators. Once the required operator is selected, the corresponding arguments are displayed.
The following dropdown lists are displayed in the Add/Edit Parsing Rule dialog box:
•Input Buffer—A dropdown list that displays the list of output arguments defined in previous operators and the default (the standard output buffer of the last predecessor operator that was not redirected into an output argument). This field is mandatory.
The parsing result of operator N is available by default as input for operator N+1 (appear as Default for the Input Buffer). The parsing result of operator N may be directed to a locally defined environment argument. In this case the input for operator N+1 is the same as for operator N. Changing the default input buffer is supported by selecting an input buffer other than Default. The available inputs buffers for Operator N+1 are the set of output arguments defined in Operators 1 through N.
The fields displayed in the Expression area of the window change depending on your selection in the Operator dropdown list, which is mandatory. When an operator is selected the corresponding arguments are displayed. The Operator dropdown list enables you to select one of the available parsing operators, namely:
•Header And Footer—Removes a specified number of lines from the header and footer of the input text. For more information, see page A-1.
•Remove Lines—Removes a range of lines from the specified starting row to the specified end row of the input text. For more information, see page A-2.
•Select Lines—Extracts a range of lines from the specified starting row to the specified end row of the input text. For more information, see page A-3.
•Replace—Finds one or all occurrences of a substring, which matches a specified regular expression, and replaces it with a specified value. For more information, see page A-4.
•Match—Finds and extracts a substring, which matches a specified regular expression. If no match can be found the output buffer receives an empty string. For more information, see page A-5.
•Set—Formats the input buffer and local arguments defined in previous operators using a regular expression. For more information, see page A-6.
•Substring—Extracts a substring of a specified length from a specified starting point. For more information, see page A-7.
•Parse Integer—Uses the substring rule and when a result is received with the substring it converts it into an integer value. For more information, see page A-8.
Note If the substring operator contains any characters the parsing integer operator will fail.
The Argument 1 and Argument n fields displayed in the Add/Edit Parsing Rule dialog box is dynamic and lists the corresponding arguments according to the selected operator. For more information about the operators and the corresponding arguments that are displayed, see Appendix A, "Parsing Operators/Rules".
The Direct result to output buffer variable checkbox and corresponding field enables you to direct the parsing output to the provided argument instead of it being the input value for the next operator. The text box is only enabled when the checkbox is selected and a unique (within the complete parsing sequence of this soft property instance) argument name must be provided in this field.
The Simulation area is divided into two text areas:
•The Source text box is used to enter or paste parsing information.
•The Result text box is used to view the parsed result.
The information entered and displayed in the Simulation area is not saved when the dialog box is closed. The Test Expression button parses the information entered in the Source text box according to the parsing operator defined and displays the result in the Result text box.
The following buttons are displayed in the Add/Edit Parsing Rule dialog box:
•OK—Validates the operator according to the selected operator's validation rules. Saves the changes and closes the Add/Edit Parsing Rule dialog box.
•Cancel—Closes the Add/Edit Parsing Rule dialog box without saving the changes.
Step 4 Define the parsing rules.
Proceed to Testing the Parsing Rules to test the parsing rules.
Defining the Parsing Parameters of a Soft Property Table
The Parsing tab displayed in the Add Soft Property dialog box changes when the user selects Table type in the General tab in order to configure a soft property table.
To define the Parsing parameters of a soft property table:
Step 1 Select the Parsing tab in the Add Soft Property dialog box. The Parsing tab is displayed.
The following radio button is displayed in the Parsing tab of the Add Soft Property dialog box:
•Use SNMP get(OID)—The SNMP retrieval expression. The text field is mandatory when this option is selected. The expression can include environmental arguments.
Note When Use SNMP get(OID) is selected press Ctrl-Spacebar in the text box to open a selection list of the entire collection of parameters available for all of the protocols.
The following columns are displayed in the table of the Parsing tab:
•Title—Displays the column headings of the table.
•OID—Displays the column information for the table.
For more information about the buttons displayed in this tab, see page 2-11.
Step 2 Click Add. The Add/Edit Column Controller dialog box is displayed.
The Add/Edit Column Controller dialog box enables you to add, and/or edit the columns and information displayed in the table.
The following fields are displayed in the Add/Edit Column Controller dialog box:
•Column Title—The column heading displayed in the table.
•Column Data—The column information displayed in the table.
The following buttons are displayed in the Add/Edit Column Controller dialog box:
•OK—Saves the column information and closes the Add/Edit Column Controller dialog box.
•Cancel—Closes the Add/Edit Column Controller dialog box without saving any changes.
•Apply—Saves the column information and the Add/Edit Column Controller dialog box remains open.
Step 3 Define the soft property's table information.
Step 4 Click OK. The Parsing tab is displayed along with the newly defined table information.
Proceed to Debugging the Soft Property to debug the soft property table.
Testing the Parsing Rules
The Soft Properties Manager provides testing functions, which enable the user to simulate each parsing rule (as well as the whole parsing sequence). In addition, the user can test and debug the property on the NE.
The user can test and simulate the actual input parsing according to the parsing operators and display the parsing result. This tests all the defined parsing rules in the order that they are given.
To test the parsing rules:
Step 1 Click Test Expression in the Add/Edit Parsing Rule dialog box. The Test Parsing Rules dialog box is displayed.
The Input Buffer area enables the user to enter the input to parse. The parsing input can be copied and pasted by the user or be retrieved from the device. The Input Buffer area is mandatory.
The Output Buffer area displays the parsing result log. It may contain only the final parsing result or the entire parsing log with comments per parser used.
The following buttons are displayed in the Test Parsing Rules dialog box:
•Close—Closes the Test Parsing Rules dialog box.
•Test—Parses the input entered in the Input Buffer area according to the parsing operators. The parsing result is displayed in the Output Buffer area.
Step 2 Click Test. The results of the test are displayed Test Parsing Rules dialog box.
Step 3 Click Close. The Add/Edit Parsing Rule dialog box is displayed.
Step 4 Click OK. The Parsing tab is displayed.
Proceed to Defining the TCA Alarms Parameters to define the TCA alarm parameters of the soft property.
Defining the TCA Alarms Parameters
The TCA Alarms tab enables the user to set threshold conditions for the soft property value, which will generate an alarm when crossed.
The user can select the severity level that will be associated with the alarm, and enable/disable the alarm. In addition, the user can select the threshold type.
The user can define multiple alarms for the same soft property. The alarm is displayed in the Alarm view of the Cisco ANA NetworkVision window.
To define the TCA Alarms parameters:
Step 1 Select the TCA Alarms tab. The TCA Alarms tab is displayed.
Note The TCA Alarms tab is only displayed when the Property type is selected in the General tab.
The following columns are displayed in the TCA Alarms tab:
•Description—A free text area used to describe the alarm.
•Trigger—Displays the details of the trigger selected, namely, what will cause the alarm to be sent. For more information about triggers, see Appendix B, "Alarm Threshold Triggers".
•Enabled—Displays the status of the alarm, namely, enabled (true) or disabled (false), as defined in the General tab of the Add TCA dialog box.
The following buttons are displayed in the TCA Alarms tab:
•Add—Opens the Add TCA dialog box, enabling you to define the parameters of the TCA alarm.
•Edit—Opens the Add TCA dialog box enabling you to edit the parameters of a previously defined TCA alarm.
Note Edit the parameters of a TCA alarm by selecting it in the table and clicking Edit.
•Delete—Deletes the selected TCA alarm from the TCA Alarms tab.
Note Delete a TCA alarm by selecting it in the table and clicking Delete.
Step 2 Click Add. The Add TCA dialog box is displayed. The Add TCA dialog box is divided into the following tabs:
•General tab—Enables you to define the general parameters of the TCA alarm, for example, the severity and the name of the alarm.
•Trigger tab—Enables you to define the alarm threshold trigger for the TCA alarm. For more information, see Appendix B, "Alarm Threshold Triggers".
The following fields are displayed in the General tab of the Add TCA dialog box:
•Name—The alarm name that is displayed in the Ticket pane when the alarm is triggered.
•Description—A description of the alarm.
The following checkboxes are displayed in the General tab of the Add TCA dialog box:
•Enabled—Select this option to enable the alarm or deselect this option to disable the alarm.
•Can be correlated to other alarms—Select this option to correlate this alarm to other alarms. For more information about correlating alarms, refer to the Cisco Active Network Abstraction NetworkVision User's Guide.
•Can other alarms be correlated to this alarm—Select this option to enable other alarms to be correlated to this alarm. For more information about correlating alarms, refer to the Cisco Active Network Abstraction NetworkVision User's Guide.
The following dropdown list is displayed in the General tab of the Add TCA dialog box:
•Alarm Severity—Select the severity level associated with the alarm, namely:
–Critical
–Major
–Minor
–Warning
–Normal
For more information about alarm severity, refer to the Cisco Active Network Abstraction NetworkVision User's Guide.
The Alarm description preview area is currently unavailable in this version.
The following buttons are displayed in the General tab of the Add TCA dialog box:
•OK—Saves the parameters of the TCA alarm and closes the Add TCA dialog box.
•Cancel—Closes the Add TCA dialog box without saving any changes.
•Apply—Saves the parameters of the TCA alarm and the Add TCA dialog box remains open.
Step 3 Define the General parameters for the TCA alarm.
Step 4 Select the Trigger tab. The Trigger tab in the Add TCA dialog box is displayed. The following dropdown list is displayed in the Trigger tab of the Add TCA dialog box:
•Trigger—Select one of the following threshold types:
–Value Equal—The alarm condition is reached when the soft property value is equal to the value defined in the "Alarm Value" regardless if it is numeric or not. For more information, see page B-1.
–Value Not Equal—The alarm condition is reached when the soft property value is NOT equal to the value defined in the "Alarm Value" regardless if it is numeric or not. For more information, see page B-1.
–Upper Threshold—The upper threshold value, which when crossed triggers the alarm for the defined numeric properties. For more information, see page B-2.
–Lower Threshold—The lower threshold value, which when crossed triggers the alarm for the defined numeric properties. For more information, see page B-3.
–Upper Rate—The upper rate threshold value for the performance counters, which when crossed triggers the alarm for the defined numeric properties. For more information, see page B-4.
–Lower Rate—The lower rate threshold value for the performance counters, which when crossed triggers the alarm for the defined numeric properties. For more information, see page B-5.
For more information about triggers, see Appendix B, "Alarm Threshold Triggers.".
Step 5 Define the Trigger parameters for the TCA alarm.
Step 6 Click OK. The TCA Alarms tab is displayed.
Proceed to Debugging the Soft Property to debug the soft property.
Debugging the Soft Property
The user can debug the soft property on the Managed Element or selected object in the Network Element by opening the Debug Soft Property dialog box, which displays the status of the soft property when it is debugged. For example, to confirm that a selected device supports Telnet (see Chapter 3, "Examples" for more information).
To debug the soft property:
Step 1 Click Debug in the Add Soft Property dialog box. The Debug Soft Property dialog box is displayed with the results of the debug.
Figure 2-5 Debug Soft Property Dialog Box
Step 2 Click Close. The Add Soft Property dialog box.
Step 3 Click OK. The Soft Properties Manager window is displayed with the newly created soft property displayed in the Element Properties table.
Step 4 Click Close. The Cisco ANA NetworkVision or Inventory window is displayed depending on your original selection.
Proceed to Viewing the Soft Property in the Inventory Window to view the results of the soft property in the Inventory window.
Viewing the Soft Property in the Inventory Window
After creating or editing a soft property the user can view the results in the Properties pane of the Inventory window for the Managed Element or selected object in the Network Element.
Note The user will only be able to view the soft property in the Inventory window after it has been closed and reopened. For example, if you open an inventory on a VNE and add a property to one of the ports then it will only be displayed after you close and reopen the inventory on the VNE.
To view the soft property:
Step 1 Right-click on the required Managed Element in the Tree pane or workspace of the Cisco ANA NetworkVision window, and select Inventory from the shortcut menu. The Inventory window for the required Managed Element is displayed with the newly defined soft property or soft property table.
Step 2 Click in the top right corner to close the Inventory window.
Proceed to Publishing the Soft Property to publish the soft property.
Publishing the Soft Property
A property definition is applicable to all objects of the same type in the selected NE. However, the user may want to apply the same property definitions to all NEs of the same type or family. This requires moving the property definition from the specific NE instance to a higher level in the Cisco ANA registry hierarchy.
After the soft property has been defined and tested on a specific instance of a Managed Element it can be published and applied to wider scope of Managed Elements in the network.
The Soft Properties Manager Soft Properties Publish Controller dialog box enables the user to publish the soft property to one or more locations across the inheritance hierarchy (as defined in the system). In other words the user defines the scope where the soft property will be applied in the hierarchy.
Different variations of a soft property can be used for different Managed Elements and Network Elements, where the implementation of the soft property is different for each Managed Element or Network Element.
An example of an inheritance hierarchy is displayed below. In this example, the top level of the hierarchy is All devices and the lowest level of the hierarchy is Device XYZ.
Figure 2-6 Inheritance Hierarchy Example
When a soft property is published to a node in the hierarchy, this overrides any inherited soft properties from a higher level, and automatically applies it to all its children. For example, if a soft property is published to Cisco 7200 it will override any variant of this soft property which is defined at a higher level, and will be assigned to all devices of type Cisco 7200 in the system.
Note It is highly recommended that you measure the affect of publishing the soft property on memory usage of the system before it is published. To view the changes you must restart the VNE or ANA Unit in order for the publishing to take affect. For more information about measuring the affect of publishing the soft property, please contact Cisco Professional Services.
Note Soft property publishing sometimes deeply affects the system memory usage, device utilization and system performance. For example, the user can add a property running "show running-config" to the device in status polling and publish it to a group of devices. This will probably cause the system memory usage to jump and the device's utilizations to jump.
To publish a soft property:
Step 1 Right-click on the required Managed Element in the Tree pane or workspace of the Cisco ANA NetworkVision window.
or
Open the Inventory window for the required Managed Element and right-click on the required object in the Network Element.
Step 2 Select Management | Soft Properties Management from the shortcut menu. The Soft Properties Manager window is displayed.
Step 3 Select the required Properties Panel and soft property in the Element Properties table.
Step 4 Click Hierarchy Manager in the toolbar of the Soft Properties Manager window.
or
Select Hierarchy Manager from the Tools menu or shortcut menu.
The Hierarchy Manager table is generated and displayed.
Note If user-friendly VNE names exist in the schema then the Hierarchy Manager table will display these user-friendly registry location names in the VNE Hierarchy Location column.
Each row that is displayed in the Hierarchy Manager table represents a different level of the hierarchy. The rows are displayed in descending order; the top row is the highest level of the hierarchy and the bottom row is the lowest level of the hierarchy.
The following information is displayed in the table:
•Exist—When a node in the hierarchy is selected this indicates that a local variant of the soft property exists for that node.
•VNE Hierarchy Location—The hierarchy path, as defined in the Cisco ANA Registry.
•IMO Class Name—Currently unavailable in this version.
The following tools are displayed in the Hierarchy Manager window:
Table 2-2 Hierarchy Manager window tools
|
Copies the soft property from a selected node in the hierarchy in order to copy it to another node in the hierarchy. A copy icon is displayed to the left of the selected node.
|
|
Cuts the soft property from a selected node in the hierarchy in order to move it to another node in the hierarchy. A cut icon is displayed to the left of the selected node.
|
|
Pastes the soft property that was copied or cut from a selected node in the hierarchy to another node in the hierarchy. A paste icon is displayed to the left of the selected node.
|
|
Deletes the soft property from the selected node in the hierarchy.
Note If the soft property has been deleted from all the nodes, the soft property will be removed from the list in the main dialog of the Soft Properties Manager.
|
The following button is displayed in the Hierarchy Manager window:
•Close—Closes the Hierarchy Manager window without publishing the soft property.
Step 5 Select the required node in the hierarchy from which you want to publish the soft property.
Step 6 Click Copy or Cut in the toolbar to copy or cut the soft property.
Step 7 Select the required node in the hierarchy where you want to publish the soft property.
Step 8 Click Paste in the toolbar to paste the soft property. The soft property is published to the selected node in the hierarchy.
Deleting a Soft Property
Soft properties created by the user are by default always created as a local instance. A soft property that is defined locally is selected in the Soft Properties Publish Controller dialog box. The user can delete soft properties whether or not they have been published.
To delete a soft property:
Step 1 Select the soft property that you want to delete in the Element Properties table of the Soft Properties Manager dialog box.
Step 2 Click Delete Element in the toolbar of the Soft Properties Manager window.
or
Select Delete Element from the File menu or shortcut menu.
A warning message is displayed.
Step 3 Click Yes. The soft property is deleted and no longer displayed in the Element Properties table of the Soft Properties Manager window.
Importing and Exporting a Soft Property
The Soft Properties Manager enables the user to export (save) a soft property definition to a file. The soft property definition can then be imported (copied) later to another Managed Element.
In addition, the user can export and import a soft property definition to a file and publish it to multiple places in the Hierarchy Manager window.
To export a soft property:
Step 1 Select the soft property that you want to export in the Element Properties table of the Soft Properties Manager dialog box.
Step 2 Click Export Element in the toolbar of the Soft Properties Manager dialog box.
or
Select Export Element from the Tools menu or shortcut menu.
The Export dialog box is displayed.
Note If user-friendly VNE names exist in the schema then the Hierarchy Manager table will display these user-friendly registry location names in the VNE Hierarchy Location column.
Step 3 Select the version that you want to export in the table of the Export window. The version is selected in the table.
Step 4 Click OK. The Export Property dialog box is displayed.
Step 5 Browse to the directory where you want to save the soft property.
Step 6 In the File name field, enter a name and extension (for example, .txt) for the soft property.
Step 7 Click Save. The soft property is saved in the selected directory. The Export dialog box is displayed.
Step 8 Click Close. The Soft Properties Manager window is displayed.
To import a soft property:
Step 1 Click Import Element in the toolbar of the Soft Properties Manager window.
or
Select Import Element from the Tools menu.
The Import Element dialog box is displayed.
Step 2 Browse to the directory and soft property that you want to import.
Step 3 Click Open. The Import elements window is displayed.
Step 4 Select the version that you want to import in the table of the Import Elements window. The version is selected in the table.
Step 5 Click OK. The Soft Properties Manager window is displayed.
Step 6 Click Close. The soft property is imported to the selected Managed Element or Network Element and displayed in the Soft Properties Manager window.
Closing the Cisco ANA Soft Properties Manager
When the user has finished working with the Cisco ANA Soft Properties Manager the user can close the Soft Properties Manager.
To close the Cisco ANA Soft Properties Manager, click Close. The Soft Properties Manager is closed.
Feedback
