Differences

This shows you the differences between two versions of the page.

--- cli:tmss10ping [2017/06/06 19:12] – [Running TMSS10Ping] dcumming
+++ cli:tmss10ping [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== TMSS10Ping ======
-The TMSS10Ping command allows you to test your connection to your TapeTrack Server.
+Command line programs are executed via a [[technote:commandline|Command Line Prompt]] or via a batch file.  They cannot be executed by double clicking or right click run
-===== Running TMSS10Ping =====
+===== Synopsis =====
+''TMSS10Ping [-n count] [-P port] host''
-To run TMSS10Ping, run the Command Prompt as an Administrator. This can be done by right-clicking on the Command Prompt Application in the Start Menu or Windows Explorer and clicking "Run as administrator".
+===== Description =====
+''TMSS10Ping'' sends dummy packets to a TapeTrack Framework Server and receives a reply packet.
-{image}
+<note tip>
+Unlike the [[https://en.wikipedia.org/wiki/Ping_(networking_utility)|ping]] command which sends ICMP echo packets, ''TMSS10Ping'' sends payload packets via the TCP/IP protocol. This means that even if a firewall is configured to block ping requests, if TapeTrack connections are allowed, then ''TMSS10Ping'' packets will be successful.
+</note>
+===== Options =====
+The options which apply to the TMSS10Ping command are:
-Once the command prompt launches, use the change directory command to navigate to your TapeTrack Lite install folder.
+  * ''-n'' This option sets the number of test packets to send, set as an Integer (default=4).
-To launch the TMSS10Ping program, use command " TMSS10Ping server ". Replace " server " with your TapeTrack server's IP address. In the below example, the TapeTrack server is located at localhost or 127.0.0.1.
+  * ''-P'' This option sets the TCP/IP port to, set as an Integer (default=5000).
+  * ''host'' Host name(DNS) or dotted IP address of the TapeTrack Framework Server.
-{image}
+===== Exit Status =====
+  - **zero** Program has ended successfully.
+  - **non-zero** Program was unable to connect to the TapeTrack Framework Server.
+===== Environment =====
-The program will ping the TapeTrack Server and return ping statistics.
+  * [[variable:tmssserverproxy|TMSSSERVERPROXY]]
+  * [[variable:tmssapilogdir|TMSSAPILOGDIR]]
+===== Files =====
+  * ''stdout'' Program messages indicating statistics from ping.
+===== Examples =====
+This example tests a TapeTrack connection on port 443.
+<code>
+C:\>TMSS10Ping -P 443 tapetrack.ironmountain.com
+bytes from 216.229.153.104: seq=1 time=58.00 ms
+bytes from 216.229.153.104: seq=2 time=58.00 ms
+bytes from 216.229.153.104: seq=3 time=58.00 ms
+bytes from 216.229.153.104: seq=4 time=57.00 ms
+--- tapetrack.ironmountain.com TMSS10Ping statistics ---
+packets transmitted
+round-trip min/avg/max = 0.00/57.75/58.00 ms
+</code>
+This example sends an email if a TapeTrack Server is down.
+<code>
+#!/bin/bash
+TMSS10Ping -P 443 tapetrack.ironmountain.com > /dev/null
+[ $? -ne 0 ]; then
+sendmail .....
+fi
+</code>
+This example sends ping request via a proxy server, creates a trace file and displays the trace file.
+<code>
+set PROXYIP=192.168.1.10
+set PROXYPORT=3128
+set PROXYUSER=
+set PROXYPW=
+set TAPETRACKIP=server.databank.co.il
+set TAPETRACKPORT=443
+set TMSSAPILOGDIR=%TEMP%
+set TMSSSERVERPROXY=%PROXYUSER%:-%PROXYPW%@%PROXYIP%:%PROXYPORT%
+del /Q "%TMSSAPILOGDIR%\TMSSAPILOG-*.txt"
+TMSS10Ping -P %TAPETRACKPORT% %TAPETRACKIP%
+type "%TMSSAPILOGDIR%\TMSSAPILOG-*.txt"
+pause
+</code>
+--> Changelog
+[filterrss http://www.tapetrack.com/cgi/changelog.cgi?module=TMSS10Ping]
+<--
+<- ^ cli:introduction|Command Line Utilities^ ->