Modified APIs

The following table lists the APIs Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. modified in the current release:

Table 1: Modified APIs

Modified API

Description

Authentication & Policy > Authentication and Session

  • [GET] /cloudAuth/api/v1/auth/cloud_identity/list

A new parameter mpskName is added in the response. The mpskName parameter displays the name of the Named MPSK Multi Pre-Shared Key. The Cloud Authentication and Policy server enables MPSK in a WLAN network in Aruba Central, to provide seamless wireless network connection to the end-users and client devices..

  • [GET] /cloudAuth/api/v1/auth/{request_id}

A new parameter mpskName is added in the response. The mpskName parameter displays the name of the Named MPSK.

In the response body additional certificate information is displayed only when a certificate is applied.

Authentication & Policy > Client Policy

  • [GET]/cloudAuth/api/v1/client_policy
  • [PUT]/cloudAuth/api/v1/client_policy

A new parameter allow_all_mac_auth is added to the body.

On setting the allow_all_mac_auth parameter to true allows the following:

You can disable the allow_all_mac_auth parameter at any time.

Authentication & Policy > Client Registration

In the response a new parameter auto_created is added. The auto_created parameter displays the following value:

  • True—Indicates the client's MAC address is registered automatically in the database. To automatically register the client's MAC Address, you must set the allow_all_mac_auth parameter value to true.
  • False—Indicates the client's MAC address is registered in the database manually by an administrator.

Authentication & Policy > User Policy

  • [GET]/cloudAuth/api/v1/user_policy
  • [PUT]/cloudAuth/api/v1/user_policy

A new parameter client_profile_tag is added to the body.

On setting a valid client tag, you can configure the user policy with a rule to include the client_profile_tag along with the user group and client role.

If client_profile_tag is not specified, the default value is set to Any in the user policy rule. This is an optional parameter.

Configuration > Certificates

The string entered in the passphrase parameter is encoded with base64 encoding scheme.

  • [PUT] /configuration/v1/non_msp/certificate

This API is used to update certificates for non MSP Managed Service Provider. The Managed Service Provider (MSP) mode is a multi-tenant operational mode that Aruba Central accounts can be converted into, provided these accounts have subscribed to the Aruba Central app. customers.

The string entered in the passphrase parameter is encoded with base64 encoding scheme.

 

Configuration > Device

  • [GET] /configuration/v1/devices/{device_serial}/group
  • [GET] /configuration/v1/devices/{device_serial}/configuration
  • [GET] /configuration/v1/devices/{device_serial}/config_details
  • [GET] /configuration/v1/devices/{device_serial}/variablised_template

A user can fetch device information using these APIs if the following criteria are fulfilled:

  • The serial number entered in the device_serial field must belong to a group scope that is part of the group set assigned to the user.

For more information about managing users and roles in the HPE GreenLake portal, see the Manage section in the HPE GreenLake Edge to Cloud Platform User Guide.

https://support.hpe.com/hpesc/public/docDisplay?docId=a00120892en_us

Configuration > MM-MD

  • [POST] /configuration/v1/devices/{device_serial}/recover_device

A user can fetch device information using these APIs if the following criteria are fulfilled:

  • Built-In role or custom role assigned to the user must have Edit access to the NMS Service Configuration application. If user is assigned with Aruba Central Administrator built-in role, then the user has View and Edit access to all Aruba Central applications.
  • User must be assigned with a group set having at least one group scope or allgroup. To assign a group set, toggle the switch next to Limit Resource Access and select the group set from the Resource Restriction Policy* drop-down list.

    NOTE: Group set must be assigned to a role (built-in role or custom role). If Limit Resource Access is not enabled, then by default all groups are assigned to the user.

  • The serial number entered in the device_serial field must belong to a group scope that is part of the group set assigned to the user.

For more information about managing users and roles in the HPE GreenLake portal, see the Manage section in the HPE GreenLake Edge to Cloud Platform User Guide.

Configuration > WLAN Configuration

The APIs are updated to support Enhanced Open Authentication.

Enhanced Open Authentication provides improved data encryption in open Wi-Fi Wi-Fi is a technology that allows electronic devices to connect to a WLAN network, mainly using the 2.4 GHz and 5 GHz radio bands. Wi-Fi can apply to products that use any 802.11 standard. networks and protects data from sniffing attacks. To set the SSID Service Set Identifier. SSID is a name given to a WLAN and is used by the client to access a WLAN network. to Enhanced Open mode, configure the following:

  • Keep the vwpa_passphrase parameter value empty
  • Set the wpa_passphrase_changed parameter value to true
  • Set the type to employee

Firmware

AOS-CX switches now support the following APIs in the Firmware category.

  • [GET] /firmware/v1/devices
  • [GET] /firmware/v1/devices/{serial}
  • [GET] /firmware/v1/versions
  • [GET] /firmware/v1/versions/{firmware_version}
  • [GET] /firmware/v1/status
  • [POST] /firmware/v1/upgrade
  • [POST] /firmware/v1/upgrade/cancel
  • [GET] /firmware/v2/upgrade/compliance_version
  • [DELETE] /firmware/v2/upgrade/compliance_version
  • [GET] /firmware/v1/upgrade/compliance_version
  • [POST] /firmware/v1/upgrade/compliance_version
  • [POST] /firmware/v1/msp/upgrade
  • [POST] /firmware/v1/msp/upgrade/customers/{customer_id}
  • [POST] /firmware/v1/msp/upgrade/cancel
  • [POST] /firmware/v1/msp/upgrade/customers/{customer_id}/cancel
  • [POST] /firmware/v2/msp/upgrade/cancel
  • [POST] /firmware/v2/msp/upgrade/customers/{customer_id}/cancel
  • [GET] /firmware/v1/models
  • [DELETE] /firmware/v1/msp/upgrade/compliance_version
  • [GET] /firmware/v1/msp/upgrade/compliance_version
  • [POST] /firmware/v1/msp/upgrade/compliance_version
  • [DELETE] /firmware/v1/msp/upgrade/customers/{customer_id}/compliance_version
  • [GET] /firmware/v1/msp/upgrade/customers/{customer_id}/compliance_version
  • [POST] /firmware/v1/msp/upgrade/customers/{customer_id}/compliance_version
  • [GET] /firmware/v1/msp/tenants/{tenant_id}

These APIs are modified to extend support on AOS-CX switches.

 

Monitoring > Switch

Monitoring > Gateway

Using the APIs, a user can fetch Switch or Gateway related information if the following criteria are fulfilled:

  • Built-In role or custom role must have at least View access for the NMS Service application. If user is assigned with Aruba Central Administrator built-in role, then the user has View and Edit access to all Aruba Central applications.
  • Input parameters such as device serial number, group name, label name, etc., must belong to a group scope that is part of the group set assigned to the user. To assign a group set, toggle the switch next to Limit Resource Access and select a Resource Restriction Policy* drop-down list.

    NOTE: Group set must be assigned to a role (built-in role or custom role). If Limit Resource Access is not enabled, then by default all groups are assigned to the user role.

For more information about managing users and roles in the HPE GreenLake portal, see the Manage section in the HPE GreenLake Edge to Cloud Platform User Guide.

New Device Inventory > Devices

  • [GET] /platform/device_inventory/v1/devices

A new parameter subscription_b is added to the response sample.

The subscription_key parameter displays the subscription key information to which the device is assigned.

New Licensing

  • [GET] /platform/licensing/v1/subscriptions

New filter parameters subscription_key and device_type are added.

  • subscription_key—Enter the subscription key information. The response will display the following:
    • Total—Displays the total number of devices that can associate with the subscription key.
    • Available—Displays the number of devices that can associate with the subscription key based on the current usage.
  • device_type—Select the device type from the drop-down list.

To view the APIs modified in previous releases, see APIs Modified In Previous Releases.