Legal Disclaimer: The resource assets in this website may include abbreviated and/or legacy terminology for HPE Aruba Networking products. See www.arubanetworks.com for current and complete HPE Aruba Networking product lines and names.
New 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. introduced in the current release:
|
New API |
Description |
|---|---|
|
Authentication & Policy > Client Policy |
|
|
This API is introduced to reset the client policies to default. You have the option to delete the MAC Media Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network. data during the reset process, by setting the deleteMAC parameter value to true. |
|
Authentication & Policy > User Policy |
|
|
This API is introduced to reset the user policies to default for the 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. administrator account. You have the option to delete all MPSK data during the reset process, by setting the deleteMPSK parameter value to true. |
|
|
|
|
|
This API is introduced to download information of all MPSK networks. Based on the MPSK SSID Service Set Identifier. SSID is a name given to a WLAN and is used by the client to access a WLAN network. and filters entered in the parameter, the CSV Comma-Separated Values. A file format that stores tabular data in the plain text format separated by commas. file downloaded will contain information about MPSK networks. Due to Swagger 2.0 limitation, it does not recognize API response with octet-streaming for downloaded file. Hence, you cannot run this API in Swagger 2.0. You can use a command line interface or an admin UI to run this API. |
|
|
This API is introduced to download information of all MAC registrations. Based on the filters entered in the parameter, the CSV file downloaded will contain information about MAC registrations. Due to Swagger 2.0 limitation, it does not recognize API response with octet-streaming for downloaded file. Hence, you cannot run this API in Swagger 2.0. You can use a command line interface or an admin UI to run this API. |
|
|
|
|
|
This API is introduced to fetch configuration information of all MPSK networks. |
|
|
This API is introduced to configure a new MPSK network. |
|
|
This API is introduced to remove the configuration of an MPSK network. |
|
|
This API is introduced to get configuration information of an MPSK network. |
|
|
This API is introduced to update the |
|
|
This API is introduced to get configuration information of all Named MPSK. Named MPSKs are MPSKs that are not associated with any user. |
|
|
This API is introduced to configure a new Named MPSK in a MPSK network. |
|
|
This API is introduced to delete a Named MPSK in an MPSK network. |
|
|
This API is introduced to get configuration information of a Named MPSK. |
|
|
This API is introduced to partially modify a few configuration parameters of a Named MPSK. It is not required for you to provide all the parameter values. |
|
|
This API is introduced to fully modify all the configuration parameters of a Named MPSK. You must provide all the parameter values to call this API. |
|
|
This API is introduced to fetch the MPSK usage statistics for all the MPSK networks. |
|
|
|
|
|
This API is introduced to create multiple resources based on the upload_type selected. The upload_type can be either mpsk or mac. |
|
|
This API is introduced to fetch error information of the most recent file upload operation. Due to Swagger 2.0 limitation, it does not recognize API response with octet-streaming for error file. Hence, you cannot run this API in Swagger 2.0. You can use a command line interface or an admin UI to run this API. |
|
|
This API is introduced to fetch status information of the most recent file upload operation. |
|
|
This API is introduced to terminate and clear status information of the most recent upload operation. After executing this API, you cannot retrieve the status information of the most recent upload operation. |
|
|
|
|
|
This API is introduced to get the information of all registered clients. In the response the
|
|
|
This API is introduced to register a new client.
|
|
|
This API is introduced to delete a registered client. |
|
|
This API is introduced to update the client_name for a registered client. |
|
|
|
|
|
This API is introduced to fetch certificate information assigned to a user. The user can be identified using any one of the following input parameters:
|
|
|
This API is introduced to revoke certificate assigned to a user's device. |
|
|
|
|
|
This API is introduced to delete the Cloud VPN Virtual Private Network. VPN enables secure access to a corporate network when located remotely. It enables a computer to send and receive data across shared or public networks as if it were directly connected to the private network, while benefiting from the functionality, security, and management policies of the private network. This is done by establishing a virtual point-to-point connection through the use of dedicated connections, encryption, or a combination of the two. Connect Service endpoint configurations for custom cloud provider. |
|
|
This API is introduced to create the Cloud VPN Connect Service endpoint configurations for custom cloud service provider. |
|
|
This API is introduced to update and modify the Cloud VPN Connect Service endpoint configurations for custom cloud service provider. |
|
|
This API is introduced to delete the Cloud VPN Connect Service endpoint configurations for Zscaler cloud service provider. |
|
|
This API is introduced to create the Cloud VPN Connect Service endpoint configurations for Zscaler cloud service provider. |
|
|
This API is introduced to update and modify the Cloud VPN Connect Service endpoint configurations for Zscaler cloud service provider. |
|
|
This API is introduced to delete the Cloud VPN Connect Service endpoint configurations for AWS cloud service provider. |
|
|
This API is introduced to create the Cloud VPN Connect Service endpoint configurations for AWS cloud service provider. |
|
|
This API is introduced to update and modify the Cloud VPN Connect Service endpoint configurations for AWS cloud service provider. |
|
|
This API is introduced to delete the Cloud VPN Connect Service endpoint configurations for Azure cloud service provider. |
|
|
This API is introduced to create the Cloud VPN Connect Service endpoint configurations for Azure cloud service provider. |
|
|
This API is introduced to update and modify the Cloud VPN Connect Service endpoint configurations for Azure cloud service provider. |
|
|
This API is introduced to scan and identify the cloud service provider endpoints. |
|
|
This API is introduced to fetch all the Cloud VPN Connect Service endpoint configurations. |
|
|
This API is introduced to fetch the list of all zscaler node endpoints. |
|
|
This API is introduced to fetch the list containing all the VLAN Virtual Local Area Network. In computer networking, a single Layer 2 network may be partitioned to create multiple distinct broadcast domains, which are mutually isolated so that packets can only pass between them through one or more routers; such a domain is referred to as a Virtual Local Area Network, Virtual LAN, or VLAN. IDs and VLAN names of a site. |
|
|
This API is introduced to fetch the list of all Cloud connect configurations of each group. |
|
|
This API is introduced to fetch the list of valid Tunnel Policy configurations. |
|
|
This API is introduced to delete a Tunnel Policy using the policy name. |
|
|
This API is introduced to fetch the Tunnel Policy configurations for the specified policy name. The |
|
|
This API is introduced to create a Tunnel Policy. The |
|
|
This API is introduced to update a Tunnel Policy. The |
|
|
|
|
|
This API is introduced to update the site installation status to either Complete or In Progress. Values for mark_as_completed parameter:
You can mark the status of a site as Complete even if Install Manager was not used to install or onboard the device. |
|
For more information on classification criteria, see Configure RAPIDS. |
|
|
|
This API is introduced to fetch the complete global RAPIDS configuration. |
|
|
This API is introduced to create a complete global RAPIDS configuration. |
|
|
This API is introduced to update a complete global RAPIDS configuration. |
|
|
This API is introduced to delete a complete global RAPIDS configuration. |
|
|
This API is introduced to fetch all classification rules. |
|
|
This API is introduced to fetch information on a classification rule by rule_name. |
|
|
This API is introduced to create a classification rule by rule_name. |
|
|
This API is introduced to create or modify a classification rule by rule_name. |
|
|
This API is introduced to delete a classification rule by rule_name. |
|
|
This API is introduced to fetch information of match_criteria for a given classification rule_name. |
|
|
This API is introduced to create a match_criteria for a given classification rule_name. |
|
|
This API is introduced to create or update a match_criteria for a given classification rule_name. |
|
|
This API is introduced to delete all match_criteria for a given classification rule_name. |
|
|
This API is introduced to fetch information for all sites in the site-excludes list for a given classification rule_name. |
|
|
This API is introduced to fetch information of a site by name in the site-excludes list for a given classification rule_name. |
|
|
This API is introduced to create or update a site by name in the site-excludes list for a given classification rule_name. The same site must not be specified in both site_includes and site_excludes API. |
|
|
This API is introduced to create sites by name in the site-excludes list for a given classification rule_name. The same site must not be specified in both site_includes and site_excludes API. |
|
|
This API is introduced to delete sites by name in the site-excludes list for a given classification rule_name. The same site must not be specified in both site_includes and site_excludes API. |
|
|
This API is introduced to fetch information for all sites in the site-Includes list for a given classification rule_name. |
|
|
This API is introduced to fetch information of sites by name in the site-includes list for a given classification rule_name. |
|
|
This API is introduced to create or update sites by name in the site-includes list for a given classification rule_name. The same site must not be specified in both site_includes and site_excludes API. |
|
|
This API is introduced to create sites by name in the site-includes list for a given classification rule_name. The same site must not be specified in both site_includes and site_excludes API. |
|
|
This API is introduced to delete sites by name in the site-includes list for a given classification rule_name. The same site must not be specified in both site_includes and site_excludes API. |
|
|
This API is introduced to fetch information for all SSIDs in the ssid_excludes list for a given classification rule_name. |
|
|
This API is introduced to fetch information of an ESSID Extended Service Set Identifier. ESSID refers to the ID used for identifying an extended service set. in the ssid_excludes list for a given classification rule_name. |
|
|
This API is introduced to create an ESSID in the ssid_excludes list for a given classification rule_name. |
|
|
This API is introduced to create or update an ESSID in the ssid_excludes list for a given classification rule_name. |
|
|
This API is introduced to deleted an ESSID in the ssid_excludes list for a given classification rule_name. |
|
|
This API is introduced to fetch information all SSIDs in the ssid_includes list for a given classification rule_name. |
|
|
This API is introduced to fetch information of an ESSID in the ssid_includes list for a given classification rule_name. |
|
|
This API is introduced to create an ESSID in the ssid_includes list for a given classification rule_name. |
|
|
This API is introduced to create or update an ESSID in the ssid_includes list for a given classification rule_name. |
|
|
This API is introduced to deleted an ESSID in the ssid_includes list for a given classification rule_name. |
|
GeoFence is a virtual perimeter surrounding a physical location. |
|
|
|
This API is introduced to get the status of the GeoFence feature. |
|
|
This API is introduced to enable the GeoFence feature |
|
|
This API is introduced to disable the GeoFence feature. |
To view the APIs introduced in previous releases, see APIs Introduced In Previous Releases.