Developer

 View Only
last person joined: 13 hours ago 

Expand all | Collapse all

Querying Airwave Client_Search API - syntax?

This thread has been viewed 0 times
  • 1.  Querying Airwave Client_Search API - syntax?

    Posted Jan 18, 2019 11:23 AM

    How do I query the Client_Search.xml API?  Ultimately, I am trying to look up the current access points for a given list of users because I want to know where devices are physically located as people move around throughout the day.

     

    I have been successful using client_detail.xml but it only accepts mac addresses for doing the lookup.  I would like to search for users by username, or to look up all users connected to a specific set of access points.

     

    So I am wondering the syntax or examples of queries that can passed to client_search.xml...



  • 2.  RE: Querying Airwave Client_Search API - syntax?

    Posted Mar 11, 2019 05:33 PM

    Were you able to make any progress with this question?

     

    We are trying to do something similar in that we wish to query for all users in a given folder.

    Each building will have it's own folder and we are trying to build up a list of connected users in a certain building at any given time.



  • 3.  RE: Querying Airwave Client_Search API - syntax?

    EMPLOYEE
    Posted Mar 12, 2019 07:31 AM

    We can use cleint_search.xml API and search client info using its username, it willl provide complete association history.

    Syntax

    https://<server ip>/client_search.xml?query=<username>

     

    We can list all the folder using folder_list.xml but output provides only client count but not complete details

     

    Sample output of folder_list.xml for folder id 18

    https://<server ip>/folder_list.xml?id=18

     

    <amp:amp_folder_list version="1" xsi:schemaLocation="http://www.airwave.com amp_folder_list.xsd"><folder id="18"><bandwidth_in>6293349</bandwidth_in><bandwidth_out>7950469</bandwidth_out><client_count>2</client_count><down>1</down><mismatch>6</mismatch><name>Aruba-Lab-TME</name><parent_id>1</parent_id><up>11</up><vpn_client_count>0</vpn_client_count></folder></amp:amp_folder_list>



  • 4.  RE: Querying Airwave Client_Search API - syntax?

    EMPLOYEE
    Posted Mar 11, 2019 05:58 PM

    Hello,

    Let me check with the Airwave experts to see if they can chime in on the subject.



  • 5.  RE: Querying Airwave Client_Search API - syntax?

    EMPLOYEE
    Posted Mar 12, 2019 12:14 PM

    From the documentation:  Client Search – Provides an interface to AMP's client search functionality.  This API requires a query string and returns an XML version of the AMP UI's search results. 

     

    We can search on username, IP address, MAC address  OR  part of one of those things. These are all the same strings someone might type into the Search Bar on the UI, where the Client Search API will return any matching client item(s).

     

    As example URLs to query: