Concept Guide

296 | Services Dell Networking W-Series Instant 6.5.1.0-4.3.1.0 | User Guide
Integration with Instant
The XML API interface allows you to send specific XML commands to a W-IAP from an external server. These
XMLcommands can be used to customize W-IAP client entries. You can use the XML API interface to add,
delete, authenticate, query, or blacklist a user or a client.
The user authentication is supported only for users authenticated by captive portal authentication and not
for the dot1x-authentication users.
The user add operation performed by the XMLAPIinterface is only used to modify the role of an existing user
and not to create a new user.
You can now use HTTP or HTTPS to post commands to W-IAP. The communication process using the
XMLAPIInterface is as follows:
l An API command is issued in XML format from the server to the VC.
l The VC processes the XML request and identifies where the client is and sends the command to the correct
slave W-IAP.
l Once the operation is completed, VC sends the XML response to the XML server.
l Users can use the response and take appropriate action to suit their requirements. The response from the
VC is returned using the predefined formats.
Configuring a W-IAP for XMLAPI integration
You can configure a W-IAP for XMLAPI integration by using the Instant UI or the CLI. W-IAP supports the
configuration of up to 8 XMLAPIserver entries.
In the Instant UI
Enabling XML API server entries:
1. Click More > Services.
2. Click Network Integration. The XMLAPIServer configuration parameters are displayed.
3. Enter a name for the XML API Server in the Name text box.
4. Enter the subnet of the XMLAPIServer in the Subnet text box.
5. Enter the subnet mask of the XML API Server in the Mask text box.
6. Enter a passcode in the Passphrase text box, to enable authorized access to the XML API Server.
7. Re-enter the passcode in the Retype box.
8. To add multiple entries, repeat the procedure.
9. Click OK.
10.To edit or delete the server entries, use the Edit and Delete buttons, respectively.
In the CLI
To enable XMLAPI integration with the W-IAP:
(Instant AP)(config)# xml-api-server <xml_api_server_profile>
(Instant AP)(xml-api-server <profile-name>)# ip <subnet> [mask <mask>]
(Instant AP)(xml-api-server)# key <key>
(Instant AP)(xml-api-server)# end
(Instant AP)# commit apply
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: