Skip to content

ns_upgrade

Configuration for Upgrade NetScaler resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
scheduleTimesEpoch<String>Read-writeSchedule time epoch (string representation of 11 digit numbers)..
device_groups<String[]>Read-writeDevice Group Array on which for which job is run.
image_name<String>Read-writeimage_name.
Minimum length = 1
Maximum length = 128
do_backup<Boolean>Read-writeTrue, if user wants to take backup before ns upgrade.
name<String>Read-writeName.
Maximum length = 128
doc_file<String>Read-writeDocumentation File Name.
Minimum length = 1
Maximum length = 128
ns_ip_address_arr<String[]>Read-writeList of NS IP Address.
scheduleId<String>Read-writescheduleId is used to refer maintenaince schedule task.
mail_profiles<String>Read-writeComma seperated list of Mail profiles.
ha_two_phase_upgrade<Boolean>Read-writeTrue, if user wants to upgarde ha in two phases or steps.
ha_node2_devices<String[]>Read-writeList of HA NS IP Address upgrade in second phase.
do_cleanup<Boolean>Read-writeTrue, if user wants to clean the image files once upgrade is completed successfully.
scheduleTimesEpoch2<String>Read-writeSchedule time epoch for ha primary node (string representation of 11 digit numbers)..
act_id<String>Read-onlyActivity Id.

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/ns_upgrade?action=upgrade;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_upgrade: {
<b>"image_name":<String_value></b>,
"do_cleanup":<Boolean_value>,
"scheduleTimesEpoch":<String_value>,
"device_groups":<String_value[]>,
"doc_file":<String_value>,
"name":<String_value>,
"do_backup":<Boolean_value>,
"ns_ip_address_arr":<String_value[]>,
"mail_profiles":<String_value>,
"scheduleId":<String_value>,
"ha_two_phase_upgrade":<Boolean_value>,
"ha_node2_devices":<String_value[]>,
"scheduleTimesEpoch2":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_upgrade":[{
"scheduleTimesEpoch":<String_value>,
"device_groups":<String_value>,
"mode":<Integer_value>,
"image_name":<String_value>,
"do_backup":<Boolean_value>,
"name":<String_value>,
"doc_file":<String_value>,
"ns_ip_address_arr":<String_value>,
"scheduleId":<String_value>,
"mail_profiles":<String_value>,
"act_id":<String_value>,
"ha_two_phase_upgrade":<Boolean_value>,
"ha_node2_devices":<String_value>,
"do_cleanup":<Boolean_value>,
"scheduleTimesEpoch2":<String_value>}]}