297
| Services
Aruba Instant 6.5.0.0-4.3.0.0 | User Guide
Integrating an IAP with an XML API Interface
The XML API interface provides options to create and execute user management operations seamlessly on
behalf of the clients or users.
Integration with Instant
The XML API interface allows you to send specific XML commands to an IAP from an external server. These
XML commands can be used to customize 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 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 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 an IAP for XML API integration
You can configure an IAP for XML API integration by using the Instant UI or the CLI. 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 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
