The response element files contain five description areas, each with their own fields that eHealth populates for each area:
• GlobalInfo
• Elements
• ElementGroups
• Associations
• Operations
Table 7 lists the areas and fields for response element files.
54 • Chapter 3 Configuring Cisco VPNSC Elements in eHealth
eHealth Integration for Cisco VPN Solutions Center User Guide Table 7. Response Element File Fields (Page 1 of 8)
Areas Field Description
GlobalInfo nmsSource Specifies the name of the NMS source of this element. For an individual element, this value overrides the nmsSource value specified in the GlobalInfo section of the DCI file.
Elements objId Assigns a unique identifier to the object
(element) in this file. eHealth uses the objId as an
“intersection reference.” Each definition in the DCI file must begin with a unique object ID (without spaces). The objId value does not appear in the eHealth Poller Configuration dialog box. eHealth uses this value in this file only.
name Specifies the name of the element. This is the name that appears in the list of elements. The element name cannot exceed 64 bytes. If the element name exceeds 64 bytes, eHealth rejects the entire DCI file.
You can specify up to 32 double-byte or 64 single-byte characters using uppercase or lowercase letters (A - Z), numbers 0 through 9, dashes (-), periods (.), underscores (_), colons (:), slashes (/), and backslashes.
nmsId Specifies a unique ID for an element; usually an NMS provides this ID. If the value includes spaces, you must enclose it in quotation marks (" "). This field accelerates eHealth processing.
Supply a value for this field to give the element a unique identifier that is independent of its name.
If you want to modify element attributes by using operations such as merge, you must specify an nmsId value and other attributes such as indexes.
NOTE: You cannot use the merge operation to change this field.
Element Files • 55
eHealth Integration for Cisco VPN Solutions Center User Guide
3 1
Elements (continued)
poll Indicates whether eHealth polls the element.
Specify Yes (the default) to enable importing data for the element. Specify No to disable importing.
NOTE: You cannot use the merge operation to change this field.
mibTranslationFile Specifies the name of the eHealth MTF for the element. The default is an empty string (" ").
When you create a new element, set this field and the discoverMtf field to the same MTF name. To determine if the configuration information for an element is imported, eHealth examines the MTF name in this field. The characters LPS must be part of the MTF name for an imported element.
If you change an element’s agent type in the poller configuration, the element’s
mibTranslationFile value changes, but its discoverMtf value does not.
ipAddr Specifies the Internet Protocol (IP) address of the element. The default is 0.0.0.0.
NOTE: You cannot modify this field on a child element; however, you can modify this field on a parent element to change its value on all associated children.
ifType Specifies the type for an interface element.
You can specify any text. This field is for display purposes only. The default is an empty string (" ").
Table 7. Response Element File Fields (Page 2 of 8)
Areas Field Description
56 • Chapter 3 Configuring Cisco VPNSC Elements in eHealth
eHealth Integration for Cisco VPN Solutions Center User Guide Elements
(continued)
index1 index2
Specifies values that help to create unique definitions for multiple elements on the same device. You can use the MIB index values to make elements easily identifiable in the DCI file or poller configuration. The value for index1 must be an integer. The default is 0. The value for index2 can be any string. The default is an empty string (" ").
nmsSource Specifies the name of the NMS source of this element. For an individual element, this value overrides the nmsSource value specified in the GlobalInfo section of the DCI file.
discoverMtf Specifies the name of the MTF that eHealth assigned when it discovered the element. This may not be the same MTF that eHealth uses to poll the element. This field is for eHealth internal use.
When you create a new element, set the mibTranslationFile field and the discoverMtf field to the same MTF name. If you change an element’s agent type in the poller configuration, the element’s mibTranslationFile value changes, but its discoverMtf value does not change.
nmsName Specifies the name of the element at the NMS.
The default value is an empty string (" ").
protocolCfgSymbol For eHealth —Response elements, specifies the protocol used to measure response time between the two endpoints of a response path.
NOTE: For defining new integration modules, you can only specify genericResponsePath (the default).
Table 7. Response Element File Fields (Page 3 of 8)
Areas Field Description
Element Files • 57
eHealth Integration for Cisco VPN Solutions Center User Guide
3 1
Elements (continued)
deviceSpeedIn Specifies the default incoming speed of a device in bits per second. To obtain the element’s
incoming speed from the NMS, specify a value for the deviceSpeedIn field. This value appears as the default incoming speed for the element in the eHealth poller configuration.
If you set an incoming override speed using the speedIn field, eHealth uses the element’s override speed instead of its default speed to calculate performance. The default leaves the
deviceSpeedIn value unchanged.
deviceSpeedOut Specifies the default outgoing speed of a device in bits per second. To obtain the element’s outgoing speed from the NMS, specify a value for this field.
This value appears as the default outgoing speed for the element in the eHealth poller
configuration.
If you set an outgoing override speed using the speedOut field, eHealth uses the element’s override speed instead of its default speed to calculate performance. The default leaves the deviceSpeedOut value unchanged.
genericResponseCommunity Name of the Response Community genericResponseAgentAddress IP address for the Response Agent genericResponseGoal Variable to set for the protocol
ElementGroups objId Assigns a unique identifier to the object
(element) in this file. eHealth uses the objId as an
“intersection reference.” Each definition in the DCI file must begin with a unique object ID (without spaces). The objId value does not appear in the eHealth Poller Configuration dialog box. eHealth uses this value in this file only.
Table 7. Response Element File Fields (Page 4 of 8)
Areas Field Description
58 • Chapter 3 Configuring Cisco VPNSC Elements in eHealth
eHealth Integration for Cisco VPN Solutions Center User Guide ElementGroups
(continued)
groupName The name of the group. If it does not exist in eHealth, eHealth creates it. If the group already exists, eHealth adds the elements to the existing group.
elementObjId Specifies the object identifier of the element that you are adding to a group. This value must correspond to the element’s object ID specified in the objId field of the Elements section.
Associations objId Assigns a unique identifier to the object
(element) in this file. eHealth uses the objId as an
“intersection reference.” Each definition in the DCI file must begin with a unique object ID (without spaces). The objId value does not appear in the eHealth Poller Configuration dialog box. eHealth uses this value in this file only.
originElemObjId Specifies the object ID of the element that you want to associate with another element. For example, in a parent-child relationship, you would specify the originElemObjIdfor a child element. The originElemObjIdvalue must correspond to the element’s object ID specified in the ObjIdfield of the Elements section.
destElemObjId Specifies the object ID of the element with which you want to associate another element. For example, in a parent-child relationship, you would specify this field for a parent element. The destElemObjId value must correspond to the element’s object ID specified in the objId field of the Elements section.
Table 7. Response Element File Fields (Page 5 of 8)
Areas Field Description
Element Files • 59
eHealth Integration for Cisco VPN Solutions Center User Guide
3 1
Associations (continued)
assocType Specifies the association (relationship) type:
• 0 - parentChild (the default)
You can define parent-child relationships for the following eHealth element types: router or system CPUs, system partitions or disks, and remote access server (RAS) CPUs.
• 1 - responseSource
The source relationship for eHealth elements associates a response path with a response source (the logical or physical source [client]
of the transaction request).
• 2 - responseDestination
The destination relationship for eHealth elements associates a response path with a response destination (logical or physical target [server] of the transaction request).
• 3 - dataCollector
The dataCollector relationship for eHealth elements associates a response path with a response collector (response data source that eHealth — Response uses to populate path elements).
• 4 - device
The device relationship for eHealth exists for application service and response elements.
This association relates an element such as an application service process set, system process set, or response endpoint (source or destination) to a device element such as a router, system, or probe. The device relationship enables these elements to share addressing information. It also allows you to drill down to device performance
information from the specific element reports.
Table 7. Response Element File Fields (Page 6 of 8)
Areas Field Description
60 • Chapter 3 Configuring Cisco VPNSC Elements in eHealth
eHealth Integration for Cisco VPN Solutions Center User Guide Associations
(continued)
assocType (continued) • 5 - copyOf
This field is for eHealth internal use.
• 6 - processSet
The processSet relationship associates multiple processes that are running on the eHealth system with a single process set.
• 7 - sideA
• 8 - sideZ
The sideA and sideZ relationship identifies the two endpoint elements associated with a common PVC element. Once this
relationship is established, eHealth can poll and report on the PVC element.
• 9 - respClientSet
The respClientSet relationship associates a response source with a client set.
• 10 - respPathSet
The respPathSet relationship associates a response path with a response destination for a particular application.
Table 7. Response Element File Fields (Page 7 of 8)
Areas Field Description
Element Files • 61
eHealth Integration for Cisco VPN Solutions Center User Guide
3 1
Operations operator Specifies the operation to perform. It has one of the following values:
• add - Adds an individual object (element, calendar, group, association), specified by its OID, to the eHealth poller configuration.
• delete - Deletes an individual object specified by the OID from the eHealth poller
configuration.
• modify - Modifies the attributes of an individual object, specified by objId1, with the non-blank fields specified for objId2.
• merge - Adds all objects (elements, groups, group contents, calendars, group lists, group list contents, and associations) specified in the DCI file to the eHealth poller
configuration.
• mergeWithDelete - Adds all objects (elements, groups, calendars, associations, or monitored subjects) specified in the DCI file to the eHealth poller configuration. It also disables polling for all elements that are not included in the DCI import file and whose NMS source value (nmsSource) matches the nmsSource value set in the GlobalInfo section.
To use the mergeWithDelete operation, you must specify an nmsSource value in the GlobalInfo section.
Table 7. Response Element File Fields (Page 8 of 8)
Areas Field Description
62 • Chapter 3 Configuring Cisco VPNSC Elements in eHealth
eHealth Integration for Cisco VPN Solutions Center User Guide