CALL:DATA:PING

CALL:DATA:PING

Last updated: May 25, 2009

This section is only applicable to the lab application.

GPIB Command Conventions

CALL:DATA:PING[:ALL]?

Function

This command returns the following results: packets transmitted, packets received, percent packets lost, minimum round trip time (in seconds), average round trip time (in seconds), maximum round trip time (in seconds).

This command will return 9.91 E+37 if the CALL:FUNCtion:DATA:TYPE command is not set to IPData, or if ping results are not available.

Requirements Lab Application Revision: A.01 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:ALL?"
 
ENTER 714;Pxmit,Prcvd,Plost,Min_time,Avg_time,Max_time

CALL:DATA:PING:ICOunt?

Function

This command queries the value that is available when the query is received.

Requirements Lab Application Revision: A.01 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:ICOUNT?"
 
ENTER 714;variable_name

CALL:DATA:PING:PACKets:RX?

Function

This command queries the number of packets received from the device being tested or from the alternate device if CALL:DATA:PING:SETup:DEVice is set to ALTernate.

This command will return 9.91 E+37 if the CALL:FUNCtion:DATA:TYPE command is not set to IPData, or if ping results are not available.

Requirements Lab Application Revision: A.01 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:PACKETS:RX?" 
 
ENTER 714;variable_name
 
!Queries the number of packets received from the device being tested.

CALL:DATA:PING:PACKets:TX?

Function

This queries the number of packets transmitted from the test set.

This command will return 9.91 E+37 if the CALL:FUNCtion:DATA:TYPE command is not set to IPData, or if ping results are not available.

Requirements Lab Application Revision: A.01 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:PACKETS:TX?"
 
ENTER 714;variable_name
 
!Queries the number of packets transmitted from the test set.

CALL:DATA:PING:PLOSs?

Function

This command queries the percentage of packets lost during the ping session.

This command will return 9.91 E+37 if the CALL:FUNCtion:DATA:TYPE command is not set to IPData, or if ping results are not available.

Requirements Lab Application Revision: A.01 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:PLOSS?" !Queries the percentage of lost packets.
 
ENTER 714;variable_name

CALL:DATA:PING:SETup:ALTernate:IP:ADDRess[:IP4]

Function

This sets/queries the alternate internet protocol (IP) address. This address will be used as the address to ping instead of the device under test if the CALL:DATA:PING:SETup:DEVice command is set to ALT and the CALL:DATA:PING:SETup:PROTocol is set to IP4.

Setting

Range: IPv4 address in dotted decimal format.

Query

Same as setting.

Requirements

Lab Application Revision: A.01 and above

Lab Application Revision: F.00.19 and above, added [:IP4]

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:SETUP:ALTERNATE:IP:ADDRESS '192.168.16.57'"

CALL:DATA:PING:SETup:ALTernate:IP:ADDRess:IP6

Function

This sets/queries the Alternate internet protocol version 6(IPv6) pinging address. This address will be used as the alternate address to ping instead of the device under test if the CALL:DATA:PING:SETup:DEVice command is set to ALT and the CALL:DATA:PING:SETup:PROTocol command is set to IP6.

Setting

Range: 0 to 45 characters of an valid IPv6 address, this can be a normal 39- character IPv6 address, a zero compression IPv6 address or a up to 45-character IPv4 address-compatible address (see IPv6 Address Requirements ). Ranges are from

  • "" (blank field) or
  • 2000:0000:0000:0000:0000:0000:0000:0000 to 3FFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF or
  • FC00:0000:0000:0000:0000:0000:0000:0000 to FDFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF or
  • FE80:0000:0000:0000:0000:0000:0000:0000 to FEBF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF

Query

Range: "" (blank field) or 39 characters of IPv6 address with the format: AAAA:BBBB:CCCC:DDDD:EEEE:FFFF:GGGG:HHHH. Each of the A, B, ... H is an hex number ranging from 0 to F.

*RST Setting

FE80:0000:0000:0000:0000:0000:0000:0001
Requirements Lab Application Revision: F.00.19 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:SETUP:ALTERNATE:IP:ADDRESS:IP6 '2009::146.208.232.220'"
Sets the alternate Ping6 Address to 2009::146.208.232.220.
 
OUTPUT 714;"CALL:DATA:PING:SETUP:ALTERNATE:IP:ADDRESS:IP6 'FE80::1'"
Sets the alternate Ping6 Address to FE80::1.

CALL:DATA:PING:SETup:COUNt

Function

This command set/queries the number of ping IP messages sent for each uninterrupted invocation of the CALL:DATA:PING:STARt command.

Setting

Range: 1 to 2147483647

Query

Same as setting
Requirements

Lab Application Revision: A.01 and above

Lab Application Revision D.01, extended the upper limit of the range from 1000 to 2147483647

*RST Setting

10

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:SETUP:COUNT 20"

CALL:DATA:PING:SETup:DEVice

Function

This command sets/queries which device address is used in the ping IP packets, the address of the device under test, or the address of an alternate device.

Setting

Range: DUT|ALTernate

Query

Range: DUT|ALT

Requirements Lab Application Revision: A.01 and above

*RST Setting

DUT

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:SETUP:DEVice ALT"

CALL:DATA:PING:SETup:PACKet[:SIZE][:IP4]

Function

This command sets/queries the number of bytes sent by the test set in each ping packet when the CALL:DATA:PING:SETup:PROTocol command is set to IP4.

Setting

Range: 8 to 4076

Resolution: 1

Query

Same as setting
Requirements

Lab Application Revision: A.01 and above

Lab Application Revision: F.00.19 and above, added [:IP4]

*RST Setting

64 bytes

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:SETup:PACKet 10"

CALL:DATA:PING:SETup:PACKet[:SIZE]:IP6

Function

This command sets/queries the number of bytes sent by the test set in each ping packet with the CALL:DATA:PING:SETup:PROTocol command set to IP6.

Setting

Range: 9 to 8192

Resolution: 1

Query

Same as setting
Requirements Lab Application Revision: F.00.19 and above

*RST Setting

64 bytes

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:SETup:PACKet:IP6 10"

CALL:DATA:PING:SETup:PROTocol

Function

This command sets/queries the ping protocol to use when pinging the external device.

Setting

IP4 | IP6

Query

Same as setting
Requirements Lab Application Revision: F.00.19 and above

*RST Setting

IP4

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:SETup:PROTocol IP4"

CALL:DATA:PING:SETup:TIMeout

Function

This command sets or queries how long the test set will wait before ending a ping session.

This command will return 9.91 E+37 if the CALL:FUNCtion:DATA:TYPE command is not set to IPData, or if ping results are not available.

Setting

Range: 1 to 100 seconds

Query

Range: 1 to 100 seconds

Requirements Lab Application Revision: A.01 and above

*RST Setting

5 seconds

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:SETUP:TIMEOUT 10"

CALL:DATA:PING:STARt

Function

This command starts a ping session.

Requirements Lab Application Revision: A.01 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:START"

CALL:DATA:PING:STOP

Function

This command immediately stops a ping session. The ping results will not include counts for any ping message that has not yet received a response.

Requirements Lab Application Revision: A.01 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:STOP"

CALL:DATA:PING:TIME[:AVERage]?

Function

This command queries the average round trip time (in seconds) for a series of pings.

This command will return 9.91 E+37 if the CALL:FUNCtion:DATA:TYPE command is not set to IPData, or if ping results are not available.

Requirements Lab Application Revision: A.01 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:TIME:AVERAGE?"
 
ENTER 714;variable_name

CALL:DATA:PING:TIME:MAXimum?

Function

This command queries the maximum round trip time (in seconds) for a series of pings.

This command will return 9.91 E+37 if the CALL:FUNCtion:DATA:TYPE command is not set to IPData, or if ping results are not available.

Requirements Lab Application Revision: A.01 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:TIME:MAXIMUM?"
 
ENTER 714;variable_name

CALL:DATA:PING:TIME:MINimum?

Function

This command queries the minimum round trip time (in seconds).

This command will return 9.91 E+37 if the CALL:FUNCtion:DATA:TYPE command is not set to IPData, or if ping results are not available.

Requirements Lab Application Revision: A.01 and above

Programming Example

 
OUTPUT 714;"CALL:DATA:PING:TIME:MINIMUM?"
 
ENTER 714;variable_name