Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

lbvserver_csvserver_binding

August 17, 2023
Contributed by: 
C

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

Properties

(click to see Operations )

Name Data Type Permissions Description
priority <Double> Read-write Priority.
policyname <String> Read-write Name of the policy bound to the LB vserver.
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
cachevserver <String> Read-write Cache virtual server.
policysubtype <Double> Read-only .
cachetype <String> Read-only Cache type.

Possible values = TRANSPARENT, REVERSE, FORWARD
hits <Double> Read-only Number of hits.
pipolicyhits <Double> Read-only Number of hits.
__count <Double> 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/lbvserver_csvserver_binding/ name_value<String>

Query-parameters:

filter

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

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

Use this query-parameter to get the lbvserver_csvserver_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_csvserver_binding": [ {
      "priority":<Double_value>,
      "policyname":<String_value>,
      "name":<String_value>,
      "cachevserver":<String_value>,
      "policysubtype":<Double_value>,
      "cachetype":<String_value>,
      "hits":<Double_value>,
      "pipolicyhits":<Double_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver_csvserver_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_csvserver_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_csvserver_binding": [ {
      "priority":<Double_value>,
      "policyname":<String_value>,
      "name":<String_value>,
      "cachevserver":<String_value>,
      "policysubtype":<Double_value>,
      "cachetype":<String_value>,
      "hits":<Double_value>,
      "pipolicyhits":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver_csvserver_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_csvserver_binding": [ { "__count": "#no"} ] }

<!--NeedCopy-->
lbvserver_csvserver_binding
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.