Download full document:

servicegroup_lbmonitor_binding

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

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
servicegroupname	<String>	Read-write	Name of the service group.<br>Minimum length = 1
port	<Integer>	Read-write	Port number of the service. Each service must have a unique port number.<br>Range 1 - 65535
state	<String>	Read-write	Initial state of the service after binding.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
hashid	<Double>	Read-write	Unique numerical identifier used by hash based load balancing methods to identify a service.<br>Minimum value = 1
serverid	<Double>	Read-write	The identifier for the service. This is used when the persistency type is set to Custom Server ID.
customserverid	<String>	Read-write	Unique service identifier. Used when the persistency type for the virtual server is set to Custom Server ID.<br>Default value: "None"
weight	<Double>	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.<br>Minimum value = 1<br>Maximum value = 100
monitor_name	<String>	Read-write	Monitor name.
passive	<Boolean>	Read-write	Indicates if load monitor is passive. A passive load monitor does not remove service from LB decision when threshold is breached.
monstate	<String>	Read-write	Monitor state.<br>Possible values = ENABLED, DISABLED
monweight	<Double>	Read-only	weight of the monitor that is bound to servicegroup.
__count	<Double>	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://NS_IP/nitro/v1/config

HTTP Method: PUT

Request Payload:

{
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
sessionid":"##sessionid","servicegroup_lbmonitor_binding":{
      "servicegroupname":<String_value>,
      "port":<Integer_value>,
      "monitor_name":<String_value>,
                  "monstate":<String_value>,
                  "passive":<Boolean_value>,
      "weight":<Double_value>,
      "customserverid":<String_value>,
      "serverid":<Double_value>,
      "state":<String_value>,
      "hashid":<Double_value>,

}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete:

URL: http://<NS_IP>/nitro/v1/config/servicegroup_lbmonitor_binding/servicegroupname_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/servicegroup_lbmonitor_binding/servicegroupname_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get

URL: http://<NS_IP>/nitro/v1/config/servicegroup_lbmonitor_binding/servicegroupname_value<String>

Query-parameters:

filter

http://<NS_IP>/nitro/v1/config/servicegroup_lbmonitor_binding/servicegroupname_value<String>?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of servicegroup_lbmonitor_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/servicegroup_lbmonitor_binding/servicegroupname_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the servicegroup_lbmonitor_binding resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/servicegroup_lbmonitor_binding?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "servicegroup_lbmonitor_binding": [ {
      "servicegroupname":<String_value>,
      "port":<Integer_value>,
      "state":<String_value>,
      "hashid":<Double_value>,
      "serverid":<Double_value>,
      "customserverid":<String_value>,
      "weight":<Double_value>,
      "monitor_name":<String_value>,
      "passive":<Boolean_value>,
      "monstate":<String_value>,
      "monweight":<Double_value>,

}]}

count

URL: http://<NS_IP>/nitro/v1/config/servicegroup_lbmonitor_binding/servicegroupname_value<String>?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",servicegroup_lbmonitor_binding: [ { "__count": "#no"} ] }