Ping
本章节介绍ping命令的配置模型,以及配置的XML报文示例。
数据模型
ping命令的配置模型文件名为huawei-ping.yang。
节点 |
说明 |
取值范围 |
备注 |
---|---|---|---|
/huawei-ping:ping/test-name | ping命令实例名称。 |
字符串形式,区分大小写,长度范围是1~32。 |
唯一标识一条ping命令,由于ping命令是异步执行,该节点供控制器关联ping命令和Notification消息。 |
/huawei-ping:ping/ipv4-ping/destination | 目的主机的域名或IPv4地址。 |
|
NA |
/huawei-ping:ping/ipv4-ping/source-ip-address | 发送ICMP请求报文的源IPv4地址。 |
点分十进制格式,必须是交换机上存在的IPv4地址。 |
NA |
/huawei-ping:ping/ipv4-ping/count | 发送ICMP请求报文的个数。 |
整数形式,取值范围是1~64,缺省值是5。 |
NA |
/huawei-ping:ping/ipv4-ping/interval | 发送ICMP请求报文的时间间隔。 |
整数形式,取值范围是1~3600,单位是毫秒,缺省值是500。 |
NA |
/huawei-ping:ping/ipv4-ping/timeout | 等待ICMP响应报文的超时时间。 |
整数形式,取值范围是0~10000,单位是毫秒,缺省值是2000。 |
NA |
/huawei-ping:ping/ipv4-ping/packet-size | ICMP请求报文的长度,不包括IPv4和ICMP报文头。 |
整数形式,取值范围是20~9600,单位是字节,缺省值是56。 |
NA |
/huawei-ping:ping/ipv4-ping/vpn-instance-name | 目的主机所属的VPN实例名称。 |
字符串形式,长度范围是1~31,必须是交换机上存在的VPN实例名称。 |
NA |
/huawei-ping:ping/ipv4-ping/ttl | ICMP请求报文的TTL值。 |
整数形式,取值范围是1~255,缺省值是255。 |
NA |
/huawei-ping:ping/ipv4-ping/tos | ICMP请求报文的ToS值。 |
整数形式,取值范围是0~255,缺省值是0。 |
NA |
/huawei-ping:ping/ipv4-ping/pattern | ICMP请求报文的填充字节。 |
16进制整数,取值范围是0~FFFFFFFF。缺省情况下,填充字节从0x01开始,依次递增。 |
NA |
/huawei-ping:ping/ipv4-ping/do-not-frag | 是否允许报文发送的过程中分片。 |
布尔型:
缺省值为false。 |
不能和ignore-mtu同时配置为true。 |
/huawei-ping:ping/ipv4-ping/ignore-mtu | 是否忽略接口MTU。 |
布尔型:
缺省值为false。 |
不能和do-not-frag同时配置为true。 |
/huawei-ping:ping/ipv4-ping/nexthop-address | 下一跳IPv4地址。 |
点分十进制格式,必须是路由可达的下一跳IPv4地址。 |
指定下一跳IPv4地址时,不支持同时指定vpn-instance-name。 |
/huawei-ping:ping/ipv6-ping/destination | 目的主机的域名或IPv6地址。 |
|
NA |
/huawei-ping:ping/ipv6-ping/source-ip-address | 发送ICMPv6请求报文的源IPv6地址。 | 总长度为128位,通常分为8组,每组为4个十六进制数的形式。格式为X:X:X:X:X:X:X:X。必须是交换机上存在的IPv6地址。 | NA |
/huawei-ping:ping/ipv6-ping/count | 发送ICMPv6请求报文的个数。 | 整数形式,取值范围是1~64,缺省值是5。 | NA |
/huawei-ping:ping/ipv6-ping/interval | 发送ICMPv6请求报文的时间间隔。 | 整数形式,取值范围是1~3600,单位是毫秒,缺省值是500。 | NA |
/huawei-ping:ping/ipv6-ping/timeout | 等待ICMPv6响应报文的超时时间。 | 整数形式,取值范围是0~10000,单位是毫秒,缺省值是2000。 | NA |
/huawei-ping:ping/ipv6-ping/packet-size | ICMPv6请求报文长度,不包括IPv6和ICMPv6报文头。 | 整数形式,取值范围是20~9600,单位是字节,缺省值是56。 | NA |
/huawei-ping:ping/ipv6-ping/vpn-instance-name | 目的主机所属的VPN实例名称。 | 字符串形式,长度范围是1~31,必须是交换机上存在的VPN实例名称。 | NA |
/huawei-ping:ping/ipv6-ping/hop-limit | ICMPv6请求报文的最大跳数。 | 整数形式,取值范围是1~255,缺省值是255。 | NA |
/huawei-ping:ping/ipv6-ping/traffic-class | ICMPv6请求报文中的流量类别。 | 整数形式,取值范围是0~255,缺省值是0。 | NA |
由于ping命令的执行需要时间,交换机在收到控制器要求交换机执行ping命令的RPC请求之后先返回RPC响应。当ping命令执行完成,获取到回显信息后,再通过Notification消息通告控制器ping命令的执行结果。
项目 |
说明 |
---|---|
test-name |
ping命令实例名称,与/huawei-ping:ping/test-name节点对应。 |
destination |
目的主机域名、IPv4地址或IPv6地址。 |
total-count |
发送的ICMP或ICMPv6请求报文的总数。 |
success-count |
接收到的ICMP或ICMPv6响应报文数目。 |
loss-rate |
未收到ICMP或ICMPv6响应报文的ICMP或ICMPv6请求报文数占发送的ICMP或ICMPv6请求报文总数的百分比。 |
rtt-min |
响应时间的最小值,单位是毫秒。 |
rtt-avg |
响应时间的平均值,单位是毫秒。 |
rtt-max |
响应时间的最大值,单位是毫秒。 |
sequence |
ICMP或ICMPv6响应报文的序号。 |
data-byte |
ICMP或ICMPv6响应报文的长度,单位是字节。 |
ttl-or-hoplimit |
|
rtt |
响应时间,单位是毫秒。 |
result |
|
complete |
该Notification消息是否是最后一条:
|
执行ping命令示例
本章节主要介绍通过rpc方法执行ping命令。
操作 |
XPATH |
---|---|
rpc |
|
数据需求
项目 |
数据 |
描述 |
---|---|---|
ping命令实例名称 |
test1 |
ping命令实例名称为test1。 |
目的主机 |
192.168.10.1 |
目的主机的IPv4地址为192.168.10.1。 |
ICMP请求报文的源IPv4地址 |
192.168.50.1 |
ICMP请求报文的源IPv4地址为192.168.50.1。 |
发送ICMP请求报文的个数 |
30 |
发送30个ICMP请求报文。 |
发送ICMP请求报文的时间间隔 |
600 |
发送ICMP请求报文的时间间隔是600毫秒。 |
等待ICMP响应报文的超时时间 |
1800 |
等待ICMP响应报文的超时时间是1800毫秒。 |
ICMP请求报文的长度,不包括IPv4和ICMP报文头 |
100 |
ICMP请求报文的长度是100字节。 |
ICMP请求报文的TTL值 |
200 |
ICMP请求报文的TTL值为200。 |
ICMP请求报文的ToS值 |
100 |
ICMP请求报文的ToS值为100。 |
ICMP请求报文填充的字节 |
1122aaee |
ICMP请求报文填充的字节为1122aaee。 |
是否允许报文发送的过程中分片 |
true |
不允许报文发送的过程中分片。 |
请求示例
<?xml version="1.0" encoding="UTF-8"?> <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1"> <hw-ping:ping xmlns:hw-ping="urn:huawei:params:xml:ns:yang:huawei-ping"> <hw-ping:test-name>test1</hw-ping:test-name> <hw-ping:ipv4-ping> <hw-ping:destination>192.168.10.1</hw-ping:destination> <hw-ping:source-ip-address>192.168.50.1</hw-ping:source-ip-address> <hw-ping:count>30</hw-ping:count> <hw-ping:interval>600</hw-ping:interval> <hw-ping:timeout>1800</hw-ping:timeout> <hw-ping:packet-size>100</hw-ping:packet-size> <hw-ping:ttl>200</hw-ping:ttl> <hw-ping:tos>100</hw-ping:tos> <hw-ping:pattern>1122aaee</hw-ping:pattern> <hw-ping:do-not-frag>true</hw-ping:do-not-frag> </hw-ping:ipv4-ping> </hw-ping:ping> </rpc>
响应示例
<?xml version='1.0' encoding='UTF-8'?> <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1"> <ok/> </rpc-reply>
<?xml version='1.0' encoding='UTF-8'?> <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1"> <error/> </rpc-reply>
Notification上报结果
# 交换机通过Notification消息上报控制器ping命令的执行结果。
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <eventTime>2017-06-09T16:48:24Z</eventTime> <ping-case-result xmlns="urn:huawei:params:xml:ns:yang:huawei-ping"> <test-name>test1</test-name> <destination>192.168.10.1</destination> <total-count>30</total-count> <success-count>0</success-count> <loss-rate>100.00</loss-rate> <replys> <sequence>1</sequence> <data-byte>0</data-byte> <ttl-or-hoplimit>0</ttl-or-hoplimit> <rtt>0</rtt> <result>timeout</result> </replys> <complete>false</complete> </ping-case-result> </notification>