Product Documentation

nsextension

Sep 07, 2016

Configuration for Extension resource.

Properties (click to see Operations)

Name Data Type Permissions Description
src
<String>
Read-write
Local path to and name of, or URL (protocol, host, path, and file name) for, the file in which to store the imported extension.
NOTE: The import fails if the object to be imported is on an HTTPS server that requires client certificate authentication for access.
Minimum length = 1
Maximum length = 2047
name
<String>
Read-write
Name to assign to the extension object on the NetScaler appliance.
Minimum length = 1
Maximum length = 31
comment
<String>
Read-write
Any comments to preserve information about the extension object.
Maximum length = 128
overwrite
<Boolean>
Read-write
Overwrites the existing file.
trace
<String>
Read-write
Enables tracing to the NS log file of extension execution:
off - turns off tracing (equivalent to unset ns extension <extension-name> -trace)
calls - traces extension function calls with arguments and function returns with the first return value
lines - traces the above plus line numbers for executed extension lines
all - traces the above plus local variables changed by executed extension lines
Note that the DEBUG log level must be enabled to see extension tracing.
This can be done by set audit syslogParams -loglevel ALL or -loglevel DEBUG.
Default value: off
Possible values = off, calls, lines, all
tracefunctions
<String>
Read-write
Comma-separated list of extension functions to trace. By default, all extension functions are traced.
Maximum length = 256
tracevariables
<String>
Read-write
Comma-separated list of variables (in traced extension functions) to trace. By default, all variables are traced.
Maximum length = 256
detail
<String>
Read-write
Show detail for extension function.
Possible values = brief, all
type
<String>
Read-only
.
Possible values = WSDL, CustomSettings, XMLSchema, XMLErrorPage, htmlpage, CustomResp, Extension
functionhits
<Double>
Read-only
Number of time function evaluates successfully.
functionundefhits
<Double>
Read-only
Number of times error occured in evaluating extension function.
functionhaltcount
<Double>
Read-only
Number of time function evaluation is halted.
__count
<Double>
Read-only
count parameter

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

Import

URL: http://<netscaler-ip-address>/nitro/v1/config/nsextension?action=Import

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nsextension":{
      "src":<String_value>,
      "name":<String_value>,
      "comment":<String_value>,
      "overwrite":<Boolean_value>
}}

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

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/nsextension/name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

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

add

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nsextension":{
      "name":<String_value>,
      "comment":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created
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

change

URL: http://<netscaler-ip-address>/nitro/v1/config/nsextension?action=update

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nsextension":{
      "name":<String_value>
}}

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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nsextension":{
      "name":<String_value>,
      "trace":<String_value>,
      "tracefunctions":<String_value>,
      "tracevariables":<String_value>,
      "comment":<String_value>
}}

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

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/nsextension?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"nsextension":{
      "name":<String_value>,
      "trace":true,
      "tracefunctions":true,
      "tracevariables":true,
      "comment":true
}}

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

get (all)

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

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/nsextension?args=name:<String_value>,detail:<String_value>

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

attrs

http://<netscaler-ip-address>/nitro/v1/config/nsextension?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/nsextension?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of nsextension resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/nsextension?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/nsextension?pagesize=#no&pageno=#no

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

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

Content-Type:application/json

Response Payload:

{ "nsextension": [ {
name:<String_value>,detail:<String_value>      "src":<String_value>,
      "type":<String_value>,
      "comment":<String_value>,
      "functionhits":<Double_value>,
      "functionundefhits":<Double_value>,
      "functionhaltcount":<Double_value>,
      "trace":<String_value>,
      "tracefunctions":<String_value>,
      "tracevariables":<String_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/nsextension/name_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/nsextension/name_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/nsextension/name_value<String>?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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

Content-Type:application/json

Response Payload:

{ "nsextension": [ {
name:<String_value>,detail:<String_value>      "src":<String_value>,
      "type":<String_value>,
      "comment":<String_value>,
      "functionhits":<Double_value>,
      "functionundefhits":<Double_value>,
      "functionhaltcount":<Double_value>,
      "trace":<String_value>,
      "tracefunctions":<String_value>,
      "tracevariables":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/nsextension?count=yes

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

Content-Type:application/json

Response Payload:

{ "nsextension": [ { "__count": "#no"} ] }