Manualshelf

Users Guide

ManualsBrandsDell ManualsAccess PlatformsW-Series Controller AOS
1061106210631064106510661067106810691070
Table Of Contents
Dell Networking W-Series ArubaOS 6.5.x | User Guide External User Management | 1064
Chapter 42
External User Management
This chapter introduces the ArubaOS XML API interface and briefly discusses how you can use simple API calls
to perform external user management tasks. Sample scripts are listed at the end of the chapter to help you get
started with using the XML API.
Topics in this chapter include:
l Overview on page 1064
l How the ArubaOS XML API Works on page 1064
l Creating an XML Request on page 1064
l XML Response on page 1067
l Sample Scripts on page 1076
Overview
ArubaOS allows you to set up customized external captive portal user management using its native XML API
interface. The XML API interface allows you to create and execute user management operations on behalf of
the clients or users. You can use the XML API interface to add, delete, authenticate, blacklist, query, or log out a
user.
Before you Begin
l Enable the External Services Interface software module. This is available in the PEFNG license.
l Ensure that you have connectivity between your XML API server and the controllers via HTTPS.
How the ArubaOS XML API Works
The typical interaction between your XML API server and the controller happens using an HTTPS POST
command. A typical communication process using the XML API interface happens as follows:
1. An API command is issued from your server in XML format to the controller. The XML request can be
composed using a language of your choice using the format described in the Creating an XML Request on
page 1064. Sample scripts are available in Python or Bourne Shell, using cURL to generate the HTTPS POST
command. See the Sample Scripts on page 1076.
2. The XML request is sent using an HTTPS POST command. The common format of the HTTPS POST is
https://<controller-ip>/auth/command.xml. See Creating an XML Request on page 1064 for more
information.
3. The controller processes the XML API request and sends the response to the XML API server. You can use
the response and take appropriate action that suits your requirement. The response from the controller is
returned using predefined formats. See the XML Response on page 1067 for more information.
Creating an XML Request
You can create XML request to add, delete, authenticate, blacklist, query, or logout a user. This section provides
XML request formats that you can use for each task.