Skip to content

metering_summary

Configuration for Metering Data Summary resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
number_of_bursts<Integer>Read-writeNumber of bursts by VM Instance in Interval.
ip_address<String>Read-writeIP Address for this VM device for which metering data summary is required.
Minimum length = 1
Maximum length = 64
max_burst<Double>Read-onlyMaximum Burst Throughput of VM Instance for Interval in Mbps.
min_rx<Double>Read-onlyMinimum In Throughput of VM Instance for Interval in Mbps.
start_time<Double>Read-onlyStart Time of interval for which summary is generated.
duration<String>Read-onlyInterval Duration for which summary is generated.
total_txmbits<Double>Read-onlyOut Total Rx of VM Instance for Interval in Mbits.
total_rxmbits<Double>Read-onlyIn Total Rx of VM Instance for Interval in Mbits.
end_time<Double>Read-onlyEnd Time of interval for which summary is generated.
max_rx<Double>Read-onlyMaximum In Throughput of VM Instance for Interval in Mbps.
max_tx<Double>Read-onlyMaximum Out Throughput of VM Instance for Interval in Mbps.
min_tx<Double>Read-onlyMinimum Out Throughput of VM Instance for Interval in Mbps.

Operations

(click to see Properties)

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>.

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "metering_summary":[{
"max_burst":<Double_value>,
"min_rx":<Double_value>,
"start_time":<Double_value>,
"duration":<String_value>,
"number_of_bursts":<Integer_value>,
"total_txmbits":<Double_value>,
"total_rxmbits":<Double_value>,
"end_time":<Double_value>,
"max_rx":<Double_value>,
"max_tx":<Double_value>,
"min_tx":<Double_value>,
"ip_address":<String_value>}]}