Creating a custom driver

Custom drivers provide the ability to support new kinds of network devices with Standard level functionality. You create a new custom driver by using an existing custom or IBM driver as a template. You then customize the VTMOS, Resource Access Doc (RAD), and device script as required. Newly created custom drivers are automatically distributed to all presentation and worker servers.

Before you begin

The user must be a member of a group who has the "View System" activity. This enables the user to see the Systems Manager in the UI.

You should also understand how to work with Device Scripts and Resource Access Documents (RADs) before creating a custom driver. See Related concepts and Related tasks for information about Device Scripts and RADs.

About this task

Use this procedure to create a new custom driver.

Procedure

  1. Navigate to the Systems Manager, and select the Drivers component.
  2. From the menu bar, select Tools > New Driver
  3. The Choose Template window displays. Using the following table as a guide, select a row in the table to act as the template from which the new custom driver is created. Optionally, the filter drop downs can be used to narrow the number of rows visible in the table. Select Next to proceed.
    Table 1. Select base driver
    Selection Description
    Driver Type You will be asked to choose which type of driver you want to use as the base driver (template): custom driver or IBM driver.
    Custom Drivers Choose this option if you want to use an existing custom driver you have created to act as a base. These are drivers that you will have already created on site.
    IBM Drivers Choose this option if you want to use an existing IBM driver to act as a base. These drivers have been supplied by IBM, and can be standard or SmartModel.
    Choose an IBM Template You will be asked to select which protocol you want to use, for example, CLI-based via Telnet/SSH, or TL1. The protocols available to you will be listed.
    Note: On the first occasion you create a new custom driver, the custom driver type will be greyed out. This is because you have not yet created a custom driver. In this instance, the IBM driver type is automatically selected.
  4. The Driver Details window displays. Using the following table as a guide, enter the appropriate information requested. When the driver details have been specified, select Next to proceed.
    Note: Use the arrows in the centre of the screen to copy values across from the previously selected base driver. These values can then be modified to suit the new custom driver.
    Table 2. Driver Details
    Selection Description
    Vendor/Type/Model/OS These values have been copied from the base drivers selection.
    Supported Models/Supported OSs A list of the Models and OSs supported by the base driver chosen.
  5. The Default Driver Device Script window displays.
    You can modify the Device Script to suit the requirements of the new custom driver. Or, you can load a new device script.
    Note: The device script needs to match the commands that would be entered manually into the device as well as the commands that handle a specific customer environment (for example, the banners). See Related concepts and Related tasks for information about Device Scripts and RADs.

    Select Next to proceed.

  6. The Default Driver RAD window displays. You can modify the RAD, if necessary. Select Next to proceed.
  7. The Description window displays. You should provide a description for the new custom driver. Select Finish to complete the new custom driver creation.
  8. A summary screen will be displayed. This reports all details of the custom driver you have just created, including: UUID, Vendor, Type, Model, OS and display name.
  9. When the custom driver is saved, it is written into the following files in the drivers section of the filesystem: /opt/IBM/tivoli/netcool/ncm/drivers/locators/drivers/<newdriveruuid>.xml, /opt/IBM/tivoli/netcool/ncm/drivers/metadata/<newdriveruuid>/devicescript.txt and /opt/IBM/tivoli/netcool/ncm/drivers/metadata/<newdriveruuid>/rad.xml. Your changes will be automatically applied to all presentation and worker servers.