Skip to content

cbwanopt_upgrade

Configuration for Upgrade CBWANOPT 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
name<String>Read-writeName.
Maximum length = 128
on_error<String>Read-writeBehaviour on encountering error while applying configuration template on a device: CONTINUE|EXIT.
Minimum length = 1
Maximum length = 16
execute_sequentially<Boolean>Read-writeTrue if configuration template is to be applied to devices sequentially.
mail_profiles<String>Read-writeComma seperated list of Mail profiles.
scheduleId<String>Read-writescheduleId is used to refer maintenaince schedule task.
sdx_ip_address_arr<String[]>Read-writeList of NetScaler SD-WAN WAN Optimization device IP Address.
do_cleanup<Boolean>Read-writeTrue, if user wants to clean the image files once upgrade is completed successfully.
task_id<String>Read-onlyTask 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/cbwanopt_upgrade?action=upgrade;onerror=<String_value>

HTTP Method: null

Request Payload:

{cbwanopt_upgrade: {
<b>"image_name":<String_value></b>,
"execute_sequentially":<Boolean_value>,
"name":<String_value>,
"do_cleanup":<Boolean_value>,
"scheduleTimesEpoch":<String_value>,
"on_error":<String_value>,
"scheduleId":<String_value>,
"mail_profiles":<String_value>,
"sdx_ip_address_arr":<String_value[]>,
"device_groups":<String_value[]>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "cbwanopt_upgrade":[{
"scheduleTimesEpoch":<String_value>,
"device_groups":<String_value>,
"mode":<Integer_value>,
"image_name":<String_value>,
"name":<String_value>,
"on_error":<String_value>,
"execute_sequentially":<Boolean_value>,
"task_id":<String_value>,
"mail_profiles":<String_value>,
"scheduleId":<String_value>,
"sdx_ip_address_arr":<String_value>,
"do_cleanup":<Boolean_value>}]}