Download full document:

lbmetrictable_metric_binding

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

Properties

(click to see Operations)

Name Data Type PermissionsDescription
metric<String>Read-writeName of the metric for which to change the SNMP OID.<br>Minimum length = 1
metrictable<String>Read-writeName of the metric table.<br>Minimum length = 1<br>Maximum length = 31
Snmpoid<String>Read-writeNew SNMP OID of the metric.<br>Minimum length = 1
metrictype<String>Read-onlyIndication if it is a configured or internal.<br>Possible values = INTERNAL, CONFIGURED
__count<Double>Read-onlycount 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","lbmetrictable_metric_binding":{
      "metrictable":<String_value>,
      "metric":<String_value>,
                  "Snmpoid":<String_value>,

}}

Response Payload:

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

delete:

URL: http://<NS_IP>/nitro/v1/config/lbmetrictable_metric_binding/metrictable_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/lbmetrictable_metric_binding/metrictable_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/lbmetrictable_metric_binding/metrictable_value<String>

Query-parameters:

filter

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

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

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

warning

http://<NS_IP>/nitro/v1/config/lbmetrictable_metric_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>, "lbmetrictable_metric_binding": [ {
      "metric":<String_value>,
      "metrictable":<String_value>,
      "Snmpoid":<String_value>,
      "metrictype":<String_value>,

}]}

count

URL: http://<NS_IP>/nitro/v1/config/lbmetrictable_metric_binding/metrictable_value<String>?count=yes

HTTP Method: GET

Response Payload:

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