API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Update existing AP system profile configurations

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/ap-system/

Defines a single AP System profile containing all system-level configurations for one or more
Access Points. Each entity is identified by name. Use these APIs to create, modify, or delete
an instance.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

System profile name.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

gps
object

Configure parameters for GPS (Global Positioning System) function.
Available on firmware versions 8.10.0 to 10.0.0, and 10.4.0 and later.

lci
object

Location Coordinate Information (LCI) configuration on AP.

barometer
object

Barometric pressure sensor configuration.

cop
object

Central On-Prem(COP) configuration. Use this API to retrieve the list of Central On-Prem(COP) server profiles.

aaa
object

Group for AP specific system level authentication configurations.

boolean
Defaults to false

Enable or disable the advanced zone feature that can configure up to 32 SSIDs.
Since the mapping method of the WLAN index and BSSID index are different,
when you change the advanced zone configuration, the BSSID is removed and created again.
When advanced zone is enabled:
The WLAN SSID profile will remain inactive without the zone.
The WLAN SSID profile will remain inactive without the zone.
A zone can be assigned to a maximum of up to 16 SSIDs.
However, if the extended SSID is disabled,
a zone can be assigned to a maximum of up to 14 SSIDs wherein the first two virtual APs are reserved for mesh.

boolean
Defaults to true

Control AP to enable/disable 'Over the Air AP Rescue' feature. This feature is enabled by default.
'Over the Air AP Rescue' feature controls AP to broadcast the AP health IE through the wireless SSIDs.
The AP health IE contains many flags that can reflect current AP status like uplink status,
Central connectivity status. Once AP lost Central connection, this AP health IE can be broadcast through
wireless beacons so that our Aruba APs nearby can hear this beacon and send the AP health IE to Central.
This will allow the user or engineer to understand the status of the issue AP and take measures to rescue it.

boolean
Defaults to false

Enable advertising location info in beacon frame.
Disable by default.

boolean
Defaults to false

Enable airslice policy

boolean

Allows the new access points to join the AP cluster. This API is AOS8 specific.

string
length between 1 and 256

Alias for allow new aps. This API is AOS8 specific

allowed-ap
array of strings
length ≤ 2147483647
allowed-ap
boolean
Defaults to false

Enables application monitoring on the AP.
Available on firmware versions 8.6.0 to 8.11.99 only.

cluster-security
object

Cluster Security DTLS configuration for IAP.
Enabling cluster-security dtls will form Datagram TLS connection between Conductor and Member APs.

boolean

Provisions the Instant AP as a conductor Instant AP. This API is AOS8 specific.

boolean
Defaults to false

Content filtering configuration at system level.
This option control access to websites and applications based on their content, adding more security.

string
length between 1 and 4

Defines the country of operation of an AP.

string
length between 1 and 256

Alias for virtual controller country code.

boolean
Defaults to false

Deny local routing.

string
length between 1 and 256

System profile description.

string
enum

Configure DHCP Option 82 XML file. The AP inserts circuit and remote ID information
into DHCP requests from clients.

Show Details
DEFAULT_DHCPOPT82_1_XMLDefault DHCP Option 82 XML file 1. Values for Circuit and Remote ID's are as follows: Circuit ID: AP Name, AP MAC Address, Extended AP MAC Address, Remote ID: User's MAC Address.
DEFAULT_DHCPOPT82_2_XMLDefault DHCP Option 82 XML file 2. Values for Circuit and Remote ID's are as follows: Circuit ID: AP MAC Address, Extended AP MAC Address, SSID Tunnel, Remote ID: User's MAC Address.
DEFAULT_DHCPOPT82_3_XMLDefault DHCP Option 82 XML file 3. Values for Circuit and Remote ID's are as follows: Circuit ID: User's MAC Address, Remote ID: AP Name, Extended AP MAC Address.
NONENo DHCP Option 82 XML file will be used.
Allowed:
string
length ≤ 9999

VLAN or VLAN range for which DHCP Option 82 XML applies. Allowed values: a single VLAN (1-4094)
or a range (e.g., 10-100). This leaf can only be configured when dhcp-option82-xml is set to a valid XML file.

boolean
Defaults to false

Disable the factory reset function on the AP. Prevent the manual hard reset to factory default by pressing
down reset button for 5 seconds.

boolean
Defaults to false

Disable the automatic download and installation of DRT updates on the AP managed by Aruba Central.

string
enum
Defaults to AUTO

Enable/Disable Dynamic CPU management to manage resources across different functions performed by an AP.

Show Details
AUTOConfigure the AP to automatically enable or disable CPU management feature during run-time. When configured, the AP determines the need for enabling or disabling CPU management, based on the real-time load calculations taking into account all different functions that the CPU needs to perform. The auto option is the default and recommended setting.
DISABLEDisable the CPU management feature, typically for small networks. This setting protects the user experience.
ENABLEEnable the CPU management feature. When configured, the client and network management functions are protected. This setting helps in large networks with a high client density.
Allowed:
int32
1 to 4093

Configures VLAN for the upstream switch to which the AP is connected.

boolean
Defaults to true

This command allows you to configure additional WLAN SSIDs.
Extended SSID is enabled in the factory default settings of APs.

boolean
Defaults to false

Controls first hop security features on the AP. When enabled, security features are active.
Available on firmware versions 10.7.1 and later.
By default these security features are enabled on the AP.

string
enum

Selects the IP mode for packet processing.
IPV4_ONLY processes only IPv4 packets; IPV4_PREFER prioritizes IPv4 over IPv6.

Show Details
IPV4_ONLYEnables system processing of IPv4 packets.
IPV4_PREFERPrefer IPv4 packets.
Allowed:
boolean
Defaults to false

Enable Intelligent Thermal Management(ITM) on the AP. When enabled, certain operations of the
AP will be throttled down to reduce its internal temperature. The limitations of AP operations
is defined by the priority assigned for reduction steps configured in Intelligent Power Monitoring(IPM)
API. IPM must be enabled for ITM to function.

string
enum
Defaults to AUTO

Enable/Disable/Remove the static LACP(Link Aggregation Control Protocol) configuration.
When an AP boots up, it forms the LACP according to the static configuration.

Show Details
AUTOThis parameter enables the dynamic LACP configuration. The AP will work on LACP mode only if the peer switch works on.
DISABLEThis parameter disables the static LACP configuration. The AP will not work on LACP mode even it detects any LACP PDUs from the peer switch.
ENABLEThis parameter enables the static LACP configuration. The AP will work on LACP mode irrespective of whether or not the peer switch works on the LACP mode.
Allowed:
boolean
Defaults to true

Enable LED display on an AP.

boolean
Defaults to false

Override the LED action for LED operation mode normal.

string
length between 1 and 32

Device location information.

boolean

Enables mobility Access Switch integration on an AP.

module
array of objects
length ≤ 2147483647

List of logging module configurations for specifying severity levels by type, process,
and subcategory. Capacity constraints apply on a per-context basis.

module
int32
1024 to 1500
Defaults to 1300

Configure the MTU size for tunnel and br0 interfaces, and uplink interface such as 3G or 4G.
The configured MTU size is applied when the uplink changes.

string
length between 1 and 256

System profile name.

int64
1 to 300
Defaults to 30

Configure a hold on time in seconds, after which out-of-service operation is triggered.
For example, if the Internet is unreachable, the effect of this out-of-service state impacts the SSID
availability after the configured hold on time.

boolean
Defaults to false

Enable optimization minimizes the POE draw of the AP and may disable some parts of the AP. The USB
and Ethernet port (eth1) are shut down on the AP when this option is enabled. The AP will operate in
the full power mode when this option is disabled. It is disabled by default on the AP.

int32
3 to 300
Defaults to 3

Configures the backoff time in minutes before bringing up the recovery SSID.
When the AP disconnects from Central, the recovery SSID will be brought up after this backoff period.
The recovery SSID type can be configured in the wlan-ssid profile and provides access to the AP's troubleshooting interface.

restricted-access
array of objects
length ≤ 2147483647

Restricted management configuration.

restricted-access
summer-time
object

Set the software clock to begin and end daylight saving time on a recurring basis.

swarm-mode
object

Provision an Instant AP in the standalone, single AP, or cluster mode. This API is AOS8 specific.

int32
1 to 4094

System-VLAN for Microbranch AP. This is L3-Enabled VLAN, mapped to IPMS-system-IP-Pool.
IPMS service will use this VLAN-id, allocate a /32 IP from the corresponding system-ip-pool,
and populate the inner-ip field in ap-system profile for each Microbranch AP.

timezone
object

Timezone configuration.

boolean
Defaults to true

Controls TX blanking for Ultra Tri-Band (UTB) channel scanning. When enabled, resolves 5GHz/6GHz co-existence interference.
Available only on models: AP-735A, AP-755A.

boolean
Defaults to false

Disable USB port.

boolean
Defaults to false

Enable USB power override.

string
length between 1 and 256

Alias for virtual controller dnsip. This API is AOS8 specific.

string
length between 1 and 256

Alias for virtual controller ip. This API is AOS8 specific.

string
length between 1 and 256

Alias for virtual controller ipv6. This API is AOS8 specific.

string
length between 1 and 256

Alias for virtual controller name.

string
length between 1 and 256

Alias for virtual controller vlan. This API is AOS8 specific.

string
length ≤ 9999

Configures the DNS IP address for the virtual controller. This API is AOS8 specific.

string
length ≤ 9999

Assigns an IPv4 address to the virtual controller for AP management. Available on firmware
versions up to 10.0.0. This setting is specific to AOS8 platforms.

string
length ≤ 9999

Assigns an IPv6 address to the virtual controller for AP management. Available on firmware
versions up to 10.0.0. This setting is specific to AOS8 platforms.

string
length between 1 and 64

Defines a unique name for the virtual controller.

virtual-controller-vlan
object

Configures the virtual controller settings. This API is AOS8 specific.

boolean
Defaults to false

Trusted Qos for UCC applications.

zonename
array of strings
length ≤ 2147483647
zonename
Responses

Updated 11 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago