Upgrade EdgeConnect appliances with ECOS firmware

post

http://127.0.0.1:8080/upgradeAppliances

Initiates an asynchronous upgrade operation for one or more EdgeConnect appliances. The upgrade can use images from Aruba Portal, locally uploaded images, or external URLs. For HA pairs, upgrades are coordinated sequentially with a 5-minute wait between peers. Returns a clientKey for tracking progress via polling.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Upgrade configuration specifying target appliances, image source, and installation behavior.

Configuration for initiating an appliance upgrade operation.

fromPortal

boolean

Defaults to false

If true, the image is downloaded from Aruba Cloud Portal. Requires valid Portal registration.

imageName

string

required

Image filename for local/Portal images, or full URL when usingUrl is true. For local images, must exist in ftp/images directory.

installOption

string

enum

required

Determines post-installation behavior. install_only: Install but don't activate. install_switch: Install and set as next boot. install_reboot: Install, switch, and reboot immediately.

Allowed:

nePks

array of objects

List of appliance identifiers (nePks).

nePks

usingUrl

boolean

Defaults to false

If true, imageName contains an external URL to download the image from.

version

string

required

Target ECOS version including build number (format: x.x.x.x_build).

applianceImageId

string

Portal image ID for Portal-based upgrades. Used internally for download link generation.

randomString

string

Portal download token. Set automatically when fromPortal is true.

fromDiscovery

boolean

Defaults to false

If true, targets discovered (not yet managed) appliances using discoveryIds instead of nePks.

discoveryIds

array of strings

List of discovery IDs for upgrading discovered appliances. Required when fromDiscovery is true.

discoveryIds

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Upgrade initiated successfully. Returns a client key for polling upgrade progress.

400Bad request due to validation errors.

500Internal server error during VXOA upgrade.