Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

gslbvserver_lbpolicy_binding

May 23, 2024
Contributed by: 
C

Binding object showing the lbpolicy that can be bound to gslbvserver.

Properties

(click to see Operations )

Name Data Type Permissions Description
priority Read-write Priority.

Minimum value = 1

Maximum value = 2147483647
order Read-write Order number to be assigned to the service when it is bound to the lb vserver.

Minimum value = 1

Maximum value = 8192
gotopriorityexpression Read-write Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE. o If gotoPriorityExpression is not present or if it is equal to END then the policy bank evaluation ends here o Else if the gotoPriorityExpression is equal to NEXT then the next policy in the priority order is evaluated. o Else gotoPriorityExpression is evaluated. The result of gotoPriorityExpression (which has to be a number) is processed as follows
  • An UNDEF event is triggered if . gotoPriorityExpression cannot be evaluated . gotoPriorityExpression evaluates to number which is smaller than the maximum priority in the policy bank but is not same as any policy’s priority . gotoPriorityExpression evaluates to a priority that is smaller than the current policy’s priority
  • If the gotoPriorityExpression evaluates to the priority of the current policy then the next policy in the priority order is evaluated.
  • If the gotoPriorityExpression evaluates to the priority of a policy further ahead in the list then that policy will be evaluated next. This field is applicable only to rewrite and responder policies.
    		•
    policyname Read-write Name of the policy bound to the GSLB vserver.
    name Read-write Name of the virtual server on which to perform the binding operation.

    Minimum length = 1
    type Read-write The bindpoint to which the policy is bound.

    Possible values = REQUEST, RESPONSE, MQTT_JUMBO_REQ
    __count 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/gslbvserver_lbpolicy_binding HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {
"gslbvserver_lbpolicy_binding":{
<b>"name":<String_value>,
</b>"policyname":<String_value>,
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"type":<String_value>,
"order":<Double_value>
}}

<!--NeedCopy-->

    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/gslbvserver_lbpolicy_binding/ name_value<String> Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_lbpolicy_binding/ name_value<String> ? args=policyname: <String_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/gslbvserver_lbpolicy_binding/ name_value<String> Query-parameters: filter http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_lbpolicy_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

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

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

    {  "gslbvserver_lbpolicy_binding": [ {
"priority":<Double_value>,
"order":<Double_value>,
"gotopriorityexpression":<String_value>,
"policyname":<String_value>,
"name":<String_value>,
"type":<String_value>
}]}

<!--NeedCopy-->

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_lbpolicy_binding HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Query-parameters: bulkbindings http:// <netscaler-ip-address> /nitro/v1/config/gslbvserver_lbpolicy_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: 

    {  "gslbvserver_lbpolicy_binding": [ {
"priority":<Double_value>,
"order":<Double_value>,
"gotopriorityexpression":<String_value>,
"policyname":<String_value>,
"name":<String_value>,
"type":<String_value>
}]}

<!--NeedCopy-->

    count

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

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

<!--NeedCopy-->
    gslbvserver_lbpolicy_binding
    May 23, 2024
    Contributed by: 
    C
    May 23, 2024
    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.