1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
|
package Net::Cisco::MSE::REST;
use warnings;
use strict;
use Carp;
use LWP::UserAgent;
use JSON;
use HTTP::Request;
our $VERSION = 0.2;
sub new {
my ($class, %params) = @_;
my $url = $params{url} || 'http://localhost:8083/';
my $user = $params{user} || 'cisco';
my $pass = $params{pass} || 'cisco';
my $agent = LWP::UserAgent->new();
$agent->timeout($params{timeout})
if $params{timeout};
$agent->ssl_opts(%{$params{ssl_opts}})
if $params{ssl_opts} && ref $params{ssl_opts} eq 'HASH';
my $req = new HTTP::Request;
$req->authorization_basic($user,$pass);
$req->header(Accept => " application/json");
my $self = {
url => $url,
agent => $agent,
req => $req,
};
bless $self, $class;
return $self;
}
sub maps {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/maps");
}
sub maps_count {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/maps/count");
}
sub maps_info {
my ($self, $args) = @_;
croak "missing campusName parameter" unless $args->{campusName};
croak "missing buildingName parameter" unless $args->{buildingName};
croak "missing floorName parameter" unless $args->{floorName};
return $self->_get("/api/contextaware/v1/maps/info/$args->{campusName}/$args->{buildingName}/$args->{floorName}");
}
sub maps_image {
my ($self, $args) = @_;
croak "missing campusName parameter" unless $args->{campusName};
croak "missing buildingName parameter" unless $args->{buildingName};
croak "missing floorName parameter" unless $args->{floorName};
return $self->_get("/api/contextaware/v1/maps/image/$args->{campusName}/$args->{buildingName}/$args->{floorName}");
}
sub maps_image_source {
my ($self, $args) = @_;
croak "missing imageName parameter" unless $args->{imageName};
return $self->_get_bin("/api/contextaware/v1/maps/imagesource/$args->{imageName}");
}
sub real_time_localisation_for_client {
my ($self, $args) = @_;
croak "missing id parameter" unless $args->{id};
return $self->_get("/api/contextaware/v1/location/clients/$args->{id}");
}
sub real_time_localisation_for_client_count {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/clients/count");
}
sub real_time_localisation_for_tags {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/tags");
}
sub real_time_localisation_for_tags_count {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/tags/count");
}
sub real_time_localisation_for_rogueaps {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/rogueaps");
}
sub real_time_localisation_for_rogueaps_count {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/rogueaps/count");
}
sub real_time_localisation_for_rogueclients {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/rogueclients");
}
sub real_time_localisation_for_rogueclients_count {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/rogueclients/count");
}
sub real_time_localisation_for_interferers {
my ($self, $args) = @_;
croak "missing id parameter" unless $args->{id};
return $self->_get("/api/contextaware/v1/location/interferers/$args->{id}");
}
sub real_time_localisation_for_interferers_count {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/interferers/count");
}
sub localisation_history_for_client {
my ($self, $args) = @_;
croak "missing id parameter" unless $args->{id};
return $self->_get("/api/contextaware/v1/location/history/clients/$args->{id}");
}
sub localisation_history_for_client_count {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/history/clients/count");
}
sub localisation_history_for_tags {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/history/tags/");
}
sub localisation_history_for_tags_count {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/history/tags/count");
}
sub localisation_history_for_rogueaps {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/history/rogueaps");
}
sub localisation_history_for_rogueaps_count {
my ($self, $args) = @_;
croak "missing id parameter" unless $args->{id};
return $self->_get("/api/contextaware/v1/location/history/rogueaps/$args->{id}/count");
}
sub localisation_history_for_rogueclients {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/history/rogueclients");
}
sub localisation_history_for_rogueclients_count {
my ($self, $args) = @_;
croak "missing id parameter" unless $args->{id};
return $self->_get("/api/contextaware/v1/location/history/rogueclients/count");
}
sub localisation_history_for_interferers {
my ($self) = @_;
return $self->_get("/api/contextaware/v1/location/history/interferers");
}
sub localisation_history_for_interferers_count {
my ($self, $args) = @_;
croak "missing id parameter" unless $args->{id};
return $self->_get("/api/contextaware/v1/location/history/interferers/$args->{id}/count");
}
sub notification_create {
my ($self, $args) = @_;
return $self->_put("/api/contextaware/v1/notifications",$args);
}
sub notification_view {
my ($self, $args) = @_;
return $self->_get("/api/contextaware/v1/notifications/",$args);
}
sub notification_delete {
my ($self, $args) = @_;
return $self->_delete("/api/contextaware/v1/notifications/$args->{name}");
}
sub _get_bin {
my ($self, $path, %params) = @_;
$self->{req}->method("GET");
$self->{req}->uri($self->{url} . $path);
$self->{req}->header(Accept => "image/jpeg");
my $response = $self->{agent}->request($self->{req});
if ($response->is_success()) {
return $response->content;
} else {
croak "communication error: " . $response->message()
}
}
sub _get {
my ($self, $path, %params) = @_;
$self->{req}->method("GET");
$self->{req}->uri($self->{url} . $path);
my $response = $self->{agent}->request($self->{req});
my $result = eval { from_json($response->content()) };
if ($response->is_success()) {
return $result;
} else {
if ($result) {
croak "server error: " . $result->{error};
} else {
croak "communication error: " . $response->message()
}
}
}
sub _put {
my ($self, $path, $params) = @_;
$self->{req}->method("PUT");
$self->{req}->uri($self->{url} . $path);
my $json = to_json($params);
$self->{req}->header( 'Content-Type' => 'application/json' );
$self->{req}->content( $json );
my $response = $self->{agent}->request($self->{req});
my $result = eval { from_json($response->content()) };
if ($response->is_success()) {
return $result;
} else {
if ($result) {
croak "server error: " . $result->{error};
} else {
croak "communication error: " . $response->message()
}
}
}
sub _delete {
my ($self, $path, $params) = @_;
$self->{req}->method("DELETE");
$self->{req}->uri($self->{url} . $path);
my $response = $self->{agent}->request($self->{req});
my $result = eval { from_json($response->content()) };
if ($response->is_success()) {
return $result;
} else {
if ($result) {
croak "server error: " . $result->{error};
} else {
croak "communication error: " . $response->message()
}
}
}
1;
__END__
=encoding utf8
=head1 NAME
Net::Cisco::MSE::REST - REST interface for Cisco MSE
=head1 DESCRIPTION
This module provides a Perl interface for communication with Cisco MSE
using REST interface.
=head1 SYNOPSIS
use Net::Cisco::MSE::REST;
my $rest = Net::Cisco::MSE::REST->new(
url => 'https://my.mse:8034',
user => 'cisco',
pass => 'cisco'
):
my $location = $rest->real_time_localisation_for_client({id => '2c:1f:23:ca:1a:cf'});
=head1 CLASS METHODS
=head2 Net::Cisco::MSE::REST->new(url => $url, [ssl_opts => $opts, timeout => $timeout], user => 'cisco', pass => 'cisco')
Creates a new L<Net::Cisco::MSE::Rest> instance.
=head1 INSTANCE METHODS
=head2 $rest->create_session(username => $username, password => $password)
Creates a new session token for the given user.
=head2 $rest->maps
The maps object returns detailed map information about campuses, buildings, floors, access points, map dimensions, regions, zones, GPS marker, image information, etc.
=head2 $rest->maps_count
The mapscount returns maps count specifying the number of Campuses, Buildings, and Floors known to MSE.
=head2 $rest->maps_info
The mapsinfo object returns all the floor information associated with the campusName -> buildingName -> floorName. This includes floor dimension, Access Points and their information, GPS Markers etc.
Parameters:
* floorname—Name of the required floor
* buildingname—Name of the required building
* campusname—Name of the required campus
=head2 $rest->maps_image
The mapsimage object returns the floor image data associated with the particular campusName -> buildingName -> floorName.
Parameters:
* floorname—Name of the required floor
* buildingname—Name of the required building
* campusname—Name of the required campus
=head2 $rest->maps_image_source
The mapsimagesource object returns the image associated with the specified image name.
Parameters:
* imageName—Name of the required image.
=head2 $rest->real_time_localisation_for_client
The location clients object returns the current location of the wireless client for the specified device ID. The ID can be MAC address, IP address, or Username.
Parameters:
* id: Mac address, IP Address, or Username of the wireless client.
=head2 $rest->real_time_localisation_for_client_count
The locationclientscount object returns count or location of wireless clients on the MSE. Results are filtered based on the specified query param conditions.
=head2 $rest->real_time_localisation_for_tags
Returns a list of Location of Tags for the specified query conditions.
=head2 $rest->real_time_localisation_for_tags_count
The location tags count object returns a count of Tags on MSE based on the specified Query Param conditions.
Parameters:
* []: Defines query conditions for the tag.
=head2 $rest->real_time_localisation_for_rogueaps
Returns a list of Location of Rogue APs for the specified query conditions.
Parameters:
* []: Defines query conditions for the rogue AP.
=head2 $rest->real_time_localisation_for_rogueaps_count
Returns a count of Rogue APs on MSE based on the specified Query Param conditions.
Returns a list of Location of Rogue APs for the specified query conditions.
Parameters:
* []: Defines query conditions for the rogue AP.
=head2 $rest->real_time_localisation_for_rogueclients
Returns the Location of Rogue Client for the specified id.
Parameters:
* id: MAC address of the rogue client.
=head2 $rest->real_time_localisation_for_rogueclients_count
Returns a count of Rogue Clients on MSE based on the specified Query Param conditions.
Parameters:
* []: Defines query conditions for the rogue client.
=head2 $rest->real_time_localisation_for_interferers
Returns the Location of Interferer for the specified id.
Returns a count of Rogue Clients on MSE based on the specified Query Param conditions.
Parameters:
* id: MAC address of the interferer.
=head2 $rest->real_time_localisation_for_interferers_count
Returns a count of Interferers on MSE based on the specified Query Param conditions.
Parameters:
* []: Defines query conditions for the interferers.
=head2 $rest->localisation_history_for_client
Returns a list of historical Location records of Wireless Client for the specified id and query conditions
Parameters:
* id: MAC address, IP address, or username of the wireless client.
* []: Defines query conditions for the wireless client
=head2 $rest->localisation_history_for_client_count
Returns a count of historical Location records of Wireless Clients on MSE based on the specified Query Param conditions.
Parameters:
* []: Defines query conditions for the wireless client.
=head2 $rest->localisation_history_for_tags
Returns a list of the historical Location records of Tag for the specified id and query conditions
Parameters:
* id: MAC address of the tag
* []: Defines query conditions for the tag.
=head2 $rest->localisation_history_for_tags_count
Returns a count of historical location records of Tags on MSE based on the specified Query Param conditions.
Parameters:
* []: Defines query conditions for the interferers.
=head2 $rest->localisation_history_for_rogueaps
Returns a list of historical records of Location of Rogue APs for the specified query conditions.
Parameters:
* []: Defines query conditions for the rogue AP.
=head2 $rest->localisation_history_for_rogueaps_count
Returns a count of historical Location records of Rogue APs based on the specified Query Param conditions.
Parameters:
* []: Defines query conditions for the rogue AP.
=head2 $rest->localisation_history_for_rogueclients
Returns a list of historical Location records of Rogue Clients for the specified query conditions.
Parameters:
* []: Defines query conditions for the rogue client.
=head2 $rest->localisation_history_for_rogueclients_count
Returns a count of Historical Location records of Rogue Clients on MSE based on the specified Query Param conditions.
Parameters:
* []: Defines query conditions for the rogue client.
=head2 $rest->localisation_history_for_interferers
Returns a list of historical Location records of Interferers for the specified query conditions.
Parameters:
* []: Defines query conditions for the interferers.
=head2 $rest->localisation_history_for_interferers_count
Returns a count of historical Location records of Interferers for the specified id and query conditions.
Parameters:
* []: Defines query conditions for the interferers.
=head2 $rest->notification_create
Create and subscribe to a notification
Parameters:
* {"NotificationSubscription"=> {
"name"=> "OutIn",
"notificationType"=> "EVENT_DRIVEN",
"dataFormat"=> "JSON",
"subscribedEvents"=> [
{
"type"=> "ContainmentEventTrigger",
"eventEntity"=> "WIRELESS_CLIENTS",
"boundary"=> "INSIDE",
"zoneHierarchy" => "Buiding>8th level>Network-Zone",
"zoneTimeout" => 10,
},
{
"type"=> "ContainmentEventTrigger",
"eventEntity"=> "WIRELESS_CLIENTS",
"boundary"=> "OUTSIDE",
"zoneHierarchy" => "Building>8th level>Network-Zone",
"zoneTimeout" => 10,
}
],
"NotificationReceiverInfo"=> {"transport"=> {
"type"=> "TransportHttp",
"hostAddress"=> "192.168.0.1",
"port"=> 9292,
"macScramblingEnabled"=> false,
"urlPath"=> "/mse/",
"https"=> false
}}
}};
=head2 $rest->notification_view
View all notification created by the current logged user
Parameters:
* []: Defines query conditions for the interferers.
=head2 $rest->notification_delete
Delete specific notification
Parameters:
* name: name of the notification
=head1 LICENSE
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>
|