Changes to Aruba Central APIs

This section lists the new APIsApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software., deprecated APIs, alternative APIs, and APIs removed from Aruba Central:

New APIs

The following table lists the new APIs:

Table 1: New APIs

New API

Description

Monitoring > Clients APIs

  • [GET] /monitoring/v2/clients

This API is introduced to get a list of unified clients and it is backward compatible with the version 1 APIs (GET /monitoring/v1/clients/wired and GET /monitoring/v1/clients/wireless). This API version is introduced with the following parameter inclusions:

  • last_client_mac—Use this parameter to fetch the next set of clients beyond set limit. This is used to fetch the clients details beyond 10000 clients.
  • timerange— Use this to filter the unified client information based on the time range. By default, 3 hours is selected.
  • client_type—Use this to select the client type as WIRELESS or WIRED. By default, client type is selected as WIRELESS.
  • client_status—Use this to select either CONNECTED for a list of connected clients or FAILED_TO_CONNECT for a list failed clients. By default, the client status is selected as CONNECTED.
  • [GET] /monitoring/v2/clients/{macaddr}

This API is introduced to get the client details (wired and wireless).

Authentication & Policy > Client Policy APIs

  • [GET] /client_policy

This API is introduced to fetch a policy that allows network access for registered clients, based on their MACMedia Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network. address and client profile tag.

  • [DELETE] /client_policy

This API is introduced to delete an existing policy to remove network access for all registered clients.

  • [PUT] /client_policy

This API is introduced to configure or update a policy that allows network access for registered clients, based on their MAC address and client profile tag.

Authentication & Policy > Client Registration APIs

  • [GET] /client_registration

This API is introduced to fetch the list of registered clients that are allowed to access the network.

  • [DELETE] /client_registration/{mac_address}

This API is introduced to delete the registered client and to remove network access.

  • [POST] /client_registration

This API is introduced to add a registered client to allow network access.

  • [PATCH] /client_registration/{mac_address}

This API is introduced to update Client Name for the registered clients.

Authentication & Policy > User policy APIs

  • [GET] /user_policy

This API is introduced to fetch a policy that allows wireless network access for users, based on their user groups.

  • [DELETE] /user_policy

This API is introduced to delete existing policy to remove wireless network access for all users.

  • [PUT] /user_policy

This API is introduced to configure a policy to allow wireless network access for users, based on their user groups.

Configuration > WLAN Configuration APIs

  • [GET] /configuration/full_hotspot/{group_name_or_guid}

This API is introduced to get the WLANWireless Local Area Network. WLAN is a 802.11 standards-based LAN that the users access through a wireless connection. list of an UI group.

 

  • [GET] /configuration/full_hotspot/{group_name_or_guid}/{mode_name}
This API is introduced to get the hotspotHotspot refers to a WLAN node that provides Internet connection and virtual private network (VPN) access from a given location. A business traveler, for example, with a laptop equipped for Wi-Fi can look up a local hotspot, contact it, and get connected through its network to reach the Internet. list of an UI group or swarm with mode name.
  • [GET] /configuration/full_hotspot/{group_name_or_guid}/template

This API is introduced to get the WLAN default configuration.

  • [GET] /configuration/full_hotspot/{group_name_or_guid}/{hotspot_name}/{mode_name}

This API is introduced to initiate backup of running config for the switch with the given serial and store output against a name starting with the given prefix.

  • [POST] /configuration/full_hotspot/{group_name_or_guid}/{hotspot_name}/{mode_name}

This API is introduced to create a new hotspot.

  • [DELETE] /configuration/full_hotspot/{group_name_or_guid}/{hotspot_name}/{mode_name}

This API is introduced to delete an existing hotspot.

  • [PUT] /configuration/full_hotspot/{group_name_or_guid}/{hotspot_name}/{mode_name}

This API is introduced to update an existing hotspot.

Troubleshooting APIs

  • [GET] /troubleshooting/v1/running-config-backup/serial/{serial}

This API is introduced to get list of backups associated with the device serial.

 

  • [GET] /troubleshooting/v1/running-config-backup/serial/{serial}/prefix/{prefix}

This API is introduced to filter/list the backups associated with the device serial and starting with the prefix.

  • [GET] /troubleshooting/v1/running-config-backup/name/{name}

This API is introduced to fetch the backup stored against the given name.

  • [POST] /troubleshooting/v1/running-config-backup/serial/{serial}/prefix/{prefix}

This API is introduced to initiate backup of running config for the switch with the given serial and store output against a name starting with the given prefix.

  • [POST] /troubleshooting/v1/running-config-backup/group_name/{group_name}/prefix/{prefix}

This API is introduced to initiate backup of running config for switches in the group and store output against names starting with the given prefix.

AI OPs > Wi-Fi Connectivity at Global APIs

NOTE: For all AI Ops APIs, AI Insights will get triggered only when there are failure events in the user network, so all Insights might not be present all the time. Therefore, providing an empty API response for a selected time period.

 

  • [GET] /aiops/v1/connectivity/global/stage/{stage}/export
  • [GET] /aiops/v1/connectivity/site/{site_id}/stage/{stage}/export
  • [GET] /aiops/v1/connectivity/group/{group}/stage/{stage}/export

This APIs are introduced to get the overall Connectivity Information for a given time duration. Use stage parameter to get the information for that stage.

 

 

AI OPs > AI Insights List APIs

 

  • [GET] /aiops/v2/insights/global/list
  • [GET] /aiops/v2/insights/site/{site_id}/list
  • [GET] /aiops/v2/insights/ap/{ap_serial}/list
  • [GET] /aiops/v2/insights/client/{sta_mac}/list
  • [GET] /aiops/v2/insights/gateway/{gw_serial}/list
  • [GET] /aiops/v2/insights/switch/{sw_serial}/list

This APIs are introduced to get the list of insights for a given time duration

 

 

 

 

 

AI OPs > AI Insight Details APIs

  • [GET] /aiops/v2/insights/global/id/{insight_id}/export
  • [GET] /aiops/v2/insights/site/{site_id}/id/{insight_id}/export
  • [GET] /aiops/v2/insights/ap/{ap_serial}/id/{insight_id}/export
  • [GET] /aiops/v2/insights/client/{sta_mac}/id/{insight_id}/export
  • [GET] /aiops/v2/insights/gateway/{gw_serial}/id/{insight_id}/export
  • [GET] /aiops/v2/insights/switch/{sw_serial}/id/{insight_id}/export

This APIs are introduced to get details of single insight for a given time duration.

 

 

 

 

 

Service IPMS > Aruba ipms APIs

NOTE: In the API parameter, make sure that the node_type and node_id fields are set to Global.

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/ip_range/

This API is introduced to retrieve an ip range.

 

  • [DELETE] /ipms-config/v1/node_list/{node_type}/{node_id}/config/

This API is introduced to delete a config.

 

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/config/

This API is introduced to retrieve a config.

 

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/

This API is introduced to retrieve an address pool.

 

  • [DELETE] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/

This API is introduced to delete an address pool.

 

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/

This API is introduced to retrieve an address pool by identifier pool name.

 

  • [POST] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/

This API is introduced to create an address pool by identifier pool name.

 

  • [PUT] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/

This API is introduced to create or update the address pool by identifier pool name.

 

  • [DELETE] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/ip_range/{range_id}/

This API is introduced to delete the IP range by identifier range id.

 

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/ip_range/{range_id}/

This API is introduced to retrieve the IP range by identifier range id.

 

  • [POST] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/ip_range/{range_id}/

This API is introduced to create IP range by identifier range id.

 

  • [PUT] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/ip_range/{range_id}/

This API is introduced to create or update the IP range by identifier range id.

 

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/

This API is introduced to have global level config for IPMS service.

 

Modified API

The following table lists the modified APIs:

Table 2: Modified APIs

Modified API

Description

Monitoring > Client API

  • [GET] /monitoring/v1/clients/wireless
  • [GET] /monitoring/v1/clients/wired
  • site parameter is introduced to filter the APIs by site name.
  • To retrieve clients beyond 10,000, use the last_client_mac parameter to fetch the next set of clients.

Topology

  • [GET] /{site_id}

Following fields are added/modified in the response:

  • [GET] /devices/{device_serial}
  • In alignment with the redesign of HPE engineering terminology, the term Master in the API response changed to Conductor.