Cisco Prime Network Customization Guide, 5.0

Accessing the VCB

You can access the VCB through Prime Network Administration or by specifying a URL in your web browser. To open the VCB:

Step 1 In Prime Network Administration, choose Tools > VNE Customization Builder.

or

In your web browser, enter the following URL. The gateway-IP can be an IPv6 address.

https://gateway-IP:8043/prime-network-web

Step 2 Enter the login credentials and then select VNE Customization Builder in the Home page. The VCB opens, and the VNE Drivers page is displayed.

Note Only two users can be logged into the VCB GUI client at one time.

Figure 3-1 VCB - VNE Drivers Page

Note You can reorder the columns by dragging and dropping the column headers. You can also determine which columns will be displayed by using the Settings tool in the toolbar above the table.

Cisco vs. Non-Cisco Devices

The VCB displays the details of the Cisco and the third-party (non-Cisco) VNE drivers in separate tabs as Prime Network supports separate installation directories and registry service for Cisco and non-Cisco drivers. Non-Cisco VNEs do not support pluggable module specification, and the pluggable module information is retrieved from the network element itself.

Note The Non-Cisco Drivers tab in VCB GUI is displayed only after successful installation of a non-Cisco device package in Prime Network.

Methods for Creating U-VNEs—Overview

Several approaches are available for creating U-VNEs. Depending on the approach you choose, the modeling capabilities will be more specific or less specific. Table 3-2 lists the supported methods and how to choose the one that is appropriate for your situation.

Creating a U-VNE Using the GenericUVNE Template

The following example shows how to enable support for an unsupported device by creating a U-VNE. For the purposes of this example, we will create a U-VNE to enable support for a Linux server. The U-VNE will be based on the GenericUVNE template. See U-VNE Templates for more information about this template.

Before You Begin

• Make sure this is the proper method for your situation by checking the information in Methods for Creating U-VNEs—Overview.
• Obtain the sysOID of the NE you want to manage. The sysOID can be retrieved from the properties of the system event generated for an unsupported device (shown in Prime Network Vision or Prime Network Events). Alternatively, you can query the device using the snmp get command.
• Confirm that Prime Network does not support the sysOID. You can do this by filtering the VNE drivers list in the VCB GUI by the sysOID. If it is not found, it is not supported.

To create a U-VNE:

Step 1 Access the VCB, as described in Accessing the VCB.

Step 2 In the VNE Drivers tab, click Add Row .

Step 3 In the SysOID field, enter the sysOID of the new device. Note that after you have saved the U-VNE, the SysOID will be automatically translated to a unique device name plus identifier (if a compiled MIB version is available). This value will be displayed in the SysOID Translation column.

Step 4 Specify the name that will represent the device in the Prime Network GUI by creating a new device type, as follows:

a. In the Device Type field, click the down arrow to display the Device Type Selector.

b. Click the Tools icon in the upper right area of the Device Type Selector and select Add .

c. In the Device Type field, enter the device name that will represent the device in the Prime Network maps and element tables. We recommend that you prefix the device type name with the network element vendor name for easy identification.

d. In the Category field, select the category to which the device belongs. In this case, select Server .

e. In the Device Series field, specify the device series to which the device belongs.

f. Click OK . The new Device Type name will appear in the Device Type field.

Step 5 In the Type field, select User Defined VNE - by Template .

Step 6 In the Cloning Reference field, select GenericUVNE .

Step 7 Click Save .

Step 8 Complete tests and certify the customization; see Testing and Certifying VCB Customizations.

Create a U-VNE by Cloning

This section describes how to enable support for an unsupported device by cloning a developed VNE driver from a supported device series or family. The cloned U-VNE inherits the behavior of the source VNE driver, and can be further extended using the VCB to add more device module discovery and event recognition.

Before You Begin

• Make sure this is the proper method for your situation by checking the information in Methods for Creating U-VNEs—Overview.
• Obtain the sysOID of the NE you want to manage. The sysOID can be retrieved from the properties of the system event generated for an unsupported device (shown in Prime Network Vision or Prime Network Events). Alternatively, you can query the device using the snmp get command.
• Confirm that Prime Network does not support the sysOID. You can do this by filtering the VNE drivers list in the VCB GUI by the sysOID. If it is not found, it is not supported.

To create a U-VNE by cloning:

Step 1 Access the VCB, as described in Accessing the VCB.

Step 2 In the VNE Drivers tab, click Add Row .

Step 3 In the SysOID field, enter the sysOID of the new device.

Step 4 In the Device Type field, select the device type that will represent the new supported device in the Prime Network maps and element tables. If necessary, you can create a new device type from the Tools icon in the Device Type selector.

Step 5 To clone from a supported device family: In the Type field, select User Defined VNE - by Device Family .
To clone from a supported software version: In the Type field, select User Defined VNE - by Software Version , then select the device series and the scheme.

Note Cloning by software version performs two customizations in a single operation. It clones both the device type and software versions. The new driver will be listed in the GUI as cloned by device.

Step 6 In the Cloning Reference field, specify the item from which you want to clone the new VNE.

Step 7 Click Save .

Step 8 Complete tests and certify the customization; see Testing and Certifying VCB Customizations.

Defining a Device Type to Determine the GUI Representation of VNE Drivers

Each VNE is represented by a specific name and icon in the maps and element tables. The device type determines the name used to represent the VNE while the device family determines the icon used to represent the VNE. When you create a U-VNE, you need to select a device type so that the system knows how to represent the new device in the GUI. If none of the existing device types is a suitable representation of your U-VNE, you can create a new device type. You can create a new device type in one of the following ways:

• From the VNE drivers window, during the VNE driver creation/editing process. See Creating a U-VNE Using the GenericUVNE Template.
• From the Device Types window, as described below.

To add a new device type:

Step 1 Access the VCB, as described in Accessing the VCB.

Step 2 In the VNE Drivers tab, click Configure Device Types . The Device Types window appears.

Figure 3-2 Device Types

The Device Types window provides a table listing all the available device types.

Step 3 Click Add Row . A row is added to the device types table, enabling you to define the parameters of the new device type.

Step 4 Define the following parameters:

Step 5 Click Save .

Adding Support for a New Standard Module

Module templates are used to enable developed VNEs to recognize new standard modules. Module templates define a set of port layers—from the connector at Layer 0 to encapsulation at Layer 2—that are applicable to a module. Module templates ensure that each port is modeled with the correct port layer information based on the ifType obtained from the SNMP MIB output.

Before You Begin

• Obtain the module identifier and research the capabilities of the module. The module identifier can be found in the properties of the event generated when an unsupported module is auto-discovered.
• Identify the appropriate module template. See Module Templates.

To add support for a new standard module:

Step 1 From the Prime Network Administration GUI client, choose Tools > VNE Customization Builder.

Step 2 Choose VNE Customization Builder > Modules. In the Modules page, the Cisco Modules tab is selected by default and all the available Cisco module groups are shown. If you are adding support for a non-Cisco module, click the Non-Cisco Modules tab.

Step 3 Click on a module group to show all the modules for that group.

Step 4 Click on the arrow next to a module to expand its display and see all the port layers supported by that module.

If you want to edit a module, select the radio button to the left of the row and then click the Edit button If you edit a system default module, the value in the Overriding column will change to True . To revert back to the system default values, click Restore .

Step 5 Select the module group under which you want to create the new module. All the modules under the module group you choose are displayed.

Step 6 Click the Add Row button on the taskbar. A new row opens in an editable mode at the end of the modules display area. Enter the value(s) for the following parameters:

Step 7 Click Save .

Step 8 Test the new module. See Testing and Certifying Module Customizations.

Adding Support for a New Pluggable Module

This procedure explains how to add support for a pluggable module. When you add support for a new pluggable module, you do not need to specify a template to use.

Note You cannot edit or delete Prime Network default pluggable modules.

To add support for a new pluggable module:

Step 1 From the Prime Network Administration GUI client, choose Tools > VNE Customization Builder.

Step 2 Choose VNE Customization Builder > Pluggable Modules. The Pluggable Modules tab displays all the pluggable modules in Prime Network VCB.

If you want to edit a module, select the radio button to the left of the row and then click the Edit button

Step 3 Click the Add Row button on the taskbar. A new row opens in an editable mode at the end of the pluggable modules display area. Enter the value(s) of the following parameters:

Step 4 Click Save .

Step 5 Test the new module. For the procedure on testing the VNEs, see Testing and Certifying Module Customizations.

Preparing to Test Your VCB Customizations

Table 3-3 provides a recommended list of test resources for verifying your customizations. Some of these resources are outside of Prime Network.

In addition, the VCB log file is useful for debugging issues that might occur when you use the VCB.

Use the -logfile option to specify the name of the log file and the -debuglevel option to define the logging level to use. The relevant command is:

vcb mode command [ command args ] -debuglevel INFO -logfile logfilename -user username -password password

When debugging, set the debug level to INFO. The log file is created in the NETWORKHOME /Main/logs directory. Error messages are written to the log file and are displayed on the console.

Testing and Certifying U-VNEs

After using the VCB to perform device customizations, you must test the VNE or U-VNE to verify that the device and its components can be managed by Prime Network to your satisfaction.To test the results of your VCB commands, we recommend that you add a single instance of the customized VNE to its own AVM in Prime Network.

Examples of the support you should test for include:

• Physical containment
• Logical inventory
• Topology
• Events

We recommend that you record the results of your tests in a compliance report, which certifies the capabilities of the customized VNE. See Preparing Compliance Reports. After you successfully complete the testing process, create additional VNE instances to manage the rest of the devices of this type in the network.

Note When performing the tests described in this section, bear in mind that unlike developed VNEs, U-VNEs are not optimized for a particular device type. The VCB enables you to extend VNEs and create U-VNEs as specified in this document. Other Prime Network features, such as Soft Properties and Command Manager, offer further extensibility to the U-VNE and developed VNE drivers. Prime Network users who need more management capability—or who prefer to have developed VNE drivers for devices that are not already in the Prime Network VNE support scope—can contact their Cisco account representative for any available Cisco Advanced Services alternative.

For details about testing U-VNEs, please see the following sections:

• Setting Up the U-VNE Test Environment
• Performing the U-VNE Tests
• Troubleshooting VCB Customizations

Setting Up the U-VNE Test Environment

Before beginning the testing process, you must ensure that:

• All the mandatory processes—avm11, avm0, and avm100 (only for event support)—are running normally.
• You have access to the device.
• You complete the actions described in Table 3-4 .

Creating a Test AVM and VNE

We recommend that you create an AVM for the sole purpose of hosting the VNE instance on which you will perform the tests described in this chapter. Placing the VNE instance in its own AVM enables you to test your customizations in a safe environment, where the logs and any errors generated by the VNE are isolated from the rest of your network. This enables you to proceed with testing without having your VNE customizations impact the network, until you are satisfied that the customizations function as required.

Testing a single VNE instance also helps you scale a rollout more easily. For example, if you have 100 devices of a certain type that you are introducing to your managed network, first create a single VNE instance on which to test your customizations. After testing is complete, create additional VNEs for the other 99 devices.

AVMs and VNEs can be created in the Prime Network Administration client. For further details about creating an AVM and adding a VNE, see the Cisco Prime Network 5.0 Administrator Guide .

Checking the Communication and Investigation State of the Test Instance

After you create a test instance of the U-VNE, you must verify that Prime Network can communicate with the device (communication state) and that Prime Network can discover the physical and logical inventory of the device (investigation state).

To check the communication and investigation state of the test instance:

Step 1 Log into Prime Network Vision.

Step 2 Choose Network Inventory > Network Elements .

Step 3 Perform a search to locate the device.

Step 4 Check the Communication State column to see the status of the communication between Prime Network and the device:

• If the status is Device Reachable, this indicates that all of the enabled protocols on the device are responding.
• If the status is Device Unreachable, this indicates that at least one of the enabled protocols is not responding. If this occurs, troubleshoot the problem, as described in Device Unreachable.

Step 5 Check the Investigation State column to see how successfully the VNE has modeled the device it represents:

• If the status is Operational, proceed to the next test.
• If the status is Incomplete, this indicates that Prime Network is unable to model all the components in the device. You must investigate further to determine whether the components or properties that cannot be modeled prevent you from using the U-VNE in your network. For troubleshooting details, see Investigation State Not Operational.

Note For more information on troubleshooting VNE modeling, see the Cisco Prime Network 5.0 Administrator Guide.

Measuring Device Performance

We recommend that you use an element manager or similar application to measure CPU and memory usage on the device before you start managing it with the VNE. This provides a baseline for comparison when you later measure the load on the VNE as part of the testing process. You should simulate various scenarios, including those that place heavy loads on the device, so that you can later determine the effect of your VNE customizations on device performance. See Testing CPU and Memory Usage.

Performing the U-VNE Tests

To test and certify U-VNEs, we recommend that you follow these procedures.

1. Preparing Compliance Reports

2. Testing the Physical Inventory

3. Testing the Logical Inventory

4. Testing CPU and Memory Usage

5. Verifying That Prime Network Receives Events from an NE and Generates Tickets

Preparing Compliance Reports

As you complete the tests described in this chapter, we recommend that you capture the results in a compliance report. A compliance report makes it easier for you to evaluate whether the U-VNE suits your needs or whether you will need to try again by cloning from a different device or using a different U-VNE template.

Create a compliance report using the information provided in Cisco Prime Network 5.0 Supported Cisco VNEs (for a U-VNE that was cloned from an existing device family) or U-VNE Templates (for a template-based U-VNE). Use the information to do the following:

1. Copy each technology table to a file (such as a spreadsheet).

2. Remove any columns that describe support for templates other than the one you are using.

3. Add a column for verifying whether each supported property is modeled in Prime Network.

4. Fill out the final column, identifying the supported and unsupported properties.

Assessing a customization requires that you test on a reasonable configuration (test-to-success) and that you evaluate extreme cases (test-to-fail).

Note You cannot use the VCB to change the templates themselves; for example, to support additional CLIs or MIBs or to modify the parsing of the device results.

If you find gaps in the modeling of the U-VNE, you can try using Soft Properties. If you need more management capability or you prefer to have developed VNE drivers for devices that are not already in the Prime Network VNE support scope, contact your Cisco account representative for any available Cisco Advanced Services alternative.

Testing the Physical Inventory

The physical inventory reflects the physical components of the managed device, including its:

• Port Connector—Port details.
• Shelf—Chassis or rack where various types of equipment may be placed or inserted.
• Slot—Details on where the modules are inserted.
• Module—Physical module or adapter card details; hardware description.

Note The list of components that are actually displayed for the U-VNE in the Prime Network client are dependent on the device from which the U-VNE was cloned or on the template that was used to create the U-VNE.

To view the physical inventory:

Step 1 Log into Prime Network Vision.

Step 2 Choose Network Inventory > Network Elements .

Step 3 Perform a search to locate the device.

Step 4 Double-click the device.

Step 5 Expand the Physical Inventory tree node.

Step 6 Compare the physical containment displayed in the Physical Inventory tree with the actual components contained in the device managed by the U-VNE. In particular, make sure that the following information is accurate:

• Slot Number
• Number of Ports
• Connector Type

Step 7 Look for signs that the U-VNE does not fully model the device, including:

• Investigation state is Currently Unsynchronized.
• A module without ports; for example, if the WS-X6724 module is described as having 24 ports, but no ports appear beneath the module in the tree.

Step 8 Select each component in the tree, then check the Properties window to verify that the physical inventory includes all the properties that are supported by the U-VNE (as defined in the U-VNE template on which it is based).

Step 9 Record your results in a compliance report. See Preparing Compliance Reports.

Step 10 If there are components or properties that are missing or incomplete, you must decide whether these components or properties prevent you from using the U-VNE in your network:

• If you determine that the U-VNE can be managed successfully by Prime Network without the unsupported component or property, proceed to the next test.

Tip In the case of a missing property, try adding it using the Soft Property Builder.

• If you need more management capability or you prefer to have developed VNE drivers for devices that are not already in the Prime Network VNE support scope, you can contact your Cisco account representative for any available Cisco Advanced Services alternative.

(The VCB enables you to extend VNEs and create U-VNEs as specified in this chapter. Other Prime Network features, such as Soft Properties and Command Builder, described in separate chapters, offer further extensibility to the U-VNE and developed VNE drivers.)

Testing the Logical Inventory

The logical inventory reflects dynamic data such as configuration data, forwarding, and service-related components that affect traffic handling in the element. The list of components that are actually displayed in the logical inventory are dependent on the technologies supported either the device family from which the U-VNE was cloned or by the template that was used to create the U-VNE.

To view the logical inventory:

Step 1 Log into Prime Network Vision.

Step 2 Choose Network Inventory > Network Elements .

Step 3 Perform a search to locate the device.

Step 4 Double-click the device.

Step 5 Expand the Logical Inventory tree node.

Step 6 Compare the information displayed in the Logical Inventory tree with the actual technologies supported by the U-VNE, as defined by the template on which the U-VNE is based. See U-VNE Templates.

Step 7 Select each component in the tree, then check the Properties view to verify that the logical inventory includes all the properties that are supported by the U-VNE (as defined in the U-VNE template on which it is based).

Verify the IP interfaces by querying the device for its list of IP interfaces and verifying that all of them appear under IP Flow Points. Verify that all the IP interfaces configured on the device appear in the IP Interfaces tab under Routing Entity.

Step 8 Record your results in a compliance report. See Preparing Compliance Reports.

Step 9 If any technologies or properties are missing or incomplete, you must investigate further to determine whether these technologies or properties prevent you from using the U-VNE in your network:

• If you determine that the device can be managed successfully by Prime Network without the unsupported technology or property, proceed to the next test.
• If you need more management capability or you prefer to have developed VNE drivers for devices that are not already in the Prime Network VNE support scope, you can contact your Cisco account representative for any available Cisco Advanced Services alternative.

Testing CPU and Memory Usage

Note Ensure that you perform both positive testing (on a reasonable configuration) and negative testing (on simulations of expected network scenarios).

In addition to verifying how well the U-VNE models the device, we recommend that you measure the CPU and memory usage demands placed by the U-VNE on the device. During test preparation, before adding the VNE instance, you measured CPU and memory usage on the NE; (see Measuring Device Performance). Now, compare the usage on the NE against the usage for the VNE instance on the Prime Network AVM and unit as follows:

• To view CPU usage, look at the properties of the device in the Inventory window.
• To monitor additional information, such as memory usage, use the Prime Network diagnostic client. To access the diagnostic client, enter the following address in your web browser (the username is normally admin; you will have to get the password from your system administrator):

https:// gateway-IP-address :1311

Verifying That Prime Network Receives Events from an NE and Generates Tickets

This topic provides steps for verifying that Prime Network receives events from an NE and that the VNE driver parses the events correctly, generating tickets if the events are ticketable.

Note Event parsing depends on the completeness and correctness of the modeling. Parsing BGP events, for example, depends on BGP being modeled correctly in the inventory.

Before You Begin

Make sure that you have configured the device to send events to the Prime Network server and created a Link Down event.

To check for events from the NE:

Step 1 Log into Prime Network Vision.

Step 2 Add the device to a map.

Step 3 Right-click on the device in the map and select Filter Tickets. The tickets pane below the map will show the tickets for the selected device.

Step 4 Check whether the Link Down event that you generated during your test preparations appears in the table.

Step 5 Generate additional events from the device, then see if they appear in the events table.

Step 6 If the events do not appear in the events table, proceed as follows:

• Check for mistakes in the device configuration.
• Use an external tool, such as a MIB browser, to determine whether events are being sent by the device.
• Troubleshoot event customization, as described in Customizing Events.

Testing and Certifying Module Customizations

First perform a static test of the module, using the vcb view module command. If the module is not correctly configured, delete it and add the module again.

After verifying the module statically, set up your test environment just as you would for testing device customization—see Setting Up the U-VNE Test Environment. Then view the physical inventory for your U-VNE test instance as follows.

Step 1 Launch Prime Network Vision.

Step 2 Add the containing device to a map.

Step 3 Double-click the device.

Step 4 Expand the Physical Inventory tree node.

Step 5 Confirm the correctness of the following for the module:

• Slot Number
• Number of Ports
• Connector Type

Step 6 Move customizations into production during a maintenance window. See Testing and Certifying U-VNEs.

Testing and Certifying Event Customizations

It is recommended that you test and certify event customizations in your lab before moving them to production:

To receive events from a device, you must configure the device with the details of the Prime Network server. For example, use the following commands for devices running Cisco IOS or Catalyst OS software:

snmp-server host 172.20.2.160

logging trap informational

logging source-interface Loopback0

logging on

logging 172.20.2.160

A similar set of commands should be used for devices belonging to other manufacturers.

These commands enable the device to send traps to the specified gateway IP over port 162. Therefore, port 162 must be enabled to receive traps from the device. In addition, you must reserve port 1162 for the general trap processing by the Prime Network server. This task is handled by the AVM 100 process.

To test your event:

Step 1 Send an event from an NE or from a simulator. Open Prime Network Events and verify that:

– Prime Network recognizes and processes the event

– Event parameters—type, subtype, severity, and so on—are as expected

– Unique ID is appended to source ID (ManagedElement)

After you complete the tests, move the customization to production and test there as well; see Testing and Certifying Event Customizations.

Troubleshooting VCB Customizations

This section describes basic troubleshooting procedures to perform when Prime Network cannot communicate with a U-VNE, and includes the following topics:

• Device Unreachable
• Investigation State Not Operational

Device Unreachable

If you cannot communicate with a U-VNE, try the following:

• Launch Prime Network Administration and verify the Admin Status and Operational Status of the VNE. The Admin Status should be Enabled and the Operational Status should be Up.
• Verify that you are using the correct SNMP and Telnet credentials for the device.
• Ping the device from the Prime Network server.

Note For more information, see the Cisco Prime Network 5.0 Administrator Guide.

Investigation State Not Operational

If the investigation state of the U-VNE is any value other than Operational, perform the actions described in the following table.

Log Entry for Unsupported Module

The log entry for an unsupported module looks like this:

ERROR [07 07 2010 17:07:47.810 IST] - PhysicalCommandHandler.isEntitySupported - 192.168.20.1 can't create module with entry
value spec/physical/modules/.1.3.6.1.4.1.9.12.3.1.9.29.118.1/loaders will use default module loader

If you have an unsupported module, your choices are to either use the VCB to add the module (see Adding Support for a New Pluggable Module), or manage the device in Prime Network without managing that particular module.

Viewing Existing VCB Customizations in the Registry

To view registry changes to the site.xml file made with the VCB, enter the following command:

vcb sitechanges view -user username -password password

Here is an example of the vcb sitechanges view command output; this examples shows customizations that were made, including some event patterns, event parsing rules, and events.

# [~/Main/registry/ConfigurationFiles]% vcb sitechanges view -user username -password password

>>>>>>>>>>>>>>>>>>>>>Event Pattern<<<<<<<<<<<<<<<<<<<<<<<<<

Hive Name:cisco-syslog-ipcore-parsing-rules

Group: cisco-syslog-ipcore-parsing-rules

Pattern ID: 5004

Rule Name: FWSM-5-713131

Repository: cisco-syslog-repository

User-defined: true

Pattern ID: 5005

Rule Name: FWSM-4-109022

Repository: cisco-syslog-repository

User-defined: true

Hive Name:cisco-trap-product-parsing-rules

Group: cisco-trap-product-parsing-rules

Pattern ID: 5008

Rule Name: STACKWISE-MEMBER-STATUS

Repository: cisco-trap-repository

User-defined: true

>>>>>>>>>>>>>>>>>>>>>Event Parsing Rules<<<<<<<<<<<<<<<<<<<<<<<<<

Hive Name:cisco-trap-repository

--------------------------------------------------------------------

RuleName Description

--------------------------------------------------------------------

STACKWISE-MEMBER-STATUS STACKWISE-MEMBER-STATUS

--------------------------------------------------------------------

total rows in report: 1

Hive Name:cisco-syslog-repository

--------------------------------------------------------------

RuleName Description

--------------------------------------------------------------

FWSM-4-109022 FWSM-4-109022

FWSM-5-713131 FWSM-5-713131

--------------------------------------------------------------

total rows in report: 2

>>>>>>>>>>>>>>>>>>>>>UVne<<<<<<<<<<<<<<<<<<<<<<<<<

>>>>>>>>>>>>>>>>>>>>>Event<<<<<<<<<<<<<<<<<<<<<<<<<

*****

Event Name: stackwise status trap

Alarm ID: 9061

User Defined: true

Subtype: stack member removed

Severity: WARNING

Short Description: Stack Member Removed

Ticketable: true

Auto Clear: true

Subtype: stack member added

Severity: CLEARED

Short Description: Stack New Member

Ticketable: false

Auto Clear: false

*****

Event Name: DWDM fatal error 2 syslog

Alarm ID: 1341

User Defined: false

Subtype: DWDM fatal error 2 syslog

Severity: MAJOR

Short Description: DWDM fatal error with reason and error number

Ticketable: true

Auto Clear: false

Exporting VCB Customizations to Another Gateway (GUI)

You can export your VCB customizations and then import them to another Prime Network gateway. During export, all customizations in the registry will be exported, including all user-defined items and all system default overrides.

To export VCB customizations:

Step 1 In the VCB tool, click Export Customization . The customizations are exported from site.xml to a VCB command script file, VcbImportCommands.sh, located in NETWORKHOME /Main.

Step 2 Save the file.

Importing VCB Customizations from Another Gateway (GUI)

To import VCB customizations:

Step 1 In the VCB tool, click Import Customization .

Step 2 Select the VcbImportCommands.sh file to be imported. The full script is displayed in the Import Customizations dialog.

Step 3 Optional. Review the script and remove commands that you do not want to import. Click Next .

Step 4 Enter the required credentials, as follows:

Step 5 Click Next . The import process begins. When it is complete, you will receive confirmation and any errors that occur during the execution will be displayed.

Step 6 Check that the imported customizations appear in the VCB tool.

Importing VCB Registry Customizations (CLI)

To import VCB registry customizations:

Step 1 After you export registry changes, copy the VcbImportCommands.sh file to the NETWORKHOME/Main folder on the Prime Network gateway on which you want to import the customizations.

Step 2 (Optional) Edit the VcbImportCommands.sh file and delete any customizations that you do not want to import. The commands of interest in the file start with $VCBPATH as shown in this example:

$VCBPATH eventpattern add -rulename L2-DWDM-3-FATAL_2
-group cisco-syslog-ipcore-parsing-rules -repository cisco-router-iox-syslog-repository -user $USER -password $PASS >> "$VCT_IMPORT_SCRIPT_LOG"

Step 3 Change permissions on the script to ensure that it is executable, by entering a command such as this one:

chmod 755 VcbImportCommands.sh

Step 4 Run the script from the NETWORKHOME/Main folder, by entering this command:

VcbImportCommands.sh username password