perf_reports

Last published : Aug 10, 2026
Configuration for Performance Management Reports resource.
Related information

Properties

(click to see Operations )
Name Data Type Permissions Description
report_description <String> Read-write Short Description of the report. Minimum length = 1 Maximum length = 200
device_family <String> Read-write Device Family of which this report belongs to.
db_table_name <String> Read-write Table Name in DB for the corresponding report. Minimum length = 1 Maximum length = 64
counter_groups <String> Read-write Counter Group(s) from which the report is generated. Minimum length = 1 Maximum length = 100
report_name <String> Read-write Name of Report. Minimum length = 1 Maximum length = 100
enable_on_devices <String> Read-write On which devices the report is enabled. Minimum length = 1 Maximum length = 100

Operations

(click to see Properties )
  • GET
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

URL: https://<MGMT-IP>/nitro/v2/config/perf_reports 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, "perf_reports":[{
"report_description":<String_value>,
"device_family":<String_value>,
"db_table_name":<String_value>,
"counter_groups":<String_value>,
"report_name":<String_value>,
"enable_on_devices":<String_value>}]}