ADC NITRO APIs

gslbservicegroup_lbmonitor_binding

August 17, 2023

Contributed by:

Binding object showing the lbmonitor that can be bound to gslbservicegroup.

Properties

(click to see Operations )

Name	Permissions	Description
state	Read-write	Initial state of the service after binding. Default value: ENABLED Possible values = ENABLED, DISABLED
publicport	Read-write	The public port associated with the GSLB service’s public IP address. The port is mapped to the service’s private port number. Applicable to the local GSLB service. Optional.
weight	Read-write	Weight to assign to the servers in the service group. Specifies the capacity of the servers relative to the other servers in the load balancing configuration. The higher the weight, the higher the percentage of requests sent to the service. Minimum value = 1 Maximum value = 100
port	Read-write	Port number of the GSLB service. Each service must have a unique port number. Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
siteprefix	Read-write	The site’s prefix string. When the GSLB service group is bound to a GSLB virtual server, a GSLB site domain is generated internally for each bound serviceitem-domain pair by concatenating the site prefix of the service item and the name of the domain. If the special string NONE is specified, the site-prefix string is unset. When implementing HTTP redirect site persistence, the Citrix ADC redirects GSLB requests to GSLB services by using their site domains.
passive	Read-write	Indicates if load monitor is passive. A passive load monitor does not remove service from LB decision when threshold is breached.
monitor_name	Read-write	Monitor name.
monstate	Read-write	Monitor state. Possible values = ENABLED, DISABLED
servicegroupname	Read-write	Name of the GSLB service group. Minimum length = 1
hashid	Read-write	Unique numerical identifier used by hash based load balancing methods to identify a service. Minimum value = 1
publicip	Read-write	The public IP address that a NAT device translates to the GSLB service’s private IP address. Optional.
monweight	Read-only	weight of the monitor that is bound to GSLB servicegroup.
__count	Read-only	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/gslbservicegroup_lbmonitor_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{
"gslbservicegroup_lbmonitor_binding":{
<b>      "servicegroupname":<String_value>,
</b>      "port":<Integer_value>,
      "monitor_name":<String_value>,
      "monstate":<String_value>,
      "passive":<Boolean_value>,
      "weight":<Double_value>,
      "state":<String_value>,
      "hashid":<Double_value>,
      "publicip":<String_value>,
      "publicport":<Integer_value>,
      "siteprefix":<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/gslbservicegroup_lbmonitor_binding/ servicegroupname_value<String>

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup_lbmonitor_binding/ servicegroupname_value<String> ? args=port: <Integer_value> ,monitor_name: <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/gslbservicegroup_lbmonitor_binding/ servicegroupname_value<String>

Query-parameters:

filter

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

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

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

{  "gslbservicegroup_lbmonitor_binding": [ {
      "state":<String_value>,
      "publicport":<Integer_value>,
      "weight":<Double_value>,
      "port":<Integer_value>,
      "siteprefix":<String_value>,
      "passive":<Boolean_value>,
      "monitor_name":<String_value>,
      "monstate":<String_value>,
      "servicegroupname":<String_value>,
      "hashid":<Double_value>,
      "publicip":<String_value>,
      "monweight":<Double_value>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

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

{  "gslbservicegroup_lbmonitor_binding": [ {
      "state":<String_value>,
      "publicport":<Integer_value>,
      "weight":<Double_value>,
      "port":<Integer_value>,
      "siteprefix":<String_value>,
      "passive":<Boolean_value>,
      "monitor_name":<String_value>,
      "monstate":<String_value>,
      "servicegroupname":<String_value>,
      "hashid":<Double_value>,
      "publicip":<String_value>,
      "monweight":<Double_value>
}]}

<!--NeedCopy-->

count

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

{"gslbservicegroup_lbmonitor_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

gslbservicegroup_lbmonitor_binding

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

gslbservicegroup_lbmonitor_binding

Properties

Operations

add

delete

get

get (all)

count

In this article