feat(nokia-timos-snmp): new sas alarm mode (#5274 #5083)

Co-authored-by: Roman Morandell <46994680+rmorandell-pgum@users.noreply.github.com> Refs: CTOR-724
2024-11-28 16:36:30 +01:00 · 2024-11-28 16:36:30 +01:00 · eba027e67c
parent 1f9e3b4340
commit eba027e67c
5 changed files with 269 additions and 0 deletions
--- a/src/network/nokia/timos/snmp/mode/sasalarm.pm
+++ b/src/network/nokia/timos/snmp/mode/sasalarm.pm
@ -0,0 +1,207 @@
+#
+# Copyright 2023 Centreon (http://www.centreon.com/)
+#
+# Centreon is a full-fledged industry-strength solution that meets
+# the needs in IT infrastructure and application monitoring for
+# service performance.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+package network::nokia::timos::snmp::mode::sasalarm;
+
+use base qw(centreon::plugins::templates::counter);
+
+use strict;
+use warnings;
+use Digest::MD5 qw(md5_hex);
+use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold);
+
+sub prefix_output {
+    my ($self, %options) = @_;
+
+    return "Alarm input '" . $options{instance_value}->{display} . "' ";
+}
+
+sub custom_status_output {
+    my ($self, %options) = @_;
+
+    my $msg = 'Alarm input status : ' . $self->{result_values}->{alarm_input_status}
+        . ' (Alarm input admin state: ' . $self->{result_values}->{alarm_input_admin_state}
+        . ' (Alarm output severity: ' . $self->{result_values}->{alarm_output_severity}
+        . ')';
+    return $msg;
+}
+
+sub custom_status_calc {
+    my ($self, %options) = @_;
+
+    $self->{result_values}->{alarm_output_severity} = $options{new_datas}->{$self->{instance} . '_alarm_output_severity'};
+    $self->{result_values}->{alarm_input_status} = $options{new_datas}->{$self->{instance} . '_alarm_input_status'};
+    $self->{result_values}->{alarm_input_admin_state} = $options{new_datas}->{$self->{instance} . '_alarm_input_admin_state'};
+    $self->{result_values}->{display} = $options{new_datas}->{$self->{instance} . '_display'};
+    return 0;
+}
+
+sub set_counters {
+    my ($self, %options) = @_;
+
+    $self->{maps_counters_type} = [
+        {
+            name             => 'sas_alarm_input',
+            type             => 1,
+            cb_prefix_output => 'prefix_output',
+            message_multiple => 'All sas alarm inputs are ok'
+        }
+    ];
+
+    $self->{maps_counters}->{sas_alarm_input} = [
+        { label => 'status', threshold => 0, set => {
+            key_values                     =>
+                [
+                    { name => 'alarm_output_severity' },
+                    { name => 'alarm_input_status' },
+                    { name => 'alarm_input_admin_state' },
+                    { name => 'display' }
+                ],
+            closure_custom_calc            =>
+                $self->can('custom_status_calc'),
+            closure_custom_output          =>
+                $self->can('custom_status_output'),
+            closure_custom_perfdata        =>
+                sub {return 0;},
+            closure_custom_threshold_check =>
+                \&catalog_status_threshold,
+        }
+        },
+    ]
+}
+
+sub new {
+    my ($class, %options) = @_;
+    my $self = $class->SUPER::new(package => __PACKAGE__, %options);
+    bless $self, $class;
+
+    $options{options}->add_options(arguments =>
+        {
+            "filter-name:s"     =>
+                { name => 'filter_name' },
+            "warning-status:s"  =>
+                { name      =>
+                    'warning_status',
+                    default =>
+                        '%{alarm_input_admin_state} eq "up" and %{alarm_input_status} eq "alarm" and %{alarm_output_severity} =~ /minor/' },
+            "critical-status:s" =>
+                { name      =>
+                    'critical_status',
+                    default =>
+                        '%{alarm_input_admin_state} eq "up" and %{alarm_input_status} eq "alarm" and %{alarm_output_severity} =~ /major|critical/' },
+        });
+
+    return $self;
+}
+
+sub check_options {
+    my ($self, %options) = @_;
+    $self->SUPER::check_options(%options);
+
+    $self->change_macros(macros => [ 'warning_status', 'critical_status' ]);
+}
+
+my %alarm_output_severity = (1 => 'none', 2 => 'minor', 3 => 'major', 4 => 'critical');
+my %alarm_input_status = (1 => 'noAlarm', 2 => 'alarm');
+my %alarm_input_admin_state = (1 => 'up', 2 => 'down');
+
+my $mapping = {
+    tmnxSasAlarmOutputSeverity   => { oid => '.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.5', map => \%alarm_output_severity },
+    tmnxSasAlarmInputDescription => { oid => '.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.2' },
+    tmnxSasAlarmInputStatus      => { oid => '.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.6', map => \%alarm_input_status },
+    tmnxSasAlarmInputAdminState  => { oid => '.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.3', map => \%alarm_input_admin_state },
+};
+
+sub manage_selection {
+    my ($self, %options) = @_;
+
+    my $snmp_result = $options{snmp}->get_multiple_table(oids => [
+        { oid => $mapping->{tmnxSasAlarmInputDescription}->{oid} },
+        { oid => $mapping->{tmnxSasAlarmInputStatus}->{oid} },
+        { oid => $mapping->{tmnxSasAlarmInputAdminState}->{oid} },
+        { oid => $mapping->{tmnxSasAlarmOutputSeverity}->{oid} }
+    ],
+        return_type                                           => 1,
+        nothing_quit                                          => 1
+    );
+
+    $self->{sas_alarm_input} = {};
+    foreach my $oid (keys %{$snmp_result}) {
+        next if ($oid !~ /^$mapping->{tmnxSasAlarmOutputSeverity}->{oid}\.(.*)$/);
+        my $instance = $1;
+        my $result = $options{snmp}->map_instance(mapping => $mapping, results => $snmp_result, instance => $instance);
+
+        if (!defined($result->{tmnxSasAlarmInputDescription}) || $result->{tmnxSasAlarmInputDescription} eq '') {
+            $result->{tmnxSasAlarmInputDescription} = "AlarmInput-Instance-$instance";
+        }
+        if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' &&
+            $result->{tmnxSasAlarmInputDescription} !~ /$self->{option_results}->{filter_name}/) {
+            $self->{output}->output_add(long_msg =>
+                "skipping Input '" . $result->{tmnxSasAlarmInputDescription} . "'.",
+                debug                            =>
+                    1);
+            next;
+        }
+
+        $self->{sas_alarm_input}->{$instance} = {
+            display                 => $result->{tmnxSasAlarmInputDescription},
+            alarm_output_severity   => $result->{tmnxSasAlarmOutputSeverity},
+            alarm_input_status      => $result->{tmnxSasAlarmInputStatus},
+            alarm_input_admin_state => $result->{tmnxSasAlarmInputAdminState}
+        };
+
+        $self->{cache_name} = "nokia_timos_" . $self->{mode} . '_' . $options{snmp}->get_hostname() . '_' . $options{snmp}->get_port() . '_' .
+            (defined($self->{option_results}->{filter_counters}) ?
+                md5_hex($self->{option_results}->{filter_counters}) :
+                md5_hex('all')) . '_' .
+            (defined($self->{option_results}->{filter_name}) ?
+                md5_hex($self->{option_results}->{filter_name}) :
+                md5_hex('all'));
+    }
+}
+
+1;
+
+__END__
+
+=head1 MODE
+
+Check SAS alarm input usage.
+
+
+=over 8
+
+=item B<--warning-status>
+
+Set warning threshold for status. (Default: '%{alarm_input_admin_state} eq "up" and %{alarm_input_status} eq "alarm" and %{alarm_output_severity} =~ /minor/')
+You can use the following variables: %{alarm_input_admin_state}, %{alarm_input_status}, %{alarm_output_severity}
+
+=item B<--critical-status>
+
+Set critical threshold for status (Default: '%{alarm_input_admin_state} eq "up" and %{alarm_input_status} eq "alarm" and %{alarm_output_severity} =~ /major|critical/').
+You can use the following variables: %{ipv4_oper_state}, %{admin_state}, %{display}
+
+=item B<--filter-name>
+
+Filter alarm input (tmnxSasAlarmInputDescription) (can be a regexp).
+
+=back
+
+=cut
--- a/src/network/nokia/timos/snmp/plugin.pm
+++ b/src/network/nokia/timos/snmp/plugin.pm
@ -46,6 +46,7 @@ sub new {
        'list-vrtr'        => 'network::nokia::timos::snmp::mode::listvrtr',
        'memory'           => 'network::nokia::timos::snmp::mode::memory',
        'sap-usage'        => 'network::nokia::timos::snmp::mode::sapusage',
+        'sas-alarm'        => 'network::nokia::timos::snmp::mode::sasalarm',
        'uptime'           => 'snmp_standard::mode::uptime',
    );

--- a/tests/network/nokia/timos/snmp/nokia.snmpwalk
+++ b/tests/network/nokia/timos/snmp/nokia.snmpwalk
@ -0,0 +1,24 @@
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.2.1 = STRING: "PSU_1_Sammelalarm"
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.2.2 = STRING: "PSU_1_230V_fehlt"
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.2.3 = STRING: "PSU_2_Sammelalarm"
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.2.4 = STRING: "PSU_2_230V_fehlt"
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.3.1 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.3.2 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.3.3 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.3.4 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.4.1 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.4.2 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.4.3 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.4.4 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.5.1 = INTEGER: 3
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.5.2 = INTEGER: 3
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.5.3 = INTEGER: 3
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.5.4 = INTEGER: 3
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.6.1 = INTEGER: 2
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.6.2 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.6.3 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.6.4 = INTEGER: 1
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.7.1 = Timeticks: (280) 0:00:02.80
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.7.2 = Timeticks: (280) 0:00:02.80
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.7.3 = Timeticks: (280) 0:00:02.80
+.1.3.6.1.4.1.6527.6.2.2.2.9.1.1.7.4 = Timeticks: (280) 0:00:02.80
--- a/tests/network/nokia/timos/snmp/sas-alarm.robot
+++ b/tests/network/nokia/timos/snmp/sas-alarm.robot
@ -0,0 +1,32 @@
+*** Settings ***
+Documentation       Check Stormshield equipment (also Netasq) in SNMP
+
+Resource            ${CURDIR}${/}..${/}..${/}..${/}..${/}resources/import.resource
+
+Test Timeout        120s
+
+
+*** Variables ***
+${CMD}      ${CENTREON_PLUGINS} --plugin=network::nokia::timos::snmp::plugin
+
+
+*** Test Cases ***
+sas-alarm ${tc}
+    [Tags]    network    nokia
+    ${command}    Catenate
+    ...    ${CMD}
+    ...    --mode=sas-alarm
+    ...    --hostname=${HOSTNAME}
+    ...    --snmp-version=${SNMPVERSION}
+    ...    --snmp-port=${SNMPPORT}
+    ...    --snmp-community=network/nokia/timos/snmp/nokia
+    ...    --snmp-timeout=1
+    ...    ${extra_options}
+ 
+    Ctn Run Command And Check Result As Strings    ${command}    ${expected_result}
+
+    Examples:        tc    extra_options                                                                                                                                                          expected_result    --
+            ...      1     --verbose                                                                                                                                                              CRITICAL: Alarm input 'PSU_1_Sammelalarm' Alarm input status : alarm (Alarm input admin state: up (Alarm output severity: major) Alarm input 'PSU_1_Sammelalarm' Alarm input status : alarm (Alarm input admin state: up (Alarm output severity: major) Alarm input 'PSU_1_230V_fehlt' Alarm input status : noAlarm (Alarm input admin state: up (Alarm output severity: major) Alarm input 'PSU_2_Sammelalarm' Alarm input status : noAlarm (Alarm input admin state: up (Alarm output severity: major) Alarm input 'PSU_2_230V_fehlt' Alarm input status : noAlarm (Alarm input admin state: up (Alarm output severity: major)
+            ...      2     --warning-status='\\\%{alarm_input_admin_state} eq "up" and \\\%{alarm_input_status} eq "alarm" and \\\%{alarm_output_severity} =~ /minor/'                            CRITICAL: Alarm input 'PSU_1_Sammelalarm' Alarm input status : alarm (Alarm input admin state: up (Alarm output severity: major)
+            ...      3     --critical-status='\\\%{alarm_input_admin_state} eq "up" and \\\%{alarm_input_status} eq "alarm" and \\\%{alarm_output_severity} =~ /major|critical/'                  CRITICAL: Alarm input 'PSU_1_Sammelalarm' Alarm input status : alarm (Alarm input admin state: up (Alarm output severity: major)
+            ...      4     --filter-name                                                                                                                                                          CRITICAL: Alarm input 'PSU_1_Sammelalarm' Alarm input status : alarm (Alarm input admin state: up (Alarm output severity: major)
--- a/tests/resources/spellcheck/stopwords.txt
+++ b/tests/resources/spellcheck/stopwords.txt
@ -2,6 +2,8 @@
 3COM
 3CX
 --3cx-version
+7210SAS
+7750SR
 ACS
 --add-fc-fe-errors
 --add-qos-limit
@ -182,6 +184,7 @@ queue-messages-inflighted
 RestAPI
 RFC1628
 RRDCached
+SAS
 Sansymphony
 --scope-datacenter
 sfp.temperature
@ -200,6 +203,8 @@ TCP
 teampass
 Teldat
 timeframe
+TiMOS
+tmnxSasAlarmInputDescription
 topic-messages-inflighted
 total-offline-prct
 total-online-prct