Skip to content
Was this article helpful?

cspolicy_csvserver_binding

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

Properties

(click to see Operations )

Name Data Type Permissions Description
policyname <String> Read-write Name of the content switching policy to display. If this parameter is omitted, details of all the policies are displayed.

Minimum length = 1
domain <String> Read-write The domain name. The string value can range to 63 characters.

Minimum length = 1
priority <Double> Read-only priority of bound policy.
hits <Double> Read-only Total number of hits.
url <String> Read-only URL string that is matched with the URL of a request. Can contain a wildcard character. Specify the string value in the following format: [[prefix] [*]] [.suffix].

Minimum length = 1

Maximum length = 208
pipolicyhits <Double> Read-only bind hits for PI CS Policy.
labeltype <String> Read-only The invocation type.

Possible values = reqvserver, resvserver, policylabel
labelname <String> Read-only Name of the label invoked.
pihits <Double> Read-only Total number of hits.
action <String> Read-only Content switching action that names the target load balancing virtual server to which the traffic is switched.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • 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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/cspolicy_csvserver_binding/ policyname_value<String>

Query-parameters:

filter

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

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

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

{  "cspolicy_csvserver_binding": [ {
      "policyname":<String_value>,
      "domain":<String_value>,
      "priority":<Double_value>,
      "hits":<Double_value>,
      "url":<String_value>,
      "pipolicyhits":<Double_value>,
      "labeltype":<String_value>,
      "labelname":<String_value>,
      "pihits":<Double_value>,
      "action":<String_value>
}]}

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

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

{  "cspolicy_csvserver_binding": [ {
      "policyname":<String_value>,
      "domain":<String_value>,
      "priority":<Double_value>,
      "hits":<Double_value>,
      "url":<String_value>,
      "pipolicyhits":<Double_value>,
      "labeltype":<String_value>,
      "labelname":<String_value>,
      "pihits":<Double_value>,
      "action":<String_value>
}]}

count

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

{"cspolicy_csvserver_binding": [ { "__count": "#no"} ] }
Was this article helpful?