306 lines
8.9 KiB
Perl
306 lines
8.9 KiB
Perl
#
|
|
# 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 network::aruba::aoscx::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' },
|
|
'user-domain:s' => { name => 'user_domain' },
|
|
'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} : '/rest/v1';
|
|
$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->{user_domain} = (defined($self->{option_results}->{user_domain})) ? $self->{option_results}->{user_domain} : '';
|
|
|
|
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;
|
|
$self->{cookie_user} = undef;
|
|
}
|
|
|
|
sub get_session {
|
|
my ($self, %options) = @_;
|
|
|
|
my $has_cache_file = $options{statefile}->read(statefile => 'aruba_aoscx_' . md5_hex($self->{option_results}->{hostname}) . '_' . md5_hex($self->{option_results}->{api_username}));
|
|
my $cookie_id = $options{statefile}->get(name => 'cookie_id');
|
|
my $cookie_user = $options{statefile}->get(name => 'cookie_user');
|
|
|
|
if ($has_cache_file == 0 || !defined($cookie_id)) {
|
|
my ($content) = $self->{http}->request(
|
|
method => 'POST',
|
|
url_path => $self->{url_path} . '/login',
|
|
post_param => [
|
|
'username=' . $self->{api_username},
|
|
'password=' . $self->{api_password}
|
|
],
|
|
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_header(name => 'Set-Cookie');
|
|
foreach my $cookie (@cookies) {
|
|
$cookie_id = $1 if ($cookie =~ /id=(.+?);/);
|
|
$cookie_user = $1 if ($cookie =~ /user=(.+?);/);
|
|
}
|
|
|
|
if (!defined($cookie_id)) {
|
|
$self->{output}->add_option_msg(short_msg => "Cannot get token");
|
|
$self->{output}->option_exit();
|
|
}
|
|
|
|
$options{statefile}->write(data => { cookie_id => $cookie_id, cookie_user => $cookie_user });
|
|
}
|
|
|
|
$self->{cookie_id} = $cookie_id;
|
|
$self->{cookie_user} = $cookie_user;
|
|
}
|
|
|
|
sub request {
|
|
my ($self, %options) = @_;
|
|
|
|
my $endpoint = $options{full_endpoint};
|
|
if (!defined($endpoint)) {
|
|
$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: ' . $self->{cookie_id},
|
|
'Cookie: ' . $self->{cookie_user}
|
|
],
|
|
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: ' . $self->{cookie_id},
|
|
'Cookie: ' . $self->{cookie_user}
|
|
],
|
|
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
|
|
|
|
ArubaOS-CX API
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
ArubaOS-CX api
|
|
|
|
=head1 REST API OPTIONS
|
|
|
|
=over 8
|
|
|
|
=item B<--hostname>
|
|
|
|
API hostname.
|
|
|
|
=item B<--url-path>
|
|
|
|
API url path (Default: '/rest/v1')
|
|
|
|
=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<custom>.
|
|
|
|
=cut
|