Creating an XML API Request
You can now create an XML request with an XML API command and send it to the switch via HTTPS POST. The
format of the URL to send the XML request is:
https://<switch-ip/auth/command.xml
n switch-ip: The IP address of the switch that will receive the XML API request
n command.xml: The XML request that contains the XML API command.
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:
XML API Command Description
user_add This command creates a new user entry in the switches 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.
user_delete This command deletes an existing user from the switches user table.
NOTE: Do not use the user_delete command if the intention is to clear
the association from the switch 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.
user_authenticate This command authenticates against the server group defined in the
captive portal profile. This is only applicable to captive portal users.
user_blacklist 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. You can use the switch CLI to clear the
blacklisted clients. Refer the show ap blacklist-clients, stm remove-
blacklist-client, and stm purge-blacklist-clients commands in the AOS-
W CLI Reference Guide to clear the blacklisted clients.
user_query 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.
user_logout This command 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.
Table 264: XML API Command
Each XML API command requires certain mandatory options to successfully execute the task. The list of all
available options are:
AOS-W 6.5.3.x | User Guide External User Management | 1079
To Next Page
Loading...