upgrade¶
Upgrade System
upgrade Specification¶
Type operational Element Name upgrade Element URI /axapi/v3/upgrade Element Attributes upgrade_attributes Schema upgrade schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
EXECUTE Object | POST | /axapi/v3/upgrade |
upgrade attributes¶
cf
Description: cf is a JSON Block. Please see below for cf
Type: Object
Reference Object: /axapi/v3/upgrade/cf
gui
Description: gui is a JSON Block. Please see below for gui
Type: Object
Reference Object: /axapi/v3/upgrade/gui
hd
Description: hd is a JSON Block. Please see below for hd
Type: Object
Reference Object: /axapi/v3/upgrade/hd
gui¶
Specification Type object delete
Description Delete one local GUI image
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
file-url
Description File URL
Type: string
Format: url
Mutual Exclusion: file-urllocal, rollback, file-url and image-file are mutually exclusive
gui-upload
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
image
Description ‘pri’: Primary image; ‘sec’: Secondary image;
Type: string
Supported Values: pri, sec
image-file
Description
Type: string
Format: string-rlx
Mutual Exclusion: image-filelocal, rollback and file-url are mutually exclusive
local
Description Local GUI image name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: local file-url and image-file are mutually exclusive
remote-url
Description
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
rollback
Description Rollback to a specific local GUI image
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: rollbackuse-mgmt-port, source-ip-address, show-percentage, save-gui, upload, file-url and image-file are mutually exclusive
source-ip-address
Description Source IP address
Type: string
Format: ipv4-address
Mutual Exclusion: source-ip-address rollback and use-mgmt-port are mutually exclusive
upload
Description Upload GUI image from remote
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: upload and rollback are mutually exclusive
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: use-mgmt-port rollback and source-ip-address are mutually exclusive
cf¶
Specification Type object Device
Description
Type: number
file-url
Description File URL
Type: string
Format: url
Mutual Exclusion: file-url local and image-file are mutually exclusive
image
Description ‘pri’: Primary image;
Type: string
Supported Values: pri
image-file
Description
Type: string
Format: string-rlx
Mutual Exclusion: image-file local and file-url are mutually exclusive
local
Description Use image from local VCS image repository (Specify an image name, format: aximage_XX_XX_XX_XX.tar.gz)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: localuse-mgmt-port, show-percentage, file-url and image-file are mutually exclusive
reboot-after-upgrade
Description reboot system after upgrade is done
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
staggered-upgrade-mode
Description in staggered upgrade mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: use-mgmt-port and local are mutually exclusive
hd¶
Specification Type object Device
Description
Type: number
file-url
Description File URL
Type: string
Format: url
Mutual Exclusion: file-urllocal, rollback and image-file are mutually exclusive
image
Description ‘pri’: Primary image; ‘sec’: Secondary image;
Type: string
Supported Values: pri, sec
image-file
Description
Type: string
Format: string-rlx
Mutual Exclusion: image-filelocal, rollback and file-url are mutually exclusive
local
Description Use image from local VCS image repository (Specify an image name, format: aximage_XX_XX_XX_XX.tar.gz)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: localuse-mgmt-port, source-ip-address, show-percentage, file-url and image-file are mutually exclusive
reboot-after-upgrade
Description reboot system after upgrade is done
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rollback
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: rollbackuse-mgmt-port, source-ip-address, show-percentage, file-url and image-file are mutually exclusive
source-ip-address
Description Source ip address
Type: string
Format: ipv4-address
Mutual Exclusion: source-ip-addresslocal, rollback and use-mgmt-port are mutually exclusive
staggered-upgrade-mode
Description in staggered upgrade mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: use-mgmt-portlocal, rollback and source-ip-address are mutually exclusive