Skip to content

metering_export

Configuration for Metering Data Export resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
file_name<String>Read-writeFile Name.
Minimum length = 1
Maximum length = 512
ip_address<String>Read-writeIP Address for this VM device for which metering data export is required.
Minimum length = 1
Maximum length = 64
end_time<Double>Read-onlyEnd Time of interval for which export is generated.
file_size<Integer>Read-onlyfile_size.
start_time<Double>Read-onlyStart Time of interval for which export is generated.
file_last_modified<String>Read-onlyLast Modified.
duration<String>Read-onlyInterval Duration for which export is generated.

Operations

(click to see Properties)

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

delete

URL: https://<MGMT-IP>/nitro/v1/config/metering_export/file_name_value<String>

HTTP Method: null

Response Payload:

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

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "metering_export":[{
"end_time":<Double_value>,
"file_size":<Integer_value>,
"file_name":<String_value>,
"start_time":<Double_value>,
"file_last_modified":<String_value>,
"duration":<String_value>,
"ip_address":<String_value>}]}