ADC NITRO APIs

lbglobal_lbpolicy_binding

May 23, 2024

Contributed by:

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

Properties

(click to see Operations )

Name	Permissions	Description
priority	Read-write	Specifies the priority of the policy.
globalbindtype	Read-write	. Default value: SYSTEM_GLOBAL Possible values = SYSTEM_GLOBAL, VPN_GLOBAL, RNAT_GLOBAL, APPFW_GLOBAL
gotopriorityexpression	Read-write	Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
policyname	Read-write	Name of the LB policy.
type	Read-write	. Possible values = REQ_OVERRIDE, REQ_DEFAULT, OTHERTCP_REQ_OVERRIDE, OTHERTCP_REQ_DEFAULT, SIPUDP_REQ_OVERRIDE, SIPUDP_REQ_DEFAULT, SIPTCP_REQ_OVERRIDE, SIPTCP_REQ_DEFAULT, MSSQL_REQ_OVERRIDE, MSSQL_REQ_DEFAULT, MYSQL_REQ_OVERRIDE, MYSQL_REQ_DEFAULT, ORACLE_REQ_OVERRIDE, ORACLE_REQ_DEFAULT, NAT_REQ_OVERRIDE, NAT_REQ_DEFAULT, DIAMETER_REQ_OVERRIDE, DIAMETER_REQ_DEFAULT, RADIUS_REQ_OVERRIDE, RADIUS_REQ_DEFAULT, DNS_REQ_OVERRIDE, DNS_REQ_DEFAULT, MQTT_REQ_OVERRIDE, MQTT_REQ_DEFAULT, QUIC_OVERRIDE, QUIC_DEFAULT, HTTPQUIC_REQ_OVERRIDE, HTTPQUIC_REQ_DEFAULT, GSLB_REQ_OVERRIDE, GSLB_REQ_DEFAULT
labeltype	Read-write	Type of invocation, Available settings function as follows vserver - Invokes the unnamed policy label associated with the specified virtual server. policylabel - Invoke the specified policy label. Possible values = reqvserver, 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	If the current policy evaluates to TRUE, terminate evaluation of policies bound to the current policy label, and then forward the request to the specified virtual server or evaluate the specified policy label.
numpol	Read-only	number of polices bound to label.
flowtype	Read-only	flowtype of the bound LB policy.
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
DELETE
GET
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/lbglobal_lbpolicy_binding HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{
"lbglobal_lbpolicy_binding":{
<b>"policyname":<String_value>,
</b><b>"priority":<Double_value>,
</b>"type":<String_value>,
"gotopriorityexpression":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"labelname":<String_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/lbglobal_lbpolicy_binding Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/lbglobal_lbpolicy_binding? args= policyname:<String_value>, type: <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

Use this query-parameter to get lbglobal_lbpolicy_binding resources based on additional properties.

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

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

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

{  "lbglobal_lbpolicy_binding": [ {
"priority":<Double_value>,
"globalbindtype":<String_value>,
"gotopriorityexpression":<String_value>,
"policyname":<String_value>,
"type":<String_value>,
"labeltype":<String_value>,
"labelname":<String_value>,
"invoke":<Boolean_value>,
"numpol":<Double_value>,
"flowtype":<Double_value>
}]}

<!--NeedCopy-->

count

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

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

lbglobal_lbpolicy_binding

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

lbglobal_lbpolicy_binding

Properties

Operations

add

delete

get

count

In this article