Debian Codegraph @

src/hardware/devices/barco/cs/restapi/custom/api.pm

raw
1 #
2 # Copyright 2024 Centreon (http://www.centreon.com/)
3 #
4 # Centreon is a full-fledged industry-strength solution that meets
5 # the needs in IT infrastructure and application monitoring for
6 # service performance.
7 #
8 # Licensed under the Apache License, Version 2.0 (the "License");
9 # you may not use this file except in compliance with the License.
10 # You may obtain a copy of the License at
11 #
12 # http://www.apache.org/licenses/LICENSE-2.0
13 #
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS,
16 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 # See the License for the specific language governing permissions and
18 # limitations under the License.
19 #
20
21 package hardware::devices::barco::cs::restapi::custom::api;
22
23 use strict;
24 use warnings;
25 use centreon::plugins::http;
26 use JSON::XS;
27
28 sub new {
29 my ($class, %options) = @_;
30 my $self = {};
31 bless $self, $class;
32
33 if (!defined($options{output})) {
34 print "Class Custom: Need to specify 'output' argument.\n";
35 exit 3;
36 }
37 if (!defined($options{options})) {
38 $options{output}->add_option_msg(short_msg => "Class Custom: Need to specify 'options' argument.");
39 $options{output}->option_exit();
40 }
41
42 if (!defined($options{noptions})) {
43 $options{options}->add_options(arguments => {
44 'api-username:s' => { name => 'api_username' },
45 'api-password:s' => { name => 'api_password' },
46 'hostname:s' => { name => 'hostname' },
47 'port:s' => { name => 'port' },
48 'proto:s' => { name => 'proto' },
49 'timeout:s' => { name => 'timeout' },
50 'unknown-http-status:s' => { name => 'unknown_http_status' },
51 'warning-http-status:s' => { name => 'warning_http_status' },
52 'critical-http-status:s' => { name => 'critical_http_status' }
53 });
54 }
55 $options{options}->add_help(package => __PACKAGE__, sections => 'REST API OPTIONS', once => 1);
56
57 $self->{output} = $options{output};
58 $self->{http} = centreon::plugins::http->new(%options);
59
60 return $self;
61 }
62
63 sub set_options {
64 my ($self, %options) = @_;
65
66 $self->{option_results} = $options{option_results};
67 }
68
69 sub set_defaults {}
70
71 sub check_options {
72 my ($self, %options) = @_;
73
74 $self->{hostname} = (defined($self->{option_results}->{hostname})) ? $self->{option_results}->{hostname} : '';
75 $self->{port} = (defined($self->{option_results}->{port})) ? $self->{option_results}->{port} : 4001;
76 $self->{proto} = (defined($self->{option_results}->{proto})) ? $self->{option_results}->{proto} : 'https';
77 $self->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 10;
78 $self->{api_username} = (defined($self->{option_results}->{api_username})) ? $self->{option_results}->{api_username} : '';
79 $self->{api_password} = (defined($self->{option_results}->{api_password})) ? $self->{option_results}->{api_password} : '';
80 $self->{unknown_http_status} = (defined($self->{option_results}->{unknown_http_status})) ? $self->{option_results}->{unknown_http_status} : '%{http_code} < 200 or %{http_code} >= 300';
81 $self->{warning_http_status} = (defined($self->{option_results}->{warning_http_status})) ? $self->{option_results}->{warning_http_status} : '';
82 $self->{critical_http_status} = (defined($self->{option_results}->{critical_http_status})) ? $self->{option_results}->{critical_http_status} : '';
83
84 if ($self->{hostname} eq '') {
85 $self->{output}->add_option_msg(short_msg => "Need to specify --hostname option.");
86 $self->{output}->option_exit();
87 }
88 if ($self->{api_username} eq '') {
89 $self->{output}->add_option_msg(short_msg => "Need to specify --api-username option.");
90 $self->{output}->option_exit();
91 }
92 if ($self->{api_password} eq '') {
93 $self->{output}->add_option_msg(short_msg => "Need to specify --api-password option.");
94 $self->{output}->option_exit();
95 }
96
97 return 0;
98 }
99
100 sub build_options_for_httplib {
101 my ($self, %options) = @_;
102
103 $self->{option_results}->{hostname} = $self->{hostname};
104 $self->{option_results}->{timeout} = $self->{timeout};
105 $self->{option_results}->{port} = $self->{port};
106 $self->{option_results}->{proto} = $self->{proto};
107 $self->{option_results}->{timeout} = $self->{timeout};
108 $self->{option_results}->{credentials} = 1;
109 $self->{option_results}->{basic} = 1;
110 $self->{option_results}->{username} = $self->{api_username};
111 $self->{option_results}->{password} = $self->{api_password};
112 }
113
114 sub settings {
115 my ($self, %options) = @_;
116
117 return if (defined($self->{settings_done}));
118 $self->build_options_for_httplib();
119 $self->{http}->add_header(key => 'Accept', value => 'application/json');
120 $self->{http}->set_options(%{$self->{option_results}});
121 $self->{settings_done} = 1;
122 }
123
124 sub get_hostname {
125 my ($self, %options) = @_;
126
127 return $self->{hostname};
128 }
129
130 sub request_api {
131 my ($self, %options) = @_;
132
133 $self->settings();
134 my $content = $self->{http}->request(
135 url_path => $options{endpoint},
136 unknown_status => $self->{unknown_http_status},
137 warning_status => $self->{warning_http_status},
138 critical_status => $self->{critical_http_status},
139 cookies_file => '' # in memory
140 );
141
142 if (!defined($content) || $content eq '') {
143 $self->{output}->add_option_msg(short_msg => "API returns empty content [code: '" . $self->{http}->get_code() . "'] [message: '" . $self->{http}->get_message() . "']");
144 $self->{output}->option_exit();
145 }
146
147 my $decoded;
148 eval {
149 $decoded = JSON::XS->new->utf8->decode($content);
150 };
151 if ($@) {
152 $self->{output}->add_option_msg(short_msg => "Cannot decode response (add --debug option to display returned content)");
153 $self->{output}->option_exit();
154 }
155
156 return $decoded;
157 }
158
159 1;
160
161 __END__
162
163 =head1 NAME
164
165 Barco ClickShare Rest API
166
167 =head1 REST API OPTIONS
168
169 Barco ClickShare Rest API
170
171 =over 8
172
173 =item B<--hostname>
174
175 Barco ClickShare hostname.
176
177 =item B<--port>
178
179 Port used (default: 4001)
180
181 =item B<--proto>
182
183 Specify https if needed (default: 'https')
184
185 =item B<--api-username>
186
187 API username.
188
189 =item B<--api-password>
190
191 API password.
192
193 =item B<--timeout>
194
195 Set timeout in seconds (default: 10).
196
197 =back
198
199 =head1 DESCRIPTION
200
201 B<custom>.
202
203 =cut