From 9134c388ba6283c0ae38c77a03e7f432f26708a2 Mon Sep 17 00:00:00 2001 From: garnier-quentin Date: Tue, 23 Jun 2020 10:32:35 +0200 Subject: [PATCH] wip netapp ontap rest api --- .../netapp/ontap/restapi/custom/api.pm | 227 +++++++++++++++++ .../ontap/restapi/mode/components/bay.pm | 76 ++++++ .../ontap/restapi/mode/components/fru.pm | 76 ++++++ .../ontap/restapi/mode/components/shelf.pm | 67 +++++ .../netapp/ontap/restapi/mode/hardware.pm | 94 +++++++ .../netapp/ontap/restapi/mode/listpools.pm | 109 ++++++++ .../restapi/mode/liststorageresources.pm | 109 ++++++++ .../netapp/ontap/restapi/mode/pools.pm | 237 +++++++++++++++++ .../ontap/restapi/mode/storageresources.pm | 240 ++++++++++++++++++ .../storage/netapp/ontap/restapi/plugin.pm | 50 ++++ 10 files changed, 1285 insertions(+) create mode 100644 centreon-plugins/storage/netapp/ontap/restapi/custom/api.pm create mode 100644 centreon-plugins/storage/netapp/ontap/restapi/mode/components/bay.pm create mode 100644 centreon-plugins/storage/netapp/ontap/restapi/mode/components/fru.pm create mode 100644 centreon-plugins/storage/netapp/ontap/restapi/mode/components/shelf.pm create mode 100644 centreon-plugins/storage/netapp/ontap/restapi/mode/hardware.pm create mode 100644 centreon-plugins/storage/netapp/ontap/restapi/mode/listpools.pm create mode 100644 centreon-plugins/storage/netapp/ontap/restapi/mode/liststorageresources.pm create mode 100644 centreon-plugins/storage/netapp/ontap/restapi/mode/pools.pm create mode 100644 centreon-plugins/storage/netapp/ontap/restapi/mode/storageresources.pm create mode 100644 centreon-plugins/storage/netapp/ontap/restapi/plugin.pm diff --git a/centreon-plugins/storage/netapp/ontap/restapi/custom/api.pm b/centreon-plugins/storage/netapp/ontap/restapi/custom/api.pm new file mode 100644 index 000000000..b0e9a17d7 --- /dev/null +++ b/centreon-plugins/storage/netapp/ontap/restapi/custom/api.pm @@ -0,0 +1,227 @@ +# +# Copyright 2020 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 storage::netapp::ontap::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->{mode} = $options{mode}; + $self->{http} = centreon::plugins::http->new(%options); + + return $self; +} + +sub set_options { + my ($self, %options) = @_; + + $self->{option_results} = $options{option_results}; +} + +sub set_defaults { + my ($self, %options) = @_; + + foreach (keys %{$options{default}}) { + if ($_ eq $self->{mode}) { + for (my $i = 0; $i < scalar(@{$options{default}->{$_}}); $i++) { + foreach my $opt (keys %{$options{default}->{$_}[$i]}) { + if (!defined($self->{option_results}->{$opt}[$i])) { + $self->{option_results}->{$opt}[$i] = $options{default}->{$_}[$i]->{$opt}; + } + } + } + } + } +} + +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} : 443; + $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}->add_header(key => 'Content-Type', 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 = do { + local $/ = undef; + if (!open my $fh, "<", '/home/qgarnier/clients/plugins/todo/netapp_restapi/shelves') { + $self->{output}->add_option_msg(short_msg => "Could not open file $self->{option_results}->{$_} : $!"); + $self->{output}->option_exit(); + } + <$fh>; + }; + #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} + #); + + 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 + +Netapp ONTAP Rest API + +=head1 REST API OPTIONS + +Netapp ONTAP Rest API + +=over 8 + +=item B<--hostname> + +Netapp hostname. + +=item B<--port> + +Port used (Default: 443) + +=item B<--proto> + +Specify https if needed (Default: 'https') + +=item B<--api-username> + +Netapp API username. + +=item B<--api-password> + +Netapp API password. + +=item B<--timeout> + +Set timeout in seconds (Default: 10). + +=back + +=head1 DESCRIPTION + +B. + +=cut diff --git a/centreon-plugins/storage/netapp/ontap/restapi/mode/components/bay.pm b/centreon-plugins/storage/netapp/ontap/restapi/mode/components/bay.pm new file mode 100644 index 000000000..6b42830cd --- /dev/null +++ b/centreon-plugins/storage/netapp/ontap/restapi/mode/components/bay.pm @@ -0,0 +1,76 @@ +# +# Copyright 2020 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 storage::netapp::ontap::restapi::mode::components::bay; + +use strict; +use warnings; + +sub load {} + +sub check { + my ($self) = @_; + + $self->{output}->output_add(long_msg => 'checking bays'); + $self->{components}->{bay} = { name => 'bays', total => 0, skip => 0 }; + return if ($self->check_filter(section => 'bay')); + return if (!defined($self->{json_results}->{records})); + + foreach my $shelf (@{$self->{json_results}->{records}}) { + my $shelf_instance = $shelf->{serial_number}; + my $shelf_name = $shelf->{name}; + + next if ($self->check_filter(section => 'shelf', instance => $shelf_instance)); + + foreach my $bay (@{$shelf->{bays}}) { + my $instance = $bay->{id}; + my $name = $bay->{id}; + + next if ($self->check_filter(section => 'bay', instance => $instance)); + $self->{components}->{bay}->{total}++; + + $self->{output}->output_add( + long_msg => sprintf( + "bay '%s' shelf '%s' state is '%s' [shelf: %s, instance: %s]", + $name, + $shelf_name, + $bay->{state}, + $shelf_instance, + $instance + ) + ); + + my $exit = $self->get_severity(label => 'state', section => 'bay', value => $bay->{state}); + if (!$self->{output}->is_status(value => $exit, compare => 'ok', litteral => 1)) { + $self->{output}->output_add( + severity => $exit, + short_msg => sprintf( + "Bay '%s' shelf '%s' state is '%s'", + $name, + $shelf_name, + $bay->{state} + ) + ); + } + } + } +} + +1; diff --git a/centreon-plugins/storage/netapp/ontap/restapi/mode/components/fru.pm b/centreon-plugins/storage/netapp/ontap/restapi/mode/components/fru.pm new file mode 100644 index 000000000..415b4be68 --- /dev/null +++ b/centreon-plugins/storage/netapp/ontap/restapi/mode/components/fru.pm @@ -0,0 +1,76 @@ +# +# Copyright 2020 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 storage::netapp::ontap::restapi::mode::components::fru; + +use strict; +use warnings; + +sub load {} + +sub check { + my ($self) = @_; + + $self->{output}->output_add(long_msg => 'checking fru'); + $self->{components}->{fru} = { name => 'frus', total => 0, skip => 0 }; + return if ($self->check_filter(section => 'fru')); + return if (!defined($self->{json_results}->{records})); + + foreach my $shelf (@{$self->{json_results}->{records}}) { + my $shelf_instance = $shelf->{serial_number}; + my $shelf_name = $shelf->{name}; + + next if ($self->check_filter(section => 'shelf', instance => $shelf_instance)); + + foreach my $fru (@{$shelf->{frus}}) { + my $instance = $fru->{serial_number}; + my $name = $fru->{type} . ':' . $fru->{id}; + + next if ($self->check_filter(section => 'fru', instance => $instance)); + $self->{components}->{fru}->{total}++; + + $self->{output}->output_add( + long_msg => sprintf( + "fru '%s' shelf '%s' state is '%s' [shelf: %s, instance: %s]", + $name, + $shelf_name, + $fru->{state}, + $shelf_instance, + $instance + ) + ); + + my $exit = $self->get_severity(label => 'state', section => 'fru', value => $fru->{state}); + if (!$self->{output}->is_status(value => $exit, compare => 'ok', litteral => 1)) { + $self->{output}->output_add( + severity => $exit, + short_msg => sprintf( + "Fru '%s' shelf '%s' state is '%s'", + $name, + $shelf_name, + $fru->{state} + ) + ); + } + } + } +} + +1; diff --git a/centreon-plugins/storage/netapp/ontap/restapi/mode/components/shelf.pm b/centreon-plugins/storage/netapp/ontap/restapi/mode/components/shelf.pm new file mode 100644 index 000000000..007c01c31 --- /dev/null +++ b/centreon-plugins/storage/netapp/ontap/restapi/mode/components/shelf.pm @@ -0,0 +1,67 @@ +# +# Copyright 2020 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 storage::netapp::ontap::restapi::mode::components::shelf; + +use strict; +use warnings; + +sub load {} + +sub check { + my ($self) = @_; + + $self->{output}->output_add(long_msg => 'checking shelfs'); + $self->{components}->{shelf} = { name => 'shelfs', total => 0, skip => 0 }; + return if ($self->check_filter(section => 'shelf')); + return if (!defined($self->{json_results}->{records})); + + foreach my $shelf (@{$self->{json_results}->{records}}) { + my $shelf_instance = $shelf->{serial_number}; + my $shelf_name = $shelf->{name}; + + next if ($self->check_filter(section => 'shelf', instance => $shelf_instance)); + + $self->{components}->{shelf}->{total}++; + + $self->{output}->output_add( + long_msg => sprintf( + "shelf '%s' state is '%s' [instance: %s]", + $shelf_name, + $shelf->{state}, + $shelf_instance + ) + ); + + my $exit = $self->get_severity(label => 'state', section => 'shelf', value => $shelf->{state}); + if (!$self->{output}->is_status(value => $exit, compare => 'ok', litteral => 1)) { + $self->{output}->output_add( + severity => $exit, + short_msg => sprintf( + "Shelf '%s' state is '%s'", + $shelf_name, + $shelf->{state} + ) + ); + } + } +} + +1; diff --git a/centreon-plugins/storage/netapp/ontap/restapi/mode/hardware.pm b/centreon-plugins/storage/netapp/ontap/restapi/mode/hardware.pm new file mode 100644 index 000000000..ab55ff23c --- /dev/null +++ b/centreon-plugins/storage/netapp/ontap/restapi/mode/hardware.pm @@ -0,0 +1,94 @@ +# +# Copyright 2020 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 storage::netapp::ontap::restapi::mode::hardware; + +use base qw(centreon::plugins::templates::hardware); + +use strict; +use warnings; + +sub set_system { + my ($self, %options) = @_; + + $self->{regexp_threshold_overload_check_section_option} = '^(?:bay|fru)$'; + + $self->{cb_hook2} = 'execute_custom'; + + $self->{thresholds} = { + state => [ + ['ok', 'OK'], + ['error', 'CRITICAL'], + ['.*', 'CRITICAL'] + ] + }; + + $self->{components_path} = 'storage::netapp::ontap::restapi::mode::components'; + $self->{components_module} = ['shelf', 'bay', 'fru']; +} + +sub new { + my ($class, %options) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options, no_absent => 1, no_performance => 1, force_new_perfdata => 1); + bless $self, $class; + + $options{options}->add_options(arguments => {}); + + return $self; +} + +sub execute_custom { + my ($self, %options) = @_; + + $self->{json_results} = $options{custom}->request_api(endpoint => '/api/storage/shelves?fields=*'); +} + +1; + +=head1 MODE + +Check hardware. + +=over 8 + +=item B<--component> + +Which component to check (Default: '.*'). +Can be: 'shelf', 'bay', 'fru'. + +=item B<--filter> + +Exclude some parts (comma seperated list) +Can also exclude specific instance: --filter='fru,-' + +=item B<--no-component> + +Return an error if no compenents are checked. +If total (with skipped) is 0. (Default: 'critical' returns). + +=item B<--threshold-overload> + +Set to overload default threshold values (syntax: section,[instance,]status,regexp) +It used before default thresholds (order stays). +Example: --threshold-overload='fru,OK,error' + +=back + +=cut diff --git a/centreon-plugins/storage/netapp/ontap/restapi/mode/listpools.pm b/centreon-plugins/storage/netapp/ontap/restapi/mode/listpools.pm new file mode 100644 index 000000000..2e3344914 --- /dev/null +++ b/centreon-plugins/storage/netapp/ontap/restapi/mode/listpools.pm @@ -0,0 +1,109 @@ +# +# Copyright 2020 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 storage::emc::unisphere::restapi::mode::listpools; + +use base qw(centreon::plugins::mode); + +use strict; +use warnings; +use storage::emc::unisphere::restapi::mode::components::resources qw($health_status); + +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' }, + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::init(%options); +} + +sub manage_selection { + my ($self, %options) = @_; + + return $options{custom}->request_api(url_path => '/api/types/pool/instances?fields=name,health'); +} + +sub run { + my ($self, %options) = @_; + + my $pools = $self->manage_selection(%options); + foreach (@{$pools->{entries}}) { + next if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' + && $_->{content}->{name} !~ /$self->{option_results}->{filter_name}/); + + $self->{output}->output_add(long_msg => sprintf( + '[name = %s][status = %s]', + $_->{content}->{name}, + $health_status->{ $_->{content}->{health}->{value} }, + )); + } + + $self->{output}->output_add( + severity => 'OK', + short_msg => 'List pools:' + ); + $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 => ['name', 'status']); +} + +sub disco_show { + my ($self, %options) = @_; + + my $pools = $self->manage_selection(%options); + foreach (@{$pools->{entries}}) { + $self->{output}->add_disco_entry( + name => $_->{content}->{name}, + status => $health_status->{ $_->{content}->{health}->{value} }, + ); + } +} + +1; + +__END__ + +=head1 MODE + +List pools. + +=over 8 + +=item B<--filter-name> + +Filter pool name (Can be a regexp). + +=back + +=cut diff --git a/centreon-plugins/storage/netapp/ontap/restapi/mode/liststorageresources.pm b/centreon-plugins/storage/netapp/ontap/restapi/mode/liststorageresources.pm new file mode 100644 index 000000000..14aac625a --- /dev/null +++ b/centreon-plugins/storage/netapp/ontap/restapi/mode/liststorageresources.pm @@ -0,0 +1,109 @@ +# +# Copyright 2020 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 storage::emc::unisphere::restapi::mode::liststorageresources; + +use base qw(centreon::plugins::mode); + +use strict; +use warnings; +use storage::emc::unisphere::restapi::mode::components::resources qw($health_status); + +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' }, + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::init(%options); +} + +sub manage_selection { + my ($self, %options) = @_; + + return $options{custom}->request_api(url_path => '/api/types/storageResource/instances?fields=name,health'); +} + +sub run { + my ($self, %options) = @_; + + my $storages = $self->manage_selection(%options); + foreach (@{$storages->{entries}}) { + next if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' + && $_->{content}->{name} !~ /$self->{option_results}->{filter_name}/); + + $self->{output}->output_add(long_msg => sprintf( + '[name = %s][status = %s]', + $_->{content}->{name}, + $health_status->{ $_->{content}->{health}->{value} }, + )); + } + + $self->{output}->output_add( + severity => 'OK', + short_msg => 'List storage resources:' + ); + $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 => ['name', 'status']); +} + +sub disco_show { + my ($self, %options) = @_; + + my $storages = $self->manage_selection(%options); + foreach (@{$storages->{entries}}) { + $self->{output}->add_disco_entry( + name => $_->{content}->{name}, + status => $health_status->{ $_->{content}->{health}->{value} }, + ); + } +} + +1; + +__END__ + +=head1 MODE + +List pools. + +=over 8 + +=item B<--filter-name> + +Filter pool name (Can be a regexp). + +=back + +=cut diff --git a/centreon-plugins/storage/netapp/ontap/restapi/mode/pools.pm b/centreon-plugins/storage/netapp/ontap/restapi/mode/pools.pm new file mode 100644 index 000000000..93b108391 --- /dev/null +++ b/centreon-plugins/storage/netapp/ontap/restapi/mode/pools.pm @@ -0,0 +1,237 @@ +# +# Copyright 2020 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 storage::emc::unisphere::restapi::mode::pools; + +use base qw(centreon::plugins::templates::counter); + +use strict; +use warnings; +use storage::emc::unisphere::restapi::mode::components::resources qw($health_status); +use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold catalog_status_calc); + +sub custom_status_output { + my ($self, %options) = @_; + + my $msg = 'status : ' . $self->{result_values}->{status}; + return $msg; +} + +sub custom_usage_output { + my ($self, %options) = @_; + + my ($total_size_value, $total_size_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{total_space}); + my ($total_used_value, $total_used_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{used_space}); + my ($total_free_value, $total_free_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{free_space}); + my $msg = sprintf('space usage total: %s used: %s (%.2f%%) free: %s (%.2f%%)', + $total_size_value . " " . $total_size_unit, + $total_used_value . " " . $total_used_unit, $self->{result_values}->{prct_used_space}, + $total_free_value . " " . $total_free_unit, $self->{result_values}->{prct_free_space} + ); + return $msg; +} + +sub custom_subscribed_output { + my ($self, %options) = @_; + + my ($total_size_value, $total_size_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{total_space}); + my ($total_used_value, $total_used_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{used_sub}); + $self->{result_values}->{free_sub} = 0 if ($self->{result_values}->{free_sub} < 0); + $self->{result_values}->{prct_free_sub} = 0 if ($self->{result_values}->{prct_free_sub} < 0); + my ($total_free_value, $total_free_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{free_sub}); + my $msg = sprintf('subscribed usage total: %s used: %s (%.2f%%) free: %s (%.2f%%)', + $total_size_value . " " . $total_size_unit, + $total_used_value . " " . $total_used_unit, $self->{result_values}->{prct_used_sub}, + $total_free_value . " " . $total_free_unit, $self->{result_values}->{prct_free_sub} + ); + return $msg; +} + +sub set_counters { + my ($self, %options) = @_; + + $self->{maps_counters_type} = [ + { name => 'pool', type => 1, cb_prefix_output => 'prefix_pool_output', message_multiple => 'All pools are ok' }, + ]; + + $self->{maps_counters}->{pool} = [ + { label => 'status', threshold => 0, set => { + key_values => [ { name => 'status' }, { name => 'display' } ], + closure_custom_calc => \&catalog_status_calc, + closure_custom_output => $self->can('custom_status_output'), + closure_custom_perfdata => sub { return 0; }, + closure_custom_threshold_check => \&catalog_status_threshold, + } + }, + { label => 'usage', nlabel => 'pool.space.usage.bytes', set => { + key_values => [ { name => 'used_space' }, { name => 'free_space' }, { name => 'prct_used_space' }, { name => 'prct_free_space' }, { name => 'total_space' }, { name => 'display' }, ], + closure_custom_output => $self->can('custom_usage_output'), + perfdatas => [ + { value => 'used_space', template => '%d', min => 0, max => 'total_space', + unit => 'B', cast_int => 1, label_extra_instance => 1, instance_use => 'display' }, + ], + } + }, + { label => 'usage-free', nlabel => 'pool.space.free.bytes', display_ok => 0, set => { + key_values => [ { name => 'free_space' }, { name => 'used_space' }, { name => 'prct_used_space' }, { name => 'prct_free_space' }, { name => 'total_space' }, { name => 'display' }, ], + closure_custom_output => $self->can('custom_usage_output'), + perfdatas => [ + { value => 'free_space', template => '%d', min => 0, max => 'total_space', + unit => 'B', cast_int => 1, label_extra_instance => 1, instance_use => 'display' }, + ], + } + }, + { label => 'usage-prct', nlabel => 'pool.space.usage.percentage', display_ok => 0, set => { + key_values => [ { name => 'prct_used_space' }, { name => 'display' } ], + output_template => 'used : %.2f %%', + perfdatas => [ + { value => 'prct_used_space', template => '%.2f', min => 0, max => 100, + unit => '%', label_extra_instance => 1, instance_use => 'display' }, + ], + } + }, + { label => 'subscribed', nlabel => 'pool.subscribed.usage.bytes', display_ok => 0, set => { + key_values => [ { name => 'used_sub' }, { name => 'free_sub' }, { name => 'prct_used_sub' }, { name => 'prct_free_sub' }, { name => 'total_space' }, { name => 'display' }, ], + closure_custom_output => $self->can('custom_subscribed_output'), + perfdatas => [ + { value => 'used_sub', template => '%d', min => 0, max => 'total_space', + unit => 'B', cast_int => 1, label_extra_instance => 1, instance_use => 'display' }, + ], + } + }, + { label => 'subscribed-prct', display_ok => 0, nlabel => 'pool.subscribed.usage.percentage', set => { + key_values => [ { name => 'prct_used_sub' }, { name => 'display' } ], + output_template => 'subcribed used : %.2f %%', + perfdatas => [ + { value => 'prct_used_sub', template => '%.2f', min => 0, max => 100, + unit => '%', label_extra_instance => 1, instance_use => 'display' }, + ], + } + }, + ]; +} + +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' }, + 'unknown-status:s' => { name => 'unknown_status', default => '%{status} =~ /unknown/i' }, + 'warning-status:s' => { name => 'warning_status', default => '%{status} =~ /ok_but|degraded|minor/i' }, + 'critical-status:s' => { name => 'critical_status', default => '%{status} =~ /major|criticalnon_recoverable/i' }, + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + $self->change_macros(macros => ['warning_status', 'critical_status', 'unknown_status']); +} + +sub prefix_pool_output { + my ($self, %options) = @_; + + return "Pool '" . $options{instance_value}->{display} . "' "; +} + +sub manage_selection { + my ($self, %options) = @_; + + my $results = $options{custom}->request_api(url_path => '/api/types/pool/instances?fields=name,sizeFree,sizeSubscribed,sizeTotal,health'); + + $self->{pool} = {}; + foreach (@{$results->{entries}}) { + if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' && + $_->{content}->{name} !~ /$self->{option_results}->{filter_name}/) { + $self->{output}->output_add(long_msg => "skipping pool '" . $_->{content}->{name} . "': no matching filter.", debug => 1); + next; + } + + my $used = $_->{content}->{sizeTotal} - $_->{content}->{sizeFree}; + $self->{pool}->{$_->{content}->{id}} = { + display => $_->{content}->{name}, + status => $health_status->{ $_->{content}->{health}->{value} }, + total_space => $_->{content}->{sizeTotal}, + used_space => $used, + free_space => $_->{content}->{sizeFree}, + prct_used_space => $used * 100 / $_->{content}->{sizeTotal}, + prct_free_space => $_->{content}->{sizeFree} * 100 / $_->{content}->{sizeTotal}, + + used_sub => $_->{content}->{sizeSubscribed}, + free_sub => $_->{content}->{sizeTotal} - $_->{content}->{sizeSubscribed}, + prct_used_sub => $_->{content}->{sizeSubscribed} * 100 / $_->{content}->{sizeTotal}, + prct_free_sub => 100 - ($_->{content}->{sizeSubscribed} * 100 / $_->{content}->{sizeTotal}), + }; + } + + if (scalar(keys %{$self->{pool}}) <= 0) { + $self->{output}->add_option_msg(short_msg => "No pool found"); + $self->{output}->option_exit(); + } +} + +1; + +__END__ + +=head1 MODE + +Check pool usages. + +=over 8 + +=item B<--filter-counters> + +Only display some counters (regexp can be used). +Example: --filter-counters='^usage$' + +=item B<--filter-name> + +Filter pool name (can be a regexp). + +=item B<--unknown-status> + +Set warning threshold for status (Default: '%{status} =~ /unknown/i'). +Can used special variables like: %{status}, %{display} + +=item B<--warning-status> + +Set warning threshold for status (Default: '%{status} =~ /ok_but|degraded|minor/i'). +Can used special variables like: %{status}, %{display} + +=item B<--critical-status> + +Set critical threshold for status (Default: '%{status} =~ /major|criticalnon_recoverable/i'). +Can used special variables like: %{status}, %{display} + +=item B<--warning-*> B<--critical-*> + +Thresholds. +Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%), +'subscribed', 'subscribed-prct'. + +=back + +=cut diff --git a/centreon-plugins/storage/netapp/ontap/restapi/mode/storageresources.pm b/centreon-plugins/storage/netapp/ontap/restapi/mode/storageresources.pm new file mode 100644 index 000000000..57815a469 --- /dev/null +++ b/centreon-plugins/storage/netapp/ontap/restapi/mode/storageresources.pm @@ -0,0 +1,240 @@ +# +# Copyright 2020 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 storage::emc::unisphere::restapi::mode::storageresources; + +use base qw(centreon::plugins::templates::counter); + +use strict; +use warnings; +use storage::emc::unisphere::restapi::mode::components::resources qw($health_status); +use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold catalog_status_calc); + +sub custom_status_output { + my ($self, %options) = @_; + + my $msg = 'status : ' . $self->{result_values}->{status}; + return $msg; +} + +sub custom_usage_output { + my ($self, %options) = @_; + + my ($total_size_value, $total_size_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{total_space}); + my ($total_used_value, $total_used_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{used_space}); + my ($total_free_value, $total_free_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{free_space}); + my $msg = sprintf('space usage total: %s used: %s (%.2f%%) free: %s (%.2f%%)', + $total_size_value . " " . $total_size_unit, + $total_used_value . " " . $total_used_unit, $self->{result_values}->{prct_used_space}, + $total_free_value . " " . $total_free_unit, $self->{result_values}->{prct_free_space} + ); + return $msg; +} + +sub custom_allocated_output { + my ($self, %options) = @_; + + my ($total_size_value, $total_size_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{total_space}); + my ($total_used_value, $total_used_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{used_alloc}); + $self->{result_values}->{free_alloc} = 0 if ($self->{result_values}->{free_alloc} < 0); + $self->{result_values}->{prct_free_alloc} = 0 if ($self->{result_values}->{prct_free_alloc} < 0); + my ($total_free_value, $total_free_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{free_alloc}); + my $msg = sprintf('allocated usage total: %s used: %s (%.2f%%) free: %s (%.2f%%)', + $total_size_value . " " . $total_size_unit, + $total_used_value . " " . $total_used_unit, $self->{result_values}->{prct_used_alloc}, + $total_free_value . " " . $total_free_unit, $self->{result_values}->{prct_free_alloc} + ); + return $msg; +} + +sub set_counters { + my ($self, %options) = @_; + + $self->{maps_counters_type} = [ + { name => 'sr', type => 1, cb_prefix_output => 'prefix_sr_output', message_multiple => 'All storage resources are ok', skipped_code => { -10 => 1 } }, + ]; + + $self->{maps_counters}->{sr} = [ + { label => 'status', threshold => 0, set => { + key_values => [ { name => 'status' }, { name => 'display' } ], + closure_custom_calc => \&catalog_status_calc, + closure_custom_output => $self->can('custom_status_output'), + closure_custom_perfdata => sub { return 0; }, + closure_custom_threshold_check => \&catalog_status_threshold, + } + }, + { label => 'usage', nlabel => 'storageresource.space.usage.bytes', set => { + key_values => [ { name => 'used_space' }, { name => 'free_space' }, { name => 'prct_used_space' }, { name => 'prct_free_space' }, { name => 'total_space' }, { name => 'display' }, ], + closure_custom_output => $self->can('custom_usage_output'), + perfdatas => [ + { value => 'used_space', template => '%d', min => 0, max => 'total_space', + unit => 'B', cast_int => 1, label_extra_instance => 1, instance_use => 'display' }, + ], + } + }, + { label => 'usage-free', nlabel => 'storageresource.space.free.bytes', display_ok => 0, set => { + key_values => [ { name => 'free_space' }, { name => 'used_space' }, { name => 'prct_used_space' }, { name => 'prct_free_space' }, { name => 'total_space' }, { name => 'display' }, ], + closure_custom_output => $self->can('custom_usage_output'), + perfdatas => [ + { value => 'free_space', template => '%d', min => 0, max => 'total_space', + unit => 'B', cast_int => 1, label_extra_instance => 1, instance_use => 'display' }, + ], + } + }, + { label => 'usage-prct', nlabel => 'storageresource.space.usage.percentage', display_ok => 0, set => { + key_values => [ { name => 'prct_used_space' }, { name => 'display' } ], + output_template => 'used : %.2f %%', + perfdatas => [ + { value => 'prct_used_space', template => '%.2f', min => 0, max => 100, + unit => '%', label_extra_instance => 1, instance_use => 'display' }, + ], + } + }, + { label => 'allocated', nlabel => 'storageresource.allocated.usage.bytes', display_ok => 0, set => { + key_values => [ { name => 'used_alloc' }, { name => 'free_alloc' }, { name => 'prct_used_alloc' }, { name => 'prct_free_alloc' }, { name => 'total_space' }, { name => 'display' }, ], + closure_custom_output => $self->can('custom_allocated_output'), + perfdatas => [ + { value => 'used_alloc', template => '%d', min => 0, max => 'total_space', + unit => 'B', cast_int => 1, label_extra_instance => 1, instance_use => 'display' }, + ], + } + }, + { label => 'allocated-prct', display_ok => 0, nlabel => 'storageresource.allocated.usage.percentage', set => { + key_values => [ { name => 'prct_used_alloc' }, { name => 'display' } ], + output_template => 'allocated used : %.2f %%', + perfdatas => [ + { value => 'prct_used_alloc', template => '%.2f', min => 0, max => 100, + unit => '%', label_extra_instance => 1, instance_use => 'display' }, + ], + } + }, + ]; +} + +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' }, + 'unknown-status:s' => { name => 'unknown_status', default => '%{status} =~ /unknown/i' }, + 'warning-status:s' => { name => 'warning_status', default => '%{status} =~ /ok_but|degraded|minor/i' }, + 'critical-status:s' => { name => 'critical_status', default => '%{status} =~ /major|criticalnon_recoverable/i' }, + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + $self->change_macros(macros => ['warning_status', 'critical_status', 'unknown_status']); +} + +sub prefix_sr_output { + my ($self, %options) = @_; + + return "Storage resource '" . $options{instance_value}->{display} . "' "; +} + +sub manage_selection { + my ($self, %options) = @_; + + my $results = $options{custom}->request_api(url_path => '/api/types/storageResource/instances?fields=name,health,sizeUsed,sizeAllocated,sizeTotal'); + + $self->{sr} = {}; + foreach (@{$results->{entries}}) { + if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' && + $_->{content}->{name} !~ /$self->{option_results}->{filter_name}/) { + $self->{output}->output_add(long_msg => "skipping storage resource '" . $_->{content}->{name} . "': no matching filter.", debug => 1); + next; + } + + $self->{sr}->{$_->{content}->{id}} = { + display => $_->{content}->{name}, + status => $health_status->{ $_->{content}->{health}->{value} }, + total_space => $_->{content}->{sizeTotal}, + }; + + if (defined($_->{content}->{sizeUsed})) { + $self->{sr}->{$_->{content}->{id}}->{used_space} = $_->{content}->{sizeUsed}; + $self->{sr}->{$_->{content}->{id}}->{free_space} = $_->{content}->{sizeTotal} - $_->{content}->{sizeUsed}; + $self->{sr}->{$_->{content}->{id}}->{prct_used_space} = $_->{content}->{sizeUsed} * 100 / $_->{content}->{sizeTotal}; + $self->{sr}->{$_->{content}->{id}}->{prct_free_space} = 100 - ($_->{content}->{sizeUsed} * 100 / $_->{content}->{sizeTotal}); + } + if (defined($_->{content}->{sizeAllocated})) { + $self->{sr}->{$_->{content}->{id}}->{used_alloc} = $_->{content}->{sizeAllocated}; + $self->{sr}->{$_->{content}->{id}}->{free_alloc} = $_->{content}->{sizeTotal} - $_->{content}->{sizeAllocated}; + $self->{sr}->{$_->{content}->{id}}->{prct_used_alloc} = $_->{content}->{sizeAllocated} * 100 / $_->{content}->{sizeTotal}; + $self->{sr}->{$_->{content}->{id}}->{prct_free_alloc} = 100 - ($_->{content}->{sizeAllocated} * 100 / $_->{content}->{sizeTotal}); + } + } + + if (scalar(keys %{$self->{sr}}) <= 0) { + $self->{output}->add_option_msg(short_msg => "No storage resource found"); + $self->{output}->option_exit(); + } +} + +1; + +__END__ + +=head1 MODE + +Check storage resources. + +=over 8 + +=item B<--filter-counters> + +Only display some counters (regexp can be used). +Example: --filter-counters='^usage$' + +=item B<--filter-name> + +Filter name (can be a regexp). + +=item B<--unknown-status> + +Set warning threshold for status (Default: '%{status} =~ /unknown/i'). +Can used special variables like: %{status}, %{display} + +=item B<--warning-status> + +Set warning threshold for status (Default: '%{status} =~ /ok_but|degraded|minor/i'). +Can used special variables like: %{status}, %{display} + +=item B<--critical-status> + +Set critical threshold for status (Default: '%{status} =~ /major|criticalnon_recoverable/i'). +Can used special variables like: %{status}, %{display} + +=item B<--warning-*> B<--critical-*> + +Thresholds. +Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%), +'allocated', 'allocated-prct'. + +=back + +=cut diff --git a/centreon-plugins/storage/netapp/ontap/restapi/plugin.pm b/centreon-plugins/storage/netapp/ontap/restapi/plugin.pm new file mode 100644 index 000000000..f9e1a1b1c --- /dev/null +++ b/centreon-plugins/storage/netapp/ontap/restapi/plugin.pm @@ -0,0 +1,50 @@ +# +# Copyright 2020 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 storage::netapp::ontap::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} = { + 'hardware' => 'storage::netapp::ontap::restapi::mode::hardware' + }; + + $self->{custom_modes}{api} = 'storage::netapp::ontap::restapi::custom::api'; + return $self; +} + +1; + +__END__ + +=head1 PLUGIN DESCRIPTION + +Check NetApp ONTAP using Rest API. +ONTAP >= 9.6 version. + +=cut