Skip to content

lbmonitor_metric_binding

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

Properties

(click to see Operations)

NameData TypePermissionsDescription
monitorname<String>Read-writeName of the monitor.
Minimum length = 1
metric<String>Read-writeMetric 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-writeThreshold to be used for that metric.
metricweight<Double>Read-writeThe weight for the specified service metric with respect to others.
Minimum value = 1
Maximum value = 100
metrictable<String>Read-onlyMetric table to which to bind metrics.
Minimum length = 1
Maximum length = 99
metric_unit<String>Read-onlyGiving the unit of the metric.
Possible values = Bytes/s, ms, pkts/s, users
__count<Double>Read-onlycount 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

add:

URL:http://<Citrix-ADC-IP-address(NSIP)/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":{
<b>"monitorname":<String_value>,
</b>"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 Citrix ADC specific errors). The response payload provides details of the error

delete:

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbmonitor_metric_binding/monitorname_value<String>

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbmonitor_metric_binding/monitorname_value<String>?args=metric:<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 Citrix ADC specific errors). The response payload provides details of the error

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbmonitor_metric_binding/monitorname_value<String>

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC. Filtering can be done on any of the properties of the resource.

pagination

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/lbmonitor_metric_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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