Download full document:

lbvserver_servicegroupmember_binding

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

Properties

(click to see Operations)

NameData TypePermissionsDescription
servicegroupname<String>Read-writeThe service group name bound to the selected load balancing virtual server.
name<String>Read-writeName 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
weight<Double>Read-writeWeight to assign to the specified service.
Minimum value = 1
Maximum value = 100
cookieipport<String>Read-onlyEncryped Ip address and port of the service that is inserted into the set-cookie http header.
port<Integer>Read-onlyPort number for the virtual server.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
curstate<String>Read-onlyCurrent 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
preferredlocation<String>Read-onlyUsed for displaying the location of bound services.
vserverid<String>Read-onlyVserver Id.
ipv46<String>Read-onlyIPv4 or IPv6 address to assign to the virtual server.
cookiename<String>Read-onlyUse this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.
dynamicweight<Double>Read-onlyDynamic weight.
servicetype<String>Read-onlyProtocol 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
__count<Double>Read-onlycount 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 redand placeholder content is marked in <green>.

get

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

Query-parameters:

filter

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

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

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

Content-Type:application/json

Response Payload:

{ "lbvserver_servicegroupmember_binding": [ {
"servicegroupname":<String_value>,
"name":<String_value>,
"weight":<Double_value>,
"cookieipport":<String_value>,
"port":<Integer_value>,
"curstate":<String_value>,
"preferredlocation":<String_value>,
"vserverid":<String_value>,
"ipv46":<String_value>,
"cookiename":<String_value>,
"dynamicweight":<Double_value>,
"servicetype":<String_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/lbvserver_servicegroupmember_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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "lbvserver_servicegroupmember_binding": [ {
"servicegroupname":<String_value>,
"name":<String_value>,
"weight":<Double_value>,
"cookieipport":<String_value>,
"port":<Integer_value>,
"curstate":<String_value>,
"preferredlocation":<String_value>,
"vserverid":<String_value>,
"ipv46":<String_value>,
"cookiename":<String_value>,
"dynamicweight":<Double_value>,
"servicetype":<String_value>
}]}

count

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

Content-Type:application/json

Response Payload:

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