Skip to content

tcp_interface

Configuration for AF TCP Interface Report table resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
data_volume<Double>Read-writeData Volume in given sampled timeframe..
__count<Double>Read-writecount..
trans_count_up<Double>Read-writeUpload Transaction Count.
avg_upload_speed_retx<Double>Read-writeTCP Average Upload Speed (with ReTx).
peak_burst_rate_down<Double>Read-writePeak Burst Download Rate.
avg_download_speed<Double>Read-writeTCP Average Download Speed.
peak_burst_rate_up_no_retx<Double>Read-writePeak Burst Upload Rate without Retransmissions.
peak_burst_rate_up<Double>Read-writePeak Burst Upload Rate.
id<String>Read-writeId is TCP Interface..
peak_burst_rate_down_no_retx<Double>Read-writePeak Burst Download Rate without Retransmissions.
avg_upload_speed<Double>Read-writeTCP Average Upload Speed.
rpt_sample_time<Double>Read-writeReport Sample time..
vlan<String>Read-writeVLAN Id.
trans_count_down<Double>Read-writeDownload Transaction Count.
avg_download_speed_retx<Double>Read-writeTCP Average Download Speed (with ReTx).
throughput<Double>Read-writeThroughput.

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/tcp_interface

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "tcp_interface":[{
"data_volume":<Double_value>,
"__count":<Double_value>,
"trans_count_up":<Double_value>,
"tcp_appname":<String_value>,
"bitrate_range_end":<Double_value>,
"avg_upload_speed_retx":<Double_value>,
"direction":<String_value>,
"peak_burst_rate_down":<Double_value>,
"avg_download_speed":<Double_value>,
"peak_burst_rate_up_no_retx":<Double_value>,
"peak_burst_rate_up":<Double_value>,
"id":<String_value>,
"peak_burst_rate_down_no_retx":<Double_value>,
"avg_upload_speed":<Double_value>,
"rpt_sample_time":<Double_value>,
"vlan":<String_value>,
"port":<String_value>,
"trans_count_down":<Double_value>,
"avg_download_speed_retx":<Double_value>,
"side":<String_value>,
"opt_type":<String_value>,
"throughput":<Double_value>}]}