Skip to content

lbvserver_cmppolicy_binding

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

Properties

(click to see Operations)

NameData TypePermissionsDescription
priority<Double>Read-writePriority.
bindpoint<String>Read-writeThe bindpoint to which the policy is bound.
Possible values = REQUEST, RESPONSE
policyname<String>Read-writeName of the policy bound to the LB vserver.
labelname<String>Read-writeName of the label invoked.
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
gotopriorityexpression<String>Read-writeExpression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
invoke<Boolean>Read-writeInvoke policies bound to a virtual server or policy label.
labeltype<String>Read-writeThe invocation type.
Possible values = reqvserver, resvserver, policylabel
sc<String>Read-onlyUse SureConnect on the virtual server.
Default value: OFF
Possible values = ON, OFF
__count<Double>Read-onlycount 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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>.

add:

URL:http://<Citrix-ADC-IP-address(NSIP)/nitro/v1/config/lbvserver_cmppolicy_binding

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{
"lbvserver_cmppolicy_binding":{
<b>"name":<String_value>,
</b>"policyname":<String_value>,
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"bindpoint":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"labelname":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

delete:

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbvserver_cmppolicy_binding/name_value<String>

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbvserver_cmppolicy_binding/name_value<String>?args=policyname:<String_value>,bindpoint:<String_value>,priority:<Double_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 Citrix ADC specific errors). The response payload provides details of the error

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbvserver_cmppolicy_binding/name_value<String>

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbvserver_cmppolicy_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of lbvserver_cmppolicy_binding resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbvserver_cmppolicy_binding/name_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the lbvserver_cmppolicy_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "lbvserver_cmppolicy_binding": [ {
"priority":<Double_value>,
"bindpoint":<String_value>,
"policyname":<String_value>,
"labelname":<String_value>,
"name":<String_value>,
"gotopriorityexpression":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"sc":<String_value>
}]}

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbvserver_cmppolicy_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbvserver_cmppolicy_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "lbvserver_cmppolicy_binding": [ {
"priority":<Double_value>,
"bindpoint":<String_value>,
"policyname":<String_value>,
"labelname":<String_value>,
"name":<String_value>,
"gotopriorityexpression":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"sc":<String_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbvserver_cmppolicy_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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