table of contents
Net::Cisco::MSE::REST(3pm) | User Contributed Perl Documentation | Net::Cisco::MSE::REST(3pm) |
NAME¶
Net::Cisco::MSE::REST - REST interface for Cisco MSEDESCRIPTION¶
This module provides a Perl interface for communication with Cisco MSE using REST interface.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'});
CLASS METHODS¶
Net::Cisco::MSE::REST->new(url => $url, [ssl_opts => $opts, timeout => $timeout], user => 'cisco', pass => 'cisco')¶
Creates a new Net::Cisco::MSE::Rest instance.INSTANCE METHODS¶
$rest->create_session(username => $username, password => $password)¶
Creates a new session token for the given user.$rest->maps¶
The maps object returns detailed map information about campuses, buildings, floors, access points, map dimensions, regions, zones, GPS marker, image information, etc.$rest->maps_count¶
The mapscount returns maps count specifying the number of Campuses, Buildings, and Floors known to MSE.$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
$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
$rest->maps_image_source¶
The mapsimagesource object returns the image associated with the specified image name.Parameters:
* imageName—Name of the required image.
$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.
$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.$rest->real_time_localisation_for_tags¶
Returns a list of Location of Tags for the specified query conditions.$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.
$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.
$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.
$rest->real_time_localisation_for_rogueclients¶
Returns the Location of Rogue Client for the specified id.Parameters:
* id: MAC address of the rogue client.
$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.
$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.
$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.
$rest->localisation_history_for_client¶
Returns a list of historical Location records of Wireless Client for the specified id and query conditionsParameters:
* id: MAC address, IP address, or username of the wireless client. * []: Defines query conditions for the wireless client
$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.
$rest->localisation_history_for_tags¶
Returns a list of the historical Location records of Tag for the specified id and query conditionsParameters:
* id: MAC address of the tag * []: Defines query conditions for the tag.
$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.
$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.
$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.
$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.
$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.
$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.
$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.
$rest->notification_create¶
Create and subscribe to a notificationParameters:
* {"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 }} }};
$rest->notification_view¶
View all notification created by the current logged userParameters:
* []: Defines query conditions for the interferers.
$rest->notification_delete¶
Delete specific notificationParameters:
* name: name of the notification
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/>
2017-01-03 | perl v5.24.1 |