AAA, NAC, Guest Access & BYOD

Add an AirGroup Enabled Shared Device using an API

by ‎08-06-2014 02:03 PM - edited ‎08-06-2014 02:06 PM

This is the API that is used to add an AirGroup Enabled Shared Device accounts to the Guest Device Repository in 6.3.0 and later versions.

 

 The API used to add AirGroup Enabled Shared Device account is:

  

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TipsApiRequest xmlns="http://www.avendasys.com/tipsapiDefs/1.0">
<TipsHeader version="3.0" source="Guest"/>
<GuestUsers>
<GuestUser name="mac address" password="mac address" startTime="yyyy-mm-dd hh:mm:ss" expiryTime="yyyy-mm-dd hh:mm:ss" sponsorName="Sponsor Name" enabled="true" guestType="DEVICE">
<GuestUserTags tagName="Role ID" tagValue="2"/>
<GuestUserTags tagName="airgroup_enable" tagValue="1"/>
<GuestUserTags tagName="airgroup_shared" tagValue="1"/>
<GuestUserTags tagName="airgroup_shared_user" tagValue="End User Name"/>
<GuestUserTags tagName="airgroup_shared_role" tagValue="Aruba User Role"/>
<GuestUserTags tagName="airgroup_shared_location" tagValue="Aruba AP Group"/>
<GuestUserTags tagName="airgroup_shared_time" tagValue="periodic weekday hh:mm to hh:mm shared users End User Name"/>
<GuestUserTags tagName="Visitor Name" tagValue="Visitor Name"/>
<GuestUserTags tagName="mac_auth" tagValue="1"/>
<GuestUserTags tagName="mac" tagValue="mac address"/>
<GuestUserTags tagName="do_expire" tagValue="4"/>
<GuestUserTags tagName="airgroup_device_type" tagValue="Device Type"/>
</GuestUser>
</GuestUsers>
</TipsApiRequest>

 

 Example is given below:

 

 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TipsApiRequest xmlns="http://www.avendasys.com/tipsapiDefs/1.0">
<TipsHeader version="3.0" source="Guest"/>
<GuestUsers>
<GuestUser name="FF-FF-FF-FF-FF-FF" password="FF-FF-FF-FF-FF-FF" startTime="2014-07-01 00:00:00" expiryTime="2015-07-31 23:59:59" sponsorName="admin" enabled="true" guestType="DEVICE">
<GuestUserTags tagName="Role ID" tagValue="2"/>
<GuestUserTags tagName="airgroup_enable" tagValue="1"/>
<GuestUserTags tagName="airgroup_shared" tagValue="1"/>
<GuestUserTags tagName="airgroup_shared_user" tagValue="Ravi"/>
<GuestUserTags tagName="airgroup_shared_role" tagValue="authenticated"/>
<GuestUserTags tagName="airgroup_shared_location" tagValue="default"/>
<GuestUserTags tagName="airgroup_shared_time" tagValue="periodic Monday 9:00 to 10:30 shared users Ravi"/>
<GuestUserTags tagName="Visitor Name" tagValue="Subhash Apple TV"/>
<GuestUserTags tagName="mac_auth" tagValue="1"/>
<GuestUserTags tagName="mac" tagValue="FF-FF-FF-FF-FF-FF"/>
<GuestUserTags tagName="do_expire" tagValue="4"/>
<GuestUserTags tagName="airgroup_device_type" tagValue="apple-tv"/>
</GuestUser>
</GuestUsers>
</TipsApiRequest>

 

This has been tested in 6.3.x versions.

 

Comments
codemode

I'm attempting to follow your example and I'm receiving a "success" message from the Clearpass server, however I'm not seeing the device in the Guest devices or anywhere else for that matter. What is the URL you're sending the XML request to? Most of my other API calls point to https://<clearpass server>/tipsapi/config/write when making changes - this is where I'm pointing this POST as well. Thanks!

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.