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

Create firmware policy configuration.

post
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/firmware-compliance

Firmware Policy configuration allows centralized control over firmware versions of all devices
including APs, switches, and gateways across various scopes. Firmware upgrade APIs will function consistently
in Central On-Prem deployments. In Central Cloud, API behavior may vary based on the customer’s deployment mode
and the device type. Full API support is available for the 5G Bridge device type while support for other
device types may differ.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

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

string

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

string

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

Body Params

firmware-compliancebody object

Firmware Policy configuration allows centralized control over firmware versions of all devices
including APs, switches, and gateways across various scopes. Firmware upgrade APIs will function consistently
in Central On-Prem deployments. In Central Cloud, API behavior may vary based on the customer’s deployment mode
and the device type. Full API support is available for the 5G Bridge device type while support for other
device types may differ.

string
enum
Defaults to PRIMARY

Partition to upgrade

Show Details
PRIMARYPrimary partition
SECONDARYSecondary partition
Allowed:
boolean
Defaults to false

Enable non-failsafe module upgrade of CX switches. Ensure that the switch will not lose power, be rebooted again, or have any modules removed until all updates have finished

string
length between 1 and 255

User maintained description for the firmware policy. System does not validate this for duplicates

boolean
Defaults to true

Enable or Disable Firmware Policy configuration. If not enabled, firmware policy configuration
will not be inherited from parent scope configuration for this or any scope/device under this scope.

enforcement-schedule
object

Info related to scheduled firmware upgrade

string
length between 1 and 255

Local image download server URL to use instead of general image server

string
length between 1 and 63

User maintained name for the firmware policy. System does not validate this for duplicates

string
enum
Defaults to REGULAR

Hitless/Live upgrade or regular upgrade

Show Details
LIVELive/Hitless Upgrade for AP and Gateway
REGULARRegular Upgrade
Allowed:
version-chart
object

Firmware Version Chart

Responses

Updated 6 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 6 days ago