Monitoring, Management & Location Tracking

How VisualRF refresh works
Q:

How could I get the updated data on the VisualRF on demand?



A:

From 8.0.x (8.0.10 and further) a new Refresh option is available via which VisualRF polls the recent Data on demand for the Floor plan from AMP.

You could find this option under VisualRF > Floor Plan > Edit > Action > Refresh

 

This link initiates several API calls which fetches every required data for a VRF Floor plans to show the updated information. Some of them are as below:

1. poll_aps_now.xml

Fetches: AP details: firmware, Folder, Device ID, latitude, longitude, Manufacturer, Model, Name, Operating Mode, Serial number, Client Counts, Rx, Tx, Status, etc.

Radio Details: Antenna, beamwidth, channel, Radio Status, Gain, Interface, mode, mount, xmit-dbm and xmit-value, Utilization and interference. 

URL: https://<airwave ip>/visualrf/poll_aps_now.xml?siteId=<site id>

Example

<visualrf:site_access_points xmlns:visualrf="http://www.airwave.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1">

<summary aps="0" sites="1"/>

<ap altitude="0.0" device_category="thin_ap" editable="true" firmware="6.4.2.15" folder="Top" folder_id="1" id="3" latitude="" longitude="" mac="AC:A3:1E:C6:36:58" manufacturer="Aruba" model="AP 215" name="ac:a3:1e:c6:36:58" operating-mode="ap" planned_maintenance_mode="false" serialNumber="CK0048599" site_id="f48f9277-6100-464c-90e6-af2ad5a2f42f" state="provisioned" status="up" view_x_pct="" view_y_pct="" x="406.502" y="367.013">...</ap>

<ap altitude="0.0" device_category="thin_ap" editable="true" firmware="6.4.2.15" folder="Top" folder_id="1" id="4" latitude="" longitude="" mac="9C:1C:12:C8:1E:7C" manufacturer="Aruba" model="AP 205" name="9c:1c:12:c8:1e:7c" operating-mode="ap" planned_maintenance_mode="false" serialNumber="CM0009069" site_id="f48f9277-6100-464c-90e6-af2ad5a2f42f" state="provisioned" status="up" view_x_pct="" view_y_pct="" x="815.154" y="366.144">

<total-bandwidth>-1</total-bandwidth>

<total-clients>0</total-clients>

<uptime>0.0</uptime>

<radio antenna="" beamwidth="360.0" channel="11" enabled="true" ext_capable="false" gain="0.0" index="1" interface="2" mac="9C:1C:12:01:E7:C0" mode="ap" mount="" orientation="0.0" phy="n" valid="true" xmit-dbm="9.0" xmit-value="9 dBm">...</radio>

<radio antenna="" beamwidth="360.0" channel="153" enabled="true" ext_capable="false" gain="0.0" index="2" interface="1" mac="9C:1C:12:01:E7:D0" mode="ap" mount="" orientation="0.0" phy="c" valid="true" xmit-dbm="23.0" xmit-value="23 dBm">...</radio>

</ap>

</visualrf:site_access_points>

2. Startup_status

VisualRF Startup status.

URL: https://<airwave ip>/visualrf/startup_status

Example

<status>1</status>

3. Site Properties

Fetches all the properties of the Floor plan.

URL:https://<airwave ip>/visualrf/site/<site id>?aps=1&properties=1&images=1

Example: 

<visualrf:sites xmlns:visualrf="http://www.airwave.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1">

<site above_id="" ap_placement_concern="0" below_id="" building_id="1a254150-af27-4776-a4f3-8d4ee6f3f7a2" building_name="Default Building" campus_id="62529ed4-c853-4a62-b88c-c981731f7dbe" campus_name="Default Campus" creator_role_id="5"desired-data-rate="36.0" editable="true" env="3.5" envCheck="0.4772425889968872" floor="1.0" floor_atten_db="10.0" floor_height_ft="10.0" gridsize="15.0" height="800.0" id="f48f9277-6100-464c-90e6-af2ad5a2f42f" name="Floor 1" orientation-x="0.0" orientation-y="0.0" planned-client-xmit-mw="30" units="ft" width="1000.0" wizard="false">

<image type="background">

<filename>...</filename>

<relative-url>...</relative-url>

<pixel-width>1000</pixel-width>

<pixel-height>800</pixel-height>

<file-size>105530</file-size>

</image>

<image type="cropped">

<filename>...</filename>

<relative-url>...</relative-url>

<pixel-width>0</pixel-width>

<pixel-height>0</pixel-height>

<file-size>107370</file-size>

</image>

<image type="original">...</image>

<ap altitude="0.0" device_category="thin_ap" editable="true" firmware="6.4.2.15" folder="Top" folder_id="1" id="3" latitude="" longitude="" mac="AC:A3:1E:C6:36:58" manufacturer="Aruba" model="AP 215" name="ac:a3:1e:c6:36:58" operating-mode="ap" planned_maintenance_mode="false" serialNumber="CK0048599" site_id="f48f9277-6100-464c-90e6-af2ad5a2f42f" state="provisioned" status="up" view_x_pct="" view_y_pct="" x="406.502" y="367.013">...</ap>

<ap altitude="0.0" device_category="thin_ap" editable="true" firmware="6.4.2.15" folder="Top" folder_id="1" id="4" latitude="" longitude="" mac="9C:1C:12:C8:1E:7C" manufacturer="Aruba" model="AP 205" name="9c:1c:12:c8:1e:7c" operating-mode="ap" planned_maintenance_mode="false" serialNumber="CM0009069" site_id="f48f9277-6100-464c-90e6-af2ad5a2f42f" state="provisioned" status="up" view_x_pct="" view_y_pct="" x="815.154" y="366.144">

<total-bandwidth>-1</total-bandwidth>

<total-clients>0</total-clients>

<uptime>0.0</uptime>

<property format="" name="installation_notes" value=""/>

<radio antenna="" beamwidth="360.0" channel="11" enabled="true" ext_capable="false" gain="0.0" index="1" interface="2" mac="9C:1C:12:01:E7:C0" mode="ap" mount="" orientation="0.0" phy="n" valid="true" xmit-dbm="15.0" xmit-value="15 dBm">...</radio>

<radio antenna="" beamwidth="360.0" channel="52" enabled="true" ext_capable="false" gain="0.0" index="2" interface="1" mac="9C:1C:12:01:E7:D0" mode="ap" mount="" orientation="0.0" phy="c" valid="true" xmit-dbm="18.0" xmit-value="18 dBm">...</radio>

</ap>

</site>

</visualrf:sites>

4. Device Catalog

Complete device catalog supported by VisualRF.

URL: https://<airwave ip>/visualrf/catalog

5. Site Summary

Complete summary of the Floor Plan.

URL: https://<airwave ip>/visualrf/site/<site id>?summary=1

Example:

<visualrf:sites xmlns:visualrf="http://www.airwave.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1">

<site above_id="" ap_placement_concern="0" below_id="" building_id="1a254150-af27-4776-a4f3-8d4ee6f3f7a2" building_name="Default Building" campus_id="62529ed4-c853-4a62-b88c-c981731f7dbe" campus_name="Default Campus" creator_role_id="5"desired-data-rate="36.0" editable="true" env="3.5" floor="1.0" floor_atten_db="10.0" floor_height_ft="10.0" gridsize="15.0" height="800.0" id="f48f9277-6100-464c-90e6-af2ad5a2f42f" name="Floor 1" orientation-x="0.0" orientation-y="0.0"planned-client-xmit-mw="30" units="ft" width="1000.0" wizard="false">

<summary ap_count="2" ap_down_count="2" ap_up_count="0" calc_time="0.00" client_count="0" controller_count="0" idf_count="0" last_calc="2016-08-30T05:41:29-04:00" next_calc="2016-08-30T05:51:29-04:00" planned_ap_count="0" rack_count="0"radio_count="0" rfid_count="0" rogue_count="0" switch_count="0"/>

</site>

</visualrf:sites>

6. Playback Summary:

URL: https://<airwave ip>/visualrf/site/<site id>?playback=1

Example:

<visualrf:sites xmlns:visualrf="http://www.airwave.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1">

<site above_id="" ap_placement_concern="0" below_id="" building_id="1a254150-af27-4776-a4f3-8d4ee6f3f7a2" building_name="Default Building" campus_id="62529ed4-c853-4a62-b88c-c981731f7dbe" campus_name="Default Campus" creator_role_id="5"desired-data-rate="36.0" editable="true" env="3.5" envCheck="0.4772425889968872" floor="1.0" floor_atten_db="10.0" floor_height_ft="10.0" gridsize="15.0" height="800.0" id="f48f9277-6100-464c-90e6-af2ad5a2f42f" name="Floor 1" orientation-x="0.0" orientation-y="0.0" planned-client-xmit-mw="30" playback_history="none" units="ft" width="1000.0" wizard="false"/>

</visualrf:sites>

7. Fetches the Overlays view options:

URL: https://<airwave ip>/visualrf/site/<site id>?&clients=1&walls=1&regions=1&rfids=1&rogues=1&surveys=1&messages=1&properties=1&sensors=1&detail=1&idf=1&rack=1&interferer=1&airgroups=1

Example:

<visualrf:sites xmlns:visualrf="http://www.airwave.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1">

<site above_id="" ap_placement_concern="0" below_id="" building_id="1a254150-af27-4776-a4f3-8d4ee6f3f7a2" building_name="Default Building" campus_id="62529ed4-c853-4a62-b88c-c981731f7dbe" campus_name="Default Campus" creator_role_id="5"desired-data-rate="36.0" editable="true" env="3.5" envCheck="0.4772425889968872" floor="1.0" floor_atten_db="10.0" floor_height_ft="10.0" gridsize="15.0" height="800.0" id="f48f9277-6100-464c-90e6-af2ad5a2f42f" name="Floor 1" orientation-x="0.0" orientation-y="0.0" planned-client-xmit-mw="30" units="ft" width="1000.0" wizard="false">

<region created="2016-08-31T16:11:19-04:00" id="f9d3c886-3bf3-4561-967c-3c93538c72ee" name="c08edd7d-d883-4c17-8a12-c83e8755c9d0" site_id="f48f9277-6100-464c-90e6-af2ad5a2f42f" type="planning" version="1">

<point x="659.31" y="247.3"/>

<point x="711.61" y="184.76"/>

<point x="754.82" y="217.74"/>

<point x="695.69" y="260.95"/>

</region>

<region created="2016-08-31T16:11:04-04:00" id="ddf80e3d-2bb7-4c06-a3a9-9c8915daf89b" name="c6876997-57c5-47ac-ad32-6683598648ec" site_id="f48f9277-6100-464c-90e6-af2ad5a2f42f" type="planning" version="1">

<point x="858.29" y="198.41"/>

</region>

</site>

</visualrf:sites>

8. SVG:

It's SVG format of the Floor plan image.

URL: https://<airwave ip>/visualrf/data/<site id>/background.svg?

Version history
Revision #:
2 of 2
Last update:
‎03-29-2017 03:48 AM
Updated by:
 
Labels (1)
Contributors
Search Airheads
Showing results for 
Search instead for 
Did you mean: 
Is this a frequent problem?

Request an official Aruba knowledge base article to be written by our experts.