diff --git a/apps/centreon/restapi/custom/api.pm b/apps/centreon/restapi/custom/api.pm new file mode 100644 index 000000000..4cda2bd5d --- /dev/null +++ b/apps/centreon/restapi/custom/api.pm @@ -0,0 +1,285 @@ +# +# Copyright 2019 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::centreon::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' }, + "api-username:s" => { name => 'api_username' }, + "api-password:s" => { name => 'api_password' }, + "api-path:s" => { name => 'api_path' }, + "timeout:s" => { name => 'timeout' }, + }); + } + $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); + $self->{cache} = centreon::plugins::statefile->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} : undef; + $self->{proto} = (defined($self->{option_results}->{proto})) ? $self->{option_results}->{proto} : 'http'; + $self->{port} = (defined($self->{option_results}->{port})) ? $self->{option_results}->{port} : 80; + $self->{api_username} = (defined($self->{option_results}->{api_username})) ? + $self->{option_results}->{api_username} : undef; + $self->{api_password} = (defined($self->{option_results}->{api_password})) ? + $self->{option_results}->{api_password} : undef; + $self->{api_path} = (defined($self->{option_results}->{api_path})) ? + $self->{option_results}->{api_path} : '/centreon/api/index.php'; + $self->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 10; + + if (!defined($self->{hostname}) || $self->{hostname} eq '') { + $self->{output}->add_option_msg(short_msg => "Need to specify --hostname option."); + $self->{output}->option_exit(); + } + if (!defined($self->{api_username}) || $self->{api_username} eq '') { + $self->{output}->add_option_msg(short_msg => "Need to specify --api-username option."); + $self->{output}->option_exit(); + } + if (!defined($self->{api_password}) || $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 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}; +} + +sub settings { + my ($self, %options) = @_; + + $self->build_options_for_httplib(); + $self->{http}->add_header(key => 'Accept', value => 'application/json'); + if (defined($self->{auth_token})) { + $self->{http}->add_header(key => 'Centreon-Auth-Token', value => $self->{auth_token}); + $self->{http}->add_header(key => 'Content-Type', value => 'application/json'); + } + $self->{http}->set_options(%{$self->{option_results}}); +} + +sub get_auth_token { + my ($self, %options) = @_; + + my $has_cache_file = $options{statefile}->read(statefile => 'centreon_api_' . md5_hex($self->{hostname}) . + '_' . md5_hex($self->{api_username})); + my $expires_on = $options{statefile}->get(name => 'expires_on'); + my $auth_token = $options{statefile}->get(name => 'auth_token'); + + if ($has_cache_file == 0 || !defined($auth_token) || (($expires_on - time()) < 10)) { + my $post_param = [ 'username=' . $self->{api_username}, 'password=' . $self->{api_password} ]; + + $self->settings(); + + my $content = $self->{http}->request( + method => 'POST', + url_path => '/centreon/api/index.php?action=authenticate', + post_param => $post_param + ); + + my $decoded; + eval { + $decoded = JSON::XS->new->utf8->decode($content); + }; + if ($@) { + $self->{output}->add_option_msg(short_msg => "Cannot decode json response"); + $self->{output}->option_exit(); + } + if (!defined($decoded->{authToken})) { + $self->{output}->add_option_msg(short_msg => "Cannot get token"); + $self->{output}->option_exit(); + } + + $auth_token = $decoded->{authToken}; + my $datas = { last_timestamp => time(), auth_token => $decoded->{authToken}, expires_on => time() + 3600 }; + $options{statefile}->write(data => $datas); + } + + return $auth_token; +} + +sub request_api { + my ($self, %options) = @_; + + if (!defined($self->{auth_token})) { + $self->{auth_token} = $self->get_auth_token(statefile => $self->{cache}); + } + + $self->settings(); + + my $encoded_form_post; + eval { + $encoded_form_post = JSON::XS->new->utf8->encode($options{query_form_post}); + }; + if ($@) { + $self->{output}->add_option_msg(short_msg => "Cannot encode json request"); + $self->{output}->option_exit(); + } + + my $content = $self->{http}->request( + method => $options{method}, + url_path => $options{url_path}, + query_form_post => $encoded_form_post, + critical_status => '', warning_status => '', unknown_status => '' + ); + + my $decoded; + eval { + $decoded = JSON::XS->new->utf8->decode($content); + }; + if ($@) { + $self->{output}->add_option_msg(short_msg => "Cannot decode json response"); + $self->{output}->option_exit(); + } + + return ($decoded, JSON::XS->new->utf8->pretty->encode($decoded)); +} + +sub submit_result { + my ($self, %options) = @_; + + my ($response, $raw) = $self->request_api( + method => 'POST', + url_path => $self->{api_path} . '?action=submit&object=centreon_submit_results', + query_form_post => $options{post_data} + ); + + return ($response, $raw); +} + +1; + +__END__ + +=head1 NAME + +Centreon REST API + +=head1 SYNOPSIS + +Centreon Rest API custom mode + +=head1 REST API OPTIONS + +=over 8 + +=item B<--hostname> + +Centreon hostname. + +=item B<--port> + +Port used (Default: 80) + +=item B<--proto> + +Specify https if needed (Default: 'http') + +=item B<--api-username> + +Centreon username. + +=item B<--api-password> + +Centreon password. + +=item B<--api-path> + +API base url path (Default: '/centreon/api/index.php'). + +=item B<--timeout> + +Set HTTP timeout in seconds (Default: '10'). + +=back + +=head1 DESCRIPTION + +B. + +=cut diff --git a/apps/centreon/restapi/mode/submitresult.pm b/apps/centreon/restapi/mode/submitresult.pm new file mode 100644 index 000000000..74e718029 --- /dev/null +++ b/apps/centreon/restapi/mode/submitresult.pm @@ -0,0 +1,156 @@ +# +# Copyright 2019 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::centreon::restapi::mode::submitresult; + +use base qw(centreon::plugins::templates::counter); + +use strict; +use warnings; + +sub set_counters { + my ($self, %options) = @_; + + $self->{maps_counters_type} = [ + { name => 'global', type => 0, cb_prefix_output => 'prefix_output', skipped_code => { -10 => 1 } }, + ]; + + $self->{maps_counters}->{global} = [ + { label => 'results-202', nlabel => 'results.202.count', set => { + key_values => [ { name => '202' } ], + output_template => '202: %d', + perfdatas => [ + { value => '202_absolute', template => '%d', min => 0 }, + ], + } + }, + { label => 'results-400', nlabel => 'results.400.count', set => { + key_values => [ { name => '400' } ], + output_template => '400: %d', + perfdatas => [ + { value => '400_absolute', template => '%d', min => 0 }, + ], + } + }, + { label => 'results-404', nlabel => 'results.404.count', set => { + key_values => [ { name => '404' } ], + output_template => '404: %d', + perfdatas => [ + { value => '404_absolute', template => '%d', min => 0 }, + ], + } + }, + ]; +} + +sub prefix_output { + my ($self, %options) = @_; + + return "Results "; +} + +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 => { + "host:s@" => { name => 'host' }, + "service:s@" => { name => 'service' }, + "status:s@" => { name => 'status' }, + "output:s@" => { name => 'output' }, + "perfdata:s@" => { name => 'perfdata' }, + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::init(%options); +} + +sub manage_selection { + my ($self, %options) = @_; + + my $post_data; + my $i = 0; + foreach (@{$self->{option_results}->{host}}) { + my %result; + $result{updatetime} = time(); + $result{host} = $_; + $result{service} = ${$self->{option_results}->{service}}[$i] if (defined(${$self->{option_results}->{service}}[$i])); + $result{status} = ${$self->{option_results}->{status}}[$i]; + $result{output} = ${$self->{option_results}->{output}}[$i]; + $result{perfdata} = ${$self->{option_results}->{perfdata}}[$i] if (defined(${$self->{option_results}->{perfdata}}[$i])); + push @{$post_data->{results}}, \%result; + $i++; + } + + my ($response, $raw) = $options{custom}->submit_result(post_data => $post_data); + + $self->{global} = { 202 => 0, 400 => 0, 404 => 0 }; + foreach my $result (@{$response->{results}}) { + $self->{global}->{$result->{code}}++; + } + + $self->{output}->output_add(long_msg => $raw); +} + +1; + +__END__ + +=head1 MODE + +Submit one or several results to the API. + +Examples: +perl centreon_plugins --plugin=apps::centreon::restapi::plugin --mode=submit-result --hostname=10.30.2.245 +--api-username=admin --api-password=centreon --host='MyHost' --service='TheService' --status=2 --output='Hi!' +--perfdata='france=3,brazil=0' --verbose + +=over 8 + +=item B<--host> + +Hostname (Mandatory). + +=item B<--service> + +Service description (If result's for a service). + +=item B<--status> + +Status in 0, 1, 2, 3 or ok, warning, critical, unknown for services, +or in 0, 1 or up, down for hosts (Mandatory). + +=item B<--output> + +Short output (Mandatory). + +=item B<--perfdata> + +Comma separated list of perfdata (Optionnal). + +=back + +=cut + diff --git a/apps/centreon/restapi/plugin.pm b/apps/centreon/restapi/plugin.pm new file mode 100644 index 000000000..3fa99e74a --- /dev/null +++ b/apps/centreon/restapi/plugin.pm @@ -0,0 +1,49 @@ +# +# Copyright 2019 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::centreon::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}} = ( + 'submit-result' => 'apps::centreon::restapi::mode::submitresult', + ); + + $self->{custom_modes}{api} = 'apps::centreon::restapi::custom::api'; + return $self; +} + +1; + +__END__ + +=head1 PLUGIN DESCRIPTION + +Interacts with Centreon RestAPI. + +=cut