Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

lbvserver_tmtrafficpolicy_binding

May 23, 2024
Contributed by: 
C

Binding object showing the tmtrafficpolicy that can be bound to lbvserver.

Properties

(click to see Operations )

Name Data Type Permissions Description
priority Read-write Priority.
order Read-write Integer specifying the order of the service. A larger number specifies a lower order. Defines the order of the service relative to the other services in the load balancing vserver’s bindings. Determines the priority given to the service among all the services bound.

Minimum value = 1

Maximum value = 8192
gotopriorityexpression Read-write Expression or other value specifying the next policy to be evaluated if the current policy evaluates to TRUE. Specify one of the following values
  • NEXT - Evaluate the policy with the next higher priority number.
  • END - End policy evaluation.
  • USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the evaluation stops. If the final goto is anything other than END, the current policy label performs a NEXT.
  • An expression that evaluates to a number. If you specify an expression, the number to which it evaluates determines the next policy to evaluate, as follows
  • If the expression evaluates to a higher numbered priority, the policy with that priority is evaluated next.
  • If the expression evaluates to the priority of the current policy, the policy with the next higher numbered priority is evaluated next.
  • If the expression evaluates to a priority number that is numerically higher than the highest numbered priority, policy evaluation ends. An UNDEF event is triggered if
  • The expression is invalid.
  • The expression evaluates to a priority number that is numerically lower than the current policy’s priority.
  • The expression evaluates to a priority number that is between the current policy’s priority number (say, 30) and the highest priority number (say, 100), but does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number increments by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.
    		•
    policyname Read-write Name of the policy bound to the LB vserver.
    name Read-write Name for the virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Can be changed after the virtual server is created.CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my vserver” or ‘my vserver’). .

    Minimum length = 1
    bindpoint Read-write Bind point to which to bind the policy.

    Possible values = REQUEST, RESPONSE, MQTT_JUMBO_REQ
    labeltype Read-write Type of policy label to invoke. Applicable only to rewrite, videooptimization and cache policies. Available settings function as follows
  • reqvserver - Evaluate the request against the request-based policies bound to the specified virtual server.
  • resvserver - Evaluate the response against the response-based policies bound to the specified virtual server.
  • policylabel - invoke the request or response against the specified user-defined policy label. Possible values = reqvserver, resvserver, policylabel
    		•
    labelname Read-write Name of the virtual server or user-defined policy label to invoke if the policy evaluates to TRUE.
    invoke Read-write Invoke policies bound to a virtual server or policy label.
    __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/lbvserver_tmtrafficpolicy_binding HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {
"lbvserver_tmtrafficpolicy_binding":{
<b>"name":<String_value>,
</b>"policyname":<String_value>,
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"bindpoint":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"labelname":<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/lbvserver_tmtrafficpolicy_binding/ name_value<String> Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/lbvserver_tmtrafficpolicy_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/lbvserver_tmtrafficpolicy_binding/ name_value<String> Query-parameters: filter http:// <netscaler-ip-address> /nitro/v1/config/lbvserver_tmtrafficpolicy_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

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

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

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

<!--NeedCopy-->

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/lbvserver_tmtrafficpolicy_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_tmtrafficpolicy_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_tmtrafficpolicy_binding": [ {
"priority":<Double_value>,
"order":<Double_value>,
"gotopriorityexpression":<String_value>,
"policyname":<String_value>,
"name":<String_value>,
"bindpoint":<String_value>,
"labeltype":<String_value>,
"labelname":<String_value>,
"invoke":<Boolean_value>
}]}

<!--NeedCopy-->

    count

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

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

<!--NeedCopy-->
    lbvserver_tmtrafficpolicy_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.