Citrix ADM NITRO API Reference

autoscalegroup_upgrade

June 20, 2023

Contributed by:

Configuration for Upgrade support for AutoScaleGroup resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
name		Read-write	Name of upgrade. Maximum length = 128
saveconfig_enabled		Read-write	True, if save config before upgrade.
is_post_upgrade_script_selected		Read-write	True, if post upgrade custom script is selected.
autoscalegroup_name_arr	<String[]>	Read-write	List of AutoScaleGroup Names.
post_upgrade_pre_failover_script		Read-write	Name of post upgrade pre failover script file. Maximum length = 128
ha_two_phase_upgrade		Read-write	True, if user wants to upgarde ha in two phases or steps.
second_failover_enabled		Read-write	True, if second failover for HA upgrade is enabled.
is_pre_post_upgrade_script_same		Read-write	True, if pre and post upgrade post failover custom scripts are same.
do_cleanup		Read-write	True, if user wants to clean the image files once upgrade is completed successfully.
id		Read-write	Id is maintenance job id.
scheduleTimesEpoch		Read-write	Schedule time epoch (string representation of 11 digit numbers)..
ns_ip_address_arr	<String[]>	Read-write	List of Citrix ADC IP Address.
is_issu_enabled		Read-write	True, if ISSU is enabled.
mail_profiles		Read-write	Comma separated list of Mail profiles.
pre_upgrade_script		Read-write	Name of pre upgrade script file. Maximum length = 128
issu_migration_timeout		Read-write	ISSU migration timeout value in minutes. Minimum value = 10 Maximum value =
device_groups	<String[]>	Read-write	Device Group Array on which for which job is run.
adc_cloud_image_id		Read-write	ADC Cloud Image ID to which AutoScaleGroup(s) is/are to be upgraded. Minimum length = 1 Maximum length = 128
ha_node2_devices	<String[]>	Read-write	List of HA Citrix ADC IP Address upgrade in second phase.
image_name		Read-write	image_name. Maximum length = 128
is_force_upgrade		Read-write	Force upgrade of AutoScaleGroup would mean to ignore Drain connection timeout.
do_backup		Read-write	True, if user wants to take backup before ns upgrade.
doc_file		Read-write	Documentation File Name. Minimum length = 1 Maximum length = 128
is_post_upgrade_pre_failover_script_selected		Read-write	True, if post upgrade pre failover custom script is selected.
adc_cloud_image_version		Read-write	ADC Cloud Image Version to which AutoScaleGroup(s) is/are to be upgraded. Minimum length = 1 Maximum length = 128
is_remote_download		Read-write	True if upgrade is remote download instead of direct upload from ADM.
is_pre_upgrade_script_selected		Read-write	True, if pre upgrade custom script is selected.
cleanup_unsupported_policy		Read-write	True, if user selected to delete unsupported policies after upgrade..
slack_profile		Read-write	Slack profile.
scheduleId		Read-write	scheduleId is used to refer maintenaince schedule task.
post_upgrade_script		Read-write	Name of post upgrade script file. Maximum length = 128
is_pre_post_upgrade_pre_failover_script_same		Read-write	True, if pre and post upgrade pre failover custom scripts are same.
scheduleTimesEpoch2		Read-write	Schedule time epoch for ha primary node (string representation of 11 digit numbers)..
act_id		Read-only	Activity Id.
tasklog_id		Read-only	Task Log Id of the Config Job.

Operations

(click to see Properties )

UPGRADE
GET (ALL)

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

upgrade

URL: https://<MGMT-IP>/nitro/v2/config/autoscalegroup_upgrade?action=upgrade;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"autoscalegroup_upgrade": {
<b>"image_name":<String_value></b>,
"cleanup_unsupported_policy":<Boolean_value>,
"slack_profile":<String_value>,
"id":<String_value>,
"do_cleanup":<Boolean_value>,
"scheduleTimesEpoch":<String_value>,
"is_force_upgrade":<Boolean_value>,
"doc_file":<String_value>,
"do_backup":<Boolean_value>,
"name":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"is_issu_enabled":<Boolean_value>,
"scheduleId":<String_value>,
"mail_profiles":<String_value>,
"post_upgrade_script":<String_value>,
"is_post_upgrade_pre_failover_script_selected":<Boolean_value>,
"saveconfig_enabled":<Boolean_value>,
"pre_upgrade_script":<String_value>,
"adc_cloud_image_version":<String_value>,
"issu_migration_timeout":<Integer_value>,
"is_post_upgrade_script_selected":<Boolean_value>,
"is_remote_download":<Boolean_value>,
"device_groups":<String_value[]>,
"autoscalegroup_name_arr":<String_value[]>,
"post_upgrade_pre_failover_script":<String_value>,
"ha_two_phase_upgrade":<Boolean_value>,
"second_failover_enabled":<Boolean_value>,
"is_pre_upgrade_script_selected":<Boolean_value>,
"ha_node2_devices":<String_value[]>,
"adc_cloud_image_id":<String_value>,
"is_pre_post_upgrade_script_same":<Boolean_value>,
"scheduleTimesEpoch2":<String_value>,
"is_pre_post_upgrade_pre_failover_script_same":<Boolean_value>}}

 

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "autoscalegroup_upgrade":[{
"act_id":<String_value>,
"name":<String_value>,
"saveconfig_enabled":<Boolean_value>,
"is_post_upgrade_script_selected":<Boolean_value>,
"autoscalegroup_name_arr":<String_value>,
"post_upgrade_pre_failover_script":<String_value>,
"ha_two_phase_upgrade":<Boolean_value>,
"second_failover_enabled":<Boolean_value>,
"is_pre_post_upgrade_script_same":<Boolean_value>,
"do_cleanup":<Boolean_value>,
"id":<String_value>,
"scheduleTimesEpoch":<String_value>,
"ns_ip_address_arr":<String_value>,
"is_issu_enabled":<Boolean_value>,
"mail_profiles":<String_value>,
"pre_upgrade_script":<String_value>,
"issu_migration_timeout":<Integer_value>,
"device_groups":<String_value>,
"adc_cloud_image_id":<String_value>,
"ha_node2_devices":<String_value>,
"image_name":<String_value>,
"mode":<Integer_value>,
"is_force_upgrade":<Boolean_value>,
"do_backup":<Boolean_value>,
"doc_file":<String_value>,
"is_post_upgrade_pre_failover_script_selected":<Boolean_value>,
"adc_cloud_image_version":<String_value>,
"is_remote_download":<Boolean_value>,
"is_pre_upgrade_script_selected":<Boolean_value>,
"cleanup_unsupported_policy":<Boolean_value>,
"slack_profile":<String_value>,
"tasklog_id":<String_value>,
"scheduleId":<String_value>,
"post_upgrade_script":<String_value>,
"is_pre_post_upgrade_pre_failover_script_same":<Boolean_value>,
"scheduleTimesEpoch2":<String_value>}]}

 

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/autoscalegroup_upgrade Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/autoscalegroup_upgrade ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of autoscalegroup_upgrade resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/autoscalegroup_upgrade ?pagesize=#no;pageno=#no Use this query-parameter to get the autoscalegroup_upgrade resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/autoscalegroup_upgrade ?count=yes Use this query-parameter to get the count of autoscalegroup_upgrade resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "autoscalegroup_upgrade":[{
"act_id":<String_value>,
"name":<String_value>,
"saveconfig_enabled":<Boolean_value>,
"is_post_upgrade_script_selected":<Boolean_value>,
"autoscalegroup_name_arr":<String_value>,
"post_upgrade_pre_failover_script":<String_value>,
"ha_two_phase_upgrade":<Boolean_value>,
"second_failover_enabled":<Boolean_value>,
"is_pre_post_upgrade_script_same":<Boolean_value>,
"do_cleanup":<Boolean_value>,
"id":<String_value>,
"scheduleTimesEpoch":<String_value>,
"ns_ip_address_arr":<String_value>,
"is_issu_enabled":<Boolean_value>,
"mail_profiles":<String_value>,
"pre_upgrade_script":<String_value>,
"issu_migration_timeout":<Integer_value>,
"device_groups":<String_value>,
"adc_cloud_image_id":<String_value>,
"ha_node2_devices":<String_value>,
"image_name":<String_value>,
"mode":<Integer_value>,
"is_force_upgrade":<Boolean_value>,
"do_backup":<Boolean_value>,
"doc_file":<String_value>,
"is_post_upgrade_pre_failover_script_selected":<Boolean_value>,
"adc_cloud_image_version":<String_value>,
"is_remote_download":<Boolean_value>,
"is_pre_upgrade_script_selected":<Boolean_value>,
"cleanup_unsupported_policy":<Boolean_value>,
"slack_profile":<String_value>,
"tasklog_id":<String_value>,
"scheduleId":<String_value>,
"post_upgrade_script":<String_value>,
"is_pre_post_upgrade_pre_failover_script_same":<Boolean_value>,
"scheduleTimesEpoch2":<String_value>}]}

 

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

autoscalegroup_upgrade

June 20, 2023

Contributed by:

autoscalegroup_upgrade

Properties

Operations

upgrade

get (all)

In this article