Bandwidth Exceeds Contract Report

Owned by ROBIN TWIGGS (Unlicensed)
Last updated: May 30, 2022
2 min read



Bandwidth Exceeds Contract Report

Available in pre-release opReports 3.5.0.
Not available in opReports 3.5 ( the official release as at 20 December 2021 ).

This report provides bandwidth exceeds contract information for node interfaces specified in a Burst Billing Customer List File.
This report requires input from a Burst Billing Customer List.

This report is not available from opReports GUI → Views → On-Demand Reports → Create New Report.


Burst Billing Customer List

In the GUI you'd select "from Burst Billing Customer List File (Upload)" and upload the file of choice. For opreports-cli you use burst_billing_customer_list=<path to listfile>, and for a scheduled report you would set the property burst_billing_customer_list with the value being the path to the list file.

The Burst Billing Customer List can only be in csv format:

  • Each entry must start with the node name, folllowed by an interface, a client number, contracted upstream (mbps) and contracted downstream (mbps):

    Burst Billing Customer List in csv format
    ASGARD,FastEthernet0/0,809-101-6782,5,45
ASGARD,2,809-101-6782,60,5
Huawei_AR2240,5,12345678,20,200
Huawei_AR2240,GigabitEthernet0/0/1.243,12345679,100,10
Teldat_ATLAS60,ethernet0/0.3839,12345670,20,20
TeldatM1,10,12345671,10,10


    Interfaces can be identified by the numeric SNMP interface index, or by the SNMP ifDescr property.


opCommon Configuration settings

/path/to/omkj/conf/opCommon.nmis has the following specific configuration settings for this report:

/path/to/omk/conf/opCommon.nmis
'opreports' =>
{
  ...   'bandwidth_exceeds_contract_csv_display_heading_row' => 0,   ...
}

Examples of Use:

To get the Burst Billing Report not to write headings to the first row of the csv file output for the report:

  • execute this one-line command:

    sudo /usr/local/omk/bin/patch_config.exe /usr/local/omk/conf/opCommon.nmis /opreports/bandwidth_exceeds_contract_csv_display_heading_row=0

Layout Customisation

The layout of this report can be customised from opReports GUI → Views → Report Schedules → Create New → Report → Type=Bandwidth Exceeds Contract Report → Layout tab:


Related Topics