Configuring XML API Interface

The XML Extensible Markup Language. XML is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable. API Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. interface allows Instant Access Points (IAPs) to communicate with an external server. The communication between IAP and an external server through XML API Interface includes the following steps:

  • An API command is issued in the XML format from the server to the virtual controller.
  • The virtual controller processes the XML request and identifies where the client is and sends the command to the correct member IAP.
  • Once the operation is completed, the virtual controller sends the XML response to the XML server.
  • The administrators can use the response and take appropriate action to suit their requirements. The response from the virtual controller is returned using the predefined formats.

To configure XML API for servers, complete the following steps:

  1. In the WebUI, set the filter to select a group or a device.
  2. Under Manage, click Devices > Access Points.
  3. Click the Config icon. The tabs to configure access points is displayed
  4. Click Show Advanced, and click Services. The Services page is displayed.
  5. Go to Network Integration > XML API Server Configuration.
  6. Click + to add a new XML API server.
  7. Enter a name for the XML API server in the Name text box.
  8. Enter the IP address of the XML API server in the IP Address text box.
  9. Enter the subnet Subnet is the logical division of an IP network. mask of the XML API server in the Mask text box.
  10. Enter a passcode in the Passphrase text box, to enable authorized access to the XML API Server.
  11. Re-enter the passcode in the Retype Passphrase box.
  12. To add multiple entries, repeat the procedure.
  13. Click Add.
  14. Click Save Settings.
  15. To edit or delete the server entries, use the Edit and Delete buttons, respectively.

For information on adding an XML API request, see HPE Aruba Networking Instant User Guide.

The following animation shows how to configure the XML API for servers: