Skip to content

mps_upgrade

Configuration for System Upgrade resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
image_name<String>Read-writeimage_name.
Minimum length = 1
Maximum length = 128
doc_file<String>Read-writeThis property is no longer used;ltbr;gtDocumentation File Name.
Minimum length = 1
Maximum length = 128
do_cleanup<Boolean>Read-writeTrue, if user wants to clean the image files once upgrade is completed successfully.

Operations

(click to see Properties)

UPGRADE

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

upgrade

URL: https://<MGMT-IP>/nitro/v1/config/mps_upgrade?action=upgrade;onerror=<String_value>

HTTP Method: null

Request Payload:

{mps_upgrade: {
<b>"image_name":<String_value></b>,
"do_cleanup":<Boolean_value>,
"doc_file":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_upgrade":[{
"image_name":<String_value>,
"doc_file":<String_value>,
"do_cleanup":<Boolean_value>}]}