Skip to content

csvserver_spilloverpolicy_binding

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

Properties

(click to see Operations )

Name Data Type Permissions Description
priority <Double> Read-write Priority for the policy.
bindpoint <String> Read-write The bindpoint to which the policy is bound.

Possible values = REQUEST, RESPONSE, ICA_REQUEST, OTHERTCP_REQUEST
policyname <String> Read-write Policies bound to this vserver.
labelname <String> Read-write Name of the label to be invoked.
name <String> Read-write Name of the content switching virtual server to which the content switching policy applies.

Minimum length = 1
targetlbvserver <String> Read-write Name of the Load Balancing virtual server to which the content is switched, if policy rule is evaluated to be TRUE. Example: bind cs vs cs1 -policyname pol1 -priority 101 -targetLBVserver lb1 Note: Use this parameter only in case of Content Switching policy bind operations to a CS vserver.

Minimum length = 1
gotopriorityexpression <String> Read-write Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
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).
labeltype <String> Read-write Type of label to be invoked.

Possible values = reqvserver, resvserver, policylabel
__count <Double> Read-write count 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 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:// <netscaler-ip-address /nitro/v1/config/csvserver_spilloverpolicy_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{
"csvserver_spilloverpolicy_binding":{
<b>      "name":<String_value>,
</b>      "policyname":<String_value>,
      "targetlbvserver":<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/csvserver_spilloverpolicy_binding/ name_value<String>

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/csvserver_spilloverpolicy_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 NetScaler-specific errors). The response payload provides details of the error

get

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

Query-parameters:

filter

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

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

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

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

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

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

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

count

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

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