Skip to content

techsupport

Configuration for Technical Support resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
mode<String>Read-writeTechnical support Mode, Possible values Appliance | XenServer | Management Service | NetScaler Insight | Appliance_full | Instances.
Minimum length = 1
Maximum length = 128
file_location_path<String>Read-writeFile Location on Client for upload/download.
file_name<String>Read-writeTechnical support File Name.
Minimum length = 1
Maximum length = 256
vpx_list_for_techsupport<String[]>Read-writeList of VPX for which the techsupport is required (Applicable for only : ManagementServiceIncludingInstances and ApplianceIncludingInstances).
Minimum length = 1
Maximum length = 50
file_size<Double>Read-onlyFile Size.
file_last_modified<String>Read-onlyLast Modified Time.
act_id<String>Read-onlyActivity Id.

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>.

start

URL: https://<MGMT-IP>/nitro/v1/config/techsupport?action=start;onerror=<String_value>

HTTP Method: null

Request Payload:

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

delete

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

HTTP Method: null

Response Payload:

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

download

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

HTTP Method: null