Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

ping6

August 17, 2023
Contributed by: 
C

Configuration for 0 resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
b Read-write Set socket buffer size. If used, should be used with roughly +100 then the datalen (-s option). The default value is 8192.

Minimum value = 132

Maximum value = 131071
c Read-write Number of packets to send. The default value is infinite. For Nitro API, defalut value is taken as 5.

Minimum value = 1

Maximum value = 65535
i Read-write Waiting time, in seconds. The default value is 1 second.

Minimum value = 0

Maximum value = 65535
I Read-write Network interface on which to ping, if you have multiple interfaces.

Minimum length = 1

Maximum length = 15
m Read-write By default, ping6 asks the kernel to fragment packets to fit into the minimum IPv6 MTU.The -m option will suppress the behavior for unicast packets.
n Read-write Numeric output only. No name resolution.
p Read-write Pattern to fill in packets. Can be up to 16 bytes, useful for diagnosing data-dependent problems.

Minimum length = 1

Maximum length = 32
q Read-write Quiet output. Only summary is printed. For Nitro API, this flag is set by default.
s Read-write Data size, in bytes. The default value is 32.

Minimum value = 0

Maximum value = 65527
V Read-write VLAN ID for link local address.

Minimum value = 1

Maximum value = 4094
S Read-write Source IP address to be used in the outgoing query packets.

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

Minimum value = 1

Maximum value = 4094
t Read-write Timeout in seconds before ping6 exits.
hostName Read-write Address of host to ping.

Minimum length = 1

Maximum length = 256
response Read-only .

Operations

(click to see Properties )

  • PING6

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

Ping6

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"ping6":{
      "b":<Double_value>,
      "c":<Double_value>,
      "i":<Double_value>,
      "I":<String_value>,
      "m":<Boolean_value>,
      "n":<Boolean_value>,
      "p":<String_value>,
      "q":<Boolean_value>,
      "s":<Double_value>,
      "V":<Double_value>,
      "S":<String_value>,
      "T":<Double_value>,
      "t":<Double_value>,
<b>      "hostName":<String_value>
</b>}}

<!--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: 


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

}]}

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