Download full document:

lbvserver_scpolicy_binding

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

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
priority	<Double>	Read-write	Priority.
gotopriorityexpression	<String>	Read-write	Expression or other value specifying the next policy to be evaluated if the current policy evaluates to TRUE. Specify one of the following values: * NEXT - Evaluate the policy with the next higher priority number. * END - End policy evaluation. * USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the evaluation stops. If the final goto is anything other than END, the current policy label performs a NEXT. * A default syntax expression that evaluates to a number. If you specify an expression, the number to which it evaluates determines the next policy to evaluate, as follows: * If the expression evaluates to a higher numbered priority, the policy with that priority is evaluated next. * If the expression evaluates to the priority of the current policy, the policy with the next higher numbered priority is evaluated next. * If the expression evaluates to a priority number that is numerically higher than the highest numbered priority, policy evaluation ends. An UNDEF event is triggered if: * The expression is invalid. * The expression evaluates to a priority number that is numerically lower than the current policys priority. * The expression evaluates to a priority number that is between the current policys priority number (say, 30) and the highest priority number (say, 100), but does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number increments by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.
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). .<br>Minimum length = 1
bindpoint	<String>	Read-write	Bind point to which to bind the policy. Applicable only to compression, rewrite, and cache policies.<br>Possible values = REQUEST, RESPONSE
labeltype	<String>	Read-write	Type of policy label to invoke. Applicable only to rewrite and cache policies. Available settings function as follows: * reqvserver - Evaluate the request against the request-based policies bound to the specified virtual server. * resvserver - Evaluate the response against the response-based policies bound to the specified virtual server. * policylabel - invoke the request or response against the specified user-defined policy label.<br>Possible values = reqvserver, resvserver, policylabel
labelname	<String>	Read-write	Name of the virtual server or user-defined policy label to invoke if the policy evaluates to TRUE.
invoke	<Boolean>	Read-write	Invoke policies bound to a virtual server or policy label.
__count	<Double>	Read-write	count parameter

Operations

(click to see Properties)

ADD: | DELETE: | GET | 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://NS_IP/nitro/v1/config

HTTP Method: PUT

Request Payload:

{
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
sessionid":"##sessionid","lbvserver_scpolicy_binding":{
      "name":<String_value>,
      "policyname":<String_value>,
                  "priority":<Double_value>,
                  "gotopriorityexpression":<String_value>,
                  "bindpoint":<String_value>,
                  "invoke":<Boolean_value>,
                  "labeltype":<String_value>,
                  "labelname":<String_value>,

}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete:

URL: http://<NS_IP>/nitro/v1/config/lbvserver_scpolicy_binding/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/lbvserver_scpolicy_binding/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get

URL: http://<NS_IP>/nitro/v1/config/lbvserver_scpolicy_binding/name_value<String>

Query-parameters:

filter

http://<NS_IP>/nitro/v1/config/lbvserver_scpolicy_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2

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

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/lbvserver_scpolicy_binding/name_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the lbvserver_scpolicy_binding resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/lbvserver_scpolicy_binding?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "lbvserver_scpolicy_binding": [ {
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "policyname":<String_value>,
      "name":<String_value>,
      "bindpoint":<String_value>,
      "labeltype":<String_value>,
      "labelname":<String_value>,
      "invoke":<Boolean_value>,

}]}

count

URL: http://<NS_IP>/nitro/v1/config/lbvserver_scpolicy_binding/name_value<String>?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",lbvserver_scpolicy_binding: [ { "__count": "#no"} ] }