| Net::Cisco::MSE::REST(3pm) | User Contributed Perl Documentation | Net::Cisco::MSE::REST(3pm) |
Net::Cisco::MSE::REST - REST interface for Cisco MSE
This module provides a Perl interface for communication with Cisco MSE using REST interface.
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'});
Creates a new Net::Cisco::MSE::Rest instance.
Creates a new session token for the given user.
The maps object returns detailed map information about campuses, buildings, floors, access points, map dimensions, regions, zones, GPS marker, image information, etc.
The mapscount returns maps count specifying the number of Campuses, Buildings, and Floors known to MSE.
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
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
The mapsimagesource object returns the image associated with the specified image name.
Parameters:
* imageName—Name of the required image.
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.
The locationclientscount object returns count or location of wireless clients on the MSE. Results are filtered based on the specified query param conditions.
Returns a list of Location of Tags for the specified query conditions.
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.
Returns a list of Location of Rogue APs for the specified query conditions.
Parameters:
* []: Defines query conditions for the rogue AP.
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.
Returns the Location of Rogue Client for the specified id.
Parameters:
* id: MAC address of the rogue client.
Returns a count of Rogue Clients on MSE based on the specified Query Param conditions.
Parameters:
* []: Defines query conditions for the rogue client.
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.
Returns a count of Interferers on MSE based on the specified Query Param conditions.
Parameters:
* []: Defines query conditions for the interferers.
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
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.
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.
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.
Returns a list of historical records of Location of Rogue APs for the specified query conditions.
Parameters:
* []: Defines query conditions for the rogue AP.
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.
Returns a list of historical Location records of Rogue Clients for the specified query conditions.
Parameters:
* []: Defines query conditions for the rogue client.
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.
Returns a list of historical Location records of Interferers for the specified query conditions.
Parameters:
* []: Defines query conditions for the interferers.
Returns a count of historical Location records of Interferers for the specified id and query conditions.
Parameters:
* []: Defines query conditions for the interferers.
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
}}
}};
View all notification created by the current logged user
Parameters:
* []: Defines query conditions for the interferers.
Delete specific notification
Parameters:
* name: name of the notification
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/>
| 2022-11-27 | perl v5.36.0 |