Skip to content

metering_data

Configuration for Metering Data for VM Devices resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
id<String>Read-writeId is system generated key for all the metering data points.
ip_address<String>Read-writeIP Address for this VM device for which data is recorded.
Minimum length = 1
Maximum length = 64
interval_txmbits<Double>Read-onlyOut Tx of VM Instance for Interval in Mbits.
burst_thpt<Double>Read-onlyBurst Throughput of VM Instance in Mbps.
tx<Double>Read-onlyOut Throughput of VM Instance in Mbps.
rx<Double>Read-onlyIn Throughput of VM Instance in Mbps.
start_time<Double>Read-onlyStart Time of Interval for which data was recorded.
min_thpt<Double>Read-onlyMinimum Throughput allocated to Instance in Mbps.
interval_rxmbits<Double>Read-onlyIn Rx of VM Instance for Interval in Mbits.
poll_time<Double>Read-onlyPoll Time at which data was recorded.
max_thpt_limit<Double>Read-onlyMaximum Throughput Limit allowed for VM Instance in Mbps.
total_txmbits<Double>Read-onlyOut Total Rx of VM Instance in Mbits.
thpt_limit<Double>Read-onlyThroughput Limit configured for VM Instance in Mbps.
total_rxmbits<Double>Read-onlyIn 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>.

prune

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

HTTP Method: null

Request Payload:

{"metering_data": { }}

Response Payload:

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

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/metering_data

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}