src/lib/Torrus/DevDiscover/CasaCMTS.pm

   1 #  Copyright (C) 2010  Stanislav Sinyagin
   2 #
   3 #  This program is free software; you can redistribute it and/or modify
   4 #  it under the terms of the GNU General Public License as published by
   5 #  the Free Software Foundation; either version 2 of the License, or
   6 #  (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software
  15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  16
  17 # $Id: CiscoIOS_Docsis.pm 439 2006-09-27 08:56:30Z ssinyagin $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19
  20 # DOCSIS interface, CASA specific
  21
  22 package Torrus::DevDiscover::CasaCMTS;
  23
  24 use strict;
  25 use warnings;
  26
  27 use Torrus::Log;
  28
  29 our $VERSION = 1.0;
  30
  31 $Torrus::DevDiscover::registry{'CasaCMTS'} = {
  32     'sequence'     => 500,
  33     'checkdevtype' => \&checkdevtype,
  34     'discover'     => \&discover,
  35     'buildConfig'  => \&buildConfig
  36     };
  37
  38
  39 $Torrus::DevDiscover::RFC2863_IF_MIB::knownSelectorActions{
  40     'DocsisMacModemsMonitor'} = 'CasaCMTS';
  41
  42
  43 our %oiddef =
  44     (
  45      'casaProducts' => '1.3.6.1.4.1.20858.2',
  46      );
  47
  48
  49 sub checkdevtype
  50 {
  51     my $dd = shift;
  52     my $devdetails = shift;
  53
  54     if( not $dd->oidBaseMatch
  55         ( 'casaProducts',
  56           $devdetails->snmpVar( $dd->oiddef('sysObjectID') ) ) or
  57         not $devdetails->isDevType('RFC2670_DOCS_IF') )
  58     {
  59         return 0;
  60     }
  61
  62     return 1;
  63 }
  64
  65
  66 sub discover
  67 {
  68     my $dd = shift;
  69     my $devdetails = shift;
  70
  71     my $data = $devdetails->data();
  72
  73     push( @{$data->{'docsConfig'}{'docsCableMaclayer'}{'templates'}},
  74           'CasaCMTS::casa-docsis-mac-subtree' );
  75
  76     for my $ifIndex ( @{$data->{'docsCableMaclayer'}} )
  77     {
  78         my $interface = $data->{'interfaces'}{$ifIndex};
  79
  80         push( @{$interface->{'docsTemplates'}},
  81               'CasaCMTS::casa-docsis-mac-util' );
  82     }
  83
  84     for my $ifIndex ( @{$data->{'docsCableUpstream'}} )
  85     {
  86         my $interface = $data->{'interfaces'}{$ifIndex};
  87
  88         push( @{$interface->{'docsTemplates'}},
  89               'CasaCMTS::casa-docsis-upstream-util' );
  90     }
  91
  92     for my $ifIndex ( @{$data->{'docsCableDownstream'}} )
  93     {
  94         my $interface = $data->{'interfaces'}{$ifIndex};
  95
  96         push( @{$interface->{'docsTemplates'}},
  97               'CasaCMTS::casa-docsis-downstream-util' );
  98     }
  99
 100     $data->{'nameref'}{'ifNodeid'} = 'ifNameT';
 101
 102     return 1;
 103 }
 104
 105
 106 sub buildConfig
 107 {
 108     my $devdetails = shift;
 109     my $cb = shift;
 110     my $devNode = shift;
 111
 112     my $data = $devdetails->data();
 113
 114
 115     if( scalar( @{$data->{'docsCableMaclayer'}} ) > 0 )
 116     {
 117         # Build All_Modems summary graph
 118         my $param = {
 119             'ds-type'              => 'rrd-multigraph',
 120             'ds-names'             => 'total,active,registered',
 121             'graph-lower-limit'    => '0',
 122             'precedence'           => '1000',
 123             'vertical-label'       => 'Modems',
 124
 125             'graph-legend-total'   => 'Total',
 126             'line-style-total'     => '##totalresource',
 127             'line-color-total'     => '##totalresource',
 128             'line-order-total'     => '1',
 129
 130             'graph-legend-active'  => 'Active',
 131             'line-style-active'    => '##resourcepartusage',
 132             'line-color-active'    => '##resourcepartusage',
 133             'line-order-active'    => '2',
 134
 135             'graph-legend-registered'  => 'Registered',
 136             'line-style-registered'    => '##resourceusage',
 137             'line-color-registered'    => '##resourceusage',
 138             'line-order-registered'    => '3',
 139             'descriptive-nickname'     => '%system-id%: All modems'
 140             };
 141
 142         # for the sake of better Emacs formatting
 143         $param->{'comment'} =
 144             'Registered, Active and Total modems on CMTS';
 145
 146         $param->{'nodeid'} =
 147             $data->{'docsConfig'}{'docsCableMaclayer'}{'nodeidCategory'} .
 148             '//%nodeid-device%//modems';
 149
 150         my $first = 1;
 151         for my $ifIndex ( @{$data->{'docsCableMaclayer'}} )
 152         {
 153             my $interface = $data->{'interfaces'}{$ifIndex};
 154
 155             my $intf = $interface->{$data->{'nameref'}{'ifSubtreeName'}};
 156
 157             if( $first )
 158             {
 159                 $param->{'ds-expr-total'} =
 160                     '{' . $intf . '/Modems_Total}';
 161                 $param->{'ds-expr-active'} =
 162                     '{' . $intf . '/Modems_Active}';
 163                 $param->{'ds-expr-registered'} =
 164                     '{' . $intf . '/Modems_Registered}';
 165                 $first = 0;
 166             }
 167             else
 168             {
 169                 $param->{'ds-expr-total'} .=
 170                     ',{' . $intf . '/Modems_Total},+';
 171                 $param->{'ds-expr-active'} .=
 172                     ',{' . $intf . '/Modems_Active},+';
 173                 $param->{'ds-expr-registered'} .=
 174                     ',{' . $intf . '/Modems_Registered},+';
 175             }
 176         }
 177
 178         my $macNode =
 179             $cb->getChildSubtree( $devNode,
 180                                   $data->{'docsConfig'}{
 181                                       'docsCableMaclayer'}{
 182                                           'subtreeName'} );
 183         if( defined( $macNode ) )
 184         {
 185             $cb->addLeaf( $macNode, 'All_Modems', $param, [] );
 186         }
 187         else
 188         {
 189             Error('Could not find the MAC layer subtree');
 190             exit 1;
 191         }
 192
 193         # Apply selector actions
 194         for my $ifIndex ( @{$data->{'docsCableMaclayer'}} )
 195         {
 196             my $interface = $data->{'interfaces'}{$ifIndex};
 197
 198             my $intf = $interface->{$data->{'nameref'}{'ifSubtreeName'}};
 199
 200             my $monitor =
 201                 $interface->{'selectorActions'}{'DocsisMacModemsMonitor'};
 202             if( defined( $monitor ) )
 203             {
 204                 my $intfNode = $cb->getChildSubtree( $macNode, $intf );
 205                 $cb->addLeaf( $intfNode, 'Modems_Registered',
 206                               {'monitor' => $monitor } );
 207             }
 208         }
 209     }
 210
 211     if( scalar( @{$data->{'docsCableUpstream'}} ) > 0 )
 212     {
 213         my $upstrNode =
 214             $cb->getChildSubtree( $devNode,
 215                                   $data->{'docsConfig'}{'docsCableUpstream'}{
 216                                       'subtreeName'} );
 217
 218         # Override the overview shortcus defined in rfc2670.docsis-if.xml
 219
 220         my $shortcuts = 'snr,fec,freq,modems';
 221
 222         my $param = {
 223             'overview-shortcuts' =>
 224                 $shortcuts,
 225
 226                 'overview-subleave-name-modems' => 'Modems',
 227                 'overview-direct-link-modems' => 'yes',
 228                 'overview-direct-link-view-modems' => 'expanded-dir-html',
 229                 'overview-shortcut-text-modems' => 'All modems',
 230                 'overview-shortcut-title-modems'=>
 231                 'Show modem quantities in one page',
 232                 'overview-page-title-modems' => 'Modem quantities',
 233             };
 234
 235         $cb->addParams( $upstrNode, $param );
 236     }
 237
 238     if( scalar( @{$data->{'docsCableDownstream'}} ) > 0 )
 239     {
 240         my $downstrNode =
 241             $cb->getChildSubtree( $devNode,
 242                                   $data->{'docsConfig'}{'docsCableDownstream'}{
 243                                       'subtreeName'} );
 244
 245         # Override the overview shortcus defined in rfc2670.docsis-if.xml
 246
 247         my $shortcuts = 'util,modems';
 248
 249         my $param = {
 250             'overview-shortcuts' => $shortcuts,
 251             'overview-subleave-name-modems' => 'Modems',
 252             'overview-direct-link-modems' => 'yes',
 253             'overview-direct-link-view-modems' => 'expanded-dir-html',
 254             'overview-shortcut-text-modems' => 'All modems',
 255             'overview-shortcut-title-modems' =>
 256                 'Show modem quantities in one page',
 257             'overview-page-title-modems' => 'Modem quantities',
 258             };
 259
 260         $cb->addParams( $downstrNode, $param );
 261     }
 262 }
 263
 264
 265 1;
 266
 267
 268 # Local Variables:
 269 # mode: perl
 270 # indent-tabs-mode: nil
 271 # perl-indent-level: 4
 272 # End: