diff --git a/centreon-plugins/hardware/devices/barco/cs/restapi/custom/api.pm b/centreon-plugins/hardware/devices/barco/cs/restapi/custom/api.pm new file mode 100644 index 000000000..160d4c73c --- /dev/null +++ b/centreon-plugins/hardware/devices/barco/cs/restapi/custom/api.pm @@ -0,0 +1,203 @@ +# +# 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 hardware::devices::barco::cs::restapi::custom::api; + +use strict; +use warnings; +use centreon::plugins::http; +use JSON::XS; + +sub new { + my ($class, %options) = @_; + my $self = {}; + bless $self, $class; + + if (!defined($options{output})) { + print "Class Custom: Need to specify 'output' argument.\n"; + exit 3; + } + if (!defined($options{options})) { + $options{output}->add_option_msg(short_msg => "Class Custom: Need to specify 'options' argument."); + $options{output}->option_exit(); + } + + if (!defined($options{noptions})) { + $options{options}->add_options(arguments => { + 'api-username:s' => { name => 'api_username' }, + 'api-password:s' => { name => 'api_password' }, + 'hostname:s' => { name => 'hostname' }, + 'port:s' => { name => 'port' }, + 'proto:s' => { name => 'proto' }, + 'timeout:s' => { name => 'timeout' }, + 'unknown-http-status:s' => { name => 'unknown_http_status' }, + 'warning-http-status:s' => { name => 'warning_http_status' }, + 'critical-http-status:s' => { name => 'critical_http_status' } + }); + } + $options{options}->add_help(package => __PACKAGE__, sections => 'REST API OPTIONS', once => 1); + + $self->{output} = $options{output}; + $self->{http} = centreon::plugins::http->new(%options); + + return $self; +} + +sub set_options { + my ($self, %options) = @_; + + $self->{option_results} = $options{option_results}; +} + +sub set_defaults {} + +sub check_options { + my ($self, %options) = @_; + + $self->{hostname} = (defined($self->{option_results}->{hostname})) ? $self->{option_results}->{hostname} : ''; + $self->{port} = (defined($self->{option_results}->{port})) ? $self->{option_results}->{port} : 4001; + $self->{proto} = (defined($self->{option_results}->{proto})) ? $self->{option_results}->{proto} : 'https'; + $self->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 10; + $self->{api_username} = (defined($self->{option_results}->{api_username})) ? $self->{option_results}->{api_username} : ''; + $self->{api_password} = (defined($self->{option_results}->{api_password})) ? $self->{option_results}->{api_password} : ''; + $self->{unknown_http_status} = (defined($self->{option_results}->{unknown_http_status})) ? $self->{option_results}->{unknown_http_status} : '%{http_code} < 200 or %{http_code} >= 300'; + $self->{warning_http_status} = (defined($self->{option_results}->{warning_http_status})) ? $self->{option_results}->{warning_http_status} : ''; + $self->{critical_http_status} = (defined($self->{option_results}->{critical_http_status})) ? $self->{option_results}->{critical_http_status} : ''; + + if ($self->{hostname} eq '') { + $self->{output}->add_option_msg(short_msg => "Need to specify --hostname option."); + $self->{output}->option_exit(); + } + if ($self->{api_username} eq '') { + $self->{output}->add_option_msg(short_msg => "Need to specify --api-username option."); + $self->{output}->option_exit(); + } + if ($self->{api_password} eq '') { + $self->{output}->add_option_msg(short_msg => "Need to specify --api-password option."); + $self->{output}->option_exit(); + } + + return 0; +} + +sub build_options_for_httplib { + my ($self, %options) = @_; + + $self->{option_results}->{hostname} = $self->{hostname}; + $self->{option_results}->{timeout} = $self->{timeout}; + $self->{option_results}->{port} = $self->{port}; + $self->{option_results}->{proto} = $self->{proto}; + $self->{option_results}->{timeout} = $self->{timeout}; + $self->{option_results}->{credentials} = 1; + $self->{option_results}->{basic} = 1; + $self->{option_results}->{username} = $self->{api_username}; + $self->{option_results}->{password} = $self->{api_password}; +} + +sub settings { + my ($self, %options) = @_; + + return if (defined($self->{settings_done})); + $self->build_options_for_httplib(); + $self->{http}->add_header(key => 'Accept', value => 'application/json'); + $self->{http}->set_options(%{$self->{option_results}}); + $self->{settings_done} = 1; +} + +sub get_hostname { + my ($self, %options) = @_; + + return $self->{hostname}; +} + +sub request_api { + my ($self, %options) = @_; + + $self->settings(); + my $content = $self->{http}->request( + url_path => $options{endpoint}, + unknown_status => $self->{unknown_http_status}, + warning_status => $self->{warning_http_status}, + critical_status => $self->{critical_http_status}, + cookies_file => '' # in memory + ); + + if (!defined($content) || $content eq '') { + $self->{output}->add_option_msg(short_msg => "API returns empty content [code: '" . $self->{http}->get_code() . "'] [message: '" . $self->{http}->get_message() . "']"); + $self->{output}->option_exit(); + } + + my $decoded; + eval { + $decoded = JSON::XS->new->utf8->decode($content); + }; + if ($@) { + $self->{output}->add_option_msg(short_msg => "Cannot decode response (add --debug option to display returned content)"); + $self->{output}->option_exit(); + } + + return $decoded; +} + +1; + +__END__ + +=head1 NAME + +Barco ClickShare Rest API + +=head1 REST API OPTIONS + +Barco ClickShare Rest API + +=over 8 + +=item B<--hostname> + +Barco ClickShare hostname. + +=item B<--port> + +Port used (Default: 4001) + +=item B<--proto> + +Specify https if needed (Default: 'https') + +=item B<--api-username> + +API username. + +=item B<--api-password> + +API password. + +=item B<--timeout> + +Set timeout in seconds (Default: 10). + +=back + +=head1 DESCRIPTION + +B. + +=cut diff --git a/centreon-plugins/hardware/devices/barco/cs/restapi/mode/device.pm b/centreon-plugins/hardware/devices/barco/cs/restapi/mode/device.pm new file mode 100644 index 000000000..57d8f4c17 --- /dev/null +++ b/centreon-plugins/hardware/devices/barco/cs/restapi/mode/device.pm @@ -0,0 +1,248 @@ +# +# 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 hardware::devices::barco::cs::restapi::mode::device; + +use base qw(centreon::plugins::templates::counter); + +use strict; +use warnings; +use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold_ng); + +sub custom_device_status_output { + my ($self, %options) = @_; + + return sprintf('status: %s', $self->{result_values}->{status}); +} + +sub custom_process_status_output { + my ($self, %options) = @_; + + return sprintf('status is %s', $self->{result_values}->{status}); +} + +sub custom_cpu_temp_perfdata { + my ($self, %options) = @_; + + $self->{output}->perfdata_add( + nlabel => $self->{nlabel}, + unit => 'C', + instances => 'cpu', + value => $self->{result_values}->{cpu}, + warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}), + critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}) + ); +} + +sub custom_pcie_temp_perfdata { + my ($self, %options) = @_; + + $self->{output}->perfdata_add( + nlabel => $self->{nlabel}, + unit => 'C', + instances => 'pcie', + value => $self->{result_values}->{pcie}, + warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}), + critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}) + ); +} + +sub custom_sio_temp_perfdata { + my ($self, %options) = @_; + + $self->{output}->perfdata_add( + nlabel => $self->{nlabel}, + unit => 'C', + instances => 'sio', + value => $self->{result_values}->{sio}, + warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}), + critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}) + ); +} + +sub device_long_output { + my ($self, %options) = @_; + + return 'checking device'; +} + +sub prefix_temperature_output { + my ($self, %options) = @_; + + return 'temperature '; +} + +sub prefix_process_output { + my ($self, %options) = @_; + + return "process '" . $options{instance_value}->{name} . "' "; +} + +sub set_counters { + my ($self, %options) = @_; + + $self->{maps_counters_type} = [ + { name => 'device', type => 3, cb_long_output => 'device_long_output', indent_long_output => ' ', + group => [ + { name => 'status', type => 0, display_short => 0, skipped_code => { -10 => 1 } }, + { name => 'temperature', type => 0, cb_prefix_output => 'prefix_temperature_output', display_short => 0, skipped_code => { -10 => 1 } }, + { name => 'processes', type => 1, display_long => 1, display_short => 0, cb_prefix_output => 'prefix_process_output', skipped_code => { -10 => 1 } } + ] + } + ]; + + $self->{maps_counters}->{status} = [ + { + label => 'device-status', + type => 2, + warning_default => '%{status} =~ /warning/', + critical_default => '%{status} =~ /error/', + set => { + key_values => [ { name => 'status' }, ], + closure_custom_output => $self->can('custom_device_status_output'), + closure_custom_perfdata => sub { return 0; }, + closure_custom_threshold_check => \&catalog_status_threshold_ng + } + } + ]; + + $self->{maps_counters}->{temperature} = [ + { label => 'cpu-temperature', nlabel => 'hardware.temperature.celsius', set => { + key_values => [ { name => 'cpu' } ], + output_template => 'cpu %s C', + closure_custom_perfdata => $self->can('custom_cpu_temp_perfdata') + } + }, + { label => 'pcie-temperature', nlabel => 'hardware.temperature.celsius', set => { + key_values => [ { name => 'pcie' } ], + output_template => 'pcie %s C', + closure_custom_perfdata => $self->can('custom_pcie_temp_perfdata') + } + }, + { label => 'sio-temperature', nlabel => 'hardware.temperature.celsius', set => { + key_values => [ { name => 'sio' } ], + output_template => 'sio %s C', + closure_custom_perfdata => $self->can('custom_sio_temp_perfdata') + } + } + ]; + + $self->{maps_counters}->{processes} = [ + { + label => 'process-status', type => 2, + set => { + key_values => [ { name => 'name' }, { name => 'status' } ], + closure_custom_output => $self->can('custom_process_status_output'), + closure_custom_perfdata => sub { return 0; }, + closure_custom_threshold_check => \&catalog_status_threshold_ng + } + } + ]; +} + +sub new { + my ($class, %options) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options, force_new_perfdata => 1); + bless $self, $class; + + $options{options}->add_options(arguments => { + }); + + return $self; +} + +sub manage_selection { + my ($self, %options) = @_; + + my $map_status = { + 0 => 'ok', 1 => 'warning', 2 => 'error' + }; + my $device_status = $options{custom}->request_api(endpoint => '/v1.0/DeviceInfo/Status'); + my $sensors = $options{custom}->request_api(endpoint => '/v1.0/DeviceInfo/Sensors'); + my $processes = $options{custom}->request_api(endpoint => '/v1.0/DeviceInfo/Processes/ProcessTable'); + + $self->{output}->output_add(short_msg => 'device is ok'); + + $self->{device} = { + global => { + status => { status => $map_status->{ $device_status->{data}->{value} } }, + temperature => { + cpu => (defined($sensors->{data}->{value}->{CpuTemperature}) && $sensors->{data}->{value}->{CpuTemperature} != 0) ? + $sensors->{data}->{value}->{CpuTemperature} : undef, + pcie => (defined($sensors->{data}->{value}->{PcieTemperature}) && $sensors->{data}->{value}->{PcieTemperature} != 0) ? + $sensors->{data}->{value}->{PcieTemperature} : undef, + sio => (defined($sensors->{data}->{value}->{SioTemperature}) && $sensors->{data}->{value}->{SioTemperature} != 0) ? + $sensors->{data}->{value}->{SioTemperature} : undef + }, + processes => {} + } + }; + + foreach (values %{$processes->{data}->{value}}) { + $self->{device}->{global}->{processes}->{ $_->{Name} } = { + name => $_->{Name}, + status => $_->{Status} =~ /true|1/i ? 'running' : 'notRunning' + }; + } +} + +1; + +__END__ + +=head1 MODE + +Check device. + +=over 8 + +=item B<--filter-counters> + +Only display some counters (regexp can be used). +Example: --filter-counters='status' + +=item B<--warning-device-status> + +Set warning threshold (Default: '%{status} =~ /warning/'). +Can used special variables like: %{status} + +=item B<--critical-device-status> + +Set critical threshold (Default: '%{status} =~ /error/'). +Can used special variables like: %{status} + +=item B<--warning-process-status> + +Set warning threshold. +Can used special variables like: %{name}, %{status} + +=item B<--critical-process-status> + +Set critical threshold. +Can used special variables like: %{name}, %{status} + +=item B<--warning-*> B<--critical-*> + +Thresholds. +Can be: 'cpu-temperature', 'pcie-temperature', 'sio-temperature'. + +=back + +=cut diff --git a/centreon-plugins/hardware/devices/barco/cs/restapi/plugin.pm b/centreon-plugins/hardware/devices/barco/cs/restapi/plugin.pm new file mode 100644 index 000000000..a05b4ae9c --- /dev/null +++ b/centreon-plugins/hardware/devices/barco/cs/restapi/plugin.pm @@ -0,0 +1,49 @@ +# +# 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 hardware::devices::barco::cs::restapi::plugin; + +use strict; +use warnings; +use base qw(centreon::plugins::script_custom); + +sub new { + my ( $class, %options ) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options); + bless $self, $class; + + $self->{version} = '0.1'; + $self->{modes} = { + 'device' => 'hardware::devices::barco::cs::restapi::mode::device' + }; + + $self->{custom_modes}->{api} = 'hardware::devices::barco::cs::restapi::custom::api'; + return $self; +} + +1; + +__END__ + +=head1 PLUGIN DESCRIPTION + +Check Barco ClickShare using Rest API. + +=cut