Cisco Prime Network Customization Guide, 5.1

vcb

The vcb command is the wrapper for all VCB-related commands.

Syntax

{uvne|module|pluggablemodule|event|eventpattern|eventparsingrules|devicetype} {add|view|modify|delete} args… [-help ] [-debuglevel {error|warn|info|debug}] [-logfile logfile ] -user username -password password

vcb {eventarg} {view} [-help ] [-debuglevel {error|warn|info|debug}] [-logfile logfile ]] -user username -password password

vcb {sitechanges} {view|export|delete} [-help ] [-debuglevel {error|warn|info|debug}] [-logfile logfile ]] -user username -password password

For information—descriptions, options, and usage—about specific commands, see specific command references:

• VCB CLI Reference: U-VNEs Commands
• VCB CLI Command Reference: Device Types Commands
• VCB CLI Command Reference: Standard Modules
• VCB CLI Command Reference: Pluggable Modules

Global Command Options

Table B-1 describes the global options and arguments that are common to all vcb commands and subcommands.

Description

Use the vcb command to create and update VNE registry configuration files. Use the vcb command to add, delete, view, and modify information in these files, based on the subcommands that are used with it.

The vcb command performs the following high-level operations:

• Executes Prime Network administrator-level operations. It also provides a service to handle authorization errors. VCB users must have the Prime Network admin user role and associated privileges in order to perform registry configuration commands.
• Verifies that the expected version of Prime Network is running.
• Provides help information for each command.
• Logs all internal commands.
• Centralizes error handling for exceptions.

General Error Codes

vcb sitechanges

The vcb sitechanges command affects all extensions in the local site.xml file—displaying, exporting, or deleting them—whether the extensions were created by the VCB or by other Prime Network utilities.

Syntax

vcb sitechanges {view|export|delete} [-help ] [-debuglevel {error|warn|info|debug}] [-logfile logfile ]] -user username -password password

Description

Use the vcb sitechanges command to view all customizations that were made to the site.xml registry file whether by the VCB or by other Prime Network utilities. Use the vcb sitechanges command also to write all customizations to script files that enable you to import changes to another system or to delete all changes, returning the system to factory default.

Because the VCB does not differentiate between changes made by the VCB and changes made by other Prime Network utilities, the vcb sitechanges export and vcb sitechanges delete commands create script files to enable you to inspect commands before you execute them. Edit the script files before running them to ensure that only the customizations that you are interested in are acted upon.

vcb uvne add

The vcb uvne add command creates a U-VNE by associating a U-VNE template with the device type associated with the given sysOID, or by cloning from an existing device or device family.

Syntax

vcb uvne add -sysoid sysoid -template template name -group template filename [-devicetype device type name ] -user username -password password

vcb uvne add -sysoid sysoid -clonesysoid clone_sysoid -user username -password password

vcb uvne add -sysoid sysoid -clonedevicefamily devicefamily [-devicetype device type ] -user username -password password

vcb uvne add -sysoid sysoid -softwareversion software-version -clonesoftwareversion clone-softwareversion -clonedevicefamily devicefamily -scheme <product|ipcore > [-devicetype device type name ] -user username -password password

Description

The vcb uvne add command creates a U-VNE-driver for the device type associated with the given sysOID using the specified U-VNE template. Creating a U-VNE-driver enables the Auto Detect feature in Prime Network to associate a device with this sysOID with the VNE-driver implementation defined by the template.

This command creates a separate registry configuration for the U-VNE. Any configuration setting given in the command parameters affect this copy.

Note This command does not create the device category for the device. For more information, see vcb devicetype add.

Usage Examples

Example 1

vcb uvne add -sysoid .1.2.3.4 -template GenericUVNE -group uvne -user root -password admin

Enables discovery of the device with sysOID 1.2.3.4 using the GenericUVNE template, which is located in group uvne-product.

The command does not create any device attributes for the newly added device. To assign the device a user-friendly name and the correct device category, use the -devicetype option (see the “vcb devicetype add” section).

Example 2

vcb uvne add -sysoid .1.2.3.4 –clonesysoid .1.3.6.1.4.1.9.1.108 -user root -password admin

Enables discovery of a new device (with sysOID.1.2.3.4) that points to registration—scheme and instrumentation commands—of the already supported sysOID.1.3.6.1.4.1.9.1.108.

(To create a list of already supported VNEs, see vcb uvne view.)

Example 3

vcb uvne add -sysoid .1.2.3.4 –softwareversion 12.6(2) –clonesoftwareversion 12.0(23)S2 –clonedevicefamily 100xx –scheme product -user root -password admin

Adds support for a new device (with sysOID.1.2.3.4) based on the device family 100xx. Also adds support for the new software version for this device family. (For a list of already supported software versions, see vcb uvne view.)

Example 4

vcb uvne add -sysoid .1.2.3.4 –clonedevicefamily 100xx -user root -password admin

Enables discovery of a new device (with sysOID.1.2.3.4), that points to registrations—scheme and instrumentation commands—for the device family 100xx.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb uvne view

The vcb uvne view command returns an existing U-VNE configuration.

Syntax

vcb uvne view -sysoid {sysoid | all} -user username -password password [-userdefined][-detail]

vcb uvne view -template { template name | all} -group <template group name> -user username -password password

Description

Use the vcb uvne view command to:

• Display information based on the specified sysOID.
• Display available templates found in the specified group.

Usage Examples

Example 1

vcb uvne view -sysoid .1.2.3.4 -user root -password admin -userdefined

Returns the configuration of the VNE with the sysOID 1.2.3.4, including the U-VNE template (or the device family for a developed VNE). If device-type associations are defined (using the vcb devicetype add command), these associations are also displayed.

Example 2

vcb uvne view -sysoid all -user root -password admin

Returns all the sysoid supported in Prime Network.

Example 3

vcb uvne view -sysoid all -user root -password admin -detail

Returns all known configured sysOIDs (regular VNEs) and also this command would show following additional informations

• Module Spec Name associated with the sysoid.
• Syslog and Trap Parsing rule name associated with the sysoid

Here is an example of the output:

SysOid......:.9.7.6.5.4.3.1

DeviceFamily:76xx

CloneSysOid.:.1.3.6.1.4.1.9.1.863

Scheme........:product

Module Spec.........:ciscophysicalspec2

Trap Parsing Rule...:cisco-trap-product-parsing-rules

Syslog Parsing Rule.:cisco-syslog-product-parsing-rules

Scheme........:ipcore

Module Spec.........:ciscophysicalspec2

Trap Parsing Rule...:cisco-trap-ipcore-parsing-rules

Syslog Parsing Rule.:cisco-syslog-ipcore-parsing-rules

SysOid.....:.3.4.5.6.7

Template...:GenericUVNE

Group......:uvne

Device Type:UNKNOWN

Scheme........:product

Module Spec.........:N/A

Trap Parsing Rule...:genericuvne-trap-parsing-rules

Syslog Parsing Rule.:genericuvne-syslog-parsing-rules

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb uvne modify

The vcb uvne modify command modifies the configuration of an existing U-VNE.

Syntax

vcb uvne modify -sysoid sysoid -template template name -group template filename -user username -password password

vcb uvne modify -sysoid sysoid -devicetype device type -user username -password password

vcb uvne modify –sysoid sysoid -clonesysoid sysoid -user username -password password

vcb uvne modify –sysoid sysoid -softwareversion softwareversion -clonesoftwareversion clonesoftwareversion -clonedevicefamily devicefamily -scheme vnescheme -user username -password password

vcb uvne modify –sysoid sysoid -clonedevicefamily devicefamily -user username -password password

Description

Use the vcb uvne modify command to:

• Associate the U-VNE with another U-VNE template.
• Change the device type associated with the U-VNE.
• Change the cloning reference of a U-VNE.

Usage Examples

Example 1

vcb uvne modify -sysoid .1.2.3.4 -group uvne-product -template GenericUVNE -user root -password admin

Modifies the template of the U-VNE to the newly specified template defined in the given group.

Example 2

vcb uvne modify -sysoid .1.2.3.4 -devicetype CISCO_1760 -user root -password admin

Modifies the device type for the U-VNE with sysOID 1.2.3.4.

Example 3

vcb uvne modify -sysoid .1.2.3.4 –clonesysoid .1.3.6.1.4.1.9.1.108 -user root -password admin

Modifies a device, with sysOID.1.2.3.4, to point to a new device family based on the clone sysoid.1.3.6.1.4.1.9.1.108.

Example 4

vcb uvne modify -sysoid .1.2.3.4 –clonedevicefamily 12xxx -user root -password admin

Modifies support for a new device, with sysOID.1.2.3.4, to point to registrations—scheme and instrumentation commands—of the device family 12xxx.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb uvne delete

The vcb uvne delete command deletes a U-VNE.

Syntax

vcb uvne delete -sysoid sysoid -user username -password password

vcb uvne delete -sysoid sysoid -devicefamily DeviceFamilyName -scheme schemeName -softwareversion “softwareVersionNumber” -user username -password password

Description

The vcb uvne delete command is useful when migrating from a U-VNE to a developed VNE. If, in an upgrade, Prime Network provides a DSP that contains a developed VNE to support the device type, the need for the U-VNE is eliminated. You must delete the U-VNE before Prime Network can use the developed VNE to model and manage the device.

Deleting a template-based U-VNE has no effect on the U-VNE template from which it derives its implementation.

Usage Example

Example 1

vcb uvne delete -sysoid .1.2.3.4 -user root -password admin

Deletes the U-VNE-driver configured for the device with sysOID 1.2.3.4.

Example 2

vcb uvne delete -sysoid .1.2.3.4 -devicefamily 70xx -scheme product -softwareversion “12.0(23)S3”

Deletes the software configuration for U-VNE driver configured for the device with sysOID.1.2.3.4. Use the command in Example 1 to delete the U-VNE.

Note that the vcb uvne delete syntax should match the vcb uvne add syntax to avoid items being left in the site.xml after the delete action. For example, if the vcb uvne add syntax is as follows:

vcb uvne add -sysoid.1.3.6.1.4.1.9.1.917 -softwareversion "15.1(2)SG1" -clonesoftwareversion "gt 12.2(52)SG" -clonedevicefamily cisco-catalyst-4900-series -scheme product -devicetype CISCO_CATALYST_4900M -override -user root -password admin

then, the vcb uvne delete syntax should be as follows:

vcb uvne delete -sysoid.1.3.6.1.4.1.9.1.917 -devicefamily cisco-catalyst-4900-series -scheme product -softwareversion "15.1(2)SG1" -user root -password admin

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb devicetype add

The vcb devicetype add command creates new user-experience attributes for the specified device type. Each device type is associated with a user-friendly name, icon, and device grouping.

Syntax

vcb devicetype add -devicetype device type -category prime network device category -name device name [ -key device type key ] -user root -password admin

Description

The vcb devicetype add command creates user-experience attributes that affect how a device type is managed and displayed in Prime Network.

Note This command is typically used before adding a new U-VNE using the vcb uvne add command. For more information, see vcb uvne add.

Usage Example

vcb devicetype add -devicetype CISCO_1760 -category ROUTER -name “Cisco 1760 Router” -user root -password admin

Adds a device-type definition for the Cisco 1760 router, including the device category and user-friendly name that will appear in the Prime Network UI. Reference this definition when adding U-VNE definitions for a Cisco 1760 device using the vcb uvne add command.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb devicetype view

The vcb devicetype view command returns an existing device-type association.

Syntax

vcb devicetype view -devicetype { device type | all } -user root -password admin

Description

Use the vcb devicetype view command to:

• Display user-experience attributes based on the specified device type.
• Display the list of device types defined in the system.
• Display all available device categories.

Usage Examples

Example 1

vcb devicetype view -devicetype all -user root -password admin

Returns a list of all device types defined in Prime Network.

Example 2

vcb devicetype view -devicetype CISCO_1760 -user root -password admin

Returns the device type details for device type CISCO_1760, including the category and user-friendly name defined for this type.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb devicetype modify

The vcb devicetype modify command modifies the user-experience attributes associated with specific device types.

Syntax

vcb devicetype modify -devicetype device type name [ -category prime network device category ] [ -name device name ] [ -key device type key ] -user username -password password

Description

The vcb devicetype modify command overwrites the user-experience settings defined for a device type, including the name, icon, and device category as they appear in Prime Network.

Usage Example

vcb devicetype modify -devicetype CISCO_1760 -category DSLAM -name “Cisco 1760 DSLAM” -user root -password admin

Modifies the category and name assigned to the specified device type. Any VNE that uses the U-VNE-driver associated with this device type inherits these modified user-experience attributes.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb devicetype delete

The vcb devicetype delete command deletes the user-experience attributes that are defined for the specified device type.

Syntax

vcb devicetype delete -devicetype device type -userdefined -user username -password password

Description

The vcb devicetype delete command deletes the user-friendly name, icon, and grouping that were defined for the specified device type from the site.xml file. It does not delete or otherwise modify the U-VNE template from which the U-VNE for this device type was created.

Usage Example

vcb devicetype delete -devicetype CISCO_1760 -userdefined -user root -password admin

Deletes the user-experience attributes defined for the CISCO_1760 device type.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

VCB CLI Command Reference: Standard Modules

These topics provide reference information for the vcb module commands you can use to create, view, and delete standard modules:

• vcb module add
• vcb module view
• vcb module delete

vcb module add

The vcb module add command adds support for a new module type by creating a new registration from the specified template. This support enables VNEs that contain this module to properly recognize and model it in Prime Network.

Syntax

vcb module add -module module identifier -template template name -group module group [ -hardwaredesc Hardware Description of the Module ] -user username -password password

vcb module add -module module identifier -template template name -sysoid <sysobject ID devicefamily under which module should be supported> -scheme <ipcore|product> [ -hardwaredesc Hardware Description of the Module ] -user username -password password

Description

The vcb module add command enables the VNE to automatically detect a physical module based on an implementation defined in a module template. It can be used to:

• Create a module definition based on the module identifier. When this option is used, any VNE that uses the same spec file for its module definitions can model the new module.
• Create a module definition based on an extension to the definition used by the driver of a specific device (defined by its sysOID). When this option is used, only this particular device can model the new module.

This command updates the site.xml file, in which customizations are stored. Doing so enables the tool to differentiate between factory defaults (changes supplied from DSPs) and changes initiated by the VCB.

Usage Examples

Example 1

vcb module add -module “.1.3.6.1.4.1.9.12.3.1.9.29.99” -template “1.2.3.4” –group ciscoentitymibspec –hardwaredesc cevCat6kWsf6kpfc3b -user root -password admin

Adds support for a module with the module ID.1.3.6.1.4.1.9.12.3.1.9.29.99, based on the 1.2.3.4 module template, which is listed in the spec group, ciscoentitymibspec. The hardware description is cevCat6kWsf6kpfc3b.

Example 2

vcb module add -module “.1.3.6.1.4.1.9.12.3.1.9.29.99” -sysoid “7.7.7” -template “1.2.3.4” -scheme product -user root -password admin

Adds support for a module with the ID.1.3.6.1.4.1.9.12.3.1.9.29.99, based on module template 1.2.3.4. The VCB looks up the module spec used by the VNE-driver with the sysOID 7.7.7, and registers the new module for this device only (not for all devices that share the same module spec file).

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb module view

The vcb module view command returns an existing module configuration.

Syntax

vcb module view -sysoid sysoid -module { module identifier | all} -user root -password admin -scheme <scheme>

vcb module view -group module group -module { module identifier | all} -user root -password admin

vcb module view -group module group -template { template name | all} -user root -password admin

Description

Use the vcb module view command to:

• Display module information based on the driver associated with the defined sysOID.
• Display details about the specified module.
• Display available templates found in the specified module spec file.

Usage Examples

Example 1

vcb module view -sysoid .1.2.3.4 -module all -user root -password admin -scheme product

Returns the list of supported modules for the device with sysOID 1.2.3.4.

Example 2

vcb module view -sysoid .1.2.3.4 -module 50068 -user root -password admin -scheme product

Returns the port layer definitions for module 50068, which was added to the VNE-driver for the device with sysOID 1.2.3.4.

Example 3

vcb module view -group ciscophysicalspec2 -module all -user root -password admin

Returns a list of all supported modules contained in the specified module group.

Example 4

vcb module view -group ciscophysicalspec2 -module 20091 -user root -password admin

Returns the port layer definitions for module 20091, which is part of the group ciscophysicalspec2.

Example 5

vcb module view -group ciscoentitymibspec –template all -user root -password admin

Returns a list of all templates defined in the specified module group.

Example 6

vcb module view –group ciscoentitymibspec –template ethernetDefault -user root -password admin

Returns the port layer definitions of the template if it is defined in the specified module group.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb module modify

Use the vcb module modify command to modify the associated module template.

Syntax

vcb module modify -module module identifier -group module group -template template name [ -hardwaredesc Hardware Description of the Module -user username -password password

vcb module modify -module module identifier -sysoid device sysoid -scheme <ipcore|product> -template template name [ -hardwaredesc Hardware Description of the Module ] -user username -password password

Description

The vcb module modify command can be used to:

• Associate a module with another module template.
• Change the association between a module and its module template for a device specified by its sysOID.

Usage Examples

Example 1

vcb module modify -module 20091 -group ciscophysicalspec2 -template GE-fiberoptic-ethernet-default -user root -password admin

Modifies the registration for module 20091 by associating it with module template GE-fiberoptic-ethernet-default, which is part of group ciscophysicalspec2. This module definition replaces the one obtained from the template that was specified when the module was first added. This change affects all devices that contain this module.

Example 2

vcb module modify -sysoid .1.2.3.4 -module 50068 -group ciscophysicalspec2
-template oc3-ppp-default -user root -password admin -scheme product

Modifies the registration for module 50068 by associating it with module template cc3-ppp-default. This change affects only the device with sysOID 1.2.3.4.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb module delete

Use the vcb module delete command to delete the association between a module and the implementation defined in a module template.

Syntax

vcb module delete -module module identifier -group module group -user username -password password

vcb module delete -module module identifier -sysoid device sysoid -scheme <ipcore|product> -user username -password password

Description

Note Use the vcb module delete command to enable VNEs to use factory-supplied updates if they become available.

The vcb module delete command is useful when migrating from an interim solution to a more complete implementation. Removing the association to the module from the site.xml file enables Prime Network to automatically detect a deployed implementation in a DSP.

Use the vcb module delete command:

• To delete the association between a module and its implementation on a specific device based on a defined sysOID. Other VNEs that use this implementation will still be able to identify the module.
• To delete the association between a module and its implementation on all devices that use the module as specified by the relevant group name. When the -group option is used, any VNEs that used this implementation will no longer be able to identify the module.

Note ● You can delete only those modules that were originally added using the VCB. Module definitions added as part of a developed VNE cannot be deleted.

• You can delete the module association on a specific device only when the association was created for that specific device.
• Deleting the module configuration does not delete or otherwise affect the template from which the configuration was created.

Usage Examples

Example 1

vcb module delete -module 20091 -group ciscophysicalspec2 -user root -password admin

Deletes the definition for module 20091 from the group ciscophysicalspec2. The module definition is deleted from all devices that contain this module.

Example 2

vcb module delete -sysoid .1.2.3.4 -module 50068 -user root -password admin -scheme product

Deletes the definition for module 50068 from the device with sysOID 1.2.3.4. Other devices that contain this module are unaffected.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

VCB CLI Command Reference: Pluggable Modules

These topics provide reference information for the vcb pluggablemodule commands you can use to create, view, modify, and delete pluggable modules:

• vcb pluggablemodule add
• vcb pluggablemodule view
• vcb pluggablemodule modify
• vcb pluggablemodule delete

Note To add, view, modify, or delete regular modules, see VCB CLI Command Reference: Standard Modules.

vcb pluggablemodule add

Use the vcb pluggablemodule add command to create a pluggable module definition that is associated using the module identifier. Use this command for pluggable modules such as SFPs and XFPs.

Syntax

vcb pluggablemodule add -group groupName -module moduleno -pid pid -mediatype MediaType -pluggabletype pluggableType -user username -password password

vcb pluggablemodule add -group groupName -containeroid containeroid -user username -password password

vcb pluggablemodule add -group groupName -basetype basetype -user username -password password

Description

Prime Network does not model pluggable modules, only the ports on them. Configuration details that are entered using this command are displayed at the port level to differentiate between pluggable and regular ports. Changes made through this command apply to all VNEs that use the same spec file for pluggable ports.

The container oid and base type value are additional configuration information needed to model pluggable module properly. When you add new pluggable module make sure that container oid and base type values are added in the system.

Usage Example

vcb pluggablemodule add -module “.1.3.6.1.4.1.9.12.3.1.9.51.22” –group pluggable-ports-spec –mediatype fiber –pluggabletype SFP -user root -password admin

Adds support for a pluggable module of type SFP with the module ID.1.3.6.1.4.1.9.12.3.1.9.51.22, to the pluggable-ports-spec module specification file. The media type is fiber optic.

vcb pluggablemodule add –group pluggable-ports-spec –basetype.1.3.6.1.4.1.9.12.3.1.9.52 -user root -password admin

Add pluggable module base type configuration with the base type value.1.3.6.1.4.1.9.12.3.1.9.52, to the pluggable-ports-spec module specification file.

vcb pluggablemodule add –group pluggable-ports-spec -containeroid.1.3.6.1.4.1.9.12.3.1.5.153 -user root -password admin

Add pluggable module container oid configuration with the container oid.1.3.6.1.4.1.9.12.3.1.9.52, to the pluggable-ports-spec module specification file.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb pluggablemodule view

Use the vcb pluggablemodule view command to display details for a pluggable module.

Syntax

vcb pluggablemodule view -group groupName -module moduleno | all [ -userdefined ] -user username -password password

vcb pluggablemodule view -group groupName -containeroid oid | all [-userdefined]-user username -password password

vcb pluggablemodule view -group groupName -basetype basetype| all [-userdefined]-user username -password password

Description

Use the vcb pluggablemodule view command to display the pluggable module details—such as pid, media type, and pluggable type—for one or all modules in the given pluggable port group.

Usage Examples

vcb pluggablemodule view –group pluggable-port-spec –module “.1.3.6.1.4.1.9.12.3.1.9.51.22” -user root -password admin

Returns the pluggable module details—such as pid, media type, and pluggable type—for the module with the given vendor oid.

vcb pluggablemodule view –group pluggable-port-spec –containeroid all -user root -password admin

Returns the pluggable module container oid details, if the list has userdefined container oid, it is marked with # after the oid.

vcb pluggablemodule view –group pluggable-port-spec –basetype all -user root -password admin

Returns the pluggable module details.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb pluggablemodule modify

Use the vcb pluggablemodule modify command to change the pluggable module configuration.

Syntax

v cb pluggablemodule modify -group groupName -module moduleno -pid pid {[ -mediatype MediaType ] | [ -pluggabletype pluggabletype ]}

Description

The vcb pluggablemodule modify command enables you to modify the configuration for a pluggable module.

Usage Example

vcb module modify -module “.1.3.6.1.4.1.9.12.3.1.9.51.22” –group pluggable-ports-spec –mediatype “fiber optic” -user root -password admin

Modifies the mediaType attribute of the pluggable module with identifier.1.3.6.1.4.1.9.12.3.1.9.51.22.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb pluggablemodule delete

Use the vcb pluggablemodule delete command to delete a pluggable module that was previously added using the VCB.

Syntax

vcb pluggablemodule delete -group pluggableport groupN -module moduleno -user username -password password

vcb pluggablemodule delete -group pluggableportgroup –containeroid container oid -user username -password password

vcb pluggablemodule delete -group pluggableportgroup –basetype basetype oid -user username -password password

Description

Use the vcb pluggablemodule delete command to delete pluggable modules that were created using the VCB.

Note Use the vcb pluggablemodule delete command to enable VNEs to use factory-supplied updates when they are available.

Usage Examples

vcb pluggablemodule delete -module “.1.3.6.1.4.1.9.12.3.1.9.51.22” –group pluggable-ports-spec -user root -password admin

Removes the definition for the pluggable module with identifier.1.3.6.1.4.1.9.12.3.1.9.51.22.

vcb pluggablemodule delete -basetype “.1.3.6.1.4.1.9.12.3.1.9.52” –group pluggable-ports-spec -user root -password admin

Removes the definition for the pluggable module basetype with identifier.1.3.6.1.4.1.9.12.3.1.9.52.

vcb pluggablemodule delete -containeroid “.1.3.6.1.4.1.9.12.3.1.5.153” –group pluggable-ports-spec -user root -password admin

Removes the definition for the pluggable module container oid with identifier.1.3.6.1.4.1.9.12.3.1.5.153.

Options

Note For the list of global options, see Global Command Options.

VCB CLI Reference: vcb event Commands

These topics provide reference information for the vcb event commands you can use to create, view, modify, and delete events:

• vcb event add
• vcb event view
• vcb event modify
• vcb event delete

vcb event add

Use the vcb event add command to create an event definition for a syslog or a trap in Prime Network based on user input.

Note To create a script to add unsupported traps from a MIB, use the e vcb event view command with the -generatecli option.To list the traps in a MIB that are supported and those that are not, use the vcb event view command with the -mibfile option. For more information, see vcb event view.

Syntax

vcb event add –eventtype { syslog|trap } –eventname eventName [ -alarmid alarmId ] { -subtype1 subtype1Name [ -ticketable1 ]
[ –severity1 critical|major|minor|warning|info|cleared>]
[ -shortdesc1 short description string ] [ -autoclear1 false |true ]

...
[-subtypen subtypenName ] [ -ticketablen ][ –severityn critical|major|minor|warning|info|cleared ]
[ -shortdesc n short description string ] [ -autoclear n false |true ]

-user username -password password

Description

The vcb event add command creates an event definition in Prime Network based on the user input. Afterwards, the VNE-driver can create specific instances of this event for incoming traps or syslogs, persist them in the event database, and forward them to interested clients.

Usage Example

vcb event add –eventtype syslog

-eventname “stack switch status syslog”

-subtype1 “stack switch removed syslog”

-severity1 minor

-subtype2 “stack switch added syslog”

-severity2 cleared

-user root -password admin

-faultnature ADAC

-faultcategory “QOS”

Adds a syslog event definition with the name “stack switch status syslog”. Two subtypes are added: “stack switch removed syslog” with severity minor and “stack switch added syslog” with severity cleared. By default, the subevents are not ticketable.

The syslog for which the event definition was added is:

A device sends one syslog when a switch is added to a stacked device (clear alarm) and another syslog when a switch is removed from a stacked device (asserted minor alarm).

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb event view

Use the vcb event view command to list event definition registrations.

Syntax

vcb event view –eventname { eventName | all } [ -substringmatch ]} -user username -password password -eventtype {trap | syslog | service}

vcb event view -genericevents all | trap | syslog [ -ipaddress vneip ] [ -date yyyy-mm-dd ] [ -time hh:mm:ss ] [ -maxrecords num ] -user username -password password

vcb event view -mibfile complete-path-mibFilename [ -generatecli -repository ParsingrulesHive - group PatternsHive ] -user username -password password

Description

The vcb event view command enables you to view event definitions including event properties such as alarm ID, event subtypes, severity, and ticketability.

Usage Examples

vcb event view –userdefined –eventname all -user root -password admin

Returns all the event definitions that were added to Prime Network using the VCB.

vcb event view –eventname bgp –substringmatch -user root -password admin

Returns all BGP event definitions in Prime Network, including those that were added using the VCB.

vcb event view -user root -password admin -eventname bgp -substringmatch -eventtype service

Returns all BGP service events.

vcb event view -mibfile /mibs/IF-MIB –user root –password admin

Returns lists of supported events and unsupported events based on the traps in the IF-MIB file.

vcb event view -mibfile /mibs/IF-MIB -generateeventcli
-group cisco-trap-product-parsing-rules -repository cisco-trap-repository –user root –password admin

Creates, but does not run, a script /Main/VcbEventCommand.sh. The script contains three vcb commands for each unsupported trap; the commands add an event (and provide an event ID), event parsing rules, and an event pattern. Optionally, edit the script.

To run the script, change permissions on the file to ensure that it is executable and supply a username and password as input; see this example:

chmod 755 VcbEventCommand.sh

./VcbEventCommand.sh -user root -password admin

Note The Prime Network gateway maintains a known list of MIBs that are used to provide translation for trap varbinds when displayed in the UI. When an event is added from a MIB that is unknown to the gateway, the VCB does not add the MIB to the known MIB list. As a result, the varbinds for this trap might not be translated to user-friendly names.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb event modify

Use the vcb event modify command to modify events that were previously defined using the VCB or to modify event attributes for factory-defined events (by using the -override option). This command can also be used to drop events.

Syntax

vcb event modify –eventname eventName [ -alarmid alarmId ] [ -override ]
{ -subtype1 subtype1Name {[ -ticketable1 ] [ -autoclear1 false |true ] –severity1 critical|major|minor|warning|info|cleared
-shortdesc1 short description string …
{ -subtypen subtypenName [ -ticketablen ] [ -autoclear1 false |true ]
–severityn critical|major|minor|warning|info|cleared
[ -shortdescn ] short description string -user username -password password
[-eventtype {trap | syslog | service | drop}

Description

The vcb event modify command modifies an event definition in Prime Network. It can also be used to instruct the system to drop a specific event.

Note Support for modifying an event is limited due to the complexity involved. When additional changes are required—such as changing the name of an event or a subtype—the supported procedure is to delete the entire event definition and add it afresh:

• Delete the event, event pattern, and associated event parsing rules.
• Add the event, event pattern, and event parsing rules.

Usage Examples

vcb event modify -eventname “stack switch status syslog”

-subtype1 “stack switch removed syslog” -severity1 major -ticketable1 -user root -password admin

Updates the event definition for the stack switch status syslog, changing the severity of the specified subtype to major and making the subtype ticketable. For a corresponding example of how this event was added, see Usage Example for the vcb event add.

vcb event modify -eventname “bgp trap” -override -eventtype drop -user root -password admin

Drops the “bgp trap” event. This overrides the system-defined event.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb event delete

Use the vcb event delete command to delete an event definition. The vcb event delete does not delete or change the event template from which the event definition was cloned.

Syntax

vcb event delete -eventname eventName -user username -password password

Description

The vcb event delete command removes event definitions created using the VCB and removes event attribute overrides from factory-defined events. Deleting a factory-defined event removes event attribute overrides only and not the event itself; the original event attributes are then applied to future events.

Usage Example

vcb event delete –eventname “stack switch status syslog” -user root -password admin

Deletes the event definition. All registry entries added as a part of the event add command are removed from the site.xml file.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

VCB CLI Reference: vcb eventparsingrules Commands

These topics provide reference information for the vcb eventparsingrules commands you can use to create, view, modify, and delete event parsing rules:

• vcb eventparsingrules add
• vcb eventparsingrules view
• vcb eventparsingrules modify
• vcb devicetype modify
• vcb eventparsingrules delete

vcb eventparsingrules add

Use the vcb eventparsingrules add command to create a VNE-driver registration for adding parsing rules to support a new trap or syslog by customizing a specified set of event templates.

Syntax

vcb eventparsingrules add -templates templateName1, templateName2, …, templateNamen -group repository –rulename rulename [ -enable ]
{ [ -arg1 -arg1Value … -argN argNValue ] } -user username -password password

Description

The vcb eventparsingrules add command creates a VNE-driver event registration based on the templates chosen by the user. This enables Prime Network to identify and associate the event to a particular device component instead of classifying the event as a generic event.

The command does the following:

• Creates a separate registry configuration (a copy) for customizing the event. Parameters that you input using the command affect the copy.
• Creates rules for handling the event based on the event template and user input.
• Updates the site.xml file, so that Prime Network can differentiate customizations created using the VCB from changes supplied in VNE-driver registration files.

Usage Example

vcb eventparsingrules add -enable

-templates syslog-identification , syslog-subtype-from-expression,create-managedelement-key,create-ana-syslog-event

-group cisco-syslog-repository

–rulename stack-switch-status-syslog

-syslog_identification_testmessage “STACKMGR-4-SWITCH_ADDED: Switch 2 has been added to the stack”

-syslog_identification_expression ”STACKMGR-4-SWITCH_%%subtypekey%%: Switch %%uniqueid%% has been.*”

-syslog_subtype_from_expression_replacing_rules ”ADDED-stack switch added syslog,REMOVED-stack switch removed syslog”

-create_ana_syslog_event_type “stack switch status syslog”

-user root -password admin

Adds parsing rules to identify the syslog correctly, associates it with the correct device component, and creates the corresponding Prime Network event and subevent.

Four event templates are entered:

• syslog-identification—Rules that pertain to syslog identification.
• syslog-subtype-from-expression—Rules that map the syslog values (in this case, ADDED and REMOVED) to the event subtype names: stack switch added syslog, stack switch removed syslog. The example includes two rules, separated by commas.

Note Rules must be comma-separated. Each rule must include a value and event subtype, separated by a hyphen: value-event subtype.

• create-managedelement-key—Indicates that the syslog should be associated with the managed element. (There are no input parameters for this template.)
• create-ana-syslog-event—Provides rules for creating instances of the corresponding Prime Network event (defined with the vcb event add command).

Input parameters for the event templates are variable arguments that depend on the templates selected.

• syslog_identification_expression—The actual syslog message with input that is of interest to the user and is masked with special keys, such as %%subtypekey%%, %%uniqueid%%, and %%entityid%%, depending on which is applicable. In the previous example, only subtypekey and uniqueid parameters are relevant.

Note Only a substring of the message is used in the example, because whatever comes afterward is of no interest to the user.

• syslog_subtype_from_expression_replacing_rules—Specifies the mapping from the subtypekey to the subevent name. The subevent string should exactly match one of the subevent names that was defined using the vcb event add command.
• create_ana_syslog_event_type—Specifies the event name.

Note This parameter should exactly match the event name defined using the vcb event add command.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb eventparsingrules view

The vcb eventparsingrules view command displays event registrations. Use it to verify that you successfully added an event parsing rule or to view parameters (to fill them in based on the example).

Syntax

vcb eventparsingrules view -group repository name –rulename { rulename | all } [ -detail ] [-userdefined] -user username -password password

vcb eventparsingrules view -template templateName | all -inputparam -user username -password password

Description

The vcb eventparsingrules view command shows configuration settings. Use it to list:

• Details of the events repository for a particular rulename or for all the events in the file. The information displayed includes the parsing rules and important parameters in each rule.
• Input parameters in the event template specified by -template option. If all is specified, the user input parameters of all the templates are displayed.

Usage Examples

Example 1

vcb eventparsingrules view -template syslog-identification –inputparam -user root -password admin

Displays the syslog-identification event template definition, including a detailed description of the input parameters required when using the template to add event parsing rules.

Example 2

vcb eventparsingrules view –group cisco-syslog-repository –userdefined –rulename all -user root -password admin

Displays all event parsing rules that were defined using the VCB under the cisco-syslog-repository hive.

Example 3

vcb eventparsingrules view –group cisco-syslog-repository
–rulename stack-switch-status-syslog -user root -password admin

Displays the event parsing rules for the event “stack-switch-status-syslog” which was created using the VCB.

Example 4

vcb eventparsingrules view –group cisco-syslog-repository –rulename all -user root -password admin

Displays all the event parsing rules present in the hive cisco-syslog-repository, including those added using the VCB.

Options

Note For the list of global options, see Global Command Options.

Error Codes

vcb eventparsingrules modify

Use the vcb eventparsingrules modify to modify the parsing rule definitions. The most common use case for this command is to select one or more different templates because the certification of the customization failed.

Syntax

vcb eventparsingrules modify -template s templateName1, templateName2, …, templateNamen -group repository –rulename rulename [ -enable ] { [ -arg1 -arg1Value … -argN argNValue ] } -user username -password password

Description

The vcb eventparsingrules modify command changes parsing rule definitions based on the templates chosen by the user. The command can also be used to add parsing rules that were inadvertently omitted when adding the parsing rule. For example, use the command to add the rules for extracting the uniqueid parameter.

Options

Note vcb eventparsingrules modify command is not supported in Prime Network. To modify the parsing rules use repository and rule name option. For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb eventparsingrules delete

Use the vcb eventparsingrules delete command to delete the parsing rule definitions of an event. Doing so does not delete or change the event template from which that event definition was cloned.

Syntax

vcb eventparsingrules delete –group repository hive –rulename rulename -user username -password password

Description

The vcb eventparsingrules delete command removes event parsing rule definitions created from an event template. It does not change or delete the event template itself.

Usage Example

vcb eventparsingrules delete -group cisco-syslog-repository –rulename stack-new-master-syslog

This example deletes the stack-new-master-syslog rule from the cisco-syslog-repository hive.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

VCB CLI Reference: vcb eventpattern Commands

These topics provide reference information for the vcb eventpattern commands you can use to create, view, modify, and delete event patterns:

• vcb eventpattern add
• vcb eventpattern view
• vcb eventpattern modify
• vcb eventpattern delete

vcb eventpattern add

Use the vcb eventpattern add command to create a VNE-driver registration that points from the parsing rules hive, which is scheme or VNE-specific, to the parsing rules defined in the repository file.

Note Only those events that have this pointer are deemed as supported events. Other events are deemed generic events despite having parsing rules and event definitions.

Syntax

vcb eventpattern add [ -patternid patternId ] -group parsing rules hive
-repository parsing rules repository hive –rulename rulename -user username -password password

Description

The vcb eventpattern add command creates a pointer from the parsing-rules hive to the repository where the actual parsing rules are defined.

Usage Examples

vcb eventpattern add

-patternid 202 -group cisco-syslog-product-parsing-rules

-repository cisco-syslog-repository

–rulename stack-switch-status-syslog -user username -password password

Adds a pointer from the parsing rules file to the actual definitions in the parsing-rules hive with pattern ID 202. It points to the key (rule) named stack-switch-status-syslog in the cisco-syslog-repository file.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb eventpattern view

Use the vcb eventpattern view command to display event registrations. It is useful when you need to verify successful completion of an add command or to help find a similar case for filling in parameters on other commands.

Syntax

vcb eventpattern view -group parsingrules hive –rulename { rulename | all } [ -substringmatch ] [ -full ] -user username -password password

Description

The vcb eventpattern view command shows the actual set of events that are supported by a particular NE type or scheme. It displays the pattern ID and the repository file where the event parsing rules are defined. When the substringmatch option is used, only rules that contain a certain substring are displayed; use this option, for example, to obtain rules for a technology name such as MPLS.

Usage Examples

Example 1

vcb eventpattern view –group cisco-syslog-parsing-rules –rulename stack-switch-status-syslog -user root -password admin

Displays the event pattern definition for the specified rulename; that is, the pattern ID, and the pattern is pointing to the parsing rules repository.

Example 2

vcb eventpattern view –group cisco-syslog-parsing-rules –rulename all -user root -password admin

This example shows all the event pattern definitions in the specified hive.

Example 3

vcb eventpattern view –group cisco-syslog-parsing-rules -userdefined

–rulename bgp –substringmatch -full -user root -password admin

This example shows the entire event definition for all BGP events (including those defined using the VCB) defined in the cisco-syslog-parsing-rules hive. The following information is displayed:

• Pattern definitions—Parsing rules repository, pattern ID
• Parsing rules definitions—All rules in the definition that require user input, and the values set for these parameters
• Event definitions—Event attributes such as eventname, subevent names, ticketability, severity and so on

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb eventpattern modify

Use the vcb eventpattern modify command to modify the pointer to the parsing rules.

Syntax

vcb eventpattern modify -patternid patternId -group parsing rules hive [ -repository parsing rules repository hive ] [ –rulename ruleName ] -user username -password password

Description

The vcb eventpattern modify command modifies the pointer from the parsing-rules hive to the repository where the actual parsing rules are defined.

Usage Examples

vcb eventpattern modify

-patternid 202

-group cisco-syslog-product-parsing-rules

-repository cisco-router-syslog-repository -user root -password admin

This example assumes that we are starting with the eventpattern with ID 202 that points to the cisco-syslog-repository (as shown in Usage Examples for the vcb eventpattern add command). In this example, we modify the repository for the eventpattern with ID 202 to the cisco-router-syslog-repository.

Note Vcb eventpattern modify cannot be performed on the group as this is the identifier for the pattern. You can modify only the repository or rule name.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

vcb eventpattern delete

Use the vcb eventpattern delete command to delete the parsing rule from the list of supported event patterns. Doing so does not delete the parsing rules in the repository file.

Syntax

vcb eventpattern delete –group parsing rule hive -patternid pattern ID -user username -password password

Description

The vcb eventpattern delete command removes the pointer to the parsing rule defined in the repository file.

Usage Examples

vcb eventpattern delete –group cisco-syslog-parsing-rules –patternid 202 -user root -password admin

Deletes the parsing rules pattern with ID 202. All registry entries added as a part of the vcb eventpattern add command will be removed from site.xml.

Options

Note For the list of global options, see Global Command Options.

Error Codes

Note For the list of general VCB error codes, see General Error Codes.

VCB CLI Reference: vcb eventarg Command

vcb eventarg view

Use the vcb eventarg view command to display event parsing rule arguments and descriptions.

Syntax

vcb eventarg view -user username -password password

Description

The vcb eventarg view command option displays all the VCB event parsing rules template variable arguments along with descriptions.

Troubleshooting Event Customization Using the VCB CLI

Errors that you receive from the VCB CLI are self-explanatory. Most errors make very clear what you need to do to correct the problem that has occurred. For example, if an event name already exists, you must enter a different event name. If an alarm ID or pattern ID is already in use, you should omit the related option and argument from your command and allow the VCB to generate a unique ID for you.

Note To get more information, add the -debug option to any vcb command; for more information, see Global Command Options.

Errors that occur in the server are not as obvious. If a newly supported event does not appear in Prime Network Events or Prime Network Vision, you need to perform some troubleshooting, as follows:

Step 1 Ensure that the device is configured to send events to Prime Network gateway. Use any tool to snoop and check whether the simulated network events that you are sending are actually arriving at the Prime Network gateway. If not, fix the issue whether it is connectivity, firewall and so on, then proceed to next step.

For detailed information, see VCB CLI Reference: Events Commands.

Step 2 Enable debug for event processing in the VNE. Execute the following commands for the AVM that has the VNE that you will be testing.

Step 3 Allow the VNE to come up, then open the log file for the AVM. Check whether the newly added pattern is being loaded at VNE startup. Look for an entry in the log file that is similar to the following text:

DEBUG [06 21 2010 12:19:59.524 IST] - ParsingApplication.buildRulesMatrix - pattern ATMLC-6-CLOCKING with index 5001 in the registry is now mapped into index 123 in the parsing application.

The above DEBUG statement includes both the rulename (ATMLC-6-CLOCKING with) and the pattern id (5001) of the newly added event. If a similar statement is not printed for the newly added event, go to Step 4; otherwise, go to Step 5.

Step 4 Review the vcb eventparsingrules add command that you used, checking whether you enabled the event using the -enable option. If the command was issued without the -enable option, delete the event parsing rules using the vcb eventparsingrules delete command and add the event parsing rules again, ensuring that you use with the -enable option.

Step 5 Check statically whether the links between event pattern, event parsing rules, and event are OK. To perform this check, use the vcb eventpattern view command with the -full option (see Example 3). The output should display details of all the three customizations. A typo in the rulename, event type name, or event subtype name can prevent the links from being established and result in a partial display. For example, if the rulename in the vcb eventpattern command does not match that used in the vcb eventparsingrules command, only event pattern details will be displayed; details for event parsing rules and the event will not be displayed.

If the output is OK (that is, it includes details for all three customizations), go to Step 7. Otherwise, go to Step 6.

Step 6 Review the commands that have been issued and re-add or modify the customizations as required. Then go back to Step 5.

Step 7 After the static verification that you perform in step 5 succeeds, check whether the parsing itself is failing. Put a tail on the AVM log file and resend the simulated event. When parsing fails, the event is classed as a generic event. Log output similar to the following will appear.

DEBUG [06 21 2010 16:11:09.623 IST] - EventManager.filterEventApplications - Event has been dropped by application [com.sheer.metrocentral.framework.eventapplication.filter.GenericSyslogTypeFilterApp]

########## com.sheer.metrocentral.framework.eventapplication.types.EventData ########

# Id : = 137611826381_1277116869542

# Unique source ID: = null

# Type : = generic syslog

# SubType : = generic syslog

# SourceOID : = {[ManagedElement(Key=10.77.212.205)][Syslog]}

# Event Time : = 1277116869542

# Info : = 7.212.205 %FAN-3-FAN_0K: Fan 3 had earlier reported a rotation error. It is ok now

# CorrelationKeys: =

# CK=(MC.DA-10.77.212.205)-25:52:0:0 [16]

# Adjacent XID : = null

# Source IP interface: = null

###################################################################################

Step 8 Open the log file and go backwards from the end of the file until you come to the place where logs pertaining to the actual parsing process are available. Search for the string 'Testing pattern: handle rulename ', where rulename is the string you used in the vcb eventpattern add command. Here you will find logs that report the results of testing each rule. Identify the rule that failed as shown in the following log.

DEBUG [06 21 2010 16:11:09.622 IST] - ParsingApplication.processEvent - Exception during parsing correlation rules, at pattern-125, rule-2

Stack:[(uniqueid=>3),(syslog=>7.212.205 %FAN-3-FAN_0K: Fan 3 had earlier reported a rotation error. It is ok now),(subtypekey=>0K),(.prulescache=>[]),(counter=>0)]

Event Data :

############## com.sheer.metrocentral.framework.eventapplication.parsing.types

.RawSyslogEventData #############

# Id : = 4311876356_1277116869490

# Unique source ID: = null

# Type : = raw event

# SubType : = raw syslog

# SourceOID : = null

# Event Time : = 1277116869494

# Info : = 7.212.205 %FAN-3-FAN_0K: Fan 3 had earlier reported a rotation error. It is ok now

# syslog = 7.212.205 %FAN-3-FAN_0K: Fan 3 had earlier reported a rotation error. It is ok now

##############################################################################

#################################

java.lang.reflect.InvocationTargetException

at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method) at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:39)

at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:27)

at java.lang.reflect.Constructor.newInstance(Constructor.java:513)

at com.sheer.metrocentral.framework.correlation.parsing.ChangeArgumentValue.execute
(ChangeArgumentValue.java:68)

In the above example, the parsing rule that failed is ChangeArgumentValue. The failure implies that the replacing rules that map the network event parameters to the Prime Network event subtypes are failing. Review the replacing_rules arguments used in the vcb eventparsingrules command and make the necessary changes.

The list of parsing rules (classes) and the corresponding option in vcb are given in the following table. Review the parameter values of the failing option and make appropriate changes.

Repeat the above steps until all errors are resolved and the event is parsed correctly and the Prime Network event is generated as expected.

U-VNE Templates

Features, advantages, and limitations of template-based U-VNEs are template-dependent. The GenericUVNE template uses the same set of MIB-II based instrumentation for logical inventory discovery as is used by the Prime Network Generic SNMP VNE. The advantage of the U-VNE—created using the VCB and the GenericUVNE template—over the Generic SNMP VNE is that you can identify the device type for the U-VNE and further extend the U-VNE for additional event recognition using the VCB.

For more information, see the following sections:

• Methods for Creating U-VNEs—Overview
• Comparison of Generic SNMP VNEs, U-VNEs, and Developed VNEs
• GenericUVNE Template

GenericUVNE Template

The GenericUVNE template is applicable to Cisco and non-Cisco NEs and supports event customization with event association to Managed Element only.

Use the GenericUVNE template to model any NE that is not currently supported by Prime Network. A U-VNE created this way is very similar to the Generic SNMP VNE. It provides basic information, such as the physical interfaces available on the device and their status, rudimentary logical modeling, and parsing of basic traps; see GenericUVNE—Supported Traps. Using the VCB, however, you can configure additional traps and syslog recognition for a U-VNE created using the GenericUVNE template.

This U-VNE models NEs using SNMP MIB-II, which is the most generic and widely used management interface. This U-VNE does not consider the device vendor, device type, or software version of the NE that it models. Using the VCB, however, you can update device type attributes for a U-VNE created using the GenericUVNE template.

Table B-58 summarize the features and advantages of the GenericUVNE template.

Note Expedite Legend—The Expedited column in the service event tables in this chapter can contain these values:
Y—Indicates that the service event is expedited by a syslog or trap generated by the device. This means that the syslog or trap causes the VNE to poll the device without waiting for the usual polling cycle, thus enabling quicker detection of the event.
N —Indicates that the service event is not expedited. The service event is not expedited.This means that the VNE will poll this device during the next regularly scheduled polling cycle.

Note In some of the following tables, attributes, protocols, technologies, etc. are listed as supported. Supported denotes that SNMP queries are made to the NE for those attributes, etc. Whether values are available in response to the queries depends on whether the instrumentation supported in the NE works.

See the following sections:

• GenericUVNE—Physical Inventory Model
• GenericUVNE—Logical Inventory Model
• GenericUVNE—Supported Traps
• GenericUVNE—Supported Events
• GenericUVNE—Limitations
• GenericUVNE—Supported Topologies
• GenericUVNEs—Supported Technologies
• GenericUVNE—Supported Service Events

GenericUVNE—Physical Inventory Model

A U-VNE created using the GenericUVNE template uses a static model for the device chassis. The rest of the physical inventory is modeled using the ifTable. Since modules are not modeled, this U-VNE creates a single generic module on which all of the physical interfaces reside.

Table B-59 describes which MIB tables are used to model the physical inventory components that are supported by a U-VNE created using the GenericUVNE template.

Note Certain general properties on the managed element, such as system description, are modeled using the RFC1213-MIB.

GenericUVNE—Logical Inventory Model

Table B-60 describes which MIB tables are used to model the logical inventory components that are supported by a U-VNE created using the GenericUVNE template. Attributes in Table B-60 are taken from MIB-II.

GenericUVNE—Supported Traps

A U-VNE created using the GenericUVNE template can parse the standard MIB-II and Bridge-MIB traps listed in Table B-61 .

A U-VNE created using the GenericUVNE template can identify traps, but it cannot correlate them. This is because this U-VNE does not include the model entities required by higher trap parsing levels.

For example, if Prime Network receives an mplsTunnelDown trap from a device modeled with the GenericUVNE template, Prime Network can identify the Tunnel Down trap, but it cannot perform correlation on the trap. The reason is that th is U-VNE does not investigate tunnels, which means that there is no Device Component in the model to which Prime Network can attach a correlation flow.

For this U-VNE, event association is always to the Managed Element.

GenericUVNE—Supported Events

A U-VNE created using the GenericUVNE template supports the service events listed in Table B-62 .

GenericUVNE—Limitations

A U-VNE created using the GenericUVNE template uses MIB2 to cover the widest possible range of NEs. Although MIB2 is a widely accepted industry standard, most network equipment vendors augment MIB2 with other Management Interfaces such as private MIBs, Telnet, XML, and so on. In addition, different vendors sometimes have different implementations of standard MIBs. As a result, even the limited model created by this U-VNE is dependent on the vendor’s adherence to general network management standards.

GenericUVNE—Supported Topologies

A U-VNE created using the GenericUVNE template supports the topologies listed in Table B-63 .

GenericUVNEs—Supported Technologies

The following sections list the objects and attributes that are recognized on a U-VNE created using the GenericUVNE template, per technology:

• IP
• Ethernet (IEEE 802.3)
• Base Logical Components
• Common

IP

Table B-64 lists the IP attribute support on a U-VNE created using the GenericUVNE template.

Note Table B-64 includes the supported technologies only.