Developer Documentation
NetScaler SDX 13.1 NITRO API Reference

clean_install

March 20, 2024
Contributed by: 
C

Configuration for Xen Upgrade resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
image_name Read-write image_name.
is_supported Read-only Is Clean-Install supported.
act_id Read-only Activity Id.

Operations

(click to see Properties )

  • ADD
  • 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

add

URL: https://<MGMT-IP>/nitro/v2/config/clean_install?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload: 

{"clean_install": {
<b>"image_name":<String_value></b>}}

<!--NeedCopy-->

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, "clean_install":[{
"is_supported":<Boolean_value>,
"act_id":<String_value>,
"image_name":<String_value>}]}

<!--NeedCopy-->

get (all)

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

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

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

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

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 Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "clean_install":[{
"is_supported":<Boolean_value>,
"act_id":<String_value>,
"image_name":<String_value>}]}

<!--NeedCopy-->
clean_install
March 20, 2024
Contributed by: 
C
March 20, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.