ADC NITRO APIs

nsextension_extensionfunction_binding

August 17, 2023

Contributed by:

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

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
name		Read-write	Name of the extension object. Minimum length = 1 Maximum length = 31
extensionfunctionlinenumber		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		Read-only	Extension function is in use or not.
extensionfunctionname		Read-only	Name of extension function given in the extension. Minimum length = 1 Maximum length = 31
extensionfunctionclasstype		Read-only	Extension function class type. Minimum length = 1 Maximum length = 31
extensionfuncdescription		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		Read-only	Number of parameters in the extension function.
extensionfunctionreturntype		Read-only	Extension function return type. Minimum length = 1 Maximum length = 31
extensionfunctionclassescount		Read-only	Number of classes the function is present in.
extensionfunctionallparamscount		Read-only	Number of parameters (including promotions) that the function can accept.
__count		Read-only	count parameter

Operations

(click to see Properties )

GET
GET (ALL)
COUNT

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

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

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>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

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

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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:

{  "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>
}]}

<!--NeedCopy-->

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

Content-Type:application/json

Response Payload:

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

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

nsextension_extensionfunction_binding

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

nsextension_extensionfunction_binding

Properties

Operations

get

get (all)

count

In this article