Summary:
Ping. Used to to test the availability of a host on a network.
Request specification:
Name |
Min/Max |
Type |
Description |
|
|
|
|
Returns:
OK/Error
Example 1:
Pinging the server that we are connected to.
Input
<packet version="4.0.0" id="2">
<data>
<system>
<ping/>
</system>
</data>
</packet>
Output
<?xml version="1.0" encoding="UTF-8"?><ns1:packet xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="15c467156a3t1ebr81c" priority="0" version="4.0.0">
<ns1:origin>gend</ns1:origin>
<ns1:target>vzclient3-638a2a56-e689-c340-877d-bd0470f2448c</ns1:target>
<ns1:dst>
<ns1:director>gend</ns1:director>
</ns1:dst>
<ns1:data>
<ns1:system>
<ns1:ok/>
</ns1:system>
</ns1:data>
</ns1:packet>
Example 2:
This example pings a remote server over the exclusive connection that was established using the connect
call.
Input
<packet version="4.0.0">
<target>192.168.0.841</target>
<data>
<system>
<ping/>
</system>
</data>
</packet>
Output
In case of success, the call will return the standard Agent OK message. If the specified server cannot be found, a response similar to the following example will be returned:
<?xml version="1.0" encoding="UTF-8"?><ns1:packet xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="1fc46715724t153cr81c" priority="0" version="4.0.0">
<ns1:origin>gend</ns1:origin>
<ns1:target>vzclient4-638a2a56-e689-c340-877d-bd0470f2448c</ns1:target>
<ns1:dst>
<ns1:director>gend</ns1:director>
</ns1:dst>
<ns1:data>
<ns1:error>
<ns1:code>2</ns1:code>
<ns1:message>Targets, specified in the message were not found.</ns1:message>
</ns1:error>
</ns1:data>
</ns1:packet>