Developer Documentation
ADM NITRO APIs

perf_tcp_surgelen_spareconn_report

June 20, 2023
Contributed by: 
C

Configuration for TCP Surge queue and spare connections Report resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
tcpsurgequeuelen Read-write tcpsurgequeuelen Value.
timestamp Read-write timestamp in milliseconds.
id Read-write Id is system generated key for all the entries in this perf table configuration.

Maximum length = 256
tcpspareconn Read-write tcpspareconn Value .
agg_level Read-write whether the row is Aggregated for Avg, Min, Max etc.
report_level Read-write whether the row is for minutely, hourly etc.
device_ip_address Read-write Device IP Address.

Minimum length = 1

Maximum length = 64
report_start_time Read-write report_start_time in seconds.
report_end_time Read-write report_end_time in seconds.

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_tcp_surgelen_spareconn_report 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_tcp_surgelen_spareconn_report":[{
"tcpsurgequeuelen":<Integer_value>,
"timestamp":<Double_value>,
"id":<String_value>,
"tcpspareconn":<Integer_value>,
"agg_level":<Integer_value>,
"report_level":<Integer_value>,
"device_ip_address":<String_value>,
"report_start_time":<Double_value>,
"report_end_time":<Double_value>}]}

<!--NeedCopy-->
perf_tcp_surgelen_spareconn_report
June 20, 2023
Contributed by: 
C
June 20, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.