2018-03-27 09:12:15 +00:00
|
|
|
The 'ping' component continuously sends ICMP Echo requests to a given IP host
|
|
|
|
and waits for the corresponding ICMP Echo replies. For each successfull ICMP
|
2018-04-26 13:57:53 +00:00
|
|
|
Echo handshake it prints a short statistic. The ICMP data field gets filled
|
|
|
|
with the letters of the alphabet ('a' to 'z') repeatedly.
|
2018-03-27 09:12:15 +00:00
|
|
|
|
|
|
|
|
|
|
|
Configuration
|
2018-04-04 10:39:50 +00:00
|
|
|
~~~~~~~~~~~~~
|
2018-03-27 09:12:15 +00:00
|
|
|
|
|
|
|
This is an example configuration of the component which shows the default
|
2018-04-26 13:57:53 +00:00
|
|
|
value for each attribute except 'config.dst_ip' and 'config.interface':
|
2018-03-27 09:12:15 +00:00
|
|
|
|
2018-04-26 13:57:53 +00:00
|
|
|
! <config interface="10.0.0.72/24"
|
2018-03-27 09:12:15 +00:00
|
|
|
! dst_ip="10.0.0.24"
|
|
|
|
! period_sec="5"
|
|
|
|
! verbose="no"
|
|
|
|
! count="5" />
|
|
|
|
|
|
|
|
This is a short description of the tags and attributes:
|
|
|
|
|
2018-04-26 13:57:53 +00:00
|
|
|
:config.interface:
|
|
|
|
Optional. IP address and subnet of the component. If not set, the component
|
|
|
|
requests and maintains the IP configuration via DHCP.
|
|
|
|
|
|
|
|
:config.gateway:
|
|
|
|
Optional. IP address of the gateway of the IP subnet.
|
2018-03-27 09:12:15 +00:00
|
|
|
|
|
|
|
:config.dst_ip:
|
|
|
|
Mandatory. IP address of the target host.
|
|
|
|
|
|
|
|
:config.period_sec:
|
|
|
|
Optional. Length of send interval in seconds.
|
|
|
|
|
|
|
|
:config.verbose:
|
|
|
|
Optional. Toggles wether the component shall log debugging information.
|
|
|
|
|
|
|
|
:config.count:
|
|
|
|
Optional. After how many successful pings the component exits successfully.
|
|
|
|
|
|
|
|
|
|
|
|
Sessions
|
2018-04-04 10:39:50 +00:00
|
|
|
~~~~~~~~
|
2018-03-27 09:12:15 +00:00
|
|
|
|
|
|
|
This is an overview of the sessions required and provided by the
|
|
|
|
component apart from the environment sessions:
|
|
|
|
|
|
|
|
* Requires one Timer session.
|
2018-04-04 10:46:16 +00:00
|
|
|
|
|
|
|
|
|
|
|
Examples
|
|
|
|
~~~~~~~~
|
|
|
|
|
|
|
|
Examples of how to use the ping component can be found in the test scripts
|
|
|
|
'os/run/ping.run' and 'os/run/ping_nic_router.run'.
|