Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

traceroute

August 17, 2023
Contributed by: 
C

Configuration for 0 resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
S Read-write Print a summary of how many probes were not answered for each hop.
n Read-write Print hop addresses numerically instead of symbolically and numerically.
r Read-write Bypass normal routing tables and send directly to a host on an attached network. If the host is not on a directly attached network, an error is returned.
v Read-write Verbose output. List received ICMP packets other than TIME_EXCEEDED and UNREACHABLE.
M Read-write Minimum TTL value used in outgoing probe packets.

Default value: 1

Minimum value = 1

Maximum value = 255
m Read-write Maximum TTL value used in outgoing probe packets. For Nitro API, default value is taken as 10.

Default value: 64

Minimum value = 1

Maximum value = 255
P Read-write Send packets of specified IP protocol. The currently supported protocols are UDP and ICMP.

Minimum length = 1

Maximum length = 20
p Read-write Base port number used in probes.

Default value: 33434

Minimum value = 1

Maximum value = 65535
q Read-write Number of queries per hop. For Nitro API, defalut value is taken as 1.

Default value: 3

Minimum value = 1

Maximum value = 65535
s Read-write Source IP address to use in the outgoing query packets. If the IP address does not belong to this appliance, an error is returned and nothing is sent.

Minimum length = 1
T Read-write Traffic Domain Id.

Minimum value = 1

Maximum value = 4094
t Read-write Type-of-service in query packets.

Minimum value = 0

Maximum value = 255
w Read-write Time (in seconds) to wait for a response to a query. For Nitro API, defalut value is set to 3.

Default value: 5

Minimum value = 2

Maximum value = 86399
host Read-write Destination host IP address or name.

Minimum length = 1

Maximum length = 64
packetlen Read-write Length (in bytes) of the query packets.

Default value: 44

Minimum value = 44

Maximum value = 32768
response Read-only .

Operations

(click to see Properties )

  • TRACEROUTE

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

Traceroute

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"traceroute":{
      "S":<Boolean_value>,
      "n":<Boolean_value>,
      "r":<Boolean_value>,
      "v":<Boolean_value>,
      "M":<Double_value>,
      "m":<Integer_value>,
      "P":<String_value>,
      "p":<Integer_value>,
      "q":<Integer_value>,
      "s":<String_value>,
      "T":<Double_value>,
      "t":<Integer_value>,
      "w":<Integer_value>,
<b>      "host":<String_value>,
</b>      "packetlen":<Integer_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

Response Payload: 


{ "traceroute": [ {
      "response":<String_value>

}]}

<!--NeedCopy-->
traceroute
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.