Differences

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

--- general:framework_connection [2017/06/06 23:07] – [Connecting via the TapeTrack Command Line] Gerard Nicol
+++ general:framework_connection [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 3: / Line 3: @@
 Each TapeTrack Framework Server accepts incoming communications on a single TCP/IP port (by default this port is 5000).
-These incoming communications are firstly compressed with gzip level 9 compression, and then encrypted with AES 256 bit encryption.
+These incoming communications are firstly compressed with gzip level 9 compression and then encrypted with AES 256 bit encryption.
 To allow these connections the TapeTrack Framework Server must have firewall access to accept incoming connections, and the connecting clients must have outbound firewall access to establish a single TCP/IP stateful connection.
@@ Line 10: / Line 10: @@
 In addition to direct TCP/IP connections, the TapeTrack communications API also supports connections via a HTTP Proxy.
+====== Names and IP addresses ======
+As with all TCP/IP connections, the endpoint address can be represented by either a domain name or dotted IP address.
+It is recommended that you always use a domain name, rather than dotted IP address to connect to your TapeTrack server as this contemplates a future change in IP address.
+<note tip>If you are using a domain name to connect to your TapeTrack Server and can not connect, you should check to ensure that your domain name is resolving to an IP address.
+\\
+\\
+<code text;>
+jsmith> nslookup tapetrack.gazillabyte.com
+Server:  dc1.gazillabyte.local
+Address:  192.168.1.2
+Non-authoritative answer:
+Name:    tapetrack.gazillabyte.com
+Address:  192.241.211.124
+</code>
+</note>
 ===== Testing your TCP/IP connection =====
-The simplest was to test if you are able to establish a connection to a TapeTrack Framework Server is to use the [[cli:tmss10ping|TMSS10Ping]] command line utility.
+The simplest way to test if you are able to establish a connection to a TapeTrack Framework Server is to use the [[cli:tmss10ping|TMSS10Ping]] command line utility.
-<note tip>The TMSS10Ping utility simply sends an empty TapeTrack packet and receives a response. It is available for all supported platforms, requires no login credentials, and has no other dependencies.
+<note tip>The [[cli:tmss10ping|TMSS10Ping]] utility simply sends an empty TapeTrack packet and receives a response. It is available for all supported platforms, requires no login credentials, and has no other dependencies.
 </note>
-Presuming your TapeTrack Framework Server at address **tapetrack.gazillabyte.com**, on port **5000** a successful test would look like this:
+TMSS10Ping installs with TapeTrack software and is stored under (depending on what products are installed):
-<code>
+**TapeMaster** \\
+  Program Files\TapeTrack\TapeTrack TapeMaster \\
+**Lite**  \\
+ Program Files\TapeTrack\TapeTrack Lite \\
+**Server Utilities**  \\
+ Program Files\TapeTrack\TapeTrack Server Utilities\bin\tapetrack \\
+<note tip>Examples shown use fictional values.  Replace domain name with the actual value you want to check the connection on</note>
+As an example, using TapeTrack Framework Server at address **tapetrack.gazillabyte.com**, on port **5000** a successful test would look like this:
+<code plain;>
 [root@documentation-us conf]# TMSS10Ping -P 5000 tapetrack.gazillabyte.com
 bytes from 192.241.211.124: seq=1 time=0.00 ms
@@ Line 32: / Line 63: @@
 </code>
-===== Connecting via the TapeTrack Command Line =====
+If TMSS10Ping fails to make a valid connection, try to connect via port 443.
+<code plain;>
+[root@documentation-us conf]# TMSS10Ping -P 443 tapetrack.gazillabyte.com
+bytes from 192.241.211.124: seq=1 time=0.00 ms
+bytes from 192.241.211.124: seq=2 time=0.00 ms
+bytes from 192.241.211.124: seq=3 time=0.00 ms
+bytes from 192.241.211.124: seq=4 time=0.00 ms
+--- 192.241.211.124 TMSS10Ping statistics ---
+packets transmitted
+round-trip min/avg/max = 0.00/0.00/0.00 ms
+</code>
+If a connection cannot be successfully completed through either port contact your network administrator to ensure ports are open.
+===== Connecting via TapeTrack Software =====
+==== Command Line Programs ====
 All TapeTrack Command Line programs that communicate with the TapeTrack Framework Server will have a ''-S argument''.
-For detailed instructions on how to use the -S argument please see the [[cli:server_argument|Command Line Server Argument]] page.
+An example for connecting as user **jsmith**, with password **mypassword** is:
+<code plain;>
+-S jsmith:-mypassword@tapetrack.gazillabyte.com
+</code>
+For detailed instructions on how to use the ''-S'' argument please see the [[cli:server_argument|Command Line Server Argument]] page.
-===== Connecting via the TapeTrack Desktop =====
+===== TapeTrack Desktop Programs =====
+Most users will connect to the TapeTrack Framework Server via one of the Desktop Applications.
+{{:general:desktop_login.png}}
+Each of these applications will automatically launch the Desktop Login Window which allows the user to setup a server connection.
+Server connections added using this Window will be stored in the user's Windows registry under the **HKEY_CURRENT_USER** section. In addition, connections can also be defined in the program's configuration file.
+For detailed instructions on how to setup a connection please see:
+   * [[desktop:adding_connection|Adding a Desktop Server Connection]].
+   * [[desktop:adding_connection_config|Adding a Desktop Server Connection via the Configuration File]].
+   * [[desktop:protocol_handler|TapeTrack Server Connection via URL Protocol Handler]].
+===== Connecting via a HTTP Proxy =====
+TapeTrack Desktop and Command Line programs allow TapeTrack Framework Server communications to be tunneled via HTTP proxy server.
+Although the communications sent via the proxy are not HTTP/HTTPS requests, they are presented to the proxy as HTTPS (Encrypted HTTP) communications.
+For details on how to tunnel TapeTrack communications via a HTTP Proxy please see:
+   * [[desktop:adding_connection|Desktop HTTP Proxy setup]]
+   * [[cli:http_proxy|Command Line HTTP Proxy setup]].
+===== Connection Troubleshooting =====
+All TapeTrack programs use an underlying low level communications API which allows users to trace connection and communications requests.
+To enable logging, set the [[variable:start|Environmental Variable]] [[variable:TMSSAPILOGDIR|TMSSAPILOGDIR]] to the path of an existing directory.
+<note important>
+Care should be taken to not leave the ''TMSSAPILOGDIR'' set as it will slow all TapeTrack Software due to the overhead of logging.
+</note>
+<code plain;>
+set TMSSAPILOGDIR=c:\Users\jsmith\Desktop\logs
+TMSS10Ping localhost
+</code>
+Creates the file **TMSSAPILOG-005336.txt** with the contents:
+<code plain;>
+:39:25: TMSS10API_Init (API Version=Feb  2 2017 10:18:50)
+:39:25: TMSS10API_Connect: Server(localhost) Port(5000)
+:39:25: TMSS10API_Connect: Connection OK IP(127.0.0.1)
+:39:25: TMSS10API_Send: Function(Ping) Length(0) Flags(0) OptArgs(0)
+:39:25: TMSS10API_Send: RC(Request OK) Feedback(0) MilliSecs(0) Avail(0) Count(0) Length(0)
+:39:25: TMSS10API_Send: Function(Ping) Length(0) Flags(0) OptArgs(0)
+:39:25: TMSS10API_Send: RC(Request OK) Feedback(0) MilliSecs(0) Avail(0) Count(0) Length(0)
+:39:25: TMSS10API_Send: Function(Ping) Length(0) Flags(0) OptArgs(0)
+:39:25: TMSS10API_Send: RC(Request OK) Feedback(0) MilliSecs(0) Avail(0) Count(0) Length(0)
+:39:25: TMSS10API_Send: Function(Ping) Length(0) Flags(0) OptArgs(0)
+:39:25: TMSS10API_Send: RC(Request OK) Feedback(0) MilliSecs(0) Avail(0) Count(0) Length(0)
+:39:25: TMSS10API_Term
+</code>
+===== See Also =====
+[[technote:setting_environmental_variables|Setting Environmental Variables]]
-{{tag>communication}}
+{{tag>communication  logging}}