Product Documentation

cmppolicy_lbvserver_binding

Sep 02, 2016

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

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name of the HTTP compression policy for which to display details.
Minimum length = 1
boundto
<String>
Read-write
The name of the entity to which the policy is bound.
priority
<Double>
Read-only
.
gotopriorityexpression
<String>
Read-only
Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
labeltype
<String>
Read-only
Type of policy label invocation.
Possible values = reqvserver, resvserver, policylabel
activepolicy
<Double>
Read-only
.
labelname
<String>
Read-only
Name of the label to invoke if the current policy rule evaluates to TRUE.
__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/cmppolicy_lbvserver_binding/name_value<String>

Query-parameters:

filter

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

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

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

{ "cmppolicy_lbvserver_binding": [ {
      "name":<String_value>,
      "boundto":<String_value>,
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "labeltype":<String_value>,
      "activepolicy":<Double_value>,
      "labelname":<String_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

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

{ "cmppolicy_lbvserver_binding": [ {
      "name":<String_value>,
      "boundto":<String_value>,
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "labeltype":<String_value>,
      "activepolicy":<Double_value>,
      "labelname":<String_value>
}]}

count

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

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