Skip to content

COM Overview

Introduction

What is COM?

COM is the Common Object Model. It is an authoritative, language-neutral format written in JSON that allows us to document, report, and define rules for our application. COM has inherent security, is declarative (future), and supports processors (like Elasticsearch). Today’s COM only supports SNMP (either traps or polling), but the goal is to enhance this capability to support protocols like tier 1, webhooks and APIs.

How Does COM Work?

The COM applications in our SDK convert your MIBs into Federos COM definition files. These definitions are in a JSON format that defines the SNMP OIDs needed to satisfy basic polling functionality like CPU, Memory, Disk, Temp, Fan, Interfaces, etc. The Federos COM definition file names are FCOM for fault and PCOM for performance metrics.

Federos Assure1 COM SDK has the following applications:

  • MIB2FCOM – Run this with a Management Information Base (MIB) file to generate a pre-certified FCOM file that then goes through curation to create a certified FCOM file.

  • FCOM2Rules – Run this with the certified FCOM file to generate the foundation rules.

  • FCOM2Test – Run this to generate a set of synthetic test traps to test the workflow of the curated FCOM file.

  • PCOM2Rules – Run this with a certified PCOM to generate the foundation rules. You must use a file that has already been manually curated and certified—Federos does not provide a MIB2PCOM app in the SDK.

The following diagram shows the overall process for converting your MIBS to Federos FCOM files. Assure1 MIB2FCOM Process

The following diagram shows the overall process for creating foundation rules with a certified FCOM file. Assure1 FCOM2Rules Process

Getting Started

To run all the Federos COM applications, you will need a system with Assure1 already installed as well as several additional packages. Follow these steps before you run the COM applications.

  1. Download all of the required packages and create the local MIB repository on the system.

  2. Log in to the command line for the server that will be used.

  3. Run the following command to install the sdk-lib package:

    $A1BASEDIR/bin/Package install sdk-lib

  4. Wait for the package installation process to complete.

  5. Put the MIBs you want to convert into a subdirectory of the local MIBs repository.

    Note

    The default location is $A1BASEDIR/distrib/mibs/.

  6. Proceed to Fault for the next steps.