The configuration model file matching the ping command is huawei-ping.yang.
Object |
Description |
Value |
Remarks |
---|---|---|---|
/huawei-ping:ping/test-name | Indicates the instance name of the ping command. |
The value is a string of 1 to 32 case-sensitive characters. |
An instance uniquely identifies one ping command. Since the ping command is executed in asynchronous mode, this object is used by the controller to associate the ping command with a notification message. |
/huawei-ping:ping/ipv4-ping/destination | Indicates the domain name or IPv4 address of a destination host. |
|
N/A |
/huawei-ping:ping/ipv4-ping/source-ip-address | Indicates the source IPv4 address of ICMP request packets to be sent. |
The value is in dotted decimal notation. It must be an existing IPv4 address on the switch. |
N/A |
/huawei-ping:ping/ipv4-ping/count | Indicates the number of ICMP request packets to be sent. |
The value is an integer that ranges from 1 to 64. The default value is 5. |
N/A |
/huawei-ping:ping/ipv4-ping/interval | Indicates the interval at which ICMP request packets are sent. |
The value is an integer that ranges from 1 to 3600, in milliseconds. The default value is 500. |
N/A |
/huawei-ping:ping/ipv4-ping/timeout | Indicates the timeout interval for ICMP response packets. |
The value is an integer that ranges from 0 to 10000, in milliseconds. The default value is 2000. |
N/A |
/huawei-ping:ping/ipv4-ping/packet-size | Indicates the length of ICMP request packets excluding the IPv4 and ICMP headers. |
The value is an integer that ranges from 20 to 9600, in bytes. The default value is 56. |
N/A |
/huawei-ping:ping/ipv4-ping/vpn-instance-name | Indicates the name of a VPN instance to which a destination host belongs. |
The value is a string of 1 to 31 characters. It must be an existing VPN instance name on the switch. |
N/A |
/huawei-ping:ping/ipv4-ping/ttl | Indicates the TTL value of ICMP request packets. |
The value is an integer that ranges from 1 to 255. The default value is 255. |
N/A |
/huawei-ping:ping/ipv4-ping/tos | Indicates the ToS value of ICMP request packets. |
The value is an integer that ranges from 0 to 255. The default value is 0. |
N/A |
/huawei-ping:ping/ipv4-ping/pattern | Indicates pad characters for ICMP request packets. |
The value is an integer that ranges from 0 to FFFFFFFF, in hexadecimal notation. By default, the pad character starts from 0x01 and increases in ascending order. |
N/A |
/huawei-ping:ping/ipv4-ping/do-not-frag | Indicates whether fragmentation is allowed in packet sending. |
The value is of the Boolean type:
The default value is false. |
This object and ignore-mtu cannot be set to true simultaneously. |
/huawei-ping:ping/ipv4-ping/ignore-mtu | Indicates whether to ignore the interface MTU. |
The value is of the Boolean type:
The default value is false. |
This object and do-not-frag cannot be set to true simultaneously. |
/huawei-ping:ping/ipv4-ping/nexthop-address | Indicates the next-hop IPv4 address. |
The value is in dotted decimal notation. It must be a reachable next-hop IPv4 address. |
The next-hop IPv4 address and vpn-instance-name cannot be specified simultaneously. |
/huawei-ping:ping/ipv6-ping/destination | Indicates the domain name or IPv6 address of a destination host. |
|
N/A |
/huawei-ping:ping/ipv6-ping/source-ip-address | Indicates the source IPv6 address of ICMPv6 request packets to be sent. | The total length of the value is 128 bits, which are divided into eight groups. Each group contains four hexadecimal digits. The value is in the format of X:X:X:X:X:X:X:X. It must be an existing IPv6 address on the switch. | N/A |
/huawei-ping:ping/ipv6-ping/count | Indicates the number of ICMPv6 request packets to be sent. | The value is an integer that ranges from 1 to 64. The default value is 5. | N/A |
/huawei-ping:ping/ipv6-ping/interval | Indicates the interval at which ICMPv6 request packets are sent. | The value is an integer that ranges from 1 to 3600, in milliseconds. The default value is 500. | N/A |
/huawei-ping:ping/ipv6-ping/timeout | Indicates the timeout interval for ICMPv6 response packets. | The value is an integer that ranges from 0 to 10000, in milliseconds. The default value is 2000. | N/A |
/huawei-ping:ping/ipv6-ping/packet-size | Indicates the length of ICMPv6 request packets excluding the IPv6 and ICMPv6 headers. | The value is an integer that ranges from 20 to 9600, in bytes. The default value is 56. | N/A |
/huawei-ping:ping/ipv6-ping/vpn-instance-name | Indicates the name of a VPN instance to which a destination host belongs. | The value is a string of 1 to 31 characters. It must be an existing VPN instance name on the switch. | N/A |
/huawei-ping:ping/ipv6-ping/hop-limit | Indicates the maximum number of hops for sending ICMPv6 request packets. | The value is an integer that ranges from 1 to 255. The default value is 255. | N/A |
/huawei-ping:ping/ipv6-ping/traffic-class | Indicates the traffic classification of ICMPv6 request packets. | The value is an integer that ranges from 0 to 255. The default value is 0. | N/A |
Since running the ping command takes time, the switch returns an RPC response first after receiving the RPC request for running the ping command sent by the controller. After running the ping command and obtaining the command output, the switch notifies the controller of the execution result by a notification message.
Item |
Description |
---|---|
test-name |
Indicates the instance name of the ping command, which matches the /huawei-ping:ping/test-name object. |
destination |
Indicates the domain name, IPv4 address, or IPv6 address of a destination host. |
total-count |
Indicates the total number of the sent ICMP or ICMPv6 request packets. |
success-count |
Indicates the number of received ICMP or ICMPv6 response packets. |
loss-rate |
Indicates the percentage of ICMP or ICMPv6 request packets with no response to the total number of ICMP or ICMPv6 request packets that have been sent. |
rtt-min |
Indicates the minimum response time, in milliseconds. |
rtt-avg |
Indicates the average response time, in milliseconds. |
rtt-max |
Indicates the maximum response time, in milliseconds. |
sequence |
Indicates the sequence number of ICMP or ICMPv6 response packets. |
data-byte |
Indicates the length of ICMP or ICMPv6 response packets, in bytes. |
ttl-or-hoplimit |
|
rtt |
Indicates the response time, in milliseconds. |
result |
|
complete |
Indicates whether the notification message is the last one:
|