Product Documentation

nsextension_extensionfunction_binding

Sep 07, 2016

Binding object showing the extensionfunction that can be bound to nsextension.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name of the extension object.
Minimum length = 1
Maximum length = 31
extensionfunctionlinenumber
<Double>
Read-only
Line number of the function in file.
extensionfunctionclasses
<String[]>
Read-only
List of classes (including inherited) that the function is present in.
extensionfunctionargtype
<String[]>
Read-only
List of extension function's arguments types.
activeextensionfunction
<Integer>
Read-only
Extension function is in use or not.
extensionfunctionname
<String>
Read-only
Name of extension function given in the extension.
Minimum length = 1
Maximum length = 31
extensionfunctionclasstype
<String>
Read-only
Extension function class type.
Minimum length = 1
Maximum length = 31
extensionfuncdescription
<String>
Read-only
Any description to preserve information about the extension function.
Maximum length = 1023
extensionfunctionallparams
<String[]>
Read-only
List of parameters (including promotions) that the function can accept.
extensionfunctionargcount
<Double>
Read-only
Number of parameters in the extension function.
extensionfunctionreturntype
<String>
Read-only
Extension function return type.
Minimum length = 1
Maximum length = 31
extensionfunctionclassescount
<Double>
Read-only
Number of classes the function is present in.
extensionfunctionallparamscount
<Double>
Read-only
Number of parameters (including promotions) that the function can accept.
__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>.

get

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

Query-parameters:

filter

http://<netscaler-ip-address>/nitro/v1/config/nsextension_extensionfunction_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2

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

pagination

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

Use this query-parameter to get the nsextension_extensionfunction_binding 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_extensionfunction_binding": [ {
      "name":<String_value>,
      "extensionfunctionlinenumber":<Double_value>,
      "extensionfunctionclasses":<String[]_value>,
      "extensionfunctionargtype":<String[]_value>,
      "activeextensionfunction":<Integer_value>,
      "extensionfunctionname":<String_value>,
      "extensionfunctionclasstype":<String_value>,
      "extensionfuncdescription":<String_value>,
      "extensionfunctionallparams":<String[]_value>,
      "extensionfunctionargcount":<Double_value>,
      "extensionfunctionreturntype":<String_value>,
      "extensionfunctionclassescount":<Double_value>,
      "extensionfunctionallparamscount":<Double_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/nsextension_extensionfunction_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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_extensionfunction_binding": [ {
      "name":<String_value>,
      "extensionfunctionlinenumber":<Double_value>,
      "extensionfunctionclasses":<String[]_value>,
      "extensionfunctionargtype":<String[]_value>,
      "activeextensionfunction":<Integer_value>,
      "extensionfunctionname":<String_value>,
      "extensionfunctionclasstype":<String_value>,
      "extensionfuncdescription":<String_value>,
      "extensionfunctionallparams":<String[]_value>,
      "extensionfunctionargcount":<Double_value>,
      "extensionfunctionreturntype":<String_value>,
      "extensionfunctionclassescount":<Double_value>,
      "extensionfunctionallparamscount":<Double_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/nsextension_extensionfunction_binding/name_value<String>?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_extensionfunction_binding": [ { "__count": "#no"} ] }