Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Ring Master Web Services

    The following is a list of Web services the Ring Master Agent provides. The Ring Master Agent publishes a list of Web API interfaces and the response XML schema in the release.

    All Web request URLs start with the Ring Master Server IP Address and port, service name, version number, followed by a method name. The method is followed by query parameters, which take the form argument=value, where arguments and values are URL encoded. Multiple parameters are separated by an ampersand character (i.e. “&”).

    For RM Agent 9.2, the command is updated to support the full access control privilege and the result has a new format where the result is divided into sections based on the privilege of the user group.

    Table 1: Get Ring Master Agent Version

     Agent Version
    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/version
    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/version

    Response Example
    <VERSION>
    <BUILD_NUMBER> 9.2.3.1.0 </ BUILD_NUMBER>
    <BUILD_DATE> 08/19/16</BUILD_DATE>
    <PRODUCT_NAME>RingMaster</PRODUCT_NAME>
    <PRODUCT_SHORT_NAME>RM</PRODUCT_SHORT_NAME>
    <VERSION>
    Comments

    The BUILD_DATE is short format, MM/DD/YY.

    Workaround

    This may not work in 9.2 MR1 release. As a workaround, add a request parameter “scope=all” in the request as below,

    https://127.0.0.1/webservice/rm-agent/v1/monitor/version?scope=all

    Table 2: Get a List of Current Alarms

     Current Alarms
    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/current-alarms?scope=all
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/current-alarms?scope=all

    Response Example
    <ALARMS-SUMMARY time="16-11-14 08:59:06">
    <VIEW name=̈all̈ scope=̈equipment”>
    <CATEGORY-COUNTS>
    <CATEGORY name="Client" critical="0" major="0" minor="0" info="0" total="0" />
    <CATEGORY name="Performance" critical="0" major="0" minor="0" info="0" total="0" />
    <CATEGORY name="Security" critical="0" major="0" minor="0" info="79" total="79" />
    <CATEGORY name=”Client” critical=”0” major=”0” minor=”0” info=”0” total=”0”/>
    <CATEGORY name="System" critical="1" major="0" minor="0" info="0" total="1" />
    <CATEGORY name="Total" critical="1" major="0" minor="0" info="79" total="80" />
    </CATEGORY-COUNTS>
    <TYPE-COUNTS>
    <TYPE name=”AP Fingerprint Check” category=”0” severity=”0” active=”1” cleared=”0” />
    <TYPE name="AP Status Alarm" count="1" severity=”0” active=”0” cleared=”0”/>
    <TYPE name=”Ad-hoc User Detected” category=”3” severity=”3” active=”0” cleared=”0” />
    <TYPE name=”Low RSSI” category=”1” severity=”1” active=”1” cleared=”0” />
    <TYPE name=”Low SNR” category=”1” severity=”1” active=”1” cleared=”0”/>
    <TYPE name="Suspect AP Detected" category=”3” severity=”3” active=”50” cleared=”9” />
    <TYPE name="total" count="80" />
    </TYPE-COUNTS>
    <SECURITY-COUNTS>
    <DOS />
    <IDS>
    <SECURITY-COUNT name="Suspect AP Detected" count="50" />
    <SECURITY-COUNT name="Ad-hoc User Detected" count="1" />
    </IDS>
    </SECURITY-COUNTS>
    </VIEW>
    <VIEW name="all" scope="rf-planning">
    <CATEGORY-COUNTS>
    <CATEGORY name="System" critical="1" major="0" minor="0" info="1" total="2"/>
    <CATEGORY name="Performance" critical="0" major="0" minor="13" info="0" total="13" />
    <CATEGORY name="Client" critical="0" major="0" minor="0" info="0" total="0"/>
    <CATEGORY name="Security" critical="0" major="6" minor="0" info="12" total="18" />
    <CATEGORY name="Total" critical="1" major="6" minor="13" info="13" total="33" />
    </CATEGORY-COUNTS>
    <TYPE-COUNTS>
    <TYPE name="AP Status Alarm" category="0" severity="0" active="1" cleared="6" />
    <TYPE name="Ad-hoc User Detected" category="3" severity="3" active="4" cleared="22" />
    <TYPE name="Low RSSI" category="1" severity="1" active="4" cleared="6"/>
    <TYPE name="Low SNR" category="1" severity="1" active="9" cleared="3"/>
    <TYPE name="Power Supply Status Check" category="0" severity="0" active="1" cleared="0" />
    <TYPE name="Rogue AP Client Detected" category="3" severity="3" active="2" cleared="7" />
    <TYPE name="Suspect AP Detected" category="3" severity="3" active="12" cleared="23" />
    </TYPE-COUNTS>
    <SECURITY-COUNTS>
    <DOS />
    <IDS>
    <SECURITY-COUNT name="Rogue AP Client Detected" count="2"/>
    <SECURITY-COUNT name="Suspect AP Detected" count="12" />
    <SECURITY-COUNT name="Ad-hoc User Detected" count="4" />
    </IDS>
    </SECURITY-COUNTS>
    </VIEW>
    </ALARMS-SUMMARY>
    </ALARMS-SUMMARY>

    Table 3: Get a List of Current Alarms with Query Criteria

     Current Alarms
    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/current-alarms?scope=all&=query&type=system&severity=minor,info&state=active

    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    op

    query (required)

    To query a different sets of alarms based on the query criteria

    Sample: op=query

    time_start

    all | time (optional)

    If this item ignored, the meaning is “all”

    The time format must like yy-mm-dd hh:mm:ss,

    Sample: time_start=16-11-29 23:20:47

    time_end

    all | time (optional)

    See above.

    type

    system | performance | client | security | all (optional)

    Sample 1: type=system

    Sample 2: type=system&type=client&type=performance

    severity

    critical | major | minor | info | all (optional)

    Sample 1: type=minor

    Sample 2: severity=critical&severity=major

    state

    all | active | acknowledged | cleared | deleted (optional)

    Sample 1: state=active

    Sample 2: state=active&state=deleted

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/current-alarms?scope=all&op=query&type=system&severity=minor,info&state=active

    Response Example
    <ALARM-DETAILS time="16-11-14 22:19:49">
    <VIEW name="all" scope="equipment">
    <ALARM_LIST count="2">
    <ALARM severity="Info" alarmObject="Default" state="Active" category="System" desc="Unable to resolve the DNS entry wlan-switch.englab.juniper.net" lastUpdateTime="16-11-14 20:40:50"/>
    <ALARM severity="Info" alarmObject="mx3" state="Active" category="System" desc="Power Supply 1 is Missing or Failed" lastUpdateTime="16-11-14 20:40:50"/>
    </ALARM_LIST>
    </VIEW>
    <VIEW name="all" scope="rf-planning">
    <ALARM_LIST count="2">
    <ALARM severity="Info" alarmObject="Default" state="Active" category="System" desc="Unable to resolve the DNS entry wlan-switch.englab.juniper.net" lastUpdateTime="16-11-14 20:40:50"/>
    <ALARM severity="Info" alarmObject="mx3" state="Active" category="System" desc="Power Supply 1 is Missing or Failed" lastUpdateTime="16-11-14 20:40:50"/>
    </ALARM_LIST>
    </VIEW>
    </ALARM-DETAILS>
    

    Table 4: Get List of Device Inventory

     Device Inventory
    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/devices?scope=all

    Request Parameters

    ParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/devices?scope=all

    Response Example
    <DEVICES count="10" time="16-10-31 21:52:16">
    <VIEW name="all" scope="equipment">
    <DEVICE license="WLAN Access Points:20Crashinfo functionality:1" mac_address="00:0C:29:60:07:7A" contact="" name="mx1" location="" model="WLC-V" serial_number="000c2960077a" system_ip="10.204.242.33/21" object-id="com.trapeze.appl.shared.mdl.Chassis: 5442" sw_version="REL_9.2.3.1.0_100716"/>
    <DEVICE mac_address="28:8a:1c:1e:59:80" name="AP01" model="WLA532-WW" serial_number="mg0213471429" system_ip="" object-id="com.trapeze.appl.shared.mdl.DistributedAP: 10501">
    <RADIOS_INFO radio_2_type="802.11b" radio_2_mac_address="28:8a:1c:1e:59:81" radio_1_type="802.11b" radio_1_mac_address="28:8a:1c:1e:59:80"/	>
    </DEVICE>
    </VIEW>
    </DEVICES>
    

    Table 5: Client Summary

     Client Summary
    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/client-summary?scope=all
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/client-summary?scope=all

    Response Example
    <CLIENT-SUMMARY>
    <VIEW name="all" scope="equipment">
    <CLIENTS-BY-SSID>
    <SSID name="zxc" count="1" />
    </CLIENTS-BY-SSID>
    <CLIENTS-BY-ACCESSTYPE>
    <ACCESS-TYPE name="DOT1X" count="1" />
    </CLIENTS-BY-ACCESSTYPE>
    <CLIENTS-BY-RADIOTYPE>
    <RADIO-TYPE name="802.11g" count="1" />
    </CLIENTS-BY-RADIOTYPE>
    </VIEW>

    Table 6: Client Summary

     

    Client Summary

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/client-summary?scope=all
    Request Parameters

    ParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/client-summary?scope=all

    Response Example
    <CLIENT-SUMMARY>
    <VIEW name="all" scope="equipment">
    <CLIENTS-BY-SSID>
    <SSID name="zxc" count="1" />
    </CLIENTS-BY-SSID>
    <CLIENTS-BY-ACCESSTYPE>
    <ACCESS-TYPE name="DOT1X" count="1" />
    </CLIENTS-BY-ACCESSTYPE>
    <CLIENS-BY-RADIOTYPE>
    <RADIO-TYPE name="802.11g" count="1" />
    </CLIENS-BY-RADIOTYPE>
    </VIEW>
    <VIEW name="all" scope="rf-planning">
    <CLIENTS-BY-SSID>
    <SSID name="zxc" count="1" />
    </CLIENTS-BY-SSID>
    <CLIENTS-BY-ACCESSTYPE>
    <ACCESS-TYPE name="DOT1X" count="1" />
    </CLIENTS-BY-ACCESSTYPE>
    <CLIENS-BY-RADIOTYPE>
    <RADIO-TYPE name="802.11g" count="1" />
    </CLIENS-BY-RADIOTYPE>
    </VIEW>
    <CLIENT-SUMMARY>
    

    Table 7: Statistics

     

    Traffic Statistics

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/statistics?scope=all&time=xxx
    Request Parameters

    ParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    time

    number of seconds (required)

    The time is to represent the specified number of seconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT

    Sample: time=165327135

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/statistics?scope=all&time=1238400000

    Response Example
    <TIMESERIES-SUMMARY
    xmlns="http://www.trapezenetworks.com/rm_statistics">
    <VIEW name="all" scope="equipment">
    <SESSION-STATISTICS authorizedClients="0" clientDot1xErrors="0" clientAssocErrors="0" clientAuthenErrors="0" clientAuthorErrors="0" />
    <TRAFFIC-STATISTICS octetIn="120237" octetOut="109197" octetTotal="229434" time="1238400000" />
    </VIEW>
    <VIEW name="all" scope="rf-planning">
    <SESSION-STATISTICS authorizedClients="1" clientDot1xErrors="0" clientAssocErrors="0" clientAuthenErrors="0" clientAuthorErrors="0" />
    <TRAFFIC-STATISTICS octetIn="60117" octetOut="54597" octetTotal="114714" time="1238400000" />
    </VIEW>
    </TIMESERIES-SUMMARY>
    

    Table 8: Status Summary

     

    Status Summary

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/status-summary?scope=all
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/status-summary?scope=all

    Response Example
    <STATUS-SUMMARY
    xmlns=”http://www.trapezenetworks.com/rm_status_summary”>
    RingMaster Software Version 9.2 Web Services API User Guide 12 Web Services Copyright © 2016, Juniper Networks, Inc.
    <VIEW name="all" scope="equipment">
    <MXS down="0" up="5" disabled="0" unknown="0" />
    <APS down="3" up="1" disabled="0" unknown="0" />
    <RADIOS down="5" up="2" disabled="0" unknown="0" />
    </VIEW>
    <VIEW name="all" scope="rf-planning">
    <MXS down="0" up="1" disabled="0" unknown="0" />
    <APS down="1" up="0" disabled="0" unknown="0" />
    <RADIOS down="2" up="0" disabled="0" unknown="0" />
    </VIEW>
    </STATUS-SUMMARY>
    <>

    Table 9: Monitor Summary

     

    Monitor Summary

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/summary?scope=all
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/summary?scope=all

    Response Example
    <MONITOR-SUMMARY
    xmlns="http://www.trapezenetworks.com/rm_monitor_summary">
    <VIEW name="all" scope="equipment">
    <ALARMS-SUMMARY>
    <CATEGORY-COUNTS>
    <CATEGORY name="System" critical="1" major="1" minor="0" info="0" total="2" />
    <CATEGORY name="Performance" critical="0" major="0" minor="2" info="0" total="2" />
    <CATEGORY name="Client" critical="0" major="0" minor="0" info="0" total="0" />
    <CATEGORY name="Security" critical="0" major="1" minor="0" info="50" total="51" />
    <CATEGORY name="Total" critical="1" major="2" minor="2" info="50" total="55" />
    </CATEGORY-COUNTS>
    <TYPE-COUNTS>
    <TYPE name="AP Fingerprint Check" category="0" severity="0" active="1" cleared="0" />
    <TYPE name="AP Status Alarm" category="0" severity="0" active="1" cleared="0" />
    <TYPE name="Ad-hoc User Detected" category="3" severity="3" active="1" cleared="9" />
    </TYPE-COUNTS>
    <SECURITY-COUNTS>
    <DOS />
    <IDS>
    <SECURITY-COUNT name="Suspect AP Detected" count="50" />
    <SECURITY-COUNT name="Ad-hoc User Detected" count="1" />
    </IDS>
    </SECURITY-COUNTS>
    </ALARMS-SUMMARY>
    <CLIENT-SUMMARY>
    <CLIENTS-BY-SSID>
    <SSID name="ssid-belinda1" count="1" />
    </CLIENTS-BY-SSID>
    <CLIENTS-BY-ACCESSTYPE>
    <ACCESS-TYPE name="DOT1X" count="1" />
    </CLIENTS-BY-ACCESSTYPE>
    <CLIENTS-BY-RADIOTYPE>
    <RADIO-TYPE name="802.11g" count="1" />
    </CLIENTS-BY-RADIOTYPE>
    </CLIENT-SUMMARY>
    <STATUS-SUMMARY>
    <MXS down="0" up="1" disabled="0" unknown="0" />
    <APS down="1" up="1" disabled="0" unknown="0" />
    <RADIOS down="1" up="2" disabled="0" unknown="0" />
    </STATUS-SUMMARY>
    </VIEW>
    <VIEW name="all" scope="rf-planning">
    <ALARMS-SUMMARY>
    <CATEGORY-COUNTS>
    <CATEGORY name="System" critical="1" major="0" minor="0" info="1" total="2" />
    <CATEGORY name="Performance" critical="0" major="0" minor="13" info="0" total="13" />
    <CATEGORY name="Client" critical="0" major="0" minor="0" info="0" total="0" />
    <CATEGORY name="Security" critical="0" major="6" minor="0" info="13" total="19" />
    <CATEGORY name="Total" critical="1" major="6" minor="13" info="14" total="34" />
    </CATEGORY-COUNTS>
    <TYPE-COUNTS>
    <TYPE name="AP Status Alarm" category="0" severity="0" active="1" cleared="6" />
    <TYPE name="Ad-hoc User Detected" category="3" severity="3" active="4" cleared="22" />
    </TYPE-COUNTS>
    <SECURITY-COUNTS>
    <DOS />
    <IDS>
    <SECURITY-COUNT name="Rogue AP Client Detected" count="2" />
    <SECURITY-COUNT name="Suspect AP Detected" count="13" />
    </IDS>
    </SECURITY-COUNTS>
    </ALARMS-SUMMARY>
    <CLIENT-SUMMARY>
    <CLIENTS-BY-SSID />
    <CLIENTS-BY-ACCESSTYPE />
    <CLIENTS-BY-RADIOTYPE />
    </CLIENT-SUMMARY>
    <STATUS-SUMMARY>
    <MXS down="0" up="0" disabled="0" unknown="0" />
    <APS down="0" up="0" disabled="0" unknown="0" />
    <RADIOS down="0" up="0" disabled="0" unknown="0" />
    <STATUS-SUMMARY>
    </VIEW>
    </MONITOR-SUMMARY>

    Table 10: Server Status

     

    Server Status

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/server-status
    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/server-status

    Response Example
    <SERVER-STATUS
    xmlns="http://www.trapezenetworks.com/rm_server_status"
    BUILD-NUMBER="9.2.3.0.266" BUILD-DATE="03/10/16"
    PRODUCT-NAME="RingMaster"
    PRODUCT-SHORT-NAME="RingMaster" PLAN-NAME="Default"
    UPTIME="71535489"
    HOST-NAME="lchcan2">
    </SERVER-STATUS>
    Comments

    The BUILD_DATE is in the short format, as MM/DD/YY.

    Workaround

    This may not work in 9.2 MR1 release. As a workaround, add a request parameter “scope=all” in the request as below,

    https://127.0.0.1/webservice/rm-agent/v1/monitor/server-status?scope=all

    Table 11: Devices Summary

     

    Devices Summary

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/devices-summary?scope=all
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    Access Control Scope

    View Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/devices-summary?scope=all

    Response Example
    <DEVICES-SUMMARY>
    <VIEW name="all" scope="equipment">
    <MXS>
    <MX model="WLC880R" managed="1" unmanaged="0"/>
    <MX model="WLC-V" managed="2" unmanaged="0"/>
    </MXS>
    <APS>
    <AP model="WLA532-WW" managed="3" unmanaged="0"/>
    </APS>
    </VIEW>
    <VIEW name="all" scope="rf-planning">
    <MXS>
    <MX model="WLC-V" managed="1" unmanaged="0"/>
    </MXS>
    <APS>
    <AP model="WLA532-WW" managed="0" unmanaged="3"/>
    </APS>
    </VIEW>
    </DEVICES-SUMMARY>
    

    Table 12: Top Summary

     

    Top Summary

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/top-summary?scope=all
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    Request Example

    https://127.0.0.1:443/webservice/rm-agent/v1/monitor/top-summary?scope=all

    Response Example
    <TOP-SUMMARY>
    <VIEW name="all" scope="equipment">
    <TOP-AP-BY-CLIENTS/>
    <TOP-AP-BY-TRAFFICAP name="mx1:AP02:Radio1" Throughput="3024">
    <AP name="mx1:AP02:Radio1" Throughput="3024" TxMulticastOctets="5293268" TxUnicastOctets="4959" RxOctets="216605" Traffic="5514832" ApLocation="test:Building1:Floor1:test-2.4GHz"/>
    <AP name="mx1:AP02:Radio2" Throughput="3709" TxMulticastOctets="6637896" TxUnicastOctets="31232" RxOctets="9259" Traffic="6678387" ApLocation="test:Building1:Floor1:test-2.4GHz"/>
    </TOP-AP-BY-TRAFFIC>
    <TOP-MX-BY-CLIENTS/>
    <TOP-MX-BY-TRAFFIC>
    <MX name="mx1" Throughput="6733" TxMulticastOctets="11931164" TxUnicastOctets="36191" RxOctets="225864" Traffic="12193219" ApLocation="0"/>
    <MX name="mx2" Throughput="7211" TxMulticastOctets="14489739" TxUnicastOctets="543301" RxOctets="6610731" Traffic="21643771" ApLocation="0"/>
    </TOP-MX-BY-TRAFFIC>
    </VIEW><VIEW name="all" scope="rf-planning">
    <TOP-AP-BY-CLIENTS/>
    <TOP-AP-BY-TRAFFIC>
    <AP name="mx1:AP02:Radio1" Throughput="3024" TxMulticastOctets="5293268" TxUnicastOctets="4959" RxOctets="216605" Traffic="5514832" ApLocation="test:Building1:Floor1:test-2.4GHz"/>
    <AP name="mx1:AP02:Radio2" Throughput="3709" TxMulticastOctets="6637896" TxUnicastOctets="31232" RxOctets="9259" Traffic="6678387" ApLocation="test:Building1:Floor1:test-2.4GHz"/>
    </TOP-AP-BY-TRAFFIC>
    <TOP-MX-BY-CLIENTS/>
    <TOP-MX-BY-TRAFFIC>
    <MX name="mx1" Throughput="6733" TxMulticastOctets="11931164" TxUnicastOctets="36191" RxOctets="225864" Traffic="12193219" ApLocation="0"/>
    <MX name="mx1" Throughput="7211" TxMulticastOctets="14489739" TxUnicastOctets="543301" RxOctets="6610731" Traffic="21643771" ApLocation="0"/>
    </TOP-MX-BY-TRAFFIC>
    </VIEW>
    </TOP-SUMMARY>
    

    Table 13: Find MX

     

    Finding WLC

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/find-mx?scope=equipment&name=xxx&ip-address=xxx&serial-number=xxx&status=xxx
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    name

    (optional)

    Name of the MX device

    ip-address

    (optional)

    IP Address of the MX device

    serial-number

    (optional)

    MX serial number

    status

    Up | Down (optional)

    MX Operational status

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/find-mx?scope=equipment

    Response Example
    <FIND-MX xmlns="http://www.trapezenetworks.com/rm_find_mx" tooManyMatches="false" limitedAccess="true">
    <VIEW name="all" scope="equipment">
    <Device object-id="Mobility Exchange:1734" name="MXR2-76" ip-address="172.31.177.76" serial-number="0621800238" model="MXR-2" status="Up" />
    <Device object-id="Mobility Exchange:397" name="MXR2-77" ip-address="172.31.177.77" serial-number="0791600540" model="MXR-2" status="Up" />
    <Device object-id="Mobility Exchange:5954" name="mx1" ip-address="172.31.177.39" serial-number="0525200128" model="MXR-2" status="Up" />
    </VIEW>
    </FIND-MX>

    Table 14: Find AP

     

    Finding WLA

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/find-ap?scope=equipment&name=xxx&ip-address=xxx&serial-number=xxx&status=xxx
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    name

    (optional)

    Name of the WLA device

    ip-address

    (optional)

    IP Address of the WLA device

    serial-number

    (optional)

    WLA serial number

    model

    Up | Down (optional)

    WLA model number

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/find-ap?scope=equipment

    Response Example
    <FIND-AP xmlns="http://www.trapezenetworks.com/rm_find_ap" tooManyMatches="false" limitedAccess="true">
    <VIEW name="all" scope="equipment">
    <DEVICE object-id="Distributed AP:826" name="MXR277-AP01" serial-number="123" model="MP-422" status="Down" />
    <DEVICE object-id="Distributed AP:6410" name="AP01" serial-number="0674600143" model="MP-422" status="Up" />
    <DEVICE object-id="Distributed AP:6419" name="AP05" serial-number="33323233" model="MP-71" status="Down" />
    </VIEW>
    </FIND-AP>

    Table 15: Find Site

     

    Finding Site

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/find-site?scope=rf-planning&name=xxx
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/find-site?scope=rf-planning

    Response Example
    <FIND-SITE xmlns="http://www.trapezenetworks.com/rm_find_site" tooManyMatches="false" limitedAccess="false">
    <VIEW name="monitor" scope="rf-planning>
    <SITE object-id="Site:5072" name="SiteA" network-plan="YourPlan" />
    </VIEW>
    </FIND-SITE>

    Table 16: Find Building

     

    Finding Building

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/find-building?scope=rf-planning&name=xxx
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    name

    (optional)

    Name of the floor

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/find-building?scope=rf-planning

    Response Example
    <FIND-BUILDING xmlns="http://www.trapezenetworks.com/rm_find_building" tooManyMatches="false" limitedAccess="true">
    <VIEW name="all" scope="rf-planning">
    <BUILDING object-id="Building:5080" name="Building1" network-plan="YourPlan" site="SiteA" />
    </VIEW>
    </FIND-BUILDING>
    

    Table 17: Find Floor

     

    Finding Floor

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/find-floor?scope=rf-planning&name=xxx
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    name

    (optional)

    Name of the floor

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/find-floor?scope=rf-planning

    Response Example
    <FIND-FLOOR xmlns="http://www.trapezenetworks.com/rm_find_floor" tooManyMatches="false" limitedAccess="true">
    <VIEW name="all" scope="rf-planning">
    <FLOOR object-id="Floor:5082" name="Floor1" network-plan="YourPlan" site="SiteA" building="Building1" />
    </VIEW>
    </FIND-FLOOR>

    Table 18: Find Outdoor Area

     

    Finding Outdoor Area

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/find-outdoorarea?scope=rf-planning&name=xxx
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    name

    (optional)

    Name of the floor

    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/find-outdoorarea?scope=rf-planning

    Response Example
    <FIND-OutdoorArea
    xmlns="http://www.trapezenetworks.com/rm_find_outdoorarea" tooManyMatches="false" limitedAccess="true">
    <VIEW name="all" scope="rf-planning">
    <OUTDOORAREA object-id="Outdoor Area:15360" name="OA1" site="SiteA" network-plan="YourPlan" />
    <OUTDOORAREA object-id="Outdoor Area:15366" name="OA2" site="SiteA" network-plan="YourPlan" />
    </VIEW>
    </FIND-OutdoorArea>
     

    Finding Client

    Request URL
    https://<RingMasterServerIP>/webservice/rm-agent/v1/monitor/find-client?scope=all&user-name=xxx&mac-address=xxx&ip-address=xxx
    Request ParametersParameterValueDescription
    scope

    all | equipment | rf-planning (required)

    Sample: scope=all

    user-name

    (optional)

    Name of the client

    mac-address

    (optional)

    MAC address of the client device

    ip-address

    (optional)

    IP address of the client device

    Besides scope, at least one of the search criteria must be provided.
    Access Control Scope

    Monitor Privilege

    Request Example

    https://127.0.0.1/webservice/rm-agent/v1/monitor/find-client?scope=all&ip-address=172.16.5.99

    Response Example
    <FIND-CLIENT-RESULT tooManyMatches="false" limitedAccess="false">
    <VIEW name="all" scope="equipment">
    <USER-SESSION session-id="SESS-2-8bef5b-558547-0c1f050" user-name="last-resort-rest-0" ip-addr="172.16.5.99" mac-addr="00:26:c6:ca:64:e2" ssid="rest" session-state="ACTIVE" start-time="1477558547000" access-type="LAST-RESORT" radio-type="802.11na" auth-server="10.204.242.33" auth-protocol="NONE" collected-time="1477932632858" snr="64" rssi="-31" device-ip-address="10.204.242.33" device-name="mx1" device-obj-id="WLAN Controller:5442" radio-obj-id="ProductSpecific Radio:10510" device-enable-pwd="" device-authmode="LEGACY"/>
    </VIEW>
    <VIEW name="all" scope="rf-planning">
    <USER-SESSION session-id="SESS-2-8bef5b-558547-0c1f050" user-name="last-resort-rest-0" ip-addr="172.16.5.99" mac-addr="00:26:c6:ca:64:e2" ssid="rest" session-state="ACTIVE" start-time="1477558547000" access-type="LAST-RESORT" radio-type="802.11na" auth-server="10.204.242.33" auth-protocol="NONE" collected-time="1477932632858" snr="64" rssi="-31" device-ip-address="10.204.242.33" device-name="mx1" device-obj-id="WLAN Controller:5442" radio-obj-id="ProductSpecific Radio:10510" device-enable-pwd="" device-authmode="LEGACY"/>
    </VIEW>
    </FIND-CLIENT-RESULT>

    ERROR HANDLING

    The RingMaster Web Services API returns standard HTTP errors. The following errors have been identified:

    • Code 400: Bad request
    • Code 403: Forbidden
    • Code 503: Service Unavailable

    When an error is returned, the following XML fragment is passed in the HTML

    <ERROR>
    <MESSAGE>The error message</MESSAGE>
    <ERROR>

    Modified: 2016-12-14