ADC NITRO APIs

techsupport

August 17, 2023

Contributed by:

Configuration for tech support resource.

Properties

(click to see Operations )

Name	Permissions	Description
scope	Read-write	Use this option to gather data on the present node, all cluster nodes, or for the specified partitions. The CLUSTER scope generates smaller abbreviated archives for all nodes. The PARTITION scope collects the admin partition in addition to those specified. The partitionName option is only required for the PARTITION scope. Default value: NODE Possible values = NODE, CLUSTER, PARTITION
partitionname	Read-write	Name of the partition. Minimum length = 1
upload	Read-write	Securely upload the collector archive to Citrix Technical Support using SSL. MyCitrix credentials will be required. If used with the -file option, no new collector archive is generated. Instead, the specified archive is uploaded. Note that the upload operation time depends on the size of the archive file, and the connection bandwidth.
proxy	Read-write	Specifies the proxy server to be used when uploading a collector archive. Use this parameter if the Citrix ADC does not have direct internet connectivity. The basic format of the proxy string is: “proxy_IP:" (without quotes). If the proxy requires authentication the format is: "username:password@proxy_IP:".
casenumber	Read-write	Specifies the associated case or service request number if it has already been opened with Citrix Technical Support.
file	Read-write	Specifies the name (with full path) of the collector archive file to be uploaded. If this is specified, no new collector archive is generated.
description	Read-write	Provides a text description for the the upload, and can be used for logging purposes.
username	Read-write	Specifies My Citrix user name, which is used to login to Citrix upload server.
password	Read-write	Specifies My Citrix password, which is used to login to Citrix upload server.
response	Read-only	Output as text printed to console and syslog at NOTICE level.
servername	Read-only	.

Operations

(click to see Properties )

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/techsupport

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/techsupport? args=scope: <String_value> ,partitionname: <String_value> ,upload: <Boolean_value> ,proxy: <String_value> ,casenumber: <String_value> ,file: <String_value> ,description: <String_value> ,username: <String_value> ,password: <String_value>

Use this query-parameter to get techsupport resources based on additional properties.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "techsupport": [ {
scope:<String_value>,partitionname:<String_value>,upload:<Boolean_value>,proxy:<String_value>,casenumber:<String_value>,file:<String_value>,description:<String_value>,username:<String_value>,password:<String_value>      "response":<String_value>,
      "servername":<String_value>
}]}

<!--NeedCopy-->

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

techsupport

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

techsupport

Properties

Operations

get (all)

In this article