Skip to content

techsupport

Configuration for Technical Support resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
mode <String> Read-write Technical support Mode, Possible values Appliance | XenServer | Management Service | Appliance_full | Instances.

Minimum length = 1

Maximum length = 128
file_location_path <String> Read-write File Location on Client for upload/download.
file_name <String> Read-write Technical support File Name.

Minimum length = 1

Maximum length = 256
file_size <Double> Read-only File Size.
file_last_modified <String> Read-only Last Modified Time.
file_last_modified_epoch <Double> Read-only Last Modified (Epoch).

Operations

(click to see Properties )

  • START
  • GET (ALL)
  • GET
  • DELETE
  • DOWNLOAD

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

start

URL: https://<MGMT-IP>/nitro/v2/config/techsupport?action=start;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:

{"techsupport": {
<b>      "mode":<String_value></b>,
<b>      "file_location_path":<String_value></b>,
<b>      "file_name":<String_value></b>}}

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, "techsupport":[{
      "enable_debug":<Boolean_value>,
      "file_size":<Double_value>,
      "mode":<String_value>,
      "file_last_modified":<String_value>,
      "enable_db_distribution":<Boolean_value>,
      "file_location_path":<String_value>,
      "file_name":<String_value>,
      "act_id":<String_value>,
      "vpx_list_for_techsupport":<String_value>,
      "debug_duration":<Integer_value>,
      "collect_options":<String_value>,
      "file_last_modified_epoch":<Double_value>}]}

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/techsupport

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/techsupport ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of techsupport 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/techsupport ?pagesize=#no;pageno=#no

Use this query-parameter to get the techsupport resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/techsupport ?count=yes

Use this query-parameter to get the count of techsupport 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, "techsupport":[{
      "enable_debug":<Boolean_value>,
      "file_size":<Double_value>,
      "mode":<String_value>,
      "file_last_modified":<String_value>,
      "enable_db_distribution":<Boolean_value>,
      "file_location_path":<String_value>,
      "file_name":<String_value>,
      "act_id":<String_value>,
      "vpx_list_for_techsupport":<String_value>,
      "debug_duration":<Integer_value>,
      "collect_options":<String_value>,
      "file_last_modified_epoch":<Double_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/techsupport/file_name_value<String>

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, "techsupport":[{
      "enable_debug":<Boolean_value>,
      "file_size":<Double_value>,
      "mode":<String_value>,
      "file_last_modified":<String_value>,
      "enable_db_distribution":<Boolean_value>,
      "file_location_path":<String_value>,
      "file_name":<String_value>,
      "act_id":<String_value>,
      "vpx_list_for_techsupport":<String_value>,
      "debug_duration":<Integer_value>,
      "collect_options":<String_value>,
      "file_last_modified_epoch":<Double_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v2/config/techsupport/file_name_value<String>

HTTPS Method: DELETE

Request Headers:

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

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

download

URL: https://<MGMT-IP>/nitro/v2/download/techsupport/file_name_value<String>

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 Payload: Binary Stream

Was this article helpful?