Create or Extend Vendor Certifications

If you have a new vendor or device that you want to support, create a vendor certification. If you want to change the way that a metric is calculated, or to add custom discovery filtering for an out-of-box vendor certification, extend the vendor certification. To remove a vendor certification extension, import an unchanged vendor certification extension template.
capm350
HID_Create_or_Extend_Vendor_Certs
If you have a new vendor or device that you want to support, create a vendor certification. If you want to change the way that a metric is calculated, or to add custom discovery filtering for an out-of-box vendor certification, extend the vendor certification. To remove a vendor certification extension, import an unchanged vendor certification extension template.
2
To avoid possible data loss, always back up the certification directory anytime you extend, create, or update a vendor certification. Metric families and vendor certifications cannot be deleted from your system. Test custom certifications before you implement the changes in your production environment.
Get a Vendor Certification XML Template
For a new certification, use an existing vendor certification for a similar device to create an XML template. For an extension, get the XML for the target vendor certification.
To find a suitable vendor certification to use as a template, look at the metric family you want to support with the new certification, and pick one that is similar to your device.
Follow these steps:
  1. Set up a REST client with a connection to the Data Aggregator server.
  2. Retrieve the template vendor certification by entering the following URL:
    • New Certification:
       
      http://
      da_hostname
      :8581/typecatalog/certifications/snmp/
      cert_name
    • Extension:
       
      http://
      da_hostname
      :8581/typecatalog/certifications/snmp/extension/
      cert_name
    cert_name
    specifies the name of the vendor certification, which is an attribute of the
    FacetType
    tag.
  3. Select GET in the Method tab, and run the method.
    The REST client returns the XML information for the vendor certification.
    Use the XML as a template to create the custom or extended vendor certification.
Edit the Vendor Certification XML
To apply the necessary changes, edit the XML file. When you extend a vendor certification, include only the XML nodes that require changes. For complete information about the XML structure, see Vendor Certification XML Structure.
Import the Custom Vendor Certification
Import the vendor certification to the system.
Verify the vendor certification in a test environment before you import the certification to your production environment. You cannot delete a vendor certification.
Select one of the following options to import the vendor certification:
3
Use a REST Client to Import a Vendor Certification
To import a single vendor certification, use a REST client.
Follow these steps:
  1. Specify one of the following URLs:
    • Import Custom Vendor Certification:
       
      http://
      da-hostname
      :8581/typecatalog/certifications/snmp
    • Update Custom Vendor Certification:
       
      http://
      da-hostname
      :8581/typecatalog/certifications/snmp/
      cert_name
    • Extend Vendor Certification:
       
      http://
      da-hostname
      :8581/typecatalog/certifications/snmp/extension/
      cert_name
  2. On the 
    Method
     tab, select 
    POST
     to import a custom vendor certification, or select 
    PUT
     to update or extend a certification.
  3. In the
    Body
    settings, select 'application/xml' as the 'Body Content-type'.
    Failing to set the Content-type results in a 415 error.
  4. Copy the vendor certification XML into the Body tab.
  5. Run the method.
    Your vendor certification is imported. If no errors occur, the Status field in the HTTP Response section displays the following result:
    HTTP/1.1 200 OK
    To import an unchanged vendor certification extension template, use a file that is similar to the following template:
    <?xml version="1.0" encoding="UTF-8"?> <DataModel namespace="http://im.ca.com/certifications/snmp" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="SNMPCertificationFacet.xsd">   <Author>CA</Author>   <Version>2.02</Version>   <FacetType name="IfXTableMib" descriptorClass="com.ca.im.core.datamodel.certs.CertificationFacetDescriptorImpl">     <FacetOf namespace="http://im.ca.com/core" name="Item" />   </FacetType> </DataModel>
Use the Vendor Certification Installer
To import custom certifications, updates, or extensions, use the certification installer. The installer lets you install certifications and extensions in three ways:
  • Install a single certification or extension
  • Install a collection of certifications or extensions in the form of a ZIP file
  • Install all the certifications or extensions in a directory
    You can only import custom certifications, updates, or extensions from a directory when using the installer in Microsoft Windows. This feature is not supported when using Linux.
Do not import both extensions and custom certifications simultaneously.
 
Follow these steps:
  1. To verify that you have the latest version, download the certification installer from the following URL:
    http://
    da_host
    :8581/cert/install.htm
    If you do not use the latest version, an error message appears when you try to install the certification.
    To run the Certification Installer on a Microsoft Windows system, log in as the Administrator, or run the installer as the administrator.
  2. Select a language for the installer.
  3. Specify the following information when the corresponding prompts appear:
    • DA Hostname
    • DA REST port
  4. To specify the type of installation, select
    Certification
    or
    Extension
    .
  5. Select one of the following options:
    • Install a single certification or extension.
    • Install a collection (ZIP) of certifications or extensions.
    • Install all the certifications or extensions in a directory.
      The certification installer does not search subdirectories.
  6. Click
    Install
    .
    The installer checks the version of each certification or extension during the installation process. If the Data Aggregator indicates that a certification or extension is already installed, the installer tries to update the certification or extension.
    The installer imports the vendor certification or extension. If the installer fails to upgrade the certification or extension, an error appears to specify the reason for the failure. Review the error details in the log files that the installer creates in the Home directory of your computer.
Verify the Vendor Certification Results
To ensure successful operation, verify the results of the import.
Follow these steps:
  1. Log in to the UI, and navigate to the
    Data Aggregator
    data source.
  2. Click 
    Monitoring Configuration
    Vendor Certifications
    .
  3. Verify that the certification appears in the list and that the Last Modified time has been updated.
  4. Click your metric family in the
    Metric Families
    view, and verify that the metric family appears.
  5. Click the
    Vendor Certification Priorities
    tab.
    New custom vendor certifications are automatically added to the bottom of the priority list for the specified metric family. If necessary, modify the priority list and move the vendor certification to a higher priority.