Product Documentation

crvserver_filterpolicy_binding

Sep 05, 2016

Binding object showing the filterpolicy that can be bound to crvserver.

Properties (click to see Operations)

Name Data Type Permissions Description
priority
<Double>
Read-write
The priority for the policy.
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 ~V Evaluate the policy with the next higher priority number. * END ~V End policy evaluation. * USE_INVOCATION_RESULT ~V Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the eval* USE_INVOCATION_RESULT ~V Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the eval uation 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 policy~Rs priority. * The expression evaluates to a priority number that is between the current policy~Rs priority number (say, 30) and the highest priority number (say, 100), b ut does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number incr ements by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.
policyname
<String>
Read-write
Policies bound to this vserver.
name
<String>
Read-write
Name of the cache redirection virtual server to which to bind the cache redirection policy.
Minimum length = 1
bindpoint
<String>
Read-write
For a rewrite policy, the bind point to which to bind the policy. Note: This parameter applies only to rewrite policies, because content switching policies are evaluated only at request time.
Possible values = REQUEST, RESPONSE, ICA_REQUEST
targetvserver
<String>
Read-write
Name of the virtual server to which content is forwarded. Applicable only if the policy is a map policy and the cache redirection virtual server is of type REVERSE.
Minimum length = 1
labeltype
<String>
Read-write
Type of label to be invoked.
Possible values = reqvserver, resvserver, policylabel
labelname
<String>
Read-write
Name of the label to be invoked.
invoke
<Boolean>
Read-write
Invoke a policy label if this policy's rule evaluates to TRUE (valid only for default-syntax policies such as application firewall, transform, integrated cache, rewrite, responder, and content switching).
inherited
<String>
Read-only
On State describes that policy bound is inherited from global binding.
Possible values = ON, OFF
__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>.

add:

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

HTTP Method: PUT

Request Headers:

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

Request Payload:

{
"crvserver_filterpolicy_binding":{
      "name":<String_value>,
      "policyname":<String_value>,
      "targetvserver":<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 NetScaler-specific errors). The response payload provides details of the error

delete:

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

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 NetScaler-specific errors). The response payload provides details of the error

get

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

Query-parameters:

filter

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

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

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

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

get (all)

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

Query-parameters:

bulkbindings

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

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

count

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

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