Developer Documentation
NetScaler SDX 14.1 NITRO API Reference

metering_data

March 20, 2024
Contributed by: 
C

Configuration for Metering Data for VM Devices resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
id Read-write Id is system generated key for all the metering data points.
ip_address Read-write IP Address for this VM device for which data is recorded.

Minimum length = 1

Maximum length = 64
interval_txmbits Read-only Out Tx of VM Instance for Interval in Mbits.
burst_thpt Read-only Burst Throughput of VM Instance in Mbps.
tx Read-only Out Throughput of VM Instance in Mbps.
rx Read-only In Throughput of VM Instance in Mbps.
start_time Read-only Start Time of Interval for which data was recorded.
min_thpt Read-only Minimum Throughput allocated to Instance in Mbps.
interval_rxmbits Read-only In Rx of VM Instance for Interval in Mbits.
poll_time Read-only Poll Time at which data was recorded.
max_thpt_limit Read-only Maximum Throughput Limit allowed for VM Instance in Mbps.
total_txmbits Read-only Out Total Rx of VM Instance in Mbits.
thpt_limit Read-only Throughput Limit configured for VM Instance in Mbps.
total_rxmbits Read-only In Total Rx of VM Instance in Mbits.

Operations

(click to see Properties )

  • PRUNE
  • GET (ALL)

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

prune

URL: https://<MGMT-IP>/nitro/v2/config/metering_data/id_value<String>?action=prune;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload: 

{"metering_data": { }}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt}

<!--NeedCopy-->

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/metering_data Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/metering_data ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of metering_data resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/metering_data ?pagesize=#no;pageno=#no Use this query-parameter to get the metering_data resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/metering_data ?count=yes Use this query-parameter to get the count of metering_data resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "metering_data":[{
"interval_txmbits":<Double_value>,
"burst_thpt":<Double_value>,
"tx":<Double_value>,
"rx":<Double_value>,
"start_time":<Double_value>,
"min_thpt":<Double_value>,
"interval_rxmbits":<Double_value>,
"poll_time":<Double_value>,
"max_thpt_limit":<Double_value>,
"total_txmbits":<Double_value>,
"thpt_limit":<Double_value>,
"total_rxmbits":<Double_value>,
"id":<String_value>,
"ip_address":<String_value>}]}

<!--NeedCopy-->
metering_data
March 20, 2024
Contributed by: 
C
March 20, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.