Product Documentation

lbmonitor_metric_binding

Sep 07, 2016

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

Properties (click to see Operations)

Name Data Type Permissions Description
metric
<String>
Read-write
Metric name in the metric table, whose setting is changed. A value zero disables the metric and it will not be used for load calculation.
Minimum length = 1
Maximum length = 37
metricthreshold
<Double>
Read-write
Threshold to be used for that metric.
metricweight
<Double>
Read-write
The weight for the specified service metric with respect to others.
Minimum value = 1
Maximum value = 100
monitorname
<String>
Read-write
Name of the monitor.
Minimum length = 1
metric_unit
<String>
Read-only
Giving the unit of the metric.
Possible values = Bytes/s, ms, pkts/s, users
metrictable
<String>
Read-only
Metric table to which to bind metrics.
Minimum length = 1
Maximum length = 99
__count
<Double>
Read-only
count parameter

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_metric_binding

HTTP Method: PUT

Request Headers:

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

Request Payload:

{
"lbmonitor_metric_binding":{
      "monitorname":<String_value>,
      "metric":<String_value>,
      "metricthreshold":<Double_value>,
      "metricweight":<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_metric_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

get

URL: http://<netscaler-ip-address>/nitro/v1/config/lbmonitor_metric_binding/monitorname_value<String>

Query-parameters:

filter

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

Use this query-parameter to get the filtered set of lbmonitor_metric_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/lbmonitor_metric_binding/monitorname_value<String>?pagesize=#no&pageno=#no

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

Content-Type:application/json

Response Payload:

{ "lbmonitor_metric_binding": [ {
      "metric":<String_value>,
      "metricthreshold":<Double_value>,
      "metricweight":<Double_value>,
      "monitorname":<String_value>,
      "metric_unit":<String_value>,
      "metrictable":<String_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/lbmonitor_metric_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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 Headers:

Content-Type:application/json

Response Payload:

{ "lbmonitor_metric_binding": [ {
      "metric":<String_value>,
      "metricthreshold":<Double_value>,
      "metricweight":<Double_value>,
      "monitorname":<String_value>,
      "metric_unit":<String_value>,
      "metrictable":<String_value>
}]}

count

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

Content-Type:application/json

Response Payload:

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