Users Guide

1077| External User Management Dell Networking W-Series ArubaOS 6.5.x| User Guide
l xml_user_query.sh: This script fetches the status and details of a user connected in the network using the
user_query command.
The Bourne Shell scripts work on most Unix, Linux, and Mac operating systems. To run on Windows, you can install
Cygwin.
All scripts require cURL to be installed on the XML API server. cURL is an open source command line tool and library
for transferring data with URL syntax. You can download cURL from http://curl.haxx.se/download.html.
XML API using Python 2.7
The information covered in the following section is based on running the ArubaXMLDemo.py script on a
Windows 8.1 64-bit and Python 2.7.
Understanding Request and Response
The controller processes the XML API request and sends the response to the XML API server. The XML
response contains the status of the request and a code in case of an error.
Request format: <script_name> <controller-ip> <secret_key> <command> [options]
Understanding XML API Request Parameters
The Table 255 lists all parameters that you can use in a request.
Parameter Description
script_name The name of the script executable.
controller-ip The IP address of the controller that will receive the XML requests.
secret_key The password used to validate the authentication request from your authentication
server. See Configuring the XML API Server on page 1071 for more information.
command The XML API command sent to the controller. You can send one of the following
commands per request:
l use_add: Creates a new user entry in the controllers user table. If the user entry is
already present in the user table, the command will modify the entry with the values
defined in the XML request. For an existing user, this command will update any value
that is supplied, with an exception of IP and MAC address. Session time-out is only
applicable to captive portal users.
l user_delete: Deletes an existing user from the controllers user table.
NOTE: Do not use the user_delete command if the intention is to clear the association
from the controller user table. If the client is dual-stack, it re-inherits the authentication
state from the IPv6 address. If not dual-stack, the client reverts to the initial role.
l user_authenticate: Authenticates against the server group defined in the captive
portal profile. This is only applicable to captive portal users.
l user_blacklist: Blacklists a user from connecting to your network. This command
uses the default blacklist timeout of 3600 seconds. There is no corresponding clear
command. You can use the controller CLI to clear the blacklisted clients. Refer the
show ap blacklist-clients, stm remove-blacklist-client, and stm purge-
blacklist-clients commands in the Dell Networking W-Series ArubaOS CLI Reference
Table 255: XML API Request Parameters and Descriptions