ADC NITRO APIs

csvserver_binding

Binding object which returns the resources bound to csvserver.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of a content switching virtual server for which to display information, including the policies bound to the virtual server. To display a list of all configured Content Switching virtual servers, do not specify a value for this parameter.

Minimum length = 1
csvserver_spilloverpolicy_binding <csvserver_spilloverpolicy_binding[]> Read-only spilloverpolicy that can be bound to csvserver.
csvserver_auditnslogpolicy_binding <csvserver_auditnslogpolicy_binding[]> Read-only auditnslogpolicy that can be bound to csvserver.
csvserver_domain_binding <csvserver_domain_binding[]> Read-only domain that can be bound to csvserver.
csvserver_filterpolicy_binding <csvserver_filterpolicy_binding[]> Read-only filterpolicy that can be bound to csvserver.
csvserver_analyticsprofile_binding <csvserver_analyticsprofile_binding[]> Read-only analyticsprofile that can be bound to csvserver.
csvserver_cmppolicy_binding <csvserver_cmppolicy_binding[]> Read-only cmppolicy that can be bound to csvserver.
csvserver_lbvserver_binding <csvserver_lbvserver_binding[]> Read-only lbvserver that can be bound to csvserver.
csvserver_appflowpolicy_binding <csvserver_appflowpolicy_binding[]> Read-only appflowpolicy that can be bound to csvserver.
csvserver_responderpolicy_binding <csvserver_responderpolicy_binding[]> Read-only responderpolicy that can be bound to csvserver.
csvserver_transformpolicy_binding <csvserver_transformpolicy_binding[]> Read-only transformpolicy that can be bound to csvserver.
csvserver_vpnvserver_binding <csvserver_vpnvserver_binding[]> Read-only vpnvserver that can be bound to csvserver.
csvserver_contentinspectionpolicy_binding <csvserver_contentinspectionpolicy_binding[]> Read-only contentinspectionpolicy that can be bound to csvserver.
csvserver_feopolicy_binding <csvserver_feopolicy_binding[]> Read-only feopolicy that can be bound to csvserver.
csvserver_botpolicy_binding <csvserver_botpolicy_binding[]> Read-only botpolicy that can be bound to csvserver.
csvserver_authorizationpolicy_binding <csvserver_authorizationpolicy_binding[]> Read-only authorizationpolicy that can be bound to csvserver.
csvserver_cachepolicy_binding <csvserver_cachepolicy_binding[]> Read-only cachepolicy that can be bound to csvserver.
csvserver_rewritepolicy_binding <csvserver_rewritepolicy_binding[]> Read-only rewritepolicy that can be bound to csvserver.
csvserver_cspolicy_binding <csvserver_cspolicy_binding[]> Read-only cspolicy that can be bound to csvserver.
csvserver_gslbvserver_binding <csvserver_gslbvserver_binding[]> Read-only gslbvserver that can be bound to csvserver.
csvserver_appqoepolicy_binding <csvserver_appqoepolicy_binding[]> Read-only appqoepolicy that can be bound to csvserver.
csvserver_tmtrafficpolicy_binding <csvserver_tmtrafficpolicy_binding[]> Read-only tmtrafficpolicy that can be bound to csvserver.
csvserver_auditsyslogpolicy_binding <csvserver_auditsyslogpolicy_binding[]> Read-only auditsyslogpolicy that can be bound to csvserver.
csvserver_appfwpolicy_binding <csvserver_appfwpolicy_binding[]> Read-only appfwpolicy that can be bound to csvserver.

Operations

(click to see Properties )

  • GET
  • GET (ALL)

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/csvserver_binding/ name_value<String>

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_binding": [ {
      "name":<String_value>,
      "csvserver_auditnslogpolicy_binding":<csvserver_auditnslogpolicy_binding[]_value>,
      "csvserver_tmtrafficpolicy_binding":<csvserver_tmtrafficpolicy_binding[]_value>,
      "csvserver_lbvserver_binding":<csvserver_lbvserver_binding[]_value>,
      "csvserver_responderpolicy_binding":<csvserver_responderpolicy_binding[]_value>,
      "csvserver_gslbvserver_binding":<csvserver_gslbvserver_binding[]_value>,
      "csvserver_cachepolicy_binding":<csvserver_cachepolicy_binding[]_value>,
      "csvserver_filterpolicy_binding":<csvserver_filterpolicy_binding[]_value>,
      "csvserver_transformpolicy_binding":<csvserver_transformpolicy_binding[]_value>,
      "csvserver_botpolicy_binding":<csvserver_botpolicy_binding[]_value>,
      "csvserver_appflowpolicy_binding":<csvserver_appflowpolicy_binding[]_value>,
      "csvserver_appfwpolicy_binding":<csvserver_appfwpolicy_binding[]_value>,
      "csvserver_authorizationpolicy_binding":<csvserver_authorizationpolicy_binding[]_value>,
      "csvserver_auditsyslogpolicy_binding":<csvserver_auditsyslogpolicy_binding[]_value>,
      "csvserver_cmppolicy_binding":<csvserver_cmppolicy_binding[]_value>,
      "csvserver_analyticsprofile_binding":<csvserver_analyticsprofile_binding[]_value>,
      "csvserver_rewritepolicy_binding":<csvserver_rewritepolicy_binding[]_value>,
      "csvserver_cspolicy_binding":<csvserver_cspolicy_binding[]_value>,
      "csvserver_contentinspectionpolicy_binding":<csvserver_contentinspectionpolicy_binding[]_value>,
      "csvserver_spilloverpolicy_binding":<csvserver_spilloverpolicy_binding[]_value>,
      "csvserver_appqoepolicy_binding":<csvserver_appqoepolicy_binding[]_value>,
      "csvserver_feopolicy_binding":<csvserver_feopolicy_binding[]_value>,
      "csvserver_vpnvserver_binding":<csvserver_vpnvserver_binding[]_value>,
      "csvserver_domain_binding":<csvserver_domain_binding[]_value>
}]}

<!--NeedCopy-->

get (all)

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


{ "csvserver_binding": [ {
      "name":<String_value>,
      "csvserver_auditnslogpolicy_binding":<csvserver_auditnslogpolicy_binding[]_value>,
      "csvserver_tmtrafficpolicy_binding":<csvserver_tmtrafficpolicy_binding[]_value>,
      "csvserver_lbvserver_binding":<csvserver_lbvserver_binding[]_value>,
      "csvserver_responderpolicy_binding":<csvserver_responderpolicy_binding[]_value>,
      "csvserver_gslbvserver_binding":<csvserver_gslbvserver_binding[]_value>,
      "csvserver_cachepolicy_binding":<csvserver_cachepolicy_binding[]_value>,
      "csvserver_filterpolicy_binding":<csvserver_filterpolicy_binding[]_value>,
      "csvserver_transformpolicy_binding":<csvserver_transformpolicy_binding[]_value>,
      "csvserver_botpolicy_binding":<csvserver_botpolicy_binding[]_value>,
      "csvserver_appflowpolicy_binding":<csvserver_appflowpolicy_binding[]_value>,
      "csvserver_appfwpolicy_binding":<csvserver_appfwpolicy_binding[]_value>,
      "csvserver_authorizationpolicy_binding":<csvserver_authorizationpolicy_binding[]_value>,
      "csvserver_auditsyslogpolicy_binding":<csvserver_auditsyslogpolicy_binding[]_value>,
      "csvserver_cmppolicy_binding":<csvserver_cmppolicy_binding[]_value>,
      "csvserver_analyticsprofile_binding":<csvserver_analyticsprofile_binding[]_value>,
      "csvserver_rewritepolicy_binding":<csvserver_rewritepolicy_binding[]_value>,
      "csvserver_cspolicy_binding":<csvserver_cspolicy_binding[]_value>,
      "csvserver_contentinspectionpolicy_binding":<csvserver_contentinspectionpolicy_binding[]_value>,
      "csvserver_spilloverpolicy_binding":<csvserver_spilloverpolicy_binding[]_value>,
      "csvserver_appqoepolicy_binding":<csvserver_appqoepolicy_binding[]_value>,
      "csvserver_feopolicy_binding":<csvserver_feopolicy_binding[]_value>,
      "csvserver_vpnvserver_binding":<csvserver_vpnvserver_binding[]_value>,
      "csvserver_domain_binding":<csvserver_domain_binding[]_value>
}]}

<!--NeedCopy-->
csvserver_binding