{
    "id":"/axapi/v3/upgrade",
    "type":"object",
    "node-type":"intermediate",
    "title":"upgrade",
    "operation-not-allowed": ["PUT", "POST", "DELETE"],
    "partition-visibility":"shared",
    "operational":1,
    "description":"Upgrade System",
    "properties":{
        "hd":{
            "type":"object",
            "$ref":"/axapi/v3/upgrade/hd",
            "properties":{
                "image":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'pri': Primary image; 'sec': Secondary image; ",
                    "enum":[
                        "pri",
                        "sec"
                    ]
                },
                "local":{
                    "type":"string",
                    "format":"string",
                    "plat-neg-list":["tps"],
                    "minLength":1,
                    "maxLength":128,
                    "partition-visibility":"shared",
                    "not-list":[ "use-mgmt-port", "source-ip-address", "show-percentage", "file-url", "image-file" ],
                    "description":"Use image from local VCS image repository (Specify an image name, format: aximage_XX_XX_XX_XX.tar.gz)"
                },
                "rollback":{
                    "type":"number",
                    "format":"flag",
                    "plat-neg-list":["tps"],
                    "default":0,
                    "partition-visibility":"shared",
                    "not-list":[ "use-mgmt-port", "source-ip-address", "show-percentage", "file-url", "image-file" ]
                },
                "use-mgmt-port":{
                    "type":"number",
                    "format":"flag",
                    "plat-neg-list":["softax-aws"],
                    "default":0,
                    "partition-visibility":"shared",
                    "not-list":[ "local", "rollback", "source-ip-address" ],
                    "description":"Use management port as source port"
                },
                "source-ip-address":{
                    "type":"string",
                    "format":"ipv4-address",
                    "partition-visibility":"shared",
                    "not-list":[ "local", "rollback", "use-mgmt-port" ],
                    "description":"Source ip address"
                },
                "file-url":{
                    "type":"string",
                    "format":"url",
                    "partition-visibility":"shared",
                    "not-list":[ "local", "rollback", "image-file" ],
                    "description":"File URL"
                },
                "image-file":{
                    "type":"string",
                    "format":"string-rlx",
                    "partition-visibility":"shared",
                    "not-list":[ "local", "rollback", "file-url" ]
                },
                "staggered-upgrade-mode":{
                    "type":"number",
                    "format":"flag",
                    "plat-neg-list":["tps"],
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"in staggered upgrade mode"
                },
                "Device":{
                    "type":"number",
                    "format":"number",
                    "platform-specific-range":1,
                    "platform-specific-default":1,
                    "partition-visibility":"shared"
                },
                "reboot-after-upgrade":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"reboot system after upgrade is done"
                }
            }
        },
        "cf":{
            "type":"object",
            "$ref":"/axapi/v3/upgrade/cf",
            "properties":{
                "image":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'pri': Primary image; ",
                    "enum":[
                        "pri"
                    ]
                },
                "local":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":128,
                    "partition-visibility":"shared",
                    "not-list":[ "use-mgmt-port", "show-percentage", "file-url", "image-file" ],
                    "description":"Use image from local VCS image repository (Specify an image name, format: aximage_XX_XX_XX_XX.tar.gz)"
                },
                "use-mgmt-port":{
                    "type":"number",
                    "format":"flag",
                    "plat-neg-list":["softax-aws"],
                    "default":0,
                    "partition-visibility":"shared",
                    "not":"local",
                    "description":"Use management port as source port"
                },
                "file-url":{
                    "type":"string",
                    "format":"url",
                    "partition-visibility":"shared",
                    "not-list":[ "local", "image-file" ],
                    "description":"File URL"
                },
                "image-file":{
                    "type":"string",
                    "format":"string-rlx",
                    "partition-visibility":"shared",
                    "not-list":[ "local", "file-url" ]
                },
                "staggered-upgrade-mode":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"in staggered upgrade mode"
                },
                "Device":{
                    "type":"number",
                    "format":"number",
                    "platform-specific-range":1,
                    "platform-specific-default":1,
                    "partition-visibility":"shared"
                },
                "reboot-after-upgrade":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"reboot system after upgrade is done"
                }
            }
        },
        "gui":{
            "type":"object",
            "$ref":"/axapi/v3/upgrade/gui",
            "properties":{
                "image":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'pri': Primary image; 'sec': Secondary image; ",
                    "enum":[
                        "pri",
                        "sec"
                    ]
                },
                "local":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":128,
                    "partition-visibility":"shared",
                    "not-list":[ "file-url", "image-file" ],
                    "description":"Local GUI image name"
                },
                "remote-url":{
                    "type":"string",
                    "format":"string-rlx",
                    "minLength":1,
                    "maxLength":128,
                    "partition-visibility":"shared"
                },
                "rollback":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":128,
                    "partition-visibility":"shared",
                    "not-list":[ "use-mgmt-port", "source-ip-address", "show-percentage", "save-gui", "upload", "file-url", "image-file" ],
                    "description":"Rollback to a specific local GUI image"
                },
                "delete":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"object"
                    },
                    "uniqueItems":true,
                    "array":[
                        {
                            "properties":{
                                "file":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":128,
                                    "partition-visibility":"shared",
                                    "description":"Delete one local GUI image"
                                }
                            }
                        }
                    ]
                },
                "use-mgmt-port":{
                    "type":"number",
                    "format":"flag",
                    "plat-neg-list":["softax-aws"],
                    "default":0,
                    "partition-visibility":"shared",
                    "not-list":[ "rollback", "source-ip-address" ],
                    "description":"Use management port as source port"
                },
                "source-ip-address":{
                    "type":"string",
                    "format":"ipv4-address",
                    "partition-visibility":"shared",
                    "not-list":[ "rollback", "use-mgmt-port" ],
                    "description":"Source IP address"
                },
                "upload":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "not":"rollback",
                    "description":"Upload GUI image from remote"
                },
                "file-url":{
                    "type":"string",
                    "format":"url",
                    "partition-visibility":"shared",
                    "not-list":[ "local", "rollback", "file-url", "image-file" ],
                    "description":"File URL"
                },
                "image-file":{
                    "type":"string",
                    "format":"string-rlx",
                    "partition-visibility":"shared",
                    "not-list":[ "local", "rollback", "file-url" ],
                    "description":"image file from AXAPI,"
                },
                "gui-upload":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"image file from AXAPI"
                }
            }
        }
    }
}