NetScaler SDX 14.1 NITRO API Reference

metering_summary

Configuration for Metering Data Summary resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
number_of_bursts Read-write Number of bursts by VM Instance in Interval.
ip_address Read-write IP Address for this VM device for which metering data summary is required.

Minimum length = 1

Maximum length = 64
max_burst Read-only Maximum Burst Throughput of VM Instance for Interval in Mbps.
min_rx Read-only Minimum In Throughput of VM Instance for Interval in Mbps.
start_time Read-only Start Time of interval for which summary is generated.
duration Read-only Interval Duration for which summary is generated.
total_txmbits Read-only Out Total Rx of VM Instance for Interval in Mbits.
total_rxmbits Read-only In Total Rx of VM Instance for Interval in Mbits.
end_time Read-only End Time of interval for which summary is generated.
max_rx Read-only Maximum In Throughput of VM Instance for Interval in Mbps.
max_tx Read-only Maximum Out Throughput of VM Instance for Interval in Mbps.
min_tx Read-only Minimum 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

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

get (all)

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

filter https://<MGMT-IP>/nitro/v2/config/metering_summary ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of metering_summary 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_summary ?pagesize=#no;pageno=#no Use this query-parameter to get the metering_summary resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/metering_summary ?count=yes Use this query-parameter to get the count of metering_summary 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_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>}]}
metering_summary