From 05b9e18986f01890f3a5feb4e3a292ce71d689ee Mon Sep 17 00:00:00 2001 From: qgarnier Date: Mon, 15 Feb 2021 15:51:33 +0100 Subject: [PATCH] Add ppma rest api plugin (#2590) --- apps/emc/ppma/restapi/custom/api.pm | 300 ++++++++++++++++++++++++ apps/emc/ppma/restapi/mode/discovery.pm | 108 +++++++++ apps/emc/ppma/restapi/mode/hosts.pm | 222 ++++++++++++++++++ apps/emc/ppma/restapi/mode/listhosts.pm | 96 ++++++++ apps/emc/ppma/restapi/plugin.pm | 53 +++++ 5 files changed, 779 insertions(+) create mode 100644 apps/emc/ppma/restapi/custom/api.pm create mode 100644 apps/emc/ppma/restapi/mode/discovery.pm create mode 100644 apps/emc/ppma/restapi/mode/hosts.pm create mode 100644 apps/emc/ppma/restapi/mode/listhosts.pm create mode 100644 apps/emc/ppma/restapi/plugin.pm diff --git a/apps/emc/ppma/restapi/custom/api.pm b/apps/emc/ppma/restapi/custom/api.pm new file mode 100644 index 000000000..70ed3d522 --- /dev/null +++ b/apps/emc/ppma/restapi/custom/api.pm @@ -0,0 +1,300 @@ +# +# 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. +# Authors : Roman Morandell - ivertix +# + +package apps::emc::ppma::restapi::custom::api; + +use strict; +use warnings; +use centreon::plugins::http; +use centreon::plugins::statefile; +use JSON::XS; +use Digest::MD5 qw(md5_hex); + +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 => { + 'hostname:s' => { name => 'hostname' }, + 'port:s' => { name => 'port' }, + 'proto:s' => { name => 'proto' }, + 'url-path:s' => { name => 'url_path' }, + 'api-username:s' => { name => 'api_username' }, + 'api-password:s' => { name => 'api_password' }, + 'timeout:s' => { name => 'timeout' } + }); + } + $options{options}->add_help(package => __PACKAGE__, sections => 'REST API OPTIONS', once => 1); + + $self->{output} = $options{output}; + $self->{http} = centreon::plugins::http->new(%options); + $self->{cache} = centreon::plugins::statefile->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->{proto} = (defined($self->{option_results}->{proto})) ? $self->{option_results}->{proto} : 'https'; + $self->{port} = (defined($self->{option_results}->{port})) ? $self->{option_results}->{port} : 443; + $self->{url_path} = (defined($self->{option_results}->{url_path})) ? $self->{option_results}->{url_path} : '/LicenseReportingApplication/rest/powerpath'; + $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->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 30; + $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(); + } + + $self->{cache}->check_options(option_results => $self->{option_results}); + return 0; +} + +sub get_connection_infos { + my ($self, %options) = @_; + + return $self->{hostname} . '_' . $self->{http}->get_port(); +} + +sub get_hostname { + my ($self, %options) = @_; + + return $self->{hostname}; +} + +sub get_port { + my ($self, %options) = @_; + + return $self->{port}; +} + +sub json_decode { + my ($self, %options) = @_; + + $options{content} =~ s/\r//mg; + my $decoded; + eval { + $decoded = JSON::XS->new->utf8->decode($options{content}); + }; + if ($@) { + $self->{output}->add_option_msg(short_msg => "Cannot decode json response: $@"); + $self->{output}->option_exit(); + } + + return $decoded; +} + +sub build_options_for_httplib { + my ($self, %options) = @_; + + $self->{option_results}->{hostname} = $self->{hostname}; + $self->{option_results}->{port} = $self->{port}; + $self->{option_results}->{proto} = $self->{proto}; +} + +sub settings { + my ($self, %options) = @_; + + $self->build_options_for_httplib(); + $self->{http}->add_header(key => 'Accept', value => 'application/json'); + $self->{http}->set_options(%{$self->{option_results}}); +} + +sub clean_session { + my ($self, %options) = @_; + + my $datas = {}; + $options{statefile}->write(data => $datas); + $self->{cookie_id} = undef; +} + +sub get_session { + my ($self, %options) = @_; + + my $has_cache_file = $options{statefile}->read(statefile => 'emc_ppma_' . md5_hex($self->{option_results}->{hostname}) . '_' . md5_hex($self->{option_results}->{api_username})); + my $cookie_id = $options{statefile}->get(name => 'cookie_id'); + + if ($has_cache_file == 0 || !defined($cookie_id)) { + my ($content) = $self->{http}->request( + method => 'POST', + url_path => '/LicenseReportingApplication/authenticate', + post_param => [ + 'j_username=' . $self->{api_username}, + 'j_password=' . $self->{api_password} + ], + cookies_file => '', + warning_status => '', unknown_status => '', critical_status => '' + ); + + if ($self->{http}->get_code() != 200) { + $self->{output}->add_option_msg(short_msg => "Authentication error [code: '" . $self->{http}->get_code() . "'] [message: '" . $self->{http}->get_message() . "']"); + $self->{output}->option_exit(); + } + + my (@cookies) = $self->{http}->get_first_header(name => 'Set-Cookie'); + foreach my $cookie (@cookies) { + $cookie_id = $1 if ($cookie =~ /JSESSIONID=(.+?);/); + } + + if (!defined($cookie_id)) { + $self->{output}->add_option_msg(short_msg => "Cannot get cookie"); + $self->{output}->option_exit(); + } + + $options{statefile}->write(data => { cookie_id => $cookie_id }); + } + + $self->{cookie_id} = $cookie_id; +} + +sub request { + my ($self, %options) = @_; + + my $endpoint = $self->{url_path} . $options{endpoint}; + + $self->settings(); + if (!defined($self->{access_token})) { + $self->get_session(statefile => $self->{cache}); + } + + my $content = $self->{http}->request( + method => 'GET', + url_path => $endpoint, + get_param => $options{get_param}, + header => [ + 'Cookie: JSESSIONID=' . $self->{cookie_id}, + 'Content-Type: application/json' + ], + warning_status => '', + unknown_status => '', + critical_status => '' + ); + + # Maybe there is an issue with the token. So we retry. + if ($self->{http}->get_code() < 200 || $self->{http}->get_code() >= 300) { + $self->clean_session(statefile => $self->{cache}); + $self->get_session(statefile => $self->{cache}); + $content = $self->{http}->request( + url_path => $endpoint, + get_param => $options{get_param}, + header => [ + 'Cookie: JSESSIONID=' . $self->{cookie_id}, + 'Content-Type: application/json' + ], + unknown_status => $self->{unknown_http_status}, + warning_status => $self->{warning_http_status}, + critical_status => $self->{critical_http_status} + ); + } + + my $decoded = $self->json_decode(content => $content); + if (!defined($decoded)) { + $self->{output}->add_option_msg(short_msg => 'Error while retrieving data (add --debug option for detailed message)'); + $self->{output}->option_exit(); + } + + return $decoded; +} + +1; + +__END__ + +=head1 NAME + +PPMA API + +=head1 SYNOPSIS + +PPMA api + +=head1 REST API OPTIONS + +=over 8 + +=item B<--hostname> + +API hostname. + +=item B<--url-path> + +API url path (Default: '/LicenseReportingApplication/rest/powerpath') + +=item B<--port> + +API port (Default: 443) + +=item B<--proto> + +Specify https if needed (Default: 'https') + +=item B<--api-username> + +Set API username + +=item B<--api-password> + +Set API password + +=item B<--timeout> + +Set HTTP timeout + +=back + +=head1 DESCRIPTION + +B. + +=cut diff --git a/apps/emc/ppma/restapi/mode/discovery.pm b/apps/emc/ppma/restapi/mode/discovery.pm new file mode 100644 index 000000000..c901436a8 --- /dev/null +++ b/apps/emc/ppma/restapi/mode/discovery.pm @@ -0,0 +1,108 @@ +# +# 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 apps::emc::ppma::restapi::mode::discovery; + +use base qw(centreon::plugins::mode); + +use strict; +use warnings; +use JSON::XS; + +sub new { + my ($class, %options) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options); + bless $self, $class; + + $options{options}->add_options(arguments => { + 'prettify' => { name => 'prettify' } + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::init(%options); +} + +sub run { + my ($self, %options) = @_; + + my $disco_data; + my $disco_stats; + + $disco_stats->{start_time} = time(); + + my $hosts = $options{custom}->request(endpoint => '/hosts'); + foreach my $host (@$hosts) { + my $detail = $options{custom}->request(endpoint => '/hosts/' . $host->{id}); + + my $item = {}; + $item->{id} = $host->{id}; + $item->{hostname} = $host->{hostname}; + $item->{platform} = $detail->{platform}; + $item->{ip} = $detail->{ip}; + $item->{os_version} = $detail->{osVersion}; + $item->{powerpath_version} = $detail->{powerpathVersion}; + $item->{state} = $detail->{state}; + + push @$disco_data, $item; + } + + $disco_stats->{end_time} = time(); + $disco_stats->{duration} = $disco_stats->{end_time} - $disco_stats->{start_time}; + $disco_stats->{discovered_items} = scalar(@$disco_data); + $disco_stats->{results} = $disco_data; + + my $encoded_data; + eval { + if (defined($self->{option_results}->{prettify})) { + $encoded_data = JSON::XS->new->utf8->pretty->encode($disco_stats); + } else { + $encoded_data = JSON::XS->new->utf8->encode($disco_stats); + } + }; + if ($@) { + $encoded_data = '{"code":"encode_error","message":"Cannot encode discovered data into JSON format"}'; + } + + $self->{output}->output_add(short_msg => $encoded_data); + $self->{output}->display(nolabel => 1, force_ignore_perfdata => 1); + $self->{output}->exit(); +} + +1; + +__END__ + +=head1 MODE + +Resources discovery. + +=over 8 + +=item B<--prettify> + +Prettify JSON output. + +=back + +=cut diff --git a/apps/emc/ppma/restapi/mode/hosts.pm b/apps/emc/ppma/restapi/mode/hosts.pm new file mode 100644 index 000000000..7f71eb336 --- /dev/null +++ b/apps/emc/ppma/restapi/mode/hosts.pm @@ -0,0 +1,222 @@ +# +# 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 apps::emc::ppma::restapi::mode::hosts; + +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_ng); + +sub custom_status_output { + my ($self, %options) = @_; + + return sprintf( + 'status: %s', + $self->{result_values}->{status} + ); +} + +sub host_long_output { + my ($self, %options) = @_; + + return "checking host '" . $options{instance_value}->{name} . "'"; +} + +sub prefix_host_output { + my ($self, %options) = @_; + + return "Host '" . $options{instance_value}->{name} . "' "; +} + +sub prefix_path_output { + my ($self, %options) = @_; + + return 'path '; +} + +sub prefix_volume_output { + my ($self, %options) = @_; + + return 'volume '; +} + +sub set_counters { + my ($self, %options) = @_; + + $self->{maps_counters_type} = [ + { + name => 'hosts', type => 3, cb_prefix_output => 'prefix_host_output', cb_long_output => 'host_long_output', indent_long_output => ' ', + message_multiple => 'All hosts are ok', + group => [ + { name => 'status', type => 0, skipped_code => { -10 => 1 } }, + { name => 'path', type => 0, cb_prefix_output => 'prefix_path_output', skipped_code => { -10 => 1 } }, + { name => 'volume', type => 0, cb_prefix_output => 'prefix_volume_output', skipped_code => { -10 => 1 } } + ] + } + ]; + + $self->{maps_counters}->{status} = [ + { + label => 'status', + type => 2, + critical_default => '%{status} !~ /powerPathManaged/', + set => { + key_values => [ { name => 'status' }, { name => 'name' } ], + closure_custom_output => $self->can('custom_status_output'), + closure_custom_perfdata => sub { return 0; }, + closure_custom_threshold_check => \&catalog_status_threshold_ng + } + } + ]; + + $self->{maps_counters}->{path} = [ + { label => 'paths-total', nlabel => 'host.paths.total.count', set => { + key_values => [ { name => 'total' } ], + output_template => 'total: %s', + perfdatas => [ + { template => '%s', min => 0, label_extra_instance => 1 } + ] + } + }, + { label => 'paths-dead', nlabel => 'host.paths.dead.count', set => { + key_values => [ { name => 'dead' }, { name => 'total' } ], + output_template => 'dead: %s', + perfdatas => [ + { template => '%s', min => 0, max => 'total', label_extra_instance => 1 } + ] + } + } + ]; + + $self->{maps_counters}->{volume} = [ + { label => 'volumes-total', nlabel => 'host.volumes.total.count', set => { + key_values => [ { name => 'total' } ], + output_template => 'total: %s', + perfdatas => [ + { template => '%s', min => 0, label_extra_instance => 1 } + ] + } + }, + { label => 'volumes-dead', nlabel => 'host.volumes.dead.count', set => { + key_values => [ { name => 'dead' }, { name => 'total' } ], + output_template => 'dead: %s', + perfdatas => [ + { template => '%s', min => 0, max => 'total', label_extra_instance => 1 } + ] + } + }, + { label => 'volumes-degraded', nlabel => 'host.volumes.degraded.count', set => { + key_values => [ { name => 'degraded' }, { name => 'total' } ], + output_template => 'degraded: %s', + perfdatas => [ + { template => '%s', min => 0, max => 'total', label_extra_instance => 1 } + ] + } + } + ]; +} + +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 => { + 'filter-name:s' => { name => 'filter_name' } + }); + + return $self; +} + +sub manage_selection { + my ($self, %options) = @_; + + my $hosts = $options{custom}->request(endpoint => '/hosts'); + + $self->{hosts} = {}; + foreach my $host (@$hosts) { + if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' && + $host->{hostname} !~ /$self->{option_results}->{filter_name}/) { + $self->{output}->output_add(long_msg => "skipping '" . $host->{hostname} . "': no matching filter.", debug => 1); + next; + } + + my $detail = $options{custom}->request(endpoint => '/hosts/' . $host->{id}); + + $self->{hosts}->{ $host->{hostname} } = { + name => $host->{hostname}, + status => { + name => $host->{hostname}, + status => $detail->{state} + }, + path => { + total => $detail->{totalPathCount}, + dead => $detail->{deadPathCount} + }, + volume => { + total => $detail->{totalVolumeCount}, + dead => $detail->{deadVolumeCount}, + degraded => $detail->{degradedVolumeCount} + } + }; + } +} + +1; + +__END__ + +=head1 MODE + +Check host powerpath informations. + +=over 8 + +=item B<--filter-name> + +Filter hosts by host name (can be a regexp). + +=item B<--unknown-status> + +Set unknown threshold for status. +Can used special variables like: %{status}, %{name} + +=item B<--warning-keepalive-status> + +Set warning threshold for status. +Can used special variables like: %{status}, %{name} + +=item B<--critical-keepalive-status> + +Set critical threshold for status (Default: '%{status} !~ /powerPathManaged/'). +Can used special variables like: %{status}, %{name} + +=item B<--warning-*> B<--critical-*> + +Thresholds. +Can be: 'paths-total', 'paths-dead', +'volumes-total', 'volumes-dead', 'volumes-degraded'. + +=back + +=cut diff --git a/apps/emc/ppma/restapi/mode/listhosts.pm b/apps/emc/ppma/restapi/mode/listhosts.pm new file mode 100644 index 000000000..8736a1870 --- /dev/null +++ b/apps/emc/ppma/restapi/mode/listhosts.pm @@ -0,0 +1,96 @@ +# +# 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 apps::emc::ppma::restapi::mode::listhosts; + +use base qw(centreon::plugins::mode); + +use strict; +use warnings; + +sub new { + my ($class, %options) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options); + bless $self, $class; + + $options{options}->add_options(arguments => { + }); + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::init(%options); +} + +sub manage_selection { + my ($self, %options) = @_; + + return $options{custom}->request(endpoint => '/hosts'); +} + +sub run { + my ($self, %options) = @_; + + my $hosts = $self->manage_selection(custom => $options{custom}); + foreach my $host (@$hosts) { + $self->{output}->output_add(long_msg => + join('', map("[$_ = " . $host->{$_} . ']', keys(%$host))) + ); + } + + $self->{output}->output_add( + severity => 'OK', + short_msg => 'List hosts:' + ); + $self->{output}->display(nolabel => 1, force_ignore_perfdata => 1, force_long_output => 1); + $self->{output}->exit(); +} + +sub disco_format { + my ($self, %options) = @_; + + $self->{output}->add_disco_format(elements => ['id', 'hostname']); +} + +sub disco_show { + my ($self, %options) = @_; + + my $hosts = $self->manage_selection(custom => $options{custom}); + foreach my $host (@$hosts) { + $self->{output}->add_disco_entry( + %$host + ); + } +} + +1; + +__END__ + +=head1 MODE + +List powerpath hosts. + +=over 8 + +=back + +=cut diff --git a/apps/emc/ppma/restapi/plugin.pm b/apps/emc/ppma/restapi/plugin.pm new file mode 100644 index 000000000..dbb83b584 --- /dev/null +++ b/apps/emc/ppma/restapi/plugin.pm @@ -0,0 +1,53 @@ +# +# 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. +# Authors : Roman Morandell - ivertix +# + +package apps::emc::ppma::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} = '1.0'; + $self->{modes} = { + 'discovery' => 'apps::emc::ppma::restapi::mode::discovery', + 'hosts' => 'apps::emc::ppma::restapi::mode::hosts', + 'list-hosts' => 'apps::emc::ppma::restapi::mode::listhosts' + }; + + $self->{custom_modes}->{api} = 'apps::emc::ppma::restapi::custom::api'; + return $self; +} + +1; + +__END__ + +=head1 PLUGIN DESCRIPTION + +Check EMC PowerPath Management Appliance using Rest API. + +=cut