NetScaler SDX 13.1 NITRO API Reference

clean_install_info

March 20, 2024

Contributed by:

Configuration for Single Bundle File Info For Clean Install resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
file_name		Read-write	File Name. Minimum length = 1 Maximum length = 256
total_approx_time		Read-only	Total approximate time that the upgrade will take.
component_info	<String[]>	Read-only	Component Info.
selected_sb_version		Read-only	Selected Single Bundle Version.
error_message		Read-only	Error Message in case the Single Bundle cannot be applied.
reboot_message		Read-only	Reboot Message.
current_sb_version		Read-only	Current Single Bundle Version.

Operations

(click to see Properties )

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

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

clean_install_info

March 20, 2024

Contributed by:

March 20, 2024

Contributed by:

clean_install_info

Properties

Operations

In this article