Citrix ADM NITRO API Reference

ns_pre_upgrade

June 20, 2023

Contributed by:

Configuration for Pre Upgrade fro Citrix ADC resource.

Properties

(click to see Operations )

Name	Permissions	Description
hardware_error_details	Read-write	Hardware error like HDD error details.
image_var_nsinstall	Read-write	Build images available in /var/nsinstall directory.
disk_space_error	Read-write	Disk space error for /var.
policy_check_details	Read-write	List of unsupported policies..
ha_ip_address	Read-write	Peer IP Address. Maximum length = 64
disk_space_error_details	Read-write	Disk space error for /var.
policy_check	Read-write	Detected unsupported policy. Maximum length = 32
ha_master_state	Read-write	Master State (Primary/Secondary). Maximum length = 32
user_custom_info	Read-write	User custom info.
hardware_error	Read-write	Hardware error like HDD error.
ip_address	Read-write	IP Address.
user_custom_info_details	Read-write	User custom info details.
display_name	Read-only	Display Name for this managed device. For HA pair it will be A-B, and for Cluster it will be CLIP.
act_id	Read-only	Activity Id.

Operations

(click to see Properties )

DELETE
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

delete

URL: https://<MGMT-IP>/nitro/v2/config/ns_pre_upgrade/ HTTPS Method: DELETE

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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 }

 

get (all)

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

filter https://<MGMT-IP>/nitro/v2/config/ns_pre_upgrade ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ns_pre_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/ns_pre_upgrade ?pagesize=#no;pageno=#no Use this query-parameter to get the ns_pre_upgrade resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ns_pre_upgrade ?count=yes Use this query-parameter to get the count of ns_pre_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, "ns_pre_upgrade":[{
"hardware_error_details":<String_value>,
"image_var_nsinstall":<String_value>,
"disk_space_error":<String_value>,
"display_name":<String_value>,
"policy_check_details":<String_value>,
"ha_ip_address":<String_value>,
"disk_space_error_details":<String_value>,
"policy_check":<String_value>,
"ha_master_state":<String_value>,
"act_id":<String_value>,
"user_custom_info":<String_value>,
"hardware_error":<String_value>,
"ip_address":<String_value>,
"user_custom_info_details":<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

ns_pre_upgrade

June 20, 2023

Contributed by:

ns_pre_upgrade

Properties

Operations

delete

get (all)

In this article