Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

lbvserver_binding

August 17, 2023
Contributed by: 
C

Binding object which returns the resources bound to lbvserver.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of the virtual server. If no name is provided, statistical data of all configured virtual servers is displayed.

Minimum length = 1
lbvserver_spilloverpolicy_binding <lbvserver_spilloverpolicy_binding[]> Read-only spilloverpolicy that can be bound to lbvserver.
lbvserver_csvserver_binding <lbvserver_csvserver_binding[]> Read-only csvserver that can be bound to lbvserver.
lbvserver_auditnslogpolicy_binding <lbvserver_auditnslogpolicy_binding[]> Read-only auditnslogpolicy that can be bound to lbvserver.
lbvserver_filterpolicy_binding <lbvserver_filterpolicy_binding[]> Read-only filterpolicy that can be bound to lbvserver.
lbvserver_analyticsprofile_binding <lbvserver_analyticsprofile_binding[]> Read-only analyticsprofile that can be bound to lbvserver.
lbvserver_cmppolicy_binding <lbvserver_cmppolicy_binding[]> Read-only cmppolicy that can be bound to lbvserver.
lbvserver_appflowpolicy_binding <lbvserver_appflowpolicy_binding[]> Read-only appflowpolicy that can be bound to lbvserver.
lbvserver_responderpolicy_binding <lbvserver_responderpolicy_binding[]> Read-only responderpolicy that can be bound to lbvserver.
lbvserver_videooptimizationdetectionpolicy_binding <lbvserver_videooptimizationdetectionpolicy_binding[]> Read-only videooptimizationdetectionpolicy that can be bound to lbvserver.
lbvserver_transformpolicy_binding <lbvserver_transformpolicy_binding[]> Read-only transformpolicy that can be bound to lbvserver.
lbvserver_dospolicy_binding <lbvserver_dospolicy_binding[]> Read-only dospolicy that can be bound to lbvserver.
lbvserver_contentinspectionpolicy_binding <lbvserver_contentinspectionpolicy_binding[]> Read-only contentinspectionpolicy that can be bound to lbvserver.
lbvserver_servicegroupmember_binding <lbvserver_servicegroupmember_binding[]> Read-only servicegroupmember that can be bound to lbvserver.
lbvserver_feopolicy_binding <lbvserver_feopolicy_binding[]> Read-only feopolicy that can be bound to lbvserver.
lbvserver_botpolicy_binding <lbvserver_botpolicy_binding[]> Read-only botpolicy that can be bound to lbvserver.
lbvserver_videooptimizationpacingpolicy_binding <lbvserver_videooptimizationpacingpolicy_binding[]> Read-only videooptimizationpacingpolicy that can be bound to lbvserver.
lbvserver_authorizationpolicy_binding <lbvserver_authorizationpolicy_binding[]> Read-only authorizationpolicy that can be bound to lbvserver.
lbvserver_dnspolicy64_binding <lbvserver_dnspolicy64_binding[]> Read-only dnspolicy64 that can be bound to lbvserver.
lbvserver_cachepolicy_binding <lbvserver_cachepolicy_binding[]> Read-only cachepolicy that can be bound to lbvserver.
lbvserver_rewritepolicy_binding <lbvserver_rewritepolicy_binding[]> Read-only rewritepolicy that can be bound to lbvserver.
lbvserver_scpolicy_binding <lbvserver_scpolicy_binding[]> Read-only scpolicy that can be bound to lbvserver.
lbvserver_pqpolicy_binding <lbvserver_pqpolicy_binding[]> Read-only pqpolicy that can be bound to lbvserver.
lbvserver_service_binding <lbvserver_service_binding[]> Read-only service that can be bound to lbvserver.
lbvserver_servicegroup_binding <lbvserver_servicegroup_binding[]> Read-only servicegroup that can be bound to lbvserver.
lbvserver_tmtrafficpolicy_binding <lbvserver_tmtrafficpolicy_binding[]> Read-only tmtrafficpolicy that can be bound to lbvserver.
lbvserver_auditsyslogpolicy_binding <lbvserver_auditsyslogpolicy_binding[]> Read-only auditsyslogpolicy that can be bound to lbvserver.
lbvserver_appqoepolicy_binding <lbvserver_appqoepolicy_binding[]> Read-only appqoepolicy that can be bound to lbvserver.
lbvserver_appfwpolicy_binding <lbvserver_appfwpolicy_binding[]> Read-only appfwpolicy that can be bound to lbvserver.

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/lbvserver_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: 


{ "lbvserver_binding": [ {
      "name":<String_value>,
      "lbvserver_auditsyslogpolicy_binding":<lbvserver_auditsyslogpolicy_binding[]_value>,
      "lbvserver_pqpolicy_binding":<lbvserver_pqpolicy_binding[]_value>,
      "lbvserver_dnspolicy64_binding":<lbvserver_dnspolicy64_binding[]_value>,
      "lbvserver_appfwpolicy_binding":<lbvserver_appfwpolicy_binding[]_value>,
      "lbvserver_rewritepolicy_binding":<lbvserver_rewritepolicy_binding[]_value>,
      "lbvserver_videooptimizationpacingpolicy_binding":<lbvserver_videooptimizationpacingpolicy_binding[]_value>,
      "lbvserver_contentinspectionpolicy_binding":<lbvserver_contentinspectionpolicy_binding[]_value>,
      "lbvserver_spilloverpolicy_binding":<lbvserver_spilloverpolicy_binding[]_value>,
      "lbvserver_auditnslogpolicy_binding":<lbvserver_auditnslogpolicy_binding[]_value>,
      "lbvserver_appqoepolicy_binding":<lbvserver_appqoepolicy_binding[]_value>,
      "lbvserver_transformpolicy_binding":<lbvserver_transformpolicy_binding[]_value>,
      "lbvserver_filterpolicy_binding":<lbvserver_filterpolicy_binding[]_value>,
      "lbvserver_scpolicy_binding":<lbvserver_scpolicy_binding[]_value>,
      "lbvserver_feopolicy_binding":<lbvserver_feopolicy_binding[]_value>,
      "lbvserver_csvserver_binding":<lbvserver_csvserver_binding[]_value>,
      "lbvserver_appflowpolicy_binding":<lbvserver_appflowpolicy_binding[]_value>,
      "lbvserver_analyticsprofile_binding":<lbvserver_analyticsprofile_binding[]_value>,
      "lbvserver_videooptimizationdetectionpolicy_binding":<lbvserver_videooptimizationdetectionpolicy_binding[]_value>,
      "lbvserver_authorizationpolicy_binding":<lbvserver_authorizationpolicy_binding[]_value>,
      "lbvserver_servicegroup_binding":<lbvserver_servicegroup_binding[]_value>,
      "lbvserver_cachepolicy_binding":<lbvserver_cachepolicy_binding[]_value>,
      "lbvserver_botpolicy_binding":<lbvserver_botpolicy_binding[]_value>,
      "lbvserver_service_binding":<lbvserver_service_binding[]_value>,
      "lbvserver_servicegroupmember_binding":<lbvserver_servicegroupmember_binding[]_value>,
      "lbvserver_responderpolicy_binding":<lbvserver_responderpolicy_binding[]_value>,
      "lbvserver_dospolicy_binding":<lbvserver_dospolicy_binding[]_value>,
      "lbvserver_tmtrafficpolicy_binding":<lbvserver_tmtrafficpolicy_binding[]_value>,
      "lbvserver_cmppolicy_binding":<lbvserver_cmppolicy_binding[]_value>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

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


{ "lbvserver_binding": [ {
      "name":<String_value>,
      "lbvserver_auditsyslogpolicy_binding":<lbvserver_auditsyslogpolicy_binding[]_value>,
      "lbvserver_pqpolicy_binding":<lbvserver_pqpolicy_binding[]_value>,
      "lbvserver_dnspolicy64_binding":<lbvserver_dnspolicy64_binding[]_value>,
      "lbvserver_appfwpolicy_binding":<lbvserver_appfwpolicy_binding[]_value>,
      "lbvserver_rewritepolicy_binding":<lbvserver_rewritepolicy_binding[]_value>,
      "lbvserver_videooptimizationpacingpolicy_binding":<lbvserver_videooptimizationpacingpolicy_binding[]_value>,
      "lbvserver_contentinspectionpolicy_binding":<lbvserver_contentinspectionpolicy_binding[]_value>,
      "lbvserver_spilloverpolicy_binding":<lbvserver_spilloverpolicy_binding[]_value>,
      "lbvserver_auditnslogpolicy_binding":<lbvserver_auditnslogpolicy_binding[]_value>,
      "lbvserver_appqoepolicy_binding":<lbvserver_appqoepolicy_binding[]_value>,
      "lbvserver_transformpolicy_binding":<lbvserver_transformpolicy_binding[]_value>,
      "lbvserver_filterpolicy_binding":<lbvserver_filterpolicy_binding[]_value>,
      "lbvserver_scpolicy_binding":<lbvserver_scpolicy_binding[]_value>,
      "lbvserver_feopolicy_binding":<lbvserver_feopolicy_binding[]_value>,
      "lbvserver_csvserver_binding":<lbvserver_csvserver_binding[]_value>,
      "lbvserver_appflowpolicy_binding":<lbvserver_appflowpolicy_binding[]_value>,
      "lbvserver_analyticsprofile_binding":<lbvserver_analyticsprofile_binding[]_value>,
      "lbvserver_videooptimizationdetectionpolicy_binding":<lbvserver_videooptimizationdetectionpolicy_binding[]_value>,
      "lbvserver_authorizationpolicy_binding":<lbvserver_authorizationpolicy_binding[]_value>,
      "lbvserver_servicegroup_binding":<lbvserver_servicegroup_binding[]_value>,
      "lbvserver_cachepolicy_binding":<lbvserver_cachepolicy_binding[]_value>,
      "lbvserver_botpolicy_binding":<lbvserver_botpolicy_binding[]_value>,
      "lbvserver_service_binding":<lbvserver_service_binding[]_value>,
      "lbvserver_servicegroupmember_binding":<lbvserver_servicegroupmember_binding[]_value>,
      "lbvserver_responderpolicy_binding":<lbvserver_responderpolicy_binding[]_value>,
      "lbvserver_dospolicy_binding":<lbvserver_dospolicy_binding[]_value>,
      "lbvserver_tmtrafficpolicy_binding":<lbvserver_tmtrafficpolicy_binding[]_value>,
      "lbvserver_cmppolicy_binding":<lbvserver_cmppolicy_binding[]_value>
}]}

<!--NeedCopy-->
lbvserver_binding
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.