249 lines
8.0 KiB
Perl
249 lines
8.0 KiB
Perl
#
|
|
# Copyright 2017 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 network::cisco::prime::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 =>
|
|
{
|
|
"hostname:s@" => { name => 'hostname' },
|
|
"port:s@" => { name => 'port' },
|
|
"proto:s@" => { name => 'proto' },
|
|
"url-path:s@" => { name => 'url_path' },
|
|
"username:s@" => { name => 'username' },
|
|
"password:s@" => { name => 'password' },
|
|
"proxyurl:s@" => { name => 'proxyurl' },
|
|
"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(output => $self->{output});
|
|
|
|
return $self;
|
|
|
|
}
|
|
|
|
# Method to manage multiples
|
|
sub set_options {
|
|
my ($self, %options) = @_;
|
|
# options{options_result}
|
|
|
|
$self->{option_results} = $options{option_results};
|
|
}
|
|
|
|
# Method to manage multiples
|
|
sub set_defaults {
|
|
my ($self, %options) = @_;
|
|
# options{default}
|
|
|
|
# Manage default value
|
|
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) = @_;
|
|
# return 1 = ok still hostname
|
|
# return 0 = no hostname left
|
|
|
|
$self->{hostname} = (defined($self->{option_results}->{hostname})) ? shift(@{$self->{option_results}->{hostname}}) : undef;
|
|
$self->{port} = (defined($self->{option_results}->{port})) ? shift(@{$self->{option_results}->{port}}) : 443;
|
|
$self->{proto} = (defined($self->{option_results}->{proto})) ? shift(@{$self->{option_results}->{proto}}) : 'https';
|
|
$self->{url_path} = (defined($self->{option_results}->{url_path})) ? shift(@{$self->{option_results}->{url_path}}) : '/webacs/api/v1/data/';
|
|
$self->{username} = (defined($self->{option_results}->{username})) ? shift(@{$self->{option_results}->{username}}) : '';
|
|
$self->{password} = (defined($self->{option_results}->{password})) ? shift(@{$self->{option_results}->{password}}) : '';
|
|
$self->{timeout} = (defined($self->{option_results}->{timeout})) ? shift(@{$self->{option_results}->{timeout}}) : 10;
|
|
$self->{proxyurl} = (defined($self->{option_results}->{proxyurl})) ? shift(@{$self->{option_results}->{proxyurl}}) : undef;
|
|
|
|
if (!defined($self->{hostname})) {
|
|
$self->{output}->add_option_msg(short_msg => "Need to specify hostname option.");
|
|
$self->{output}->option_exit();
|
|
}
|
|
|
|
if (!defined($self->{hostname}) ||
|
|
scalar(@{$self->{option_results}->{hostname}}) == 0) {
|
|
return 0;
|
|
}
|
|
return 1;
|
|
}
|
|
|
|
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}->{proxyurl} = $self->{proxyurl};
|
|
$self->{option_results}->{credentials} = 1;
|
|
$self->{option_results}->{username} = $self->{username};
|
|
$self->{option_results}->{password} = $self->{password};
|
|
}
|
|
|
|
sub settings {
|
|
my ($self, %options) = @_;
|
|
|
|
$self->build_options_for_httplib();
|
|
$self->{http}->set_options(%{$self->{option_results}});
|
|
}
|
|
|
|
sub cache_ap {
|
|
my ($self, %options) = @_;
|
|
|
|
my $has_cache_file = $options{statefile}->read(statefile => 'cache_cisco_prime_accesspoint_' . $self->{hostname} . '_' . $self->{port});
|
|
my $timestamp_cache = $options{statefile}->get(name => 'last_timestamp');
|
|
my $ap = $options{statefile}->get(name => 'ap');
|
|
if ($has_cache_file == 0 || !defined($timestamp_cache) || ((time() - $timestamp_cache) > (($options{reload_cache_time}) * 60))) {
|
|
$ap = $self->get(function => 'AccessPoints', object => 'accessPointsDTO', key => 'name',
|
|
fields => ['adminStatus', 'clientCount', 'controllerName', 'lwappUpTime', 'status', 'upTime']);
|
|
my $datas = { last_timestamp => time(), ap => $ap };
|
|
$options{statefile}->write(data => $datas);
|
|
}
|
|
|
|
return $ap;
|
|
}
|
|
|
|
sub get {
|
|
my ($self, %options) = @_;
|
|
|
|
$self->settings();
|
|
my ($result, $first_result, $max_results) = ({}, 0, 1000);
|
|
|
|
while (1) {
|
|
my $response = $self->{http}->request(url_path => $self->{url_path} . $options{function} .'.json?.full=true&.sort=' . $options{key} . '&.firstResult=' . $first_result . '&.maxResults=' . $max_results,
|
|
critical_status => '', warning_status => '');
|
|
my $content;
|
|
eval {
|
|
$content = JSON::XS->new->utf8->decode($response);
|
|
};
|
|
if ($@) {
|
|
$self->{output}->add_option_msg(short_msg => "Cannot decode json response: $@");
|
|
$self->{output}->option_exit();
|
|
}
|
|
if (defined($content->{errorDocument})) {
|
|
$self->{output}->add_option_msg(short_msg => "Cannot get data: " . $content->{errorDocument}->{message});
|
|
$self->{output}->option_exit();
|
|
}
|
|
if (!defined($content->{queryResponse})) {
|
|
$self->{output}->add_option_msg(short_msg => "Cannot understand response");
|
|
$self->{output}->option_exit();
|
|
}
|
|
|
|
foreach (@{$content->{queryResponse}->{entity}}) {
|
|
$result->{$_->{$options{object}}->{$options{key}}} = {};
|
|
foreach my $field (@{$options{fields}}) {
|
|
$result->{$_->{$options{object}}->{$options{key}}}->{$field} = $_->{$options{object}}->{$field}
|
|
if (defined($_->{$options{object}}->{$field}));
|
|
}
|
|
}
|
|
|
|
$first_result += $max_results;
|
|
last if ($max_results > $content->{queryResponse}->{'@count'});
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
1;
|
|
|
|
__END__
|
|
|
|
=head1 NAME
|
|
|
|
CISCO PRIME REST API
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
Cisco Prime Rest API custom mode
|
|
|
|
=head1 REST API OPTIONS
|
|
|
|
=over 8
|
|
|
|
=item B<--hostname>
|
|
|
|
Cisco Prime hostname.
|
|
|
|
=item B<--port>
|
|
|
|
Port used (Default: 443)
|
|
|
|
=item B<--proto>
|
|
|
|
Specify https if needed (Default: 'https')
|
|
|
|
=item B<--url-path>
|
|
|
|
Cisco Prime API Path (Default: '/webacs/api/v1/data/').
|
|
|
|
=item B<--username>
|
|
|
|
Storeonce username.
|
|
|
|
=item B<--password>
|
|
|
|
Storeonce password.
|
|
|
|
=item B<--proxyurl>
|
|
|
|
Proxy URL if any
|
|
|
|
=item B<--timeout>
|
|
|
|
Set HTTP timeout
|
|
|
|
=back
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
B<custom>.
|
|
|
|
=cut
|