Creating An Xml Api Request; Xml Api Command - Aruba IAP-335 User Manual

Creating an XML API Request

You can now create an XML request with an appropriate authentication command and send it to the VC
through HTTPS post. The format of the URL to send the XML request is:
https://<virtualcontroller-ip/auth/command.xml>
virtualcontroller-ip: The IP address of the VC that will receive the XML API request
l
command.xml : The XML request that contains the XML API command.
l
The format of the XML API request is:
xml=<aruba command="<XML API command>">
<options>Value</options>
...
<options>Value</options>
</aruba>
You can specify any of the following commands in the XML request:
Table 65: XML API Command
Parameter
user_add
user_delete
user_authenticate
user_blacklist
user_query
Each XML API command requires certain mandatory options to successfully execute the task. The list of all
available options are:
Aruba Instant 6.5.0.0-4.3.0.0 | User Guide
Description
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.
This command deletes an existing user from the user table of the VC.
NOTE: Do not use the user_delete command if the intention is to clear the association from
the VC 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.
This command authenticates against the server group defined in the captive portal profile.
This is only applicable to captive portal users.
This command blacklists a user from connecting to your network. This command uses the
default blacklist timeout of 3600 seconds. There is no corresponding clear command.
This command 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.
Services | 298