Users Guide

Table Of Contents
Parameter Description
Guide to clear the blacklisted clients.
l user_query: Fetches the status and details of a user connected to your network. A
dual-stack client can be queried by any of its IPv4 or IPv6 addresses, but only the
queried IP address is displayed in the output.
l user_logout: Reverts the user to the initial role. This is only applicable to captive
portal users. For dual-stack clients, all user-table entries will be reverted to the initial
role.
Options l -i <ip_addr>: Specify the IP address of the user in IPv4 or IPv6 format.
l -m <mac_addr>: Specify the MAC address of the user in aa:bb:cc:dd:ee:ff format.
l -n <name>: Specify the name of the user.
l -p <password>: Specify the password of the user for authentication.
l -r role: Specify the role to apply to a newly created user, or change of role for an
existing user. This option applies to user_add and user_delete commands only.
l -t timeout: Specifies the session time-out in seconds. User will be disconnected
after this time.
l -v version: Specifies the version of the XML API interface available in the controller.
This field is mandatory is all requests. Default version is 1.0.
l -a method: Specifies the encryption method to send the secret key. You can specify
MD5 or SHA-1 or cleartext as the encryption method. By default, cleartext method is
used to send the key.
l -s sessid: Specifies the active session ID.
Understanding an XML API Response
The response message from the controller is sent in an XML format. The default format of the response is:
[Message header]
Displays the request parameters and other standard header details.
...
...
...
<response>
<status>Status Message</status>
<code>Code in case of an error</code>
</response>
The following section describes few of the XML API requests and responses from the controller.
Adding a User
This XML request uses the user_add command to create a new user entry in the controllers user table.
C:\Python27>python ArubaXMLDemo.py --switch-ip=192.0.2.1 --secret=aruba123 --command=user_add
--ip=192.0.2.2 --mac=a4:e:60:c3:10:59 --role=logon
The command sends the following information in the XML request to the controller:
l --switch-ip: IP address of the controller
l --secret: Shared secret key (sent as plain text)
l --command: XML API command
l --ip: IP address of the user
l --mac: MAC address of the user
Dell Networking W-Series ArubaOS 6.5.x | User Guide External User Management | 1078