Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

nstimeout

August 17, 2023
Contributed by: 
C

Configuration for timeout resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
zombie Read-write Interval, in seconds, at which the Citrix ADC zombie cleanup process must run. This process cleans up inactive TCP connections.

Default value: 120

Minimum value = 1

Maximum value = 600
client Read-write Client idle timeout (in seconds). If zero, the service-type default value is taken when service is created.

Default value: 0

Minimum value = 0

Maximum value = 18000
server Read-write Server idle timeout (in seconds). If zero, the service-type default value is taken when service is created.

Default value: 0

Minimum value = 0

Maximum value = 18000
httpclient Read-write Global idle timeout, in seconds, for client connections of HTTP service type. This value is over ridden by the client timeout that is configured on individual entities.

Default value: 0

Minimum value = 0

Maximum value = 18000
httpserver Read-write Global idle timeout, in seconds, for server connections of HTTP service type. This value is over ridden by the server timeout that is configured on individual entities.

Default value: 0

Minimum value = 0

Maximum value = 18000
tcpclient Read-write Global idle timeout, in seconds, for non-HTTP client connections of TCP service type. This value is over ridden by the client timeout that is configured on individual entities.

Default value: 0

Minimum value = 0

Maximum value = 18000
tcpserver Read-write Global idle timeout, in seconds, for non-HTTP server connections of TCP service type. This value is over ridden by the server timeout that is configured on entities.

Default value: 0

Minimum value = 0

Maximum value = 18000
anyclient Read-write Global idle timeout, in seconds, for non-TCP client connections. This value is over ridden by the client timeout that is configured on individual entities.

Default value: 0

Minimum value = 0

Maximum value = 31536000
anyserver Read-write Global idle timeout, in seconds, for non TCP server connections. This value is over ridden by the server timeout that is configured on individual entities.

Default value: 0

Minimum value = 0

Maximum value = 31536000
anytcpclient Read-write Global idle timeout, in seconds, for TCP client connections. This value takes precedence over entity level timeout settings (vserver/service). This is applicable only to transport protocol TCP.

Default value: 0

Minimum value = 0

Maximum value = 31536000
anytcpserver Read-write Global idle timeout, in seconds, for TCP server connections. This value takes precedence over entity level timeout settings ( vserver/service). This is applicable only to transport protocol TCP.

Default value: 0

Minimum value = 0

Maximum value = 31536000
halfclose Read-write Idle timeout, in seconds, for connections that are in TCP half-closed state.

Default value: 10

Minimum value = 1

Maximum value = 600
nontcpzombie Read-write Interval at which the zombie clean-up process for non-TCP connections should run. Inactive IP NAT connections will be cleaned up.

Default value: 60

Minimum value = 1

Maximum value = 600
reducedfintimeout Read-write Alternative idle timeout, in seconds, for closed TCP NATPCB connections.

Default value: 30

Minimum value = 1

Maximum value = 300
reducedrsttimeout Read-write Timer interval, in seconds, for abruptly terminated TCP NATPCB connections.

Default value: 0

Minimum value = 0

Maximum value = 300
newconnidletimeout Read-write Timer interval, in seconds, for new TCP NATPCB connections on which no data was received.

Default value: 4

Minimum value = 1

Maximum value = 120

Operations

(click to see Properties )

  • UPDATE
  • UNSET
  • 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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstimeout

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"nstimeout":{
      "zombie":<Double_value>,
      "client":<Double_value>,
      "server":<Double_value>,
      "httpclient":<Double_value>,
      "httpserver":<Double_value>,
      "tcpclient":<Double_value>,
      "tcpserver":<Double_value>,
      "anyclient":<Double_value>,
      "anyserver":<Double_value>,
      "anytcpclient":<Double_value>,
      "anytcpserver":<Double_value>,
      "halfclose":<Double_value>,
      "nontcpzombie":<Double_value>,
      "reducedfintimeout":<Double_value>,
      "reducedrsttimeout":<Double_value>,
      "newconnidletimeout":<Double_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstimeout? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"nstimeout":{
      "zombie":true,
      "client":true,
      "server":true,
      "httpclient":true,
      "httpserver":true,
      "tcpclient":true,
      "tcpserver":true,
      "anyclient":true,
      "anyserver":true,
      "anytcpclient":true,
      "anytcpserver":true,
      "halfclose":true,
      "nontcpzombie":true,
      "reducedfintimeout":true,
      "reducedrsttimeout":true,
      "newconnidletimeout":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstimeout

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{ "nstimeout": [ {
      "zombie":<Double_value>,
      "client":<Double_value>,
      "server":<Double_value>,
      "httpclient":<Double_value>,
      "httpserver":<Double_value>,
      "tcpclient":<Double_value>,
      "tcpserver":<Double_value>,
      "anyclient":<Double_value>,
      "anyserver":<Double_value>,
      "halfclose":<Double_value>,
      "anytcpclient":<Double_value>,
      "anytcpserver":<Double_value>,
      "nontcpzombie":<Double_value>,
      "reducedfintimeout":<Double_value>,
      "reducedrsttimeout":<Double_value>,
      "newconnidletimeout":<Double_value>
}]}

<!--NeedCopy-->
nstimeout
August 17, 2023
Contributed by: 
C
August 17, 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.