ADC NITRO APIs

lbvserver_service_binding

Binding object showing the service that can be bound to lbvserver.

Properties

(click to see Operations )

Name Data Type Permissions Description
order <Double> Read-write Order number to be assigned to the service when it is bound to the lb vserver.

Minimum value = 1

Maximum value = 8192
weight <Double> Read-write Weight to assign to the specified service.

Minimum value = 1

Maximum value = 100
name <String> Read-write Name for the virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Can be changed after the virtual server is created. CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my vserver" or 'my vserver'). .

Minimum length = 1
servicename <String> Read-write Service to bind to the virtual server.

Minimum length = 1
servicegroupname <String> Read-write Name of the service group.

Minimum length = 1
preferredlocation <String> Read-only Used for displaying the location of bound services.
vserverid <String> Read-only Vserver Id.
vsvrbindsvcip <String> Read-only used for showing the ip of bound entities.
servicetype <String> Read-only Protocol used by the service (also called the service type).

Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, DNS, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, RTSP, PUSH, SSL_PUSH, RADIUS, RDP, MYSQL, MSSQL, DIAMETER, SSL_DIAMETER, TFTP, ORACLE, SMPP, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, PROXY, USER_TCP, USER_SSL_TCP, QUIC, IPFIX, LOGSTREAM, MONGO, MONGO_TLS, MQTT, MQTT_TLS, QUIC_BRIDGE, HTTP_QUIC
cookieipport <String> Read-only Encryped Ip address and port of the service that is inserted into the set-cookie http header.
orderstr <String> Read-only Order in string form assigned to the service when it is bound to the lb vserver.
port <Integer> Read-only Port number for the virtual server.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
vsvrbindsvcport <Integer> Read-only used for showing ports of bound entities.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
curstate <String> Read-only Current LB vserver state.

Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
ipv46 <String> Read-only IPv4 or IPv6 address to assign to the virtual server.
dynamicweight <Double> Read-only Dynamic weight.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • 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

add

URL: http:// <netscaler-ip-address /nitro/v1/config/lbvserver_service_binding HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{
"lbvserver_service_binding":{
<b>"name":<String_value>,
</b>"servicename":<String_value>,
"weight":<Double_value>,
"servicegroupname":<String_value>,
"order":<Double_value>
}}

<!--NeedCopy-->

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver_service_binding/ name_value<String> Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/lbvserver_service_binding/ name_value<String> ? args=servicename: <String_value> ,servicegroupname: <String_value>

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

get

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

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

Use this query-parameter to get the lbvserver_service_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:

{  "lbvserver_service_binding": [ {
"order":<Double_value>,
"weight":<Double_value>,
"name":<String_value>,
"servicename":<String_value>,
"servicegroupname":<String_value>,
"preferredlocation":<String_value>,
"vserverid":<String_value>,
"vsvrbindsvcip":<String_value>,
"servicetype":<String_value>,
"cookieipport":<String_value>,
"orderstr":<String_value>,
"port":<Integer_value>,
"vsvrbindsvcport":<Integer_value>,
"curstate":<String_value>,
"ipv46":<String_value>,
"dynamicweight":<Double_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver_service_binding HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters: bulkbindings http:// <netscaler-ip-address> /nitro/v1/config/lbvserver_service_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:

{  "lbvserver_service_binding": [ {
"order":<Double_value>,
"weight":<Double_value>,
"name":<String_value>,
"servicename":<String_value>,
"servicegroupname":<String_value>,
"preferredlocation":<String_value>,
"vserverid":<String_value>,
"vsvrbindsvcip":<String_value>,
"servicetype":<String_value>,
"cookieipport":<String_value>,
"orderstr":<String_value>,
"port":<Integer_value>,
"vsvrbindsvcport":<Integer_value>,
"curstate":<String_value>,
"ipv46":<String_value>,
"dynamicweight":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver_service_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:

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

<!--NeedCopy-->
lbvserver_service_binding