.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Net::Cisco::MSE::REST 3pm" .TH Net::Cisco::MSE::REST 3pm "2021-01-07" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::Cisco::MSE::REST \- REST interface for Cisco MSE .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a Perl interface for communication with Cisco \s-1MSE\s0 using \s-1REST\s0 interface. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Net::Cisco::MSE::REST; \& \& my $rest = Net::Cisco::MSE::REST\->new( \& url => \*(Aqhttps://my.mse:8034\*(Aq, \& user => \*(Aqcisco\*(Aq, \& pass => \*(Aqcisco\*(Aq \& ): \& my $location = $rest\->real_time_localisation_for_client({id => \*(Aq2c:1f:23:ca:1a:cf\*(Aq}); .Ve .SH "CLASS METHODS" .IX Header "CLASS METHODS" .ie n .SS "Net::Cisco::MSE::REST\->new(url => $url, [ssl_opts => $opts, timeout => $timeout], user => 'cisco', pass => 'cisco')" .el .SS "Net::Cisco::MSE::REST\->new(url => \f(CW$url\fP, [ssl_opts => \f(CW$opts\fP, timeout => \f(CW$timeout\fP], user => 'cisco', pass => 'cisco')" .IX Subsection "Net::Cisco::MSE::REST->new(url => $url, [ssl_opts => $opts, timeout => $timeout], user => 'cisco', pass => 'cisco')" Creates a new Net::Cisco::MSE::Rest instance. .SH "INSTANCE METHODS" .IX Header "INSTANCE METHODS" .ie n .SS "$rest\->create_session(username => $username, password => $password)" .el .SS "\f(CW$rest\fP\->create_session(username => \f(CW$username\fP, password => \f(CW$password\fP)" .IX Subsection "$rest->create_session(username => $username, password => $password)" Creates a new session token for the given user. .ie n .SS "$rest\->maps" .el .SS "\f(CW$rest\fP\->maps" .IX Subsection "$rest->maps" The maps object returns detailed map information about campuses, buildings, floors, access points, map dimensions, regions, zones, \s-1GPS\s0 marker, image information, etc. .ie n .SS "$rest\->maps_count" .el .SS "\f(CW$rest\fP\->maps_count" .IX Subsection "$rest->maps_count" The mapscount returns maps count specifying the number of Campuses, Buildings, and Floors known to \s-1MSE.\s0 .ie n .SS "$rest\->maps_info" .el .SS "\f(CW$rest\fP\->maps_info" .IX Subsection "$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, \s-1GPS\s0 Markers etc. .PP Parameters: * floorname—Name of the required floor * buildingname—Name of the required building * campusname—Name of the required campus .ie n .SS "$rest\->maps_image" .el .SS "\f(CW$rest\fP\->maps_image" .IX Subsection "$rest->maps_image" The mapsimage object returns the floor image data associated with the particular campusName \-> buildingName \-> floorName. .PP Parameters: .PP * floorname—Name of the required floor * buildingname—Name of the required building * campusname—Name of the required campus .ie n .SS "$rest\->maps_image_source" .el .SS "\f(CW$rest\fP\->maps_image_source" .IX Subsection "$rest->maps_image_source" The mapsimagesource object returns the image associated with the specified image name. .PP Parameters: .PP * imageName—Name of the required image. .ie n .SS "$rest\->real_time_localisation_for_client" .el .SS "\f(CW$rest\fP\->real_time_localisation_for_client" .IX Subsection "$rest->real_time_localisation_for_client" The location clients object returns the current location of the wireless client for the specified device \s-1ID.\s0 The \s-1ID\s0 can be \s-1MAC\s0 address, \s-1IP\s0 address, or Username. .PP Parameters: .PP * id: Mac address, \s-1IP\s0 Address, or Username of the wireless client. .ie n .SS "$rest\->real_time_localisation_for_client_count" .el .SS "\f(CW$rest\fP\->real_time_localisation_for_client_count" .IX Subsection "$rest->real_time_localisation_for_client_count" The locationclientscount object returns count or location of wireless clients on the \s-1MSE.\s0 Results are filtered based on the specified query param conditions. .ie n .SS "$rest\->real_time_localisation_for_tags" .el .SS "\f(CW$rest\fP\->real_time_localisation_for_tags" .IX Subsection "$rest->real_time_localisation_for_tags" Returns a list of Location of Tags for the specified query conditions. .ie n .SS "$rest\->real_time_localisation_for_tags_count" .el .SS "\f(CW$rest\fP\->real_time_localisation_for_tags_count" .IX Subsection "$rest->real_time_localisation_for_tags_count" The location tags count object returns a count of Tags on \s-1MSE\s0 based on the specified Query Param conditions. .PP Parameters: .PP * []: Defines query conditions for the tag. .ie n .SS "$rest\->real_time_localisation_for_rogueaps" .el .SS "\f(CW$rest\fP\->real_time_localisation_for_rogueaps" .IX Subsection "$rest->real_time_localisation_for_rogueaps" Returns a list of Location of Rogue APs for the specified query conditions. .PP Parameters: .PP * []: Defines query conditions for the rogue \s-1AP.\s0 .ie n .SS "$rest\->real_time_localisation_for_rogueaps_count" .el .SS "\f(CW$rest\fP\->real_time_localisation_for_rogueaps_count" .IX Subsection "$rest->real_time_localisation_for_rogueaps_count" Returns a count of Rogue APs on \s-1MSE\s0 based on the specified Query Param conditions. Returns a list of Location of Rogue APs for the specified query conditions. .PP Parameters: .PP * []: Defines query conditions for the rogue \s-1AP.\s0 .ie n .SS "$rest\->real_time_localisation_for_rogueclients" .el .SS "\f(CW$rest\fP\->real_time_localisation_for_rogueclients" .IX Subsection "$rest->real_time_localisation_for_rogueclients" Returns the Location of Rogue Client for the specified id. .PP Parameters: .PP * id: \s-1MAC\s0 address of the rogue client. .ie n .SS "$rest\->real_time_localisation_for_rogueclients_count" .el .SS "\f(CW$rest\fP\->real_time_localisation_for_rogueclients_count" .IX Subsection "$rest->real_time_localisation_for_rogueclients_count" Returns a count of Rogue Clients on \s-1MSE\s0 based on the specified Query Param conditions. .PP Parameters: .PP * []: Defines query conditions for the rogue client. .ie n .SS "$rest\->real_time_localisation_for_interferers" .el .SS "\f(CW$rest\fP\->real_time_localisation_for_interferers" .IX Subsection "$rest->real_time_localisation_for_interferers" Returns the Location of Interferer for the specified id. Returns a count of Rogue Clients on \s-1MSE\s0 based on the specified Query Param conditions. .PP Parameters: .PP * id: \s-1MAC\s0 address of the interferer. .ie n .SS "$rest\->real_time_localisation_for_interferers_count" .el .SS "\f(CW$rest\fP\->real_time_localisation_for_interferers_count" .IX Subsection "$rest->real_time_localisation_for_interferers_count" Returns a count of Interferers on \s-1MSE\s0 based on the specified Query Param conditions. .PP Parameters: .PP * []: Defines query conditions for the interferers. .ie n .SS "$rest\->localisation_history_for_client" .el .SS "\f(CW$rest\fP\->localisation_history_for_client" .IX Subsection "$rest->localisation_history_for_client" Returns a list of historical Location records of Wireless Client for the specified id and query conditions .PP Parameters: .PP * id: \s-1MAC\s0 address, \s-1IP\s0 address, or username of the wireless client. * []: Defines query conditions for the wireless client .ie n .SS "$rest\->localisation_history_for_client_count" .el .SS "\f(CW$rest\fP\->localisation_history_for_client_count" .IX Subsection "$rest->localisation_history_for_client_count" Returns a count of historical Location records of Wireless Clients on \s-1MSE\s0 based on the specified Query Param conditions. .PP Parameters: .PP * []: Defines query conditions for the wireless client. .ie n .SS "$rest\->localisation_history_for_tags" .el .SS "\f(CW$rest\fP\->localisation_history_for_tags" .IX Subsection "$rest->localisation_history_for_tags" Returns a list of the historical Location records of Tag for the specified id and query conditions .PP Parameters: .PP * id: \s-1MAC\s0 address of the tag * []: Defines query conditions for the tag. .ie n .SS "$rest\->localisation_history_for_tags_count" .el .SS "\f(CW$rest\fP\->localisation_history_for_tags_count" .IX Subsection "$rest->localisation_history_for_tags_count" Returns a count of historical location records of Tags on \s-1MSE\s0 based on the specified Query Param conditions. .PP Parameters: .PP * []: Defines query conditions for the interferers. .ie n .SS "$rest\->localisation_history_for_rogueaps" .el .SS "\f(CW$rest\fP\->localisation_history_for_rogueaps" .IX Subsection "$rest->localisation_history_for_rogueaps" Returns a list of historical records of Location of Rogue APs for the specified query conditions. .PP Parameters: .PP * []: Defines query conditions for the rogue \s-1AP.\s0 .ie n .SS "$rest\->localisation_history_for_rogueaps_count" .el .SS "\f(CW$rest\fP\->localisation_history_for_rogueaps_count" .IX Subsection "$rest->localisation_history_for_rogueaps_count" Returns a count of historical Location records of Rogue APs based on the specified Query Param conditions. .PP Parameters: .PP * []: Defines query conditions for the rogue \s-1AP.\s0 .ie n .SS "$rest\->localisation_history_for_rogueclients" .el .SS "\f(CW$rest\fP\->localisation_history_for_rogueclients" .IX Subsection "$rest->localisation_history_for_rogueclients" Returns a list of historical Location records of Rogue Clients for the specified query conditions. .PP Parameters: .PP * []: Defines query conditions for the rogue client. .ie n .SS "$rest\->localisation_history_for_rogueclients_count" .el .SS "\f(CW$rest\fP\->localisation_history_for_rogueclients_count" .IX Subsection "$rest->localisation_history_for_rogueclients_count" Returns a count of Historical Location records of Rogue Clients on \s-1MSE\s0 based on the specified Query Param conditions. .PP Parameters: .PP * []: Defines query conditions for the rogue client. .ie n .SS "$rest\->localisation_history_for_interferers" .el .SS "\f(CW$rest\fP\->localisation_history_for_interferers" .IX Subsection "$rest->localisation_history_for_interferers" Returns a list of historical Location records of Interferers for the specified query conditions. .PP Parameters: .PP * []: Defines query conditions for the interferers. .ie n .SS "$rest\->localisation_history_for_interferers_count" .el .SS "\f(CW$rest\fP\->localisation_history_for_interferers_count" .IX Subsection "$rest->localisation_history_for_interferers_count" Returns a count of historical Location records of Interferers for the specified id and query conditions. .PP Parameters: .PP * []: Defines query conditions for the interferers. .ie n .SS "$rest\->notification_create" .el .SS "\f(CW$rest\fP\->notification_create" .IX Subsection "$rest->notification_create" Create and subscribe to a notification .PP Parameters: .PP * {\*(L"NotificationSubscription\*(R"=> { \*(L"name\*(R"=> \*(L"OutIn\*(R", \*(L"notificationType\*(R"=> \*(L"\s-1EVENT_DRIVEN\*(R",\s0 \*(L"dataFormat\*(R"=> \*(L"\s-1JSON\*(R",\s0 \*(L"subscribedEvents\*(R"=> [ { \*(L"type\*(R"=> \*(L"ContainmentEventTrigger\*(R", \*(L"eventEntity\*(R"=> \*(L"\s-1WIRELESS_CLIENTS\*(R",\s0 \*(L"boundary\*(R"=> \*(L"\s-1INSIDE\*(R",\s0 \*(L"zoneHierarchy\*(R" => \*(L"Buiding>8th level>Network\-Zone\*(R", \*(L"zoneTimeout\*(R" => 10, }, { \*(L"type\*(R"=> \*(L"ContainmentEventTrigger\*(R", \*(L"eventEntity\*(R"=> \*(L"\s-1WIRELESS_CLIENTS\*(R",\s0 \*(L"boundary\*(R"=> \*(L"\s-1OUTSIDE\*(R",\s0 \*(L"zoneHierarchy\*(R" => \*(L"Building>8th level>Network\-Zone\*(R", \*(L"zoneTimeout\*(R" => 10, } ], \*(L"NotificationReceiverInfo\*(R"=> {\*(L"transport\*(R"=> { \*(L"type\*(R"=> \*(L"TransportHttp\*(R", \*(L"hostAddress\*(R"=> \*(L"192.168.0.1\*(R", \*(L"port\*(R"=> 9292, \*(L"macScramblingEnabled\*(R"=> false, \*(L"urlPath\*(R"=> \*(L"/mse/\*(R", \*(L"https\*(R"=> false }} }}; .ie n .SS "$rest\->notification_view" .el .SS "\f(CW$rest\fP\->notification_view" .IX Subsection "$rest->notification_view" View all notification created by the current logged user .PP Parameters: .PP * []: Defines query conditions for the interferers. .ie n .SS "$rest\->notification_delete" .el .SS "\f(CW$rest\fP\->notification_delete" .IX Subsection "$rest->notification_delete" Delete specific notification .PP Parameters: .PP * name: name of the notification .SH "LICENSE" .IX Header "LICENSE" This program is free software: you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \&\s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program. If not, see