From 92171e1355ab49285850cada421291a9d377eca1 Mon Sep 17 00:00:00 2001 From: qgarnier Date: Wed, 1 Dec 2021 08:23:17 +0100 Subject: [PATCH] add(mode): fortinet fortigate sdwan (#3283) --- .../fortinet/fortigate/snmp/mode/sdwan.pm | 358 ++++++++++++++++++ .../network/fortinet/fortigate/snmp/plugin.pm | 1 + 2 files changed, 359 insertions(+) create mode 100644 centreon-plugins/centreon/common/fortinet/fortigate/snmp/mode/sdwan.pm diff --git a/centreon-plugins/centreon/common/fortinet/fortigate/snmp/mode/sdwan.pm b/centreon-plugins/centreon/common/fortinet/fortigate/snmp/mode/sdwan.pm new file mode 100644 index 000000000..cd0516b36 --- /dev/null +++ b/centreon-plugins/centreon/common/fortinet/fortigate/snmp/mode/sdwan.pm @@ -0,0 +1,358 @@ +# +# Copyright 2021 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 centreon::common::fortinet::fortigate::snmp::mode::sdwan; + +use base qw(centreon::plugins::templates::counter); + +use strict; +use warnings; +use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold_ng); +use Digest::MD5 qw(md5_hex); + +sub prefix_traffic_output { + my ($self, %options) = @_; + + return 'traffic '; +} + +sub sdwan_long_output { + my ($self, %options) = @_; + + return sprintf( + "checking sd-wan '%s' [vdom: %s] [interface: %s]", + $options{instance_value}->{name}, + $options{instance_value}->{vdom}, + $options{instance_value}->{ifName} + ); +} + +sub prefix_sdwan_output { + my ($self, %options) = @_; + + return sprintf( + "sd-wan '%s' [vdom: %s] [interface: %s] ", + $options{instance_value}->{name}, + $options{instance_value}->{vdom}, + $options{instance_value}->{ifName} + ); +} + +sub set_counters { + my ($self, %options) = @_; + + $self->{maps_counters_type} = [ + { name => 'sdwan', type => 3, cb_prefix_output => 'prefix_sdwan_output', cb_long_output => 'sdwan_long_output', + indent_long_output => ' ', message_multiple => 'All sd-wan links are ok', + group => [ + { name => 'status', type => 0, skipped_code => { -10 => 1 } }, + { name => 'traffic', type => 0, cb_prefix_output => 'prefix_traffic_output', skipped_code => { -10 => 1 } }, + { name => 'latency', type => 0, skipped_code => { -10 => 1 } }, + { name => 'jitter', type => 0, skipped_code => { -10 => 1 } } + ] + } + ]; + + $self->{maps_counters}->{status} = [ + { + label => 'status', + type => 2, + critical_default => '%{state} eq "down"', + set => { + key_values => [ { name => 'state' }, { name => 'vdom' }, { name => 'ifName' }, { name => 'name' }, { name => 'id' } ], + output_template => 'state: %s', + closure_custom_perfdata => sub { return 0; }, + closure_custom_threshold_check => \&catalog_status_threshold_ng + } + } + ]; + + $self->{maps_counters}->{traffic} = [ + { label => 'traffic-in', nlabel => 'sdwan.traffic.in.bitspersecond', set => { + key_values => [ { name => 'in', per_second => 1 }, { name => 'vdom' }, { name => 'name' }, { name => 'ifName' } ], + output_template => 'in: %s %s/s', + output_change_bytes => 2, + closure_custom_perfdata => sub { + my ($self, %options) = @_; + + $self->{output}->perfdata_add( + nlabel => $self->{nlabel}, + unit => 'b/s', + instances => [$self->{result_values}->{vdom}, $self->{result_values}->{name}, $self->{result_values}->{ifName}], + value => sprintf('%.2f', $self->{result_values}->{in}), + warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}), + critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}), + min => 0 + ); + } + } + }, + { label => 'traffic-out', nlabel => 'sdwan.traffic.out.bitspersecond', set => { + key_values => [ { name => 'out', per_second => 1 }, { name => 'vdom' }, { name => 'name' }, { name => 'ifName' } ], + output_template => 'out: %s %s/s', + output_change_bytes => 2, + closure_custom_perfdata => sub { + my ($self, %options) = @_; + + $self->{output}->perfdata_add( + nlabel => $self->{nlabel}, + unit => 'b/s', + instances => [$self->{result_values}->{vdom}, $self->{result_values}->{name}, $self->{result_values}->{ifName}], + value => sprintf('%.2f', $self->{result_values}->{out}), + warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}), + critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}), + min => 0 + ); + } + } + }, + { label => 'traffic-bi', nlabel => 'sdwan.traffic.bi.bitspersecond', set => { + key_values => [ { name => 'bi', per_second => 1 }, { name => 'vdom' }, { name => 'name' }, { name => 'ifName' } ], + output_template => 'bi: %s %s/s', + output_change_bytes => 2, + closure_custom_perfdata => sub { + my ($self, %options) = @_; + + $self->{output}->perfdata_add( + nlabel => $self->{nlabel}, + unit => 'b/s', + instances => [$self->{result_values}->{vdom}, $self->{result_values}->{name}, $self->{result_values}->{ifName}], + value => sprintf('%.2f', $self->{result_values}->{bi}), + warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}), + critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}), + min => 0 + ); + } + } + } + ]; + + $self->{maps_counters}->{latency} = [ + { label => 'latency', nlabel => 'sdwan.latency.milliseconds', set => { + key_values => [ { name => 'latency' }, { name => 'vdom' }, { name => 'name' }, { name => 'ifName' } ], + output_template => 'latency: %sms', + closure_custom_perfdata => sub { + my ($self, %options) = @_; + + $self->{output}->perfdata_add( + nlabel => $self->{nlabel}, + unit => 'ms', + instances => [$self->{result_values}->{vdom}, $self->{result_values}->{name}, $self->{result_values}->{ifName}], + value => sprintf('%.2f', $self->{result_values}->{latency}), + warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}), + critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}), + min => 0 + ); + } + } + } + ]; + + $self->{maps_counters}->{jitter} = [ + { label => 'jitter', nlabel => 'sdwan.jitter.milliseconds', set => { + key_values => [ { name => 'jitter' }, { name => 'vdom' }, { name => 'name' }, { name => 'ifName' } ], + output_template => 'jitter: %sms', + closure_custom_perfdata => sub { + my ($self, %options) = @_; + + $self->{output}->perfdata_add( + nlabel => $self->{nlabel}, + unit => 'ms', + instances => [$self->{result_values}->{vdom}, $self->{result_values}->{name}, $self->{result_values}->{ifName}], + value => sprintf('%.2f', $self->{result_values}->{jitter}), + warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}), + critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}), + min => 0 + ); + } + } + } + ]; +} + +sub new { + my ($class, %options) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options, statefile => 1, force_new_perfdata => 1); + bless $self, $class; + + $options{options}->add_options(arguments => { + 'filter-id:s' => { name => 'filter_id' }, + 'filter-name:s' => { name => 'filter_name' }, + 'filter-vdom:s' => { name => 'filter_vdom' } + }); + + return $self; +} + +my $mapping_status = { 0 => 'up', 1 => 'down' }; + +my $mapping = { + state => { oid => '.1.3.6.1.4.1.12356.101.4.9.2.1.4', map => $mapping_status }, # fgVWLHealthCheckLinkState + latency => { oid => '.1.3.6.1.4.1.12356.101.4.9.2.1.5' }, # fgVWLHealthCheckLinkLatency + jitter => { oid => '.1.3.6.1.4.1.12356.101.4.9.2.1.6' }, # fgVWLHealthCheckLinkJitter + vdom => { oid => '.1.3.6.1.4.1.12356.101.4.9.2.1.10' }, # fgVWLHealthCheckLinkVdom + traffic_in => { oid => '.1.3.6.1.4.1.12356.101.4.9.2.1.11' }, # fgVWLHealthCheckLinkBandwidthIn + traffic_out => { oid => '.1.3.6.1.4.1.12356.101.4.9.2.1.12' }, # fgVWLHealthCheckLinkBandwidthOut + traffic_bi => { oid => '.1.3.6.1.4.1.12356.101.4.9.2.1.13' }, # fgVWLHealthCheckLinkBandwidthBi + ifName => { oid => '.1.3.6.1.4.1.12356.101.4.9.2.1.14' } # fgVWLHealthCheckLinkIfName +}; + +sub manage_selection { + my ($self, %options) = @_; + + $self->{cache_name} = 'fortinet_fortigate_' . $options{snmp}->get_hostname() . '_' . $options{snmp}->get_port() . '_' . $self->{mode} . '_' . + md5_hex( + (defined($self->{option_results}->{filter_counters}) ? md5_hex($self->{option_results}->{filter_counters}) : 'all') . '_' . + (defined($self->{option_results}->{filter_id}) ? md5_hex($self->{option_results}->{filter_id}) : 'all') . '_' . + (defined($self->{option_results}->{filter_name}) ? md5_hex($self->{option_results}->{filter_name}) : 'all') . '_' . + (defined($self->{option_results}->{filter_vdom}) ? md5_hex($self->{option_results}->{filter_vdom}) : 'all') + ); + + if ($options{snmp}->is_snmpv1()) { + $self->{output}->add_option_msg(short_msg => "Need to use SNMP v2c or v3."); + $self->{output}->option_exit(); + } + + my $oid_name = '.1.3.6.1.4.1.12356.101.4.9.2.1.2'; # fgVWLHealthCheckLinkName + my $snmp_result = $options{snmp}->get_table( + oid => $oid_name, + nothing_quit => 1 + ); + + $self->{sdwan} = {}; + foreach (keys %$snmp_result) { + /^$oid_name\.(.*)$/; + my $id = $1; + + if (defined($self->{option_results}->{filter_id}) && $self->{option_results}->{filter_id} ne '' && + $id !~ /$self->{option_results}->{filter_id}/) { + $self->{output}->output_add(long_msg => "skipping sd-wan '" . $snmp_result->{$_} . "'.", debug => 1); + next; + } + if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' && + $snmp_result->{$_} !~ /$self->{option_results}->{filter_name}/) { + $self->{output}->output_add(long_msg => "skipping sd-wan '" . $snmp_result->{$_} . "'.", debug => 1); + next; + } + + $self->{sdwan}->{ $id } = { + id => $id, + name => $snmp_result->{$_} + }; + } + + return if (scalar(keys %{$self->{sdwan}}) <= 0); + + $options{snmp}->load( + oids => [ map($_->{oid}, values(%$mapping)) ], + instances => [ map($_, keys(%{$self->{sdwan}})) ], + instance_regexp => '^(.*)$' + ); + $snmp_result = $options{snmp}->get_leef(); + foreach (keys %{$self->{sdwan}}) { + my $result = $options{snmp}->map_instance(mapping => $mapping, results => $snmp_result, instance => $_); + + if (defined($self->{option_results}->{filter_vdom}) && $self->{option_results}->{filter_vdom} ne '' && + $result->{vdom} !~ /$self->{option_results}->{filter_vdom}/) { + $self->{output}->output_add(long_msg => "skipping sd-wan '" . $self->{sdwan}->{$_}->{name} . "'.", debug => 1); + next; + } + + $self->{sdwan}->{$_}->{vdom} = $result->{vdom}; + $self->{sdwan}->{$_}->{ifName} = $result->{ifName}; + + $self->{sdwan}->{$_}->{status} = { + state => $result->{state}, + name => $self->{sdwan}->{$_}->{name}, + id => $self->{sdwan}->{$_}->{id}, + vdom => $result->{vdom}, + ifName => $result->{ifName} + }; + + $self->{sdwan}->{$_}->{traffic} = { + name => $self->{sdwan}->{$_}->{name}, + vdom => $result->{vdom}, + ifName => $result->{ifName}, + in => $result->{traffic_in} * 1000 * 1000, + out => $result->{traffic_out} * 1000 * 1000, + bi => $result->{traffic_bi} * 1000 * 1000, + }; + + $self->{sdwan}->{$_}->{jitter} = { + name => $self->{sdwan}->{$_}->{name}, + vdom => $result->{vdom}, + ifName => $result->{ifName}, + jitter => $result->{jitter} + }; + $self->{sdwan}->{$_}->{latency} = { + name => $self->{sdwan}->{$_}->{name}, + vdom => $result->{vdom}, + ifName => $result->{ifName}, + latency => $result->{latency} + }; + } +} + +1; + +__END__ + +=head1 MODE + +Check sd-wan links. + +=over 8 + +=item B<--filter-id> + +Filter sd-wan links by ID (can be a regexp). + +=item B<--filter-name> + +Filter sd-wan links by name (can be a regexp). + +=item B<--filter-vdom> + +Filter sd-wan links by vdom name (can be a regexp). + +=item B<--unknown-status> + +Set unknown threshold for status. +Can used special variables like: %{state}, %{vdom}, %{id}, %{name}, %{ifName} + +=item B<--warning-status> + +Set warning threshold for status. +Can used special variables like: %{state}, %{vdom}, %{id}, %{name}, %{ifName} + +=item B<--critical-status> + +Set critical threshold for status (Default: '%{state} eq "down"'). +Can used special variables like: %{state}, %{vdom}, %{id}, %{name}, %{ifName} + +=item B<--warning-*> B<--critical-*> + +Thresholds. +Can be: 'traffic-in', 'traffic-out', 'traffic-bi', +'latency', 'jitter'. + +=back + +=cut diff --git a/centreon-plugins/network/fortinet/fortigate/snmp/plugin.pm b/centreon-plugins/network/fortinet/fortigate/snmp/plugin.pm index 6f2ed75f2..9c212dd93 100644 --- a/centreon-plugins/network/fortinet/fortigate/snmp/plugin.pm +++ b/centreon-plugins/network/fortinet/fortigate/snmp/plugin.pm @@ -44,6 +44,7 @@ sub new { 'sessions' => 'centreon::common::fortinet::fortigate::snmp::mode::sessions', 'signatures' => 'centreon::common::fortinet::fortigate::snmp::mode::signatures', 'uptime' => 'snmp_standard::mode::uptime', + 'sdwan' => 'centreon::common::fortinet::fortigate::snmp::mode::sdwan', 'vdom-usage' => 'centreon::common::fortinet::fortigate::snmp::mode::vdomusage', 'virus' => 'centreon::common::fortinet::fortigate::snmp::mode::virus', 'vpn' => 'centreon::common::fortinet::fortigate::snmp::mode::vpn'