Event Gateway stitcher rules
Use these stitcher rules for reference when you are working
with Event Gateway stitchers. These rules are only available within
the Event Gateway, ncp_g_event and its plugins.
GwCollects() GwCollects(); rule retrieves a list of entities directly collected by a specified entity. This data is retrieved from the NCIM cache table, ncimCache.collects.GwConnects() GwConnects(); rule retrieves a list of entities directly connected to a specified entity. This data is retrieved from the NCIM cache table, ncimCache.connects. A limitation on this rule is that it does not retrieve connections to contained entities. For example, if the entity passed to the rule represents a chassis, connections to interfaces within that chassis will not be returned.GwContains() GwContains(); rule retrieves a list of entities directly contained by a specified entity. This data is retrieved from the NCIM cache table, ncimCache.contains. No recursion is performed. For example, if a chassis contains some cards, and those cards contain interfaces, the result of running this rule against the chassis will be a list of cards.GwDependency() GwDependency(); rule retrieves a list of dependencies upon a specified entity. This data is retrieved from the NCIM cache table, ncimCache.dependency.GwEnrichEvent() GwEnrichEvent(); updates fields in an event. Any data can be added to an event using this rule; however, the only fields which are permitted to update the ObjectServer alerts.status table are those fields that are listed in the outgoing field filter, as defined in the in the FieldFilter section of the nco2ncp table within the EventGatewaySchema.cfg configuration file.GwEntityData() GwEntityData(); rule provides a simplified way of looking up topology data in NCIM cache. This rule performs topology lookups in the ncimCache.entityData table.GwHostedService() GwHostedService(); rule retrieves a list of entities directly connected to a specified entity. This data is retrieved from the NCIM cache table, ncimCache.hostedService.GwIpLookup() GwIpLookup(); rule allows rapid and efficient topology lookups for the entity that implements a given IP address or DNS name. This entity is often an interface, but, if no SNMP access is available to a device, it could be the related chassis.GwIpLookupUsing() GwIpLookupUsing(); rule performs the same operation as the GwIpLookup() rule, except that a field within the current top-level in-scope event is used to perform the lookup.GwMainNodeLookup() GwMainNodeLookup(); rule performs topology lookups for main nodes, based on a limited number of fields.GwMainNodeLookupUsing() GwMainNodeLookupUsing(); rule performs the same operation as the GwMainNodeLookup() rule, except that a field within the current top-level in-scope event is used to perform the lookup. GwManagedStatus() GwPipeComposition() GwPipeComposition(); rule retrieves a list of pipe compositions for a specified entity. This data is retrieved from the NCIM cache table, ncimCache.pipeComposition.GwProtocolEndPoint() GwProtocolEndPoint(); rule retrieves a list of entities directly connected to a specified entity. This data is retrieved from the NCIM cache table, ncimCache.protocolEndPoint.