Product Documentation

lbmonitor_servicegroup_binding

Sep 07, 2016

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

Properties (click to see Operations)

Name Data Type Permissions Description
servicegroupname
<String>
Read-write
Name of the service group.
Minimum length = 1
dup_state
<String>
Read-write
State of the monitor. The state setting for a monitor of a given type affects all monitors of that type. For example, if an HTTP monitor is enabled, all HTTP monitors on the appliance are (or remain) enabled. If an HTTP monitor is disabled, all HTTP monitors on the appliance are disabled.
Default value: ENABLED
Possible values = ENABLED, DISABLED
servicename
<String>
Read-write
Name of the service or service group.
Minimum length = 1
state
<String>
Read-write
State of the monitor. The state setting for a monitor of a given type affects all monitors of that type. For example, if an HTTP monitor is enabled, all HTTP monitors on the appliance are (or remain) enabled. If an HTTP monitor is disabled, all HTTP monitors on the appliance are disabled.
Default value: ENABLED
Possible values = ENABLED, DISABLED
dup_weight
<Double>
Read-write
Weight to assign to the binding between the monitor and service.
Default value: 1
Minimum value = 1
Maximum value = 100
monitorname
<String>
Read-write
Name of the monitor.
Minimum length = 1
weight
<Double>
Read-write
Weight to assign to the binding between the monitor and service.
Minimum value = 1
Maximum value = 100

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add:

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{
"lbmonitor_servicegroup_binding":{
      "monitorname":<String_value>,
      "servicename":<String_value>,
      "dup_state":<String_value>,
      "dup_weight":<Double_value>,
      "servicegroupname":<String_value>,
      "state":<String_value>,
      "weight":<Double_value>
}}

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/lbmonitor_servicegroup_binding/monitorname_value<String>

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