Parameter Description
l-r role—Specifythe current user role of the client.
l-t timeout—Usersessiontim eout.
l-v version—APIversion number. Default is 1.0
l-a method—Specifythe encryption method to sendthe secret key. You can specify MD5 or SHA-
1or cleartext as the encryption method. By default, cleartextm ethodi sused to send the key.
l-s sessid—ActivesessionId
controller-ip TheIP addressof the controller that will recei vethe authentication requests.
command
Theauthentication comm and sentto the controller. You can send one of the following comm andsper
request:
ladd:Adds the client to your network.
ldelete:Deletes the client from yournetwork
lquery:Fetches information about the client
lblacklist:Blacklists or block the client from connecting to yournetwork
lauthenticate:Authenticatesthe client and assigns the default authenticated role.
secret_key Thepassword used tovali datethe authentication request from your authentication server. See
"Configuring the XML API S erver" on page 779 for more information.
Understanding XMl API Response

The responsemessage from the controller is sent in an XML format. The defaultformat 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>
Adding a Client

This command will add a client on your network.

Figure 359: Addinga cli ent—requestandresponse
john@linux:/home/john/tools/xml-api# ./auth -i 10.10.10.249 -m 00:19:d2:01:0b:aa -r logon
10.11.12.13 add $abcd$1234$

The commandssends the following information in the authentication request to the controller:

lClient IP address: 10.10.10.249
lClient MAC address: 00:19:d2:01:0b:aa
lAuthentication server IP address: 10.11.12.13
lAuthentication command: add
lKey to validate authentication request: $abcd$1234$
lVerification key is sent in cleartext format
Responsefrom thecontroller
server=10.11.12.13, command=add, version=1.0, secret=$abcd$1234$sessid=
Message authentication is cleartext ($abcd$1234$)
DellPowerConnect W- Series ArubaOS 6.2 | UserGuide ExternalUser Manageme nt |788