Professional Documents
Culture Documents
User's Manual
Version 0.0.14.0 for Windows-32, 07.Nov.2011
Chapter
Introduction
This manual tries to give an introduction to the functionality and the features of the TSS software.
You should read this manual carefully if you are not familiar with the Test Scheduling System. If
youre already comfortable with the functionalities and the workflows, you might need the technical
documentation in chapters 4 and 5.
Introduction
Introduction
Introduction
0.0.12.0 - 05.11.2010 ... changes are highlighted in light yellow and indicated with =0.0.12=
Support for Cleware USB Breaker (as modem power switch)
allow scheduler to load tasks even if CIC/HwNd entry not available to enable std error handling
additional error handling for job load errors
force soft reboot if assisted reboot fails after 60 seconds
bugfix in reboot recovery (revert to standard operation if reboot fails)
bugfix in RAS metric function: additional exception handler required for LAN tests
support to check disk free space (new section [DiskFree])
support for Hwnd:* as CIC parameter (if exactly one CIC entry is available)
new config parameter for assistance check (CheckAssistanceSvc)
new config parameter for assistance errors (MaxAssistErrors)
new config parameter for hard reboots (MaxSoftReboots)
add WD+MPSW status to status tickets (new metrics x.250..)
reboot on TSS Assistance Service (WD/MPSW) problems
add unmapped metrics as comment (TSS + PO + WST)
new parameters RebootMode, UseExternalTool and ExternalToolName for reboot task
new parameter DontCheckReboot for execution tasks
added support for immediate reboot requests by tool (===REBOOT)
added ModemPowerCycle task (with different reboot actions on failure)
added config parameter Tool/Mpsw-Tool
change rating for CIC tickets (new parameter RateOnResponseOnly)
added persistence for registration (forced) and reboot (default) task
added persistence for task status, new parameter Period-Persist
added support for SAFE reboot mode
0.0.11.7 - 23.09.2010
support for Cleware USB Watchdog XP with external power supply
problem with certain HDD serial numbers in WebSpeedTest fixed
0.0.11.6 - 16.09.2010
support for Windows Vista and 7
Vista manifest to run with privilege elevation
support for VNC in TSS assistance service
bugfix in FTP client (exceptions in FTP upload under certain timing conditions)
bugfix in CIC detection (inactive connections detected as active since 0.0.11.0)
ReducePrivileges parameter to execute sub-jobs non-elevated in Windows Vista and 7
0.0.11.5 - 21.08.2010
support for USB power switch (type serial), new [ModemSwitch] section in machine.cfg
0.0.11.4 - 20.08.2010
support for %rands()% and %randi()% functions in job files
0.0.11.3 - 13.08.2010
bugfix in RAS connection manager: connections closed under certain timing conditions
0.0.11.2 - 28.07.2010 (internal test version)
support for hard reboot via TSS assistance service (Cleware USB Watchdog XP)
0.0.11.1 - 15.07.2010
change parameter HttpTimeout to Timeout for TimeSync task
0.0.11.0 - 09.07.2010
support for HTTP time synchronization with get-time request
new custom internet connection (CIC) task
tasks RAS-Connect and RAS-Hangup are deprecated, use CIC-Connect and CIC-Hangup instead
support for undefined configuration variables with %@...%
support for Huawei NDIS API
0.0.10.3 - 18.12.2009
update to PocketOptimizer/LE code base
0.0.10.0 - 12.12.2009
GUI shows if a restart/reboot is required after manual job execution
additional log messages for interaction with assistance service
available physical memory is shown in system summary
jobs with system tasks (sync, register...) can be executed if the application is not registered
support for AutoBaseDir parameter
improvements in AT command interface for non-Huawei modems
Introduction
0.0.9.9 - 18.08.2009
Improvement in installer: restart service if it was previously running
bugfix in parameter Ras-DontHangup (was not working)
0.0.9.8 - 29.07.2009
bugfix in FTP submission (didn't delete files)
0.0.9.7 - 28.07.2009
FTP submission: check expected submission time and delay submission if longer than timeout
FTP submission: alternately search by size and date before FTP submission
added parameter v1m to 7z arguments to split large data files in smaller segments
0.0.9.6 - 21.07.2009
fixed FTP submission: old files not dropped
0.0.9.5 - 15.07.2009
changed check for tool executable file
added APN detection
0.0.9.3 - 19.06.2009
improvement: load default RAS entry in fallback job
improvement: execute fallback job if no tasks executed for 6 hours
bugfix in AT reset command
0.0.9.1 - 18.06.2009
bugfix in RAS internal storage
0.0.9.0 - 17.06.2009
support for assistance service interface management
improvements in registration
new parameters in machine.cfg: ModemReset-Enable, ModemReset-Ports
support to reset mobiles with AT+CFUN=1,1
change in user defined commands: use AT++XXX instead of AT+XXX
track COM ports used for RAS connections
0.0.8.5 - 04.05.2009
bugfix in extension reporting
bugfix in RAS task: default value for clear mobile info set to false
bugfix in RAS mobile info: use total timeout, not single timeout
0.0.8.3 - 26.04.2009
initial release
Introduction
Introduction
Test functions: these include functions to establish and analyze internet connections and to
execute test tools such as PocketOptimizer, WebSpeedTest and other tools. These active tools
usually require suitable reference servers.
Reporting: The reporting layer consists of the report generation in the measurement tool and a
report submission unit that submits XML reports to a QTS ticket receiver or relay. Measurement
data can be accessed via SQL, reporting tools or a dashboard.
Synchronization: This layer includes time synchronization via SNTP and synchronization of
application and configuration files via HTTP. Usually public (S)NTP servers can be used for time
synchronization, a dedicated HTTP server is required for file synchronization.
Control functions: Standard methods such as Remote Desktop or OpenSSH are used to control
the Test Unit if required. In addition the TSS Assistance Service provides functions accessible
with the TSS Assistance client.
Log functions: Additional information can be uploaded to an FTP server. The log or data files
can be analyzed manually, automatically or viewed by a Dashboard.
Reporting functions
The following figure shows the data flow of XML reports through a QTS Ticket Relay and the QTS
Ticket Receiver. Please note that reporting can be done through the test network (e.g. mobile
internet) or through the management network (e.g. DSL).
Introduction
Synchronization functions
The next figure shows the data flow for synchronization. Application and configuration files are
uploaded to the configuration server from a management console and fetched from the test units
as required. Synchronization can be done through the test network or the management network.
Please note that it might be complicated to manage test units with varying IP addresses and
multiple network connections (RAS and DSL simultaneously). The TSS Assistance Service contains
functions to deal with some of these problems, but the preferred method is the TSS Management
Server.
Introduction
Log functions
The following figure shows the data flow for log file submission. Log files are submitted to a
standard FTP server via the test or the management network. They can be forwarded to or fetched
from an internal server to be available for analysis, reporting functions or the dashboard.
Introduction
Chapter
Installation
This chapter covers the installation of TSS on Windows platforms.
10
Installation
C:\TSS-System.
11
Installation
(GPS broadcast)
(status broadcast)
(UDP command interface)
(local communication, external use reserved)
12
Installation
Registration basics
TSS automatically calculates a Machine ID from your machines unique data.
This Machine ID has to be submitted to the license server or administrator.
The sales representative or license administrator will assign an Agent ID and generate the
Unlocking Code for your combination of Machine ID and Agent ID.
After entering Agent-ID and Unlocking Code your copy of TSS is functional.
Please note that TSS, PocketOptimizer and WebSpeedTest have to be registered independently. If
you use the registration function in TSS to submit a request to the registration server,
WebSpeedTest and PocketOptimizer will automatically started in the background to submit a
registration request, too.
13
Installation
If it is not possible to send the data directly, use the button Save... to save the license request to a
file and send this file to your sales representative or license administrator via e-mail.
Fetching the unlock data
You will be sent an e-mail when your registration has been processed.
To fetch the license data from the server, simply submit the license request again without
changing any information on the Licensee sheet. Please ensure that you use the request Extend
active registration, otherwise the server will not provide the unlock data.
If unlock data is available on the server, the unlocking data is automatically inserted into the input
fields. Check the option I accept the license terms if you agree to the license terms and use the
button Register to save the registration information.
14
Installation
15
Installation
Chapter
Operations Manual
This section describes how to use TSS.
16
Operations Manual
The buttons Start Sched. and Stop Sched. start and stop the scheduler.
The button Start Job allows the selection of a job and immediately executes it. Please note
that there are no concurrency checks, i.e. the user is responsible to start jobs only if no other
tasks are affected.
The button Register opens the registration dialog.
Scheduler/Task view
Two different views are available:
The default view uses a text control to give a resource optimized overview of running and
finished tasks.
The table view provides a graphical view but consumes more resources. A context menu is
available in this view that allows cancellation of running tasks.
Special data view
The bottom area contains several dedicated text controls:
The view Selected Item shows the content of the item selected in the scheduler/task view. You
can either select a task in the table to view its log or click on the order number in the simple
text view.
The System Status shows important internal parameters such as run time, memory and
resource requirements.
The Task Status shows the content of the internal task storage. This storage contains the
maximum number of consecutive errors, the current number of errors and the number of
successful and total executions for every task.
The Scheduler Status shows the scheduled items.
The Registration Status shows the registration information for TSS, PocketOptimizer and
WebSpeedTest.
The Message tab shows additional messages on startup or errors and warnings when starting
the application, the scheduler or a task.
17
Operations Manual
To use the assistance client, please enter the target machine's IP address and select the required
operation. If you want to reboot the target machine, the reboot password is required.
After clicking the Send button, the client license sends the command via UDP and waits for
returning UDP packets. Usually the server should return 4 packets. Please note that it might be
impossible for the client to send the packet if different default routes are configured.
The possible commands are:
connection test
set route
reboot
The connection test simply sends connection test commands and waits for UDP response
packets. Use this command to check if the connection is available. Please note that it might be
impossible for the target to return UDP packets if the routes are not set correctly.
The set route command sets a route for the machine running the TSS Assistance Client on the
target machine. The command can be used to set a route before the Remote Desktop Protocol
(RDP) can be used. The command works as follows: If the TSS Assistance Service receives a set
route packet from <src> in interface <if>, a route to <src> with mask 255.255.255.255 will be
added to the routing table for interface <if>. The routine will automatically be removed after a
given timeout.
The reboot command can be used to reboot the target computer. You should use a connection
test command to ensure that a connection is available. Please note that it is possible that the
target is rebooted even if no response UDP packets are received.
In addition the button Connect RDP can be used to start the Remote Desktop Client (MSTSC.exe)
for the specified IP Address (and port - 1). The function is the same as opening MSTSC.exe
manually and connecting it to the given port. It is provided for convenience if the TSS Assistance
Client was used to set a route and the IP address is already entered.
If a file default.rdp exists in the same directory as the TSS Assistance Client executable, this file
will be used as template for MSTSC.exe. You can save your user name, password and display
resolution to this file, the client will then automatically log on to the target machine. Please note
that the same restrictions due to routing apply.
18
Operations Manual
19
Operations Manual
Chapter
Administrators Manual
This section contains information for the system and license administrator and is not intended for end
users.
4.2 Directories
TSS is usually installed in one or two directories.
The manual distinguishes program directories (programs and configuration files) and data directories
(containing data created by TSS and the measurement tools).
20
Administrators Manual
C:\TSS-System\Jobs
C:\TSS-System\Jobs\PO
C:\TSS-System\Jobs\WST
C:\TSS-System\Scheduler
Data directories
C:\TSS-System\Data
C:\TSS-System\Data\Work
C:\TSS-System\Data\Work\Logs
C:\TSS-System\Data\Work\Reports
C:\TSS-System\Data\Work\Data
C:\TSS-System\Data\Work\Sniffer
C:\TSS-System\Data\Work\Scheduler
C:\TSS-System\Data\Work\Assistance
C:\TSS-System\Data\Archive
C:\TSS-System\Data\Archive\Logs
C:\TSS-System\Data\Archive\Reports
C:\TSS-System\Data\Archive\Data
C:\TSS-System\Data\Archive\Sniffer
C:\TSS-System\Data\Archive\Scheduler
C:\TSS-System\Data\Archive\Assistance
C:\TSS-System\Data\Outbox
C:\TSS-System\Data\Outbox\Logs
C:\TSS-System\Data\Outbox\Reports
C:\TSS-System\Data\Outbox\Data
C:\TSS-System\Data\Errors
C:\TSS-System\Data\Errors\Logs
C:\TSS-System\Data\Errors\Reports
C:\TSS-System\Data\Errors\Data
C:\TSS-System\Data\Temp
C:\TSS-System\Data\Persistent
21
Administrators Manual
4.3 Scheduler
One main component of TSS is the integrated scheduler. This scheduler is configured with the file
scheduler.xml and is responsible for starting TSS jobs.
The scheduler periodically loads scheduler.xml and evaluates the next scheduler item to be executed.
Items can be scheduled periodically (e.g. hourly) at given times of a day (e.g. every day at 14:00) or
continuously. The scheduler manages internal resources and delays scheduled tasks until the required
resources are available. Then the job files are loaded and execution is passed to the execution unit.
Note: In the current version of TSS resources are used exclusively, i.e. only one concurrent task is
executed by the scheduler.
4.5 Tasks
TSS jobs consist of well known tasks.
The supported task types are:
Pause
Inserts a pause of the specified duration into the job sequence.
Sub-Job
This task executes another TSS-Job as a sub job. Sub jobs can be used for logical grouping, to reuse sequences of tasks or to apply conditions to a group of tasks.
CIC-Connect
Establishes a custom internet connection (CIC), such as a RAS connection or a Huawei NDIS
connection. The connection can be continuously monitored if required.
CIC-Hangup
Terminates a custom internet connection.
RAS-Connect (deprecated, use CIC-Connect instead)
Establishes a RAS connection. The connection can be continuously monitored if required.
RAS-Hangup (deprecated, use CIC-Hangup instead)
Terminates a RAS connection.
AT-Command
Sends AT commands to the device associated with a RAS connection.
CheckModem =0.0.12.6=
Checks if the modem device is available and responding to AT commands.
PocketOptimizer
Executes PocketOptimizer with a specified job file.
WebSpeedTest
Executes WebSpeedTest, the required parameters can be specified as parameters.
Execute
Executes additional tools such as Perl scripts, batch files etc.
TimeSync
Runs the SNTP client to synchronize the local time with an external time server.
Report
Submits the measurement (XML) reports from the outbox directory to the ticket receiver.
SubmitLogs
Submits the measurement logs and data files from the outbox directory to an FTP server. The task
can be deactivated with the configuration parameter Submit-Enable.
FileSync
Synchronizes configuration and application files from the synchronization. This task can be
deactivated with the configuration parameter Sync-Enable.
Registration
Submits a registration request to the registration server to register the application or extend the
expiration date.
TSS 0.0.14.0 07.Nov.2011
22
Administrators Manual
IPConfig
Manages IP parameters for LAN or RAS interfaces. Usually this task is used to remove default
routes and DNS servers from LAN/DSL interfaces to avoid influences to the measurement results.
Route
This task removes default routes if required.
GetPublicIP
Contacts a special server to get a public IP address. The task will only be executed if an active
interface is available.
Clean
Manages log and data files on the file system: adds files to .7z archives and the archive folders,
deletes excessive data files and copies files to the outbox folder.
Reboot
Initiates a system reboot.
ModemPowerCycle =0.0.12=
Run a modem power cycle (i.e. turn power off for 10 seconds) if an external modem power switch
(MPSW) is available.
Sniffer-Start and Sniffer-Stop =0.0.13.6=
Start or stop an external packet sniffer (NetCap, NMCap or TShark). Sniffer files can be shrinked
(i.e. reduce packet size) and compressed with 7-zip.
yyyymmdd-hhnnss-zzzz-pp-qq
j[(ll)].tii[(ll)][...]
[job/task info]
<ExecId>.<LogId>
<agent-ID>
<RAS entry>
<ip>
<CIC identifier>
<ip>
<dir>
(sys)
=0.0.13.0=
<dir>
(sys\apps)
=0.0.13.0=
<dir>
(sys\scripts) =0.0.13.0=
<dir>
(sys\jobs)
=0.0.13.0=
<dir>
(var)
=0.0.13.0=
<dir>
(var\work\logs)
<dir>
(var\work\reports)
<dir>
(var\work\data)
<dir>
(var\temp)
<execid>-control.dat
<execid>-response.dat
<execid>-index.dat
<execid>-history.dat
<execid>-report.xml
...
...
...
...
...
23
Administrators Manual
24
Administrators Manual
Huawei NDIS Connections can be used with the tasks CIC-Connect and CIC-Hangup. In contrast to
RAS connections the NDIS API does not provide a phonebook that stores user names and passwords.
Thus a number of additional parameters (user name, password, APN) has to be provided for these
connections.
4.7.1.4 Connections managed by external tools
It is possible to manage internet connections with external tools. These connections are treated as
permanent internet connections by TSS.
25
Administrators Manual
26
Administrators Manual
Please note that the CIC connection ID ends with an asterisk (*) to allow for device names ending
with #2, #3 etc. =0.0.12=
4.7.3.3 Sample measurement task
The following sample job shows how the CIC tasks and the parameters defined in the machine
configuration files can be used in a measurement job.
For convenience local variables can be defined in the [Job] section. This can be of advantage if the
internet connection shall be defined manually for test purposes. In this case only a single occurrence
has to be edited even if the parameter is used multiple times in the job file or in sub-jobs.
Please note the variables using %@...%: If a referenced variable is preceded by the @ character, no
error will occur if it is not defined. This allows for compatibility with old machine configuration files.
[Job]
User-CIC-ConnId:
User-CIC-User:
User-CIC-Password:
User-CIC-APN:
%Default-CIC-ConnId%
%@Default-CIC-User%
%@Default-CIC-Password%
%@Default-CIC-APN%
[Task]
Type:
CIC-ConnId:
CIC-User:
CIC-Password:
CIC-APN:
Scenario-ID:
CIC-Connect
%User-CIC-Entry%
%User-CIC-User%
%User-CIC-Password%
%User-CIC-APN%
1001
[Task]
... measurement tasks here...
[Task]
Type:
CIC-ConnID:
Scenario-ID:
CIC-Hangup
%User-CIC-Entry%
1002
Administrators Manual
Default-RAS-Password:
Default-RAS-APN:
ppp
a1.net
Please note that the CIC connection ID ends with an asterisk (*) to allow for device names ending
with #2, #3 etc. =0.0.12=
4.7.4.3 Sample measurement task
The following sample job shows how the RAS tasks and the parameters defined in the machine
configuration files can be used in a measurement job.
For convenience local variables can be defined in the [Job] section. This can be of advantage if the
internet connection shall be defined manually for test purposes. In this case only a single occurrence
has to be edited even if the parameter is used multiple times in the job file or in sub-jobs.
Please note that parameters for user name, password and APN should be defined even if not required
for RAS tasks. Otherwise the job cannot be used for Huawei NDIS connections at a later time.
Please note the variables using %@...%: If a referenced variable is preceded by the @ character, no
error will occur if it is not defined. This allows for compatibility with old machine configuration files.
[Job]
User-RAS-Entry:
User-RAS-User:
User-RAS-Password:
User-RAS-APN:
%Default-RAS-Entry%
%@Default-RAS-User%
%@Default-RAS-Password%
%@Default-RAS-APN%
[Task]
Type:
RAS-Entry:
RAS-User:
RAS-Password:
RAS-APN:
Scenario-ID:
RAS-Connect
%User-RAS-Entry%
%User-RAS-User%
%User-RAS-Password%
%User-RAS-APN%
1001
[Task]
... measurement tasks here...
[Task]
Type:
Ras-Entry:
Scenario-ID:
RAS-Hangup
%User-RAS-Entry%
1002
28
Administrators Manual
direction
zone
default port
info
out
in
localhost
localhost
8868 or 9018
8866 or 9012
out
in
in
in
LAN
LAN
LAN
LAN
8869
8866
8869
8869
UDP
UDP
UDP
TCP
or
or
or
or
9016
9012
9016
9016
packet broadcast
GPS broadcast (LAN)
packet broadcast
communication with TSM
default port
info
8868 or 9018
8866 or 9012
8868 or 9018
8798
8700..8797
8798
3389 or 9017
5900 or 9014
22 or 9015
3389 or 9017
5900 or 9014
22 or 9015
8867 or 9013
8866 or 9012
8867 or 9013
29
Administrators Manual
30
Administrators Manual
31
Administrators Manual
32
Administrators Manual
33
Administrators Manual
%url%\jobs-default\scheduler\scheduler.xml
%url%\jobs-default\files.cfg
%url%\synchronization.cfg
Sample response
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes" ?>
<systime>2010-06-01T01:02:03.456+02:00</systime>
34
Administrators Manual
The task or configuration parameter TimeSync-Method has to be set to "http-gettime" for this
method. The URL has to be configured in the task or configuration parameter GetTime-Server.
Note: time adjustments are only done if the deviation is larger then 200ms to avoid frequent time
changes.
Sample response
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes" ?>
<ipaddr>192.168.1.123:1231</ipaddr>
Windows XP
RAS + HwNd + LAN
RAS + NwNd + LAN
RAS + HwNd + LAN
Windows 7
LAN only
RAS + NwNd + LAN
LAN only
Shrink
No
Yes
Yes
Please note that Microsoft NMCap provides best compatibility and functionality, but has to be installed
as separate package (available for 32 and 64 bit). NetCap does not support shrinking (i.e. frame size
limitation), but WireShark's EditCap.exe can be used to shrink capture files created by Netcap.
The packet sniffer can be configured either in the machine configuration file or inline in the CIC or
Sniffer task, a sample content for machine.cfg is shown below:
[Sniffer]
Sniffer-Type:
Sniffer-Tool:
Sniffer-Args:
Shrink-Type:
Shrink-Tool:
Shrink-Args:
Sniffer-Enabled:
Sniffer-TruncBytes:
Sniffer-MaxErrors:
NetCap
; sniffer type (NetCap, NMCap or TShark)
D:\Tools\SupportToolsXp\netcap.exe
; additional command line arguments
TShark
; shrinking tool (TShark only)
D:\Tools\Wireshark\editcap.exe
; additional command line arguments
true
; enable use of sniffer (has to be true)
86
; truncate frame length to shrink files
5
; max. errors until reboot (def: 10)
With this configuration, a packet sniffer can be associated with a CIC task as follows:
[Task]
Type:
CIC-ConnId:
CIC-User:
CIC-Password:
CIC-APN:
Monitored:
Scenario-Id:
OnError:
UsePacketSniffer:
Sniffer-Compress:
CIC-Connect
%User-CIC-Entry%
%User-CIC-User%
%User-CIC-Password%
%User-CIC-APN%
true
1001
Continue
true
; use packet sniffer defined in [Sniffer] section
true
; compress .cap or .scap file with 7-zip
[Task]
...
[Task]
Type:
CIC-ConnId:
Scenario-Id:
CIC-Hangup
%User-CIC-Entry%
1002
Please note that the packet sniffer is automatically stopped in the CIC-Hangup task (unless explicitly
disabled) or at the end of the job execution. Temporary sniffer files are placed in directory
data\work\sniffer, the output file (shrinked or zipped) is moved to data\work\data.
TSS 0.0.14.0 07.Nov.2011
35
Administrators Manual
available to shrink capture files during or after capturing, defined with parameter
In addition, the smaller output file (either .cap or .scap) can be compressed with 7-zip. The resulting
output file (.7z, .scap or .cap) is moved to directory data\work\data and can be copied to the output
directory for data upload, too. Possible upload modes (defined with Sniffer-Submit) are:
Never
do not upload sniffer files
OnError
upload sniffer files in case of errors
OnWarning
upload sniffer files in case of errors or warnings
Always
always upload sniffer files
If more than one directory is available, the setup utility provides a method to select the configuration
directory to be used.
TraceRt
Execute
20s
true
; true ... skip task if no internet connection is active
30s
c:\windows\system32\TraceRt.exe
193.99.144.85
true
true
continue
Simple applications
Simple applications are assumed to create an XML ticket with result data. The name of the ticket is
given by TSS and can be accessed with the system defined variables %ReportPath%\%ReportFile%. Log
files should be written to %LogPath%\%Prefix%-<suffix>.log.
[Task]
ID:
Type:
Exec-Estimation:
NeedCIC:
Timeout:
AppFileName:
DoSomething
Execute
10s
true
; true ... skip task if no internet connection is active
30s
%scripts%\perl\dosomething.pl
36
Administrators Manual
Arguments:
/arg1 /log=%logpath%\%prefix%\some.log
/report=%reportpath%\%ReportFile%
UseShellExec:
true
; note: we can use shellexec to execute a .pl file
OnError:
continue
Complex applications
More complex applications might need to analyze report and log files of previous tasks. These file
names can either be derived from the execution and task ID (available with %execid% and
%taskid%) or by parsing the index file (available with %TempPath%\%IndexFile% if UseHistoryFile is set
to true).
Execute
~\cmd.exe
/c %scripts%\bat\test1.bat
true ; this is needed as cmd.exe is somewhere in the search path
true
Note: the tilde (~) advices TSS to avoid expanding the file name to the %apps% directory.
Using ArgumentRule
Instead of specifying all arguments directly, an argument rule can be used. This method uses the
parameters AppFileName, ScriptFileName and Arguments. The script file name and the arguments can
be used with the variables $script$ and $args$ in the argument rule as shown below:
[Task]
Type:
AppFileName:
ScriptFileName:
Arguments:
ArgumentRule:
UseRedirect:
Execute
~\perl.exe
%scripts%\perl\test2.pl
/log=%logpath%\%prefix%\some.log
$script$ $args$
true
Cmd
c:\windows\system32\cmd.exe
/c $script$ $args$
Execute
Cmd
%scripts%\batch\test1.bat
true
Using ShellExec
ShellExec allows launching tools with the windows Shell Execute method. This is similar to double
clicking on a file in Windows Explorer. The advantage is that data or script files can be launched
directly if they are associated with a tool, the disadvantage is that console redirection is not possible.
[Task]
Type:
ExeFile:
UseShellExecute:
Execute
%scripts%\perl\test2.pl
true
Note that Perl has to be installed in the system and associated with .pl files to use this method.
37
Administrators Manual
===STATUS <status>
===LOG <text>
===ERROR <text>
===WARNING <text>
===REBOOT
j.t03
report 0 20090330-135815-00-01.Demo-Std01-WithDSL.03-RASDial-report.xml
j.t04
report 0 20090330-135815-00-01.MKA-Std01-WithDSL.04-PocketOptimizer-report.xml
log
1 20090330-135815-00-01.MKA-Std01-WithDSL.04-PocketOptimizer.0000-job.log
A third party tool can parse the file line by line to search for the required task. The next lines then
contain the task's output including one report entry and log files if available. The file name for the
TSS 0.0.14.0 07.Nov.2011
38
Administrators Manual
index
file
is
given
by
TSS
and
can
be
accessed
with
the
system
defined
variables
%TempPath%\%HistoryFile%.
Allowed types are Report, Log and Data. Allowed levels are 0..9.
LAN-Verbindung
39
Administrators Manual
AdapterDefaultGw:
AdapterDNSServers:
192.168.23.1
192.168.23.10,192.168.23.1
40
Administrators Manual
If a hard reboot is required, the TSS Assistance Service stops calming the watchdog and initiates a
WD power cycle while windows is running. The watchdog then does a power cycle and reboots the
machine.
The watchdog section in machine.cfg for this case is:
[Watchdog]
Model:
Cleware
41
Administrators Manual
Cleware
SupportPowerDown=true
Watchdog configuration
To use the Cleware watchdog functions, two steps are required:
The API (Usbaccess.dll) has to be installed.
The [Watchdog] section in machine.cfg has to be configured.
To allow TSS to interface with the Cleware USB Watchdog XP, the interface dll Usbaccess.dll has to be
copied to the TSS binary directory. The file can be found on the Cleware driver CD.
To configure TSS to interface with the watchdog, the [Watchdog] section has to be configured. Set
the parameter Model to Cleware and the parameter Functions to SupportPowerDown=true if external
power was applied as described.
42
Administrators Manual
Serial
\\.\COM31:9600,n,8,1
Reset=DTR,Status=RTS
; serial/cleware
; COM port and parameters
; Reset=[!]DTR/RTS,Status=[!]DTR/RTS
Cleware
; serial/cleware
In addition, the API file Usbaccess.dll has to be copied to the TSS binary directory. The file can be
found on the Cleware driver CD, please note that at least version 4.0.3 is required for the USB cutter.
Serial
\\.\COM32:4800,n,8,1
TAS
8866
;
;
;
;
serial
COM port and parameters
Owner: TAS or TSS, default: TAS
8866/9012: UDP broadcast port
43
Administrators Manual
[GPS]
Model:
Port:
Owner:
Serial
\\.\COM32:4800,n,8,1
TSS
; serial
; COM port and parameters
; Owner: TAS or TSS, default: TAS
The device has a serial GPS input that is distributed to several PC serial inputs. Please note that this is
not contained in the RS232 specification, it has to be checked if the GPS receiver's output is able to
drive more than one serial input.
In addition the device provides a shutdown signal to the PC DCD inputs, the power supply is drawn
from the PC DTR outputs that are set to high by the software. Please note that this is not contained in
the specification but works in most cases. The LEDs have to be high efficiency devices to operate with
low currents down to 0.5mA.
Please note that the threshold voltage for the given implementation will be approximately VCC - 1.75V
with VCC of 5..12V depending on the used serial ports. The used IGN signal has to be at least VCC 1.0V for proper operation.
The PowerMonitor section for the previous device in machine.cfg is
[PowerMonitor]
Model:
Port:
Functions:
ShutDownDelay:
Serial
; serial
GPS
; COM port and parameters (GPS to share)
PowerDown=DCD,Status=RTS,Const=DTR
10s
44
Administrators Manual
Chapter
Technical Reference
5.1 Configuration file reference
The configuration of TSS is contained in several configuration files residing in the TSS system
directory.
only once
only once (merged)
only once
=0.0.13.0=
only once
=0.0.13.6=
multiple
only once
only once
only once
only once
=0.0.12.3=
only once
=0.0.12.3=
only once (merged)
multiple
only once
only once
only once (merged)
only
only
only
only
only
once
once
=0.0.12=
once
once per directory
once (merged)
45
Technical Reference
[Scenarios]
[User]
mobiles.cfg
[MobileDevice]
[MobilePorts]
mapping.cfg
[default]
[TSS.*]
assistance.cfg
[Network]
[Management]
[Routing]
[Directories]
[Log]
[Installer]
only once
only once (merged)
multiple
multiple
=0.0.13.5=
only once
only once per measurement format
[Machine]
;Machine-Name:
;Sync-Enable:
;Sync-AllowDefault:
;Sync-Groups:
;Submit-Enable:
;Report-Enable:
;Fallback-Enable:
;ManageServer-Enable:
;ModemReset-Enable:
;ModemReset-Ports:
;HwNd-Enable:
;InterceptShutdown:
;EwfTimeZoneFix:
Bot01
yes
yes
global group1
yes
yes
yes
yes
yes
;
;
;
;
;
;
;
;
;
;
;
;
;
yes
no
yes
[Scheduler]
; Note: every agent can be assigned a random or fixed agent shift to spread server loads
;Agent-Shift-Fixed:
9s
; use fixed agent shift as specified
;Agent-Shift-Max:
10m
; use random shift derived from agent ID
;Agent-Shift-Inc:
30s
; increment (or rounding value) for shifts
;MaxAssistErrors:
3
; max. TAS errors until a reboot (def: 3)
;MaxSoftReboots:
1
; max. soft reboots before a hard reboot
;MinAssistRebootWait:
1d
; min. time between reboots due to TAS
;CheckAssistanceSvc:
true
; set to false if TAS shall not be checked
;WatchAssistanceSvc:
true
; communicate with TAS in bkground thread
;InitialMPSWDelay:
40s
; delay job after initial MPSW cycle
;TerminateJobTimeout:
15s
; timeout before starting shutdown job
;ShutdownJobTimeout:
60s
; timeout for shutdown job
;MaxCpuOverloads:
2
; reboot after N tasks > 100% sng CPU load
;DisableDelayedStart:
false
; disable automatic start after 30 min
[NetworkServices]
;EnableStatusServer:
;StatusTCPPort:
;StoreTime:
;EnableUdpBroadcast:
;UdpBroadcastPort:
;UdpReceiveTickets:
;UdpBroadcastTickets:
[Sniffer]
Sniffer-Type:
true
8869
3d
true
8869
true
true
;
;
;
;
;
;
;
NetCap
46
Technical Reference
Sniffer-Tool:
Sniffer-Args:
Shrink-Type:
Shrink-Tool:
Shrink-Args:
Sniffer-Enabled:
;Sniffer-TruncBytes:
;Sniffer-TruncMode:
;Sniffer-BufferSize:
;Sniffer-Compress:
;Sniffer-Submit:
;Sniffer-MaxErrors:
;Sniffer-AddLog:
D:\Tools\SupportToolsXp\netcap.exe
; additional command line arguments
TShark
; shrinking tool (TShark only)
D:\Tools\Wireshark\editcap.exe
; additional command line arguments
true
; enable use of sniffer (has to be true)
86
; truncate frame length to shrink files
ShrinkCap
; None/ShrinkCap/ShrinkReplace/ShrinkAdd
100
; buffer size for packet sniffer in MB
true
; compress capture files with 7-zip
Never
; Never/OnError/OnWarning/Always
5
; max. errors until reboot (def: 10)
true
; add sniffer's output to exec log
[Watchdog]
; use these parameters to define an external watchdog to be used by TSS/TAS
; supported watchdog models:
; - cleware ... Cleware USB-Watchdog XP (requires USBAccess.dll)
;Model:
Cleware
; cleware
;Functions:
SupportPowerDown=true
; SupportPowerDown=true
[ModemSwitch]
; use these parameters to define an external power switch to be used by TSS/TAS
; supported USB Switch models:
; - serial ... COM/FTDI based power switch
; - cleware ... Cleware USB cutter (requires USBAccess.dll)
; Serial MPSW switch
;Model:
;Port:
;Functions:
Serial
\\.\COM31:9600,n,8,1
Reset=DTR,Status=RTS
[GPS]
; use these parameters to define a serial/USB GPS receiver
; supported GPS models:
; - serial ... COM based GPS receiver (includes USB with virtual COM port)
;Model:
Serial
; GPS Model (serial only)
;Port:
\\.\COM99:4800,n,8,1
; COM port and parameters
;Owner:
TAS
; Owner: TAS or TSS, default: TAS
;Broadcast-Port:
8866
; 8866/9012: UDP broadcast port
;Broadcast-Port-TXL:
; override for TX local port (from)
;Broadcast-Port-TXT:
; override for TX remote port (to)
;Broadcast-Port-RXL:
; override for RX local port (to)
;Broadcast-Port-RXF:
; override for RX remote port (from)
;Log-TAS:
basic
; GPS log level (off/basic/full)
[PowerMonitor]
; use these parameters to define a power monitor device
; supported power monitor models:
; - serial ... COM based power monitor (includes USB with virtual COM port)
;Model:
Serial
; PM Model (serial only)
;Port:
\\.\COM30:4800,n,8,1
; COM port and parameters (or GPS)
;Functions:
PowerDown=DCD,Status=RTS,Const=DTR
; PowerDown=[!]DCD/DSR/CTS/RI,Status=[!]DTR/RTS,Const=[!]DTR/RTS
;ShutdownDelay:
10s
; delay until shutdown is requested
[NetworkAdapter]
; Note: if adapters have static IP configuration, these parameters are required to restore
; the adapter settings in case of an error
;AdapterName:
LAN-Connection
; name of NIC connection
;AdapterDefaultGw:
192.168.1.1
; default GW in case of static IP config
;AdapterDNSServers:
195.127.23.17
; default DNS servers for static IP config
[Directories]
System:
Data:
C:\TSS-System
C:\TSS-Data
[User]
; Note: this section contains user defined parameters that can be used in jobs and tasks.
; connection variables for RAS tasks in sample jobs
Default-RAS-Entry:
MBB
;Default-RAS-Entry:
HwNd:HUAWEI Mobile Connect - 3G Network Card*
Default-RAS-User:
; not required for RAS
Default-RAS-Password:
; not required for RAS
Default-RAS-APN:
; not required for RAS
47
Technical Reference
only once
only once (merged)
only once
=0.0.13.0=
only once
=0.0.13.6=
multiple
only once
only once
only once
only once
=0.0.12.3=
only once
=0.0.12.3=
only once (merged)
<name>
(string, optional)
This parameter can be used to specify a different agent name than the Windows machine name. The
agent name will be reported in the XML reports and in some log files.
Sync-Enable:
(yes/no/manual/forced)
This parameter can be used to disable synchronization for an individual machine or to restrict
synchronization to manual execution or special tasks. Possible values are:
o yes Synchronization is always enabled.
o manual Synchronization is only enabled if a job is executed manually. If a job is executed
by the scheduler, FileSync tasks will be skipped.
o forced Synchronization is only enabled if a job is executed manually and the task parameter
Sync-Forced is set to true. Otherwise FileSync tasks will be skipped.
o no Synchronization is disabled, FileSync tasks are skipped.
The parameter should be used with care and only be set for test machines or machines with special
configurations. =0.0.13.1=
Sync-AllowDefault:
(True/False/Yes/No)
This parameter can be used to disable synchronization to the default item (*) for an individual
machine. This can be useful for devices that shall not be synchronized to the default configuration.
=0.0.12.8=
Sync-Groups:
(group,group,..)
(string, optional)
This parameter can be used to specify other synchronization groups than defined in the
synchronization server's synchronization.cfg. The parameter should only be used for test machines
as the group assignment cannot be changed on the server if the parameter is set.
Submit-Enable:
(True/False/Yes/No)
This parameter can be used to disable log and data file submission for an individual machine. In this
case SubmitLogs tasks will be skipped and log or data files are not moved to the outbox folder.
Please note that this parameter overrides the parameter Log-Enable in the system configuration file.
Report-Enable:
(True/False/Yes/No)
This parameter can be used to disable QTS ticket upload for an individual machine. If set to false,
Report tasks will be skipped. =0.0.13.8=
Fallback-Enable:
(True/False/Yes/No)
This parameter can be used to disable fallback handling for special cases. Fallback handling
automatically executes special tasks (reporting, synchronization, file submission) if these are not
executed for a longer time period. While this behavior will be suitable for most situations as it avoids
TSS 0.0.14.0 07.Nov.2011
48
Technical Reference
configuration errors, it may be undesirable for special tasks and can thus be disabled. The parameter
should only be used for test machines as it might happen that machines do not recover after
configuration problems.
ManageServer-Enable:
(True/False/Yes/No)
This parameter can be set to false to prevent TSS from querying an interface's management status
from the TSS Assistance Server.
ModemReset-Enable:
(True/False/Yes/No)
Use this parameter to disable the automatic reset of modems or data cards. If this parameter is set
to true, the COM ports defined in the parameter ModemReset-Ports will be reset with the user
defined command AT++RESET or, if not defined, AT+CFUN=1,1.
ModemReset-Ports:
(port,port,...)
(string, default: *)
This parameter can be used to manually define the COM ports of the modems to be reset. If the
parameter is not defined or has the value '*', the COM ports of all CIC or RAS connections used in
the executed jobs will be used.
HwNd-Enable:
(True/False/Yes/No)
This parameter can be set to prevent the Huawei NDIS API functions to be loaded. Please note that
the interface dll ndisapi.dll has to be present in the TSS executable directory.
InterceptShutdown:
(True/False/Yes/No)
This parameter has to be set to true to allow the execution of a shutdown job when the power
button is pressed. This feature is not required if a power monitor device is managed by TAS but is
required if a power button press is simulated (e.g. by the DCDC-USB power supply). Please note that
as a side effect the system will execute a shutdown job and then be turned off in the following
cases:
o when the power button is pressed
o when the user shuts down the system (e.g. with the start menu)
o when the user reboots the system (e.g. with the start menu)
This behavior is caused by the implementation of windows that does not allow the application to
distinguish between those events. To avoid this behavior the user has to terminate TSS before
initiating a windows reboot. =0.0.12.10=
EwfTimeZoneFix:
(True/False/Yes/No)
If this parameter is set to true, TSS automatically checks if the OS is XP embedded or Windows 7
embedded and EWF is enabled. In this case, an automatic EWF commit is initiated if the time zone
has changed (e.g. from standard time to summer time), to fix an issue of Windows and EWF.
Otherwise windows would adjust the system time by one hour after every reboot. Set the parameter
to false to disable EWF checks. =0.0.13.1=
Section [Scheduler]
The machine configuration file may include one section Scheduler. Please note that the parameters in
the machine configuration file supersede the settings in the system configuration file.
Known parameters in machine.cfg configuration section [Scheduler]
Agent-Shift-Fixed:
<1d1h1m1s1ms>
(duration, optional)
If this parameter is defined, it overrides the automatic agent shift defined by Agent-Shift-Max and
Agent-Shift-Inc and delays all task executions by the specified time. Please note that the execution
IDs will be assigned the non-delayed time while the Measurement time (mtime) will be assigned the
actual execution time, e.g.
Agent-Shift-Fixed:
Scheduled time:
Execution ID:
Measurement time:
Agent-Shift-Max:
3m
01.Jan.2009 13:00:00
20090101-130000+0100
20090101-130301+0100
<1d1h1m1s1ms>
(duration, optional)
This parameter is only used if Agent-Shift-Fixed is empty. In this case the agents are assigned time
shifts from 0 to Agent-Shift-Fixed in steps of Agent-Shift-Inc. The actual shift is derived from a
permutation of the agent ID to reduce the probability that neighboring agent IDs get similar time
shifts.
Agent-Shift-Inc:
<1d1h1m1s1ms>
(duration, optional)
This parameter is only used if Agent-Shift-Fixed is empty. It provides the finest granularity between
the different agent shifts.
49
Technical Reference
MaxAssistErrors:
<int>
(integer, default: 3)
Maximum number of consecutive problems reported by the TSS Assistance Service until a soft/hard
reboot is executed. = 0.0.12=
MaxSoftReboots:
<int>
(integer, default: 1)
Maximum number of soft reboots before a hard reboot is executed. This parameter is only used if a
watchdog is available and it does NOT support safe power down. In this case up to MaxSoftReboots
soft reboots are executed before a hard reboot to reduce the risk of file system problems due to the
hard power-off while the OS is running. =0.0.12=
MinAssistRebootWait:
<1d1h1m1s1ms>
Minimum delay between reboots due to TAS problems. Typical problems leading to TAS reboots are
communication problems with watchdogs or power switches. The parameter MinAssistRebootWait
can be used to prevent excessive reboots due to (non-critical) TAS problems. =0.0.12.3=
CheckAssistanceSvc:
(True/False/Yes/No)
If this parameter is set to false, the TSS Assistance Service is not checked by the scheduler. If it is
true (default), the scheduler regularly queries the TSS Assistance service for problems (e.g. nonfunctioning watchdog or MPSW devices). In case of problems, additional reboots (not shorter than
every 12 hours) are executed. =0.0.12=
WatchAssistanceSvc:
(True/False/Yes/No)
Communicate with TSS Assistance Service in background thread. This function is required when
using a power monitor device. =0.0.12.6=
InitialMPSWDelay:
<1d1h1m1s1ms>
Delay execution of first job by given time if a pending MPSW cycle is executed at startup. The delay
is required to allow the mobile to register to the network. =0.0.12.6=
TerminateJobTimeout:
<1d1h1m1s1ms>
Timeout to terminate a running job before starting the shutdown job. The shutdown job is executed
when the power button is pressed (except if RDP owns the console session) or the power monitor
device requests a system shutdown. =0.0.12.6=
ShutdownJobTimeout:
<1d1h1m1s1ms>
Timeout to execute the shutdown job. Shutdown is delayed while the shutdown job is executed, this
parameter is used to prevent the shutdown job from locking or excessive duration. =0.0.12.6=
MaxCpuOverloads:
<int>
(optional, default: 2)
Maximum # of job executions with CPU overload issues before a reboot is initiated. TSS
automatically detects the CPU load during task executions. If the CPU load of one single core is at
100%, this indicates a software issue. If the number of consecutive CPU overload situations exceeds
MaxCpuOverloads, a reboot is initiated. =0.0.13.1=
DisableDelayedStart:
(True/False/Yes/No)
Disable automatic scheduler start after 30min even if not called with /autorun argument. =0.0.14.0
Section [NetworkServices]
The machine configuration file may include one section NetworkServices.
Known parameters in machine.cfg configuration section [NetworkServices]
EnableStatusServer:
(True/False/Yes/No)
Set this parameter to true to enable the internal status server and the memory based ticket storage.
These functions are required by the TSS Status Monitor to access ticket data. =0.0.13.0=
StatusTCPPort:
<int>
(integer, default:8869)
Defines the TCP port used for the integrated status server. Typical values are 8869 or 9016.
=0.0.13.0=
StoreTime:
<1d1h1m1s1ms>
Defines the storage time for tickets in in-memory ticket storage. This parameter is only required if
the integrated status server is used for communication with the TSS Status Monitor (i.e. if
EnableStatusServer is true). =0.0.13.1=
EnableUdpBroadcast:
(True/False/Yes/No)
Enables UDP broadcasting from TSS to TSS. This function has to be enabled to submit or receive
QTS tickets from other test units via UDP. =0.0.13.1=
UdpBroadcastPort:
<int>
(integer, default:8869)
Defines the UDP port used for sending and receiving broadcast messages (e.g. QTS execution tickets
that could not be sent to the QTS Ticket Receiver). Typical values are 8869 or 9016. =0.0.13.1=
50
Technical Reference
UdpReceiveTickets:
(True/False/Yes/No)
Enables reception of QTS tickets via UDP. Received tickets are stored in the outbox directory and
submitted to the QTS Ticket Receiver in the next reporting task. =0.0.13.1=
UdpBroadcastTickets:
(True/False/Yes/No)
Enables submission of QTS tickets via UDP. Only execution tickets are submitted via UDP and only if
the submission in the reporting task failed. This feature can be used in drive testing to allow
reporting even if a single test unit cannot submit QTS tickets. =0.0.13.1=
Section [Sniffer]
The machine configuration file may include one section Sniffer to define a packet sniffer utility and
operational parameters. Please note that the parameters can be overridden in the CIC or Sniffer tasks
=0.0.13.6=.
Known parameters in machine.cfg configuration section [NetworkAdapter]
Sniffer-Type:
(NetCap/NMCap/TShark)
(string, optional)
Defines the packet sniffer tool to be used. Possible values are: =0.0.13.6=
o NetCap
Microsoft NetCap from XP support tools (Windows XP only)
o NMCap
Microsoft NMCap from Network Monitor 3.4 (Windows XP and Windows 7)
o TShark
Wireshark's TShark (Windows XP, LAN only in Windows 7)
Sniffer-Tool:
<exe-file>
(string, optional)
<args>
(string, optional)
Additional command line arguments for the packet sniffer tool. Arguments automatically applied are:
NetCap:
NMCap:
TShark:
Shrink-Type:
(TShark)
(string, optional)
Defines the capture file shrinking tool (only required if a .cap file shall be reduced in size by
truncating frames after N bytes). The only supported type is TShark using Wireshark's editcap.exe.
=0.0.13.6=
Shrink-Tool:
<exe-file>
(string, optional)
Defines the executable file name for the capture file shrinking tool (editcap.exe). =0.0.13.6=
Shrink-Args:
<args>
(string, optional)
Additional command line arguments for the capture file shrinking tool. =0.0.13.6=
Sniffer-Enabled:
(True/False/Yes/No)
This parameter has to be set to true to enable the packet sniffer. Can be used to disable the packet
sniffer while preserving all configuration parameters.
Sniffer-Connection:
<type>:<id>
(string, optional)
<bytes>
(integer, optional)
Define this parameter to reduce the number of bytes per captured frame and thus reduce the size of
the capture file while preserving the header information. Please note that TSS uses a different file
extension .scap for shrinked capture files. =0.0.13.6
The following header sizes have to be considered when shrinking capture files:
o MAC header 14 bytes
o IP header
20 bytes
o TCP header 20..32 bytes
A typical frame length of 86 thus results in 20..32 bytes of TCP payload data per frame.
Sniffer-TruncMode:
51
Technical Reference
o ShrinkReplace shrink after capturing, but delete .cap file (only .scap file created)
o ShrinkAdd
shrink after capturing, preserve .cap file (.cap and .scap files created)
Sniffer-BufferSize:
<MB>
(integer, optional)
Defines the buffer size for the packet sniffer. Some packet sniffers (NetCap and NMCap) use circular
buffers, i.e. the existing buffer bytes are overwritten once the buffer size is reached. In this case the
buffer size has to be chosen large enough to contain the entire data session. =0.0.13.6=
Sniffer-Compress:
(True/False/Yes/No)
Compress capture file with 7-zip. The smaller output file (either the .scap or .cap) can be
compressed with 7-zip before storage or submission. The input file is deleted after compression to
reduce file system usage. =0.0.13.6=
Sniffer-Submit:
Sniffer files can automatically be submitted via FTP data upload if required. Please note that in this
case the smallest sniffer file (.7z, .scap or .cap) will be copied to the outbox directory, upload has to
be done with a properly configured SubmitLogs task. Possible upload modes are =0.0.13.6=
o Never
do not upload sniffer files
o OnError
upload sniffer files in case of errors
o OnWarning
upload sniffer files in case of errors or warnings
o Always
always upload sniffer files
Sniffer-MaxErrors:
<int>
Maximum number of errors (starting or stopping the packet sniffer) until a reboot is done.
Sniffer-AddLog:
(True/False/Yes/No)
Add sniffer tool's console output to execution log for debugging purposes.
Section [NetworkAdapter]
The machine configuration file may include one or several section NetworkAdapter. One section is
required for every LAN Adapter (connected to a LAN or DSL connection) with static IP configuration.
The purpose of this parameters is to provide the parameters for IPConfig tasks with mode Restore.
Note: These parameters are only required for static IP configuration, not if the interface is on DHCP.
The parameters are needed because in case of a power loss or an external reboot while the interface
is configured for measurement, the system will reboot without proper IP configuration and TSS can
only revert to the proper settings if these are defined.
In case of multiple adapters multiple sections have to be defined, the primary key for the sections is
the parameter AdapterName.
Known parameters in machine.cfg configuration section [NetworkAdapter]
AdapterName:
<NIC name>
(string)
This parameter uniquely identifies the NetworkAdapter section. Please use the same adapter name
as in the Windows Networks connections.
AdapterDefaultGW:
<IP addr>
(string)
(string)
Specify one or several DNS server IP addresses for the adapter, separated by commas
Section [Directories]
The machine configuration file may include one section Directories. Usually this section will contain
the system and the data directory, but other directories can be defined as well.
Known parameters in machine.cfg configuration section [Directories]
System:
<dir>
(string, mandatory)
The system directory has to be defined, usually it will be the directory the file TSS.exe is located in.
In most cases the parameter will automatically be set by the installer. The system directory is the
base directory for all other directories
Data:
<dir>
(string, optional)
Usually the data directory will be a special directory, if not defined it will default to %system%\data. In
most cases the parameter will automatically be set be the installer.
<Dir>:
<dir>
(string, optional)
Any required directory can be defined according to the following scheme: The parameter name is the
requested directory with an underscore (_) instead of the backslash (\) as directory separator.
Directory
Parameter Name
52
Technical Reference
Apps
Apps\PO
Apps\WST
Scripts
Jobs
Jobs\PO
Jobs\WST
Scheduler
Apps
Apps_PO
Apps_WST
Scripts
Jobs
Jobs_PO
Jobs_WST
Scheduler
Data
Data\Work
Data\Work\Logs
Data\Work\Reports
Data\Work\Data
Data\Work\Sniffer
Data\Work\Scheduler
Data\Work\Assistance
Data\Archive
Data\Archive\Logs
Data\Archive\Reports
Data\Archive\Data
Data\Archive\Sniffer
Data\Archive\Scheduler
Data\Archive\Assistance
Data\Outbox
Data\Outbox\Logs
Data\Outbox\Reports
Data\Outbox\Data
Data\Errors
Data\Errors\Logs
Data\Errors\Reports
Data\Errors\Data
Data\Temp
Data\Persistent
Data
Data_Work
Data_Work_Logs
Data_Work_Reports
Data_Work_Data
Data_Work_Sniffer
Data_Work_Scheduler
Data_Work_Assistance
Data_Archive
Data_Archive_Logs
Data_Archive_Reports
Data_Archive_Data
Data_Archive_Sniffer
Data_Archive_Scheduler
Data_Archive_Assistance
Data_Outbox
Data_Outbox_Logs
Data_Outbox_Reports
Data_Outbox_Data
Data_Errors
Data_Errors_Logs
Data_Errors_Reports
Data_Errors_Data
Data_Temp
Data_Persistent
Section [Watchdog]
A single watchdog model is supported by the TSS Management Service
Cleware USB Watchdog XP (www.cleware.de)
The Cleware access API (usbaccess.dll) has to be copied to the windows directory or the application
directory to use the watchdog.
If the watchdog is configured, it is automatically calmed by the TSS Assistance Service. Every second
reboot is executed as a hard reboot in this case.
Parameters in section [Watchdog]
Model
<model>
Currently only the model Cleware is supported (Cleware USB Watchdog XP). The Cleware access API
(usbaccess.dll) has to be copied to the application directory to use the watchdog.
Functions
<function>,<function>
Currently only one function is supported: Set SupportPowerDown to true if the Cleware USB
Watchdog is connected to an external power supply (e.g. via an USB hub) to ensure USB power is
maintained even if the PS is shut down. If the parameter is set to true, the TSS Assistance service
will safely shut down windows instead of initiating a WD hard reboot.
SupportPowerDown=true/false
Section [ModemSwitch]
Two Modem power switches (MPSW) are supported by the TSS Management Service
Serial USB power switch
Cleware USB cutter
If the power switch is used, a 10 second power cycle is automatically executed before a reboot.
Parameters in section [ModemSwitch]
Model
<model>
Currently the models Serial and Cleware are supported. For serial switches the control lines (DTR or
RTS) are used to control the power switch and an optional activity indicator (LED). The Cleware USB
cutter uses an API (contained in Usbaccess.dll) that does not require parameters. =0.0.12=
Port
<com>:<params>
Contains the serial port and the parameters, e.g. \\.\COM30:9600,n,8.1. This parameter is only
required for serial power switches.
TSS 0.0.14.0 07.Nov.2011
53
Technical Reference
Functions
<function>,<function>
Defines the functions provided by the USB power switch. Two functions can be defined for serial
power switches: Reset and Status. Both functions can be assigned to an output signal (DTR or RTS),
the signal can be inverted if required (if preceded by an exclamation mark).
Reset=DTR/!DTR/RTS/!RTS
Status=DTR/!DTR/RTS/!RTS
The default implementation uses non-inverted DTR for the switch and non-inverted RTS for the LED,
i.e. Functions: Reset=DTR,Status=RTS
Section [GPS]
Serial GPS receivers are supported by TSS and TAS. Please note that most USB GPS receivers provide
a virtual serial port, these are supported by TSS, too. =0.0.12.3=
Parameters in section [GPS]
Model
<model>
<com>:<params>
Contains the serial port and the parameters, e.g. \\.\COM30:4800,n,8.1. =0.0.12.3=
Owner
TAS/TSS
Defines the GPS port's owner (TAS or TSS). If owned by TAS, the TSS Assistance Service receives
data from the serial port and broadcasts them via UDP for use on the local machine and in the LAN.
If owned by TSS, UDP functions are not available and GPS data can only be used by the local TSS
instance. =0.0.12.3=
Broadcast-Port
<port>
The UDP port to broadcast the data to. The port is used for local and remote port in TSS and TAS if
not overridden by one of the detail parameters described below. This parameter is only used if
Owner is TAS. Please note that GPS data is broadcasted to LAN interface only, not to the
measurement interface. =0.0.12.3=
Broadcast-Port-TXL
<port>
(integer, optional)
Override for the local transmit port for special requirements. =0.0.12.3=
Broadcast-Port-TXT
<port>
(integer, optional)
Override for the remote transmit port (transmit-to) for special requirements. =0.0.12.3=
Broadcast-Port-RXL
<port>
(integer, optional)
Override for the local receive port for special requirements. =0.0.12.3=
Broadcast-Port-RXF
<port>
(integer, optional)
Override for the remote receive port (receive-from) for special requirements. =0.0.12.3=
Log-TAS
<off/basic/full>
(string, default:off)
Log mode for GPS data, only used if Owner is TAS. Possible log modes are
o off
... no GPS data is logged
o basic
... only GPRMC and GPGGA records are logged
o full
... the entire GPS NMEA data is logged
Please note that the log file is defined in assistance.cfg, parameter Logfile-GPS. =0.0.12.3=
Section [PowerMonitor]
A power monitor is an external device that signals a required power shutdown to TSS. In addition a
status signal can be controlled by TSS (e.g. a blinking LED). Currently power monitor functions are
available for test purposes only, more advanced functions can be implemented in the future.
=0.0.12.3=
Parameters in section [PowerMonitor]
Model
<model>
Currently the model Serial is supported. Both physical and virtual serial ports can be used.
=0.0.12.3=
Port
<com>:<params>
Contains the serial port and the parameters, e.g. \\.\COM30:4800,n,8.1. =0.0.12.3=
The special value "GPS" is supported to share the serial port with the GPS receiver. Use this method
to use a combined GPS/PowerMonitor cable as shown in section Fehler! Verweisquelle konnte
nicht gefunden werden.. =0.0.12.7=
54
Technical Reference
Functions
<port>
(integer, optional)
Defines the functions provided by the power monitor device. Three functions can be defined for
serial power switches: PowerDown, Status and Const. The first function can be assigned to an input
signal (DCD, DSR, CTS or RI), the remaining functions can be assigned to an output signal (DTR or
RTS), the signals can be inverted if required (if preceded by an exclamation mark). =0.0.12.3=
=0.0.12.6=
PowerDown=DCD/!DCD/DSR/!DSR/CTS/!CTS/RI/!RI
Status=DTR/!DTR/RTS/!RTS
Const=DTR/!DTR/RTS/!RTS
If the PowerDown signal is raised for a time longer than the given shutdown-delay, a shutdown is
internally scheduled. The Status signal can drive a LED that will be toggled to indicate operation. The
Const signal can be used to set an output to constant high or low (e.g. for power supply purposes).
=0.0.21=
The reference implementation uses non-inverted DCD as power input (raised to positive voltage if
shutdown is required), RTS for a LED and DTR as power supply, i.e. Functions:
PowerDown=DCD,Status=RTS,Const=DTR
ShutdownDelay
<1d1h1m1s1ms>
Defines the mimimum time the PowerDown signal has to be set until a shutdown is scheduled.
Please
note
that
an
additional
time
from
Management/ShutdownDelay
to
Management/ShutdownTimeout will occur until the system shutdown is initiated. =0.0.12.3=
=0.0.12.6=
Section [User]
The machine configuration file may include one section User.
Known parameters in machine.cfg configuration section [User]
The user section can contain any user defined parameter. The parameters can be accessed in any
job or task section, e.g.
Sample content in machine.cfg:
[User]
Default-CIC-ConnId:
RAS:A1.net
;Default-CIC-User:
; not required for RAS
;Default-CIC-Password: ; not required for RAS
;Default-CIC-APN:
; not required for RAS
CIC-Connect
%Default-CIC-Entry%
%Default-CIC-User%
%Default-CIC-Password%
%Default-CIC-APN%
----- application configuration ----this section contains applications that can be accessed by the name defined in
parameter AppType
note: these files are located in %apps% (or %system%\apps) if a relative path is specified
[Application]
AppType:
ExeFile:
PocketOptimizer
PO\PocketOptimizer.exe
[Application]
AppType:
ExeFile:
WebSpeedtest
WST\WebSpeedTest.exe
http-gettime
55
Technical Reference
; ----- tool configuration ----; file names for special known tools
; note: these files are located in %apps% (or %system%\apps) if a relative path is specified
[Tools]
;Reboot-Tool:
;MPSW-Tool:
Zip-Tool:
;SNTP-Tool:
SNTP-Tool:
cmd.exe /c scripts\extreset.bat
mpsw.exe
7Zip\7z.exe
SmallSNTP\SmallSNTPAgent.exe
NTPDate\ntpdate.exe
multiple
only once
only once
only once (merged)
<name>
(string)
The name of the application. Known names are PocketOptimizer and WebSpeedTest. Other names
can be used as required.
ExeFile:
<path\file.exe>
(string)
Path to the executable file name. If the file name is not absolute, it has to be relative to the
configuration path %system\apps%, except if it starts with the prefix ~\. In this case, the file name is
not expanded and will be searched in the Windows search path.
ArgumentRule:
<rule>
(string, optional)
The optional argument rule can be used to create the application arguments for script processing
tools. The parameter can contain the placeholders $script$ and $args$ that are expanded to the
corresponding parameters.
The application rule for the Windows command processor cmd.exe is
/c $script$ $args$
Section [Methods]
The application configuration file may include one Method section. This section contains configuration
parameters for special tasks.
Known parameters in application.cfg configuration section [Methods]
TimeSync-Method:
[exec/http-gettime]
(string, optional)
Two different time synchronization methods are available: An external tool or HTTP get-time.
exec: the external tool defined in [Tools].SNTP-Tool is used
http-gettime: An internal HTTP request to the server defined in GetTime-Server is used (typically a
QTS Ticket Receiver or Relay).
Section [Tools]
The application configuration file may include one Tool section. This section contains file names for a
list of well known tools.
Known parameters in application.cfg configuration section [Tools]
Reboot-Tool:
[path\]<file.ext> [args]
(string, optional)
If this parameter is not empty, the specified reset tool is executed instead of rebooting the system
with Windows API calls.
MPSW-Tool:
[path\]<file.ext> [args]
(string, optional)
If this parameter is not empty, the specified modem power switch tool is executed instead of an
internal power switch. The tool shall apply a short (e.g. 10 seconds) power cycle to the modem.
Zip-Tool:
[path\]7z.exe
(string, optional)
The zip tool is used to compress log and data files to backup files. Currently only 7-zip is supported.
TSS 0.0.14.0 07.Nov.2011
56
Technical Reference
SNTP-Tool:
[path\]<file.exe>
(string, optional)
The SNTP tool has to start an SNTP synchronization and terminate if the synchronization is
successful. Otherwise TSS will terminate the application after a timeout and raise an error. Currently
two tools are supported: GNU ntpdate and Alsedi Small SNTP Agent.
Section [User]
The application configuration file may include one section User.
Known parameters in application.cfg configuration section [User]
The user section can contain any user defined parameter. The parameters can be accessed in any
job or task section.
1000M
1000M
1000M
100M
100M
100M
100M
100M
100M
100M
true
P1d
0h
31d
true
false
true
P1d
0h
31d
3d
10000
30d
100000
60d
100
90d
10000
7d
5000
[Tempfiles/Logs]
compress-submit:
clean-maxsize:
true
15%
[Tempfiles/Reports]
compress-submit:
clean-maxsize:
true
15%
[Tempfiles/Data]
clean-maxsize:
30%
[Tempfiles/Sniffer]
clean-maxsize:
30%
[Tempfiles/Assistance]
compress-enabled:
archive-enabled:
clean-maxsize:
false
false
5%
[Tempfiles/Scheduler]
compress-enabled:
false
57
Technical Reference
archive-enabled:
clean-maxsize:
false
5%
[Tempfiles/Temp]
compress-enabled:
archive-enabled:
clean-tmp-maxage:
clean-maxsize:
false
false
7d
100%
only
only
only
only
only
once
once
once
once per directory
once (merged)
<int> or <int>M
Specifies the maximum size for the directory %system/data/work%, either in bytes or MB.
Data_Archive:
<int> or <int>M
Specifies the maximum size for the directory %system/data/archive%, either in bytes or MB.
Data_Backup:
<int> or <int>M
Specifies the maximum size for the directory %system/data/backup%, either in bytes or MB.
Data_Errors:
<int> or <int>M
Specifies the maximum size for the directory %system/data/errors%, either in bytes or MB.
Data_Outbox:
<int> or <int>M
Specifies the maximum size for the directory %system/data/outbox%, either in bytes or MB.
Data_Temp:
<int> or <int>M
Specifies the maximum size for the directory %system/data/temp%, either in bytes or MB.
Section [Diskfree]
The platform configuration file may include one Diskfree section. The settings are used to check
different drives for minimum free disk space. Warnings are generated in the execution tickets if the
free space drops below the allowed limit. Free disk space is checked in the Cleanup task. =0.0.12=
Known parameters in platform.cfg configuration section [Diskfree]
sys_os:
<int> or <int>M
(string, default: 0)
Specifies the minimum free size for the drive containing the operating system (typically C:\).
sys_temp:
<int> or <int>M
(string, default: 0)
Specifies the minimum free size for the drive containing the system temp directory (typically C:\).
tss:
<int> or <int>M
(string, default: 0)
Specifies the minimum free size for the drive containing the TSS base directory.
data:
<int> or <int>M
(string, default: 0)
Specifies the minimum free size for the drive containing the TSS data directory.
<other>:
<int> or <int>M
(string, default: 0)
Specifies the minimum free size for the drive containing a special TSS directory. The same directory
parameters as in the [Directory] section in machine.cfg can be used (e.g. data_work or data_temp).
Section [Tempfiles]
The platform configuration file may include one Tempfiles section. This section contains the default
values for the specific Tempfiles/<dir> sections.
Please refer to the next section for details.
58
Technical Reference
Section [Tempfiles/<dir>]
The platform configuration file may include one Tempfiles section for the directories Logs, Reports,
Data, Assistance, Scheduler. The first 3 directories are considered as high frequency directory with a
larger amount of files per day, the last 2 directory are low frequency directory.
The different settings apply to the following folders:
Config section
Tempfiles/Logs
Tempfiles/Reports
Tempfiles/Data
Tempfiles/Sniffer
Tempfiles/Scheduler
Tempfiles/Assistance
work directory
data\work\logs
data\work\reports
data\work\data
data\work\sniffer
data\work\scheduler
data\work\assistance
archive directory
data\archive\logs
data\archive\reports
data\archive\data
data\archive\sniffer
data\archive\scheduler
data\archive\assistance
backup directory
data\backup\logs
data\backup\reports
data\backup\data
data\backup\sniffer
data\backup\scheduler
data\backup\assistance
freq
high
high
high
high
low
low
The default values in this chapter are given as <high freq>/<low freq> and are used in clean tasks
only.
Known parameters in platform configuration section [Tempfiles]
compress-enabled:
(True/False/Yes/No)
If this parameter is set to true, the content of the work folder will be compressed to 7z backup files.
compress-period:
(P1DT1H1M1S+O1DT1H1M1S)
This parameter specifies the compression interval. A value of P1D leads to one backup file per day.
compress-delay:
(1d1h1m1s1ms)
This parameter defines an additional delay before the backup file is created. This parameter is used
to avoid the creation of backup archives before the data files are entirely written.
compress-history:
(1d1h1m1s1ms)
This parameter defines the maximum age for files in the work directory to be compressed in backup
files. Usually this parameter should not be needed as the files are usually deleted from the work
directory at a maximum age of clean-work-maxage.
compress-complete:
(True/False/Yes/No)
If this parameter is set, the creation of the archive file is delayed until the archive period (compressperiod) and the delay (compress-delay) have expired. Otherwise the archive is created immediately
and will grow in every clean task as new files are added.
compress-complete:
(True/False/Yes/No)
If this parameter is set to true, the content of the work folder will only be compressed if the
compression period is complete, i.e. the compression is delayed until no more files are likely to be
added.
compress-submit:
(True/False/Yes/No)
If this parameter is set to true, the backup file is moved to the output directory for submission.
archive-enabled:
(True/False/Yes/No)
If this parameter is set to true, the content of the work folder will be moved to the archive folder.
archive-period:
(P1DT1H1M1S+O1DT1H1M1S)
This parameter defines the backup interval. One sub-directory in the archive directory per backup
interval is created to improve the file system access performance for large amounts of files.
archive-delay:
(1d1h1m1s1ms)
This parameter defines an additional delay before files are moved to the archive directory.
archive-history:
(1d1h1m1s1ms)
This parameter defines the maximum age for files in the work directory to be moved to the archive
directory. Usually this parameter should not be needed as the files are usually deleted from the work
directory at a maximum age of clean-work-maxage.
clean-maxsize:
<int>%/<int>/<int>M
Defines the quota for a particular sub-directory in the work, archive and backup directory. Values
given in percent are relative to the corresponding parameter in section [Quota]. The default values
of 30%+30%+30%+5%+5% will lead to a total utilization of 100%.
Usually this parameter is used if the work, archive and backup directory are assigned the same
percentage. Otherwise different quotas can be defined with clean-work-maxsize, clean-arch-maxsize
and clean-zip-maxsize.
clean-work-maxage:
(1d1h1m1s1ms)
The maximum file age in the work directory. Files are deleted from the work directory after reaching
the specified age.
59
Technical Reference
clean-work-maxnum:
<int>
<int>%/<int>/<int>M
Defines the quota for a particular sub-directory of the work directory (Logs/Reports/Data/Scheduler/
Assistance). Values given in percent are relative to the corresponding parameter in section [Quota].
clean-arch-maxage:
(1d1h1m1s1ms)
The maximum file age in the work directory. Files are deleted from the archive directory after
reaching the specified age.
clean-arch-maxnum:
<int>
<int>%/<int>/<int>M
Defines
the
quota
for
a
particular
sub-directory
of
the
archive
directory
(Logs/Reports/Data/Scheduler/ Assistance). Values given in percent are relative to the corresponding
parameter in section [Quota].
clean-bak-maxage:
(1d1h1m1s1ms)
The maximum file age in the backup directory. Files are deleted from the backup directory after
reaching the specified age.
clean-bak-maxnum:
<int>
<int>%/<int>/<int>M
Defines
the
quota
for
a
particular
sub-directory
of
the
backup
directory
(Logs/Reports/Data/Scheduler/ Assistance). Values given in percent are relative to the corresponding
parameter in section [Quota].
clean-err-maxage:
(1d1h1m1s1ms)
The maximum file age in the error directory. Files are deleted from the error directory after reaching
the specified age.
clean-err-maxnum:
<int>
<int>%/<int>/<int>M
Defines the quota for a particular sub-directory of the error directory (Logs/Reports/Data/Scheduler/
Assistance). Values given in percent are relative to the corresponding parameter in section [Quota].
Section [Tempfiles/Temp]
The platform configuration file may include one section Tempfiles/Temp.
The parameters control deletion of files in the directory %system\data\temp%.
Known parameters in platform.cfg configuration section [Tempfiles/Temp]
clean-err-maxage:
(1d1h1m1s1ms)
The maximum file age in the error directory. Files are deleted from the temp directory after reaching
the specified age.
clean-err-maxnum:
<int>
<int>%/<int>/<int>M
Defines the quota for a particular sub-directory of the temp directory (Logs/Reports/Data/Scheduler/
Assistance). Values given in percent are relative to the corresponding parameter in section [Quota].
[Scheduler]
;Agent-Shift-Fixed:
Agent-Shift-Max:
Agent-Shift-Inc:
9s
10m
30s
60
Technical Reference
;MaxAssistErrors:
;MaxSoftReboots:
;MinAssistRebootWait:
;CheckAssistanceSvc:
;WatchAssistanceSvc:
;InitialMPSWDelay:
;TerminateJobTimeout:
;ShutdownJobTimeout:
3
1
1d
true
true
40s
15s
60s
;
;
;
;
;
;
;
;
[Communication]
Report-Instance:
Report-TIC:
Report-Server:
Report-Enable:
PublicIP-Server:
GetTime-Server:
Sync-Server:
Log-Server:
Log-User:
Log-Pass:
;Log-Passive:
;Log-Enable:
NTP-Server:
Manage-Server:
Manage-Instance:
QTS-Demo
; instance name for QTS
0
; Ticket identification code for QTS
http://www.i-qos.com:8808/
false
; enable QTS ticket upload
http://www.i-qos.com:8808/get-ipaddr
http://www.i-qos.com:8808/get-time
http://www.i-qos.com/config/demo/TSS/default
ftp://www.i-qos.com/upload/demo/TSS/%agentid%
iFtpXxx
; FTP user name for log file upload
iFtpXxx
; FTP password for log file upload
true
; use FTP passive mode for log upload
true
; enable FTP log file upload
0.pool.ntp.org
; NTP server for time synchronization
test2.i-qos.com:8798
; TSS management server
Manage-Demo
; override instance name for TMS
[Tickets]
AddGPSPoints:
;MobileInfoHistory:
auto
10
[Scenarios]
CID-Execution:
CID-Status:
CID-Startup:
CID-Restart:
CID-Shutdown:
CID-ModemReset:
CID-MPSW:
Status-Period:
;Mapping:
1000.exec
1001.status
1002.startup
1003.restart
1004.shutdown
1005.reset
1006.mpsw
P1D+OT15M
mapping.cfg
[User]
; user defined variables for use in job files
;Default-ICMP-Host:
128.131.88.39
only
only
only
only
only
once (merged)
once
once
=0.0.12.3=
once
once (merged)
<1d1h1m1s1ms>
(duration, optional)
If this parameter is defined, it overrides the automatic agent shift defined by Agent-Shift-Max and
Agent-Shift-Inc and delays all task executions by the specified time. Please note that the execution
ids will be assigned the non-delayed time while the Measurement time (mtime) will be assigned the
actual execution time, e.g.
Agent-Shift-Fixed:
Scheduled time:
Execution ID:
Measurement time:
3m
01.Jan.2009 13:00:00
20090101-130000+0100
20090101-130301+0100
61
Technical Reference
Agent-Shift-Max:
<1d1h1m1s1ms>
(duration, optional)
This parameter is only used if Agent-Shift-Fixed is empty. In this case the agents are assigned time
shifts from 0 to Agent-Shift-Fixed in steps of Agent-Shift-Inc. The actual shift is derived from a
permutation of the agent ID to reduce the probability that neighboring agent IDs get similar time
shifts.
Agent-Shift-Inc:
<1d1h1m1s1ms>
(duration, optional)
This parameter is only used if Agent-Shift-Fixed is empty. It provides the finest granularity between
the different agent shifts.
MaxAssistErrors:
<int>
(integer, default: 3)
Maximum number of consecutive problems reported by the TSS Assistance Service until a soft/hard
reboot is executed. =0.0.12=
MaxSoftReboots:
<int>
(integer, default: 1)
Maximum number of soft reboots before a hard reboot is executed. This parameter is only used if a
watchdog is available and it does NOT support safe power down. In this case up to MaxSoftReboots
soft reboots are executed before a hard reboot to reduce the risk of file system problems due to the
hard power-off while the OS is running. =0.0.12=
MinAssistRebootWait:
<1d1h1m1s1ms>
Minimum delay between reboots due to TAS problems. Typical problems leading to TAS reboots are
communication problems with watchdogs or power switches. The parameter MinAssistRebootWait
can be used to prevent excessive reboots due to (non-critical) TAS problems. =0.0.12.3=
CheckAssistanceSvc:
(True/False/Yes/No)
If this parameter is set to false, the TSS Assistance Service is not checked by the scheduler. If it is
true (default), the scheduler regularly queries the TSS Assistance service for problems (e.g. nonfunctioning watchdog or MPSW devices). In case of problems, additional reboots (not shorter than
every 12 hours) are executed. =0.0.12=
WatchAssistanceSvc:
(True/False/Yes/No)
Communicate with TSS Assistance Service in background thread. This function is required when
using a power monitor device. =0.0.12.6=
InitialMPSWDelay:
<1d1h1m1s1ms>
Delay execution of first job by given time if a pending MPSW cycle is executed at startup. The delay
is required to allow the mobile to register to the network. =0.0.12.6=
TerminateJobTimeout:
<1d1h1m1s1ms>
Timeout to terminate a running job before starting the shutdown job. The shutdown job is executed
when the power button is pressed (except if RDP owns the console session) or the power monitor
device requests a system shutdown. =0.0.12.6=
ShutdownJobTimeout:
<1d1h1m1s1ms>
Timeout to execute the shutdown job. Shutdown is delayed while the shutdown job is executed, this
parameter is used to prevent the shutdown job from locking or excessive duration. =0.0.12.6=
Section [Communication]
The system configuration file may include one section Communication.
Known parameters in System.cfg configuration section [Communication]
Report-Instance:
<instance>
(string, optional)
The QTS instance (database) name. The instance name will automatically be inserted into all
submitted tickets.
Report-TIC:
<http-int>
(integer, optional)
The QTS TIC (ticket identification code). The TIC will automatically be inserted into all submitted
tickets.
Report-Server:
<http-url>
(string, optional)
URL for a report server (QTS ticket receiver or relay). QTS tickets are delivered using the HTTP
protocol.
Report-Enable:
(True/False/Yes/No)
If this parameter is false, QTS ticket files are not submitted to the QTS ticket receiver. In this case,
Report tasks are skipped. =0.0.13.8=
PublicIP-Server:
<http-url>
(string, optional)
URL for a server providing the public IP address. Usually the QTS ticket receiver or relay provides
this information under the path get-ipaddr. The parameter can be overwritten in the PublicIP task
parameter PublicIP-Server.
TSS 0.0.14.0 07.Nov.2011
62
Technical Reference
GetTime-Server:
<http-url>
(string, optional)
URL for a server providing the current time in XML format. Usually the QTS ticket receiver or relay
provides this information under the path get-time. The parameter can be overwritten in the
TimeSync task parameter GetTime-Server.
Sync-Server:
<http-url>
(string, optional)
URL to the server containing the synchronization data. The synchronization main configuration file
synchronization.cfg has to reside in this directory.
Log-Server:
<ftp-url>
(string, optional)
Path to a server to receive or store the log files. The placeholder %agentid% is replaced by the actual
agent ID. The two sub-directories logs and data have to be available in the directory to receive the
corresponding files from the output directories.
Log-User:
<user>
(string, optional)
<pass>
(string, optional)
(True/False/Yes/No)
If this parameter is true, passive mode is used for log/data file submission.
Log-Enable:
(True/False/Yes/No)
If this parameter is false, no log or data files are moved to the outbox folder and loaded to the FTP
server. Note that the parameter can be overridden by the parameter Submit-Enable in the machine
configuration file.
Section [Tickets]
The system configuration file may include one section Tickets. =0.0.12.3=
Known parameters in System.cfg configuration section [Tickets]
AddGPSPoints:
<none/auto/always>
(string, optional)
Specifies how GPS coordinates are added to the ticket, parameter <coordinates><points>. Please
note that coordinates are always added to <coordinates><longitude> and <coordinates><latitude> if
available =0.0.12.3=.
o none
... <points> is not filled
o auto
... <points> is only filled if coordinates with more than 50m distance exist
o always
... <points> is always filled, even if only a single point is added
MobileInfoHistory:
<int>
Number of task executions to store mobile information in internal storage. Set this parameter to 0 to
use life data only and disable storage of mobile information. =0.0.12.7=
Section [Scenarios]
The system configuration file may include one section Scenarios.
Known parameters in System.cfg configuration section [Scenarios]
CID-Execution:
<int>[:<eid>]
(string, optional)
Scenario ID and execution ID for execution tickets. An execution ticket is generated for every job
sequence started by the scheduler.
CID-Status:
<int>[:<eid>]
(string, optional)
Scenario ID and execution ID for status tickets. Status tickets are created periodically if required.
CID-Startup:
<int>[:<eid>]
(string, optional)
Scenario ID and execution ID for startup tickets. Startup tickets are created when the scheduler is
started.
CID-Restart:
<int>[:<eid>]
(string, optional)
Scenario ID and execution ID for restart tickets. Restart tickets are required before a reboot or
restart is required.
CID-Shutdown:
<int>[:<eid>]
(string, optional)
Scenario ID and execution ID for shutdown tickets. Shutdown tickets are created when system
shutdown is requested (either by pressing the power button or by the power monitor device).
=0.0.12.6=
CID-ModemReset:
<int>[:<eid>]
(string, optional)
Scenario ID and execution ID for modem reset tickets. Modem reset tickets are created before a
reboot if a modem is reset with e.g. an AT+CFUN command.
63
Technical Reference
CID-MPSW:
<int>[:<eid>]
(string, optional)
Scenario ID and execution ID for modem power switch tickets. MPSW tickets are created when an
MPSW cycle is executed by the TSS Asisstance Service. This can be the case in CheckModem tasks,
before a reboot or after startup. =0.0.12.6=
Status-Period:
(P1DT1H1M1S+O1DT1H1M1S)
<file.ext>
(string, optional)
File name of an optional metric mapping file. The file contains custom mappings from internal metric
ids (such as x.100 or m.5230) to user defined text or metric IDs or extension field names.
Section [User]
The system configuration file may include one section User.
Known parameters in application.cfg configuration section [User]
The user section can contain any user defined parameter. The parameters can be accessed in any
job or task section.
;
;
;
;
;
;
[MobileDevice]
Name:
Id-01:
Id-02:
Id-03:
Id-04:
Id-05:
Id-06:
Id-07:
Id-08:
Id-09:
Id-10:
;IMEI-01:
Cmd-AT++RAT-auto:
Cmd-AT++RAT-2G:
Cmd-AT++RAT-3G:
Cmd-AT++RAT-2G+3G:
Cmd-AT++RAT-3G+2G:
[MobileDevice]
Name:
Id-01:
Method-RAT:
Cmd-AT++RAT-auto:
Cmd-AT++RAT-2G:
Cmd-AT++RAT-3G:
Cmd-AT++RAT-2G+3G:
Cmd-AT++RAT-3G+2G:
;
;
;
;
;
AT++RAT=auto
AT++RAT=2G
AT++RAT=3G
AT++RAT=2G+3G
AT++RAT=3G+2G
[MobileDevice]
Name:
Huawei LTE Data Cards (SysInfoEx+SysCfgEx)
Id-01:
huawei*|E392
; note: requires TSS 0.0.13.10 or above to support vendor wildcards
TSS 0.0.14.0 07.Nov.2011
64
Technical Reference
Method-RAT:
SysInfoEx
; note: E392 does not support AT^SYSCFG, just AT^SYSCFGEX
; note: 00=auto, 01=GSM, 02=UMTS, 03=LTE
Cmd-AT++RAT-auto:
AT^SYSCFGEX="00",3FFFFFFF,1,2,7FFFFFFFFFFFFFFF,0,0
Cmd-AT++RAT-2G:
AT^SYSCFGEX="01",3FFFFFFF,1,2,7FFFFFFFFFFFFFFF,0,0
Cmd-AT++RAT-3G:
AT^SYSCFGEX="02",3FFFFFFF,1,2,7FFFFFFFFFFFFFFF,0,0
Cmd-AT++RAT-4G:
AT^SYSCFGEX="03",3FFFFFFF,1,2,7FFFFFFFFFFFFFFF,0,0
Cmd-AT++RAT-2G+3G:
AT^SYSCFGEX="0102",3FFFFFFF,1,2,7FFFFFFFFFFFFFFF,0,0
Cmd-AT++RAT-3G+2G:
AT^SYSCFGEX="0201",3FFFFFFF,1,2,7FFFFFFFFFFFFFFF,0,0
[MobileDevice]
Name:
Id-01:
Id-02:
Method-RAT:
Cmd-AT++RAT-2G:
Cmd-AT++RAT-3G:
Cmd-AT++RAT-2G+3G:
Cmd-AT++RAT-3G+2G:
[MobileDevice]
Name:
Id-01:
Id-02:
Method-RAT:
Method-SignalLevel:
Method-Power:
Cmd-AT++RAT-2G:
Cmd-AT++RAT-3G:
Cmd-AT++RAT-2G+3G:
Cmd-AT++RAT-3G+2G:
;
;
;
;
;
;
AT++RAT=auto
AT++RAT=2G
AT++RAT=3G
AT++RAT=4G
AT++RAT=2G+3G
AT++RAT=3G+2G
[;MobilePorts]
; sample rule to derive diagnostic COM port
; use this section as sample for other sections, it is internally contained in TSS
Name:
Huawei Data Cards (test)
ID-01:
USB\Vid_12d1*
DeviceDesc-01:
Huawei Test
Rule-Modem-01:
Class=Modem
Rule-Port0-01:
Class=Modem
Rule-Port1-01:
Class=Ports,DeviceDesc="*PC UI Interface*"
Method-Modem:
Device:FriendlyName
Method-Port0:
Modem:AttachedTo
Method-Port1:
Device:Device Parameters\PortName
multiple
multiple
=0.0.13.5=
<name>
(string, optional)
Use this parameter to provide a descriptive name for the device configuration. The parameter is used
for log file output only.
ID-00..ID-99:
<vendor>|<model>[*]
(string, optional)
Use the parameters ID-00 to ID-99 to specify combinations of vendor and model separated by a pipe
character (|). A trailing asterisk (*) can be used to indicate that any characters may follow the given
string. The configuration will be used if any of the ID-xx or IMEI-xx filters match.
IMEI-00..IMEI-99:
<imei>[*]
(string, optional)
Use the parameters IMEI-00 to IMEI-99 to specifiy an IMEI or the start characters of the IMEI if
using a trailing asterisk (*). The configuration will be used if any of the ID-xx or IEMI-xx filters
match.
65
Technical Reference
Cmd-<cmd>:
<at-command>
(string, optional)
Use these parameters to specify user defined AT commands. The parameter name has to be the
command preceded by the prefix 'Cmd-'. Please note that in addition the character '=' has to be
replaced by '-'. To distinguish user defined commands from regular commands, they should be
named AT++XXX.
Examples:
; AT++ZZZ
; AT++RAT=2G
Method-RAT:
o COPS
o SYSINFO
o SYSINFOEX
o E2EMM9
Method-SignalLevel:
(COPS/SYSINFO)
(string, optional)
the AT command used to get the radio access technology. Possible methods
same as COPS
use AT+COPS (default)
use AT^SYSINFO (Huawei)
use AT^SYSINFOEX (Huawei E372 and above) =0.0.13.5=
use AT*E2EMM=9 (Ericsson)
(E2EMM9)
(string, optional)
This parameter defines the AT command used to get the signal level. Possible methods are:
o <empty>
use AT+CSQ (default)
o E2EMM9
use AT*E2EMM=9 (Ericsson)
Method-Power:
(CFUNE4)
(string, optional)
This parameter defines the AT command used to detect the power state. Possible methods are:
o <empty>
don't detect power state
o CFUNE04
use AT+CFUN and treat result 0 and 4 as turned off (Ericsson)
Section [MobilePorts]
The mobile configuration file may include multiple MobilePorts sections. =0.0.13.5=
Known parameters in mobiles.cfg configuration section [MobilePorts]
Name:
<name>
(string, optional)
Use this parameter to provide a descriptive name for the device configuration. The parameter is used
for log file output only.
ID-00..ID-99:
<device id>
(string, optional)
Use the parameters ID-00 to ID-99 to specify hardware device IDs (typically USB device IDs)
identifying the device. A trailing asterisk (*) can be used to indicate that any characters may follow
the given string. The configuration will be used if any of the ID-xx or DeviceDesc-xx filters match.
A typical USB device ID is in form USB\Vid_xxxx&Pid_xxxx*, a filter for Huawei devices is
USB\Vid_12d1*.
DeviceDesc-00..99:
<device description>
(string, optional)
<rule>
(string, optional)
Rule to derive the modem device from a given hardware device ID. The rule is used to select the
modem device from a multi-function device. Please note that this rule is reserved for future use and
is not required by TSS.
For example a Huawei E170 data card contains the following devices:
Vid_12d1&Pid_1003&MI_00 HUAWEI Mobile Connect - 3G Modem
Vid_12d1&Pid_1003&MI_01 HUAWEI Mobile Connect - 3G PC UI Interface
Vid_12d1&Pid_1003&MI_02 USB-Mass Storage device
For most devices, the modem can be identified by the simple filter Class=Modem. Once the device is
identified, the modem name is derived with the method defined in Method-Modem.
Rule-Port0-00..99:
<rule>
(string, optional)
Rule to derive the modem COM port name from a given hardware device ID. The rule is used to
select the modem device from a multi-function device. Please note that this rule is reserved for
future use and is not required by TSS.
For most devices, the modem can be identified by the simple filter Class=Modem. Once the device is
identified, the modem COM port is derived with the method defined in Method-Port0.
TSS 0.0.14.0 07.Nov.2011
66
Technical Reference
Rule-Port1-00..99:
<rule>
(string, optional)
Rule to derive the monitoring COM port from a given hardware device ID. The rule is used to select
the secondary COM port (typically used by the dashboard application) from a multi-function device.
This rule is required if an AT background thread shall be used with a data card.
Typical Rules for secondary COM ports are:
Class=Ports,DeviceDesc="*3G PC UI Interface*"
Class=Ports,Service=hwdatacard,Serial:PortIdentify=HWPCUI
Class=Ports,USB:Prot=Prot_02
Class=Ports,USB:MI=MI_01
(Huawei
(Huawei
(Huawei
(Huawei
generic)
E372)
E372/Win7)
E170/XP)
<method>
(string, optional)
This method uses the parameter FriendlyName in the device's enumeration registry key.
Method-Port0:
<method>
(string, optional)
Method to derive the primary COM port from the modem device.
The method suitable for most modems is:
Modem:AttachedTo
This method uses the parameter AttachedTo in the associated modem's registry key.
Method-Port1:
<method>
(string, optional)
Method to derive the secondary COM port from the communication device.
The method suitable for most modems is:
Device:Device Parameters\PortName
This method uses the parameter PortName in the associated port's registry key, sub-key Device
Parameters.
[default]
; this section
mfid:
x.100:
x.101:
x.105:
x.140:
[TSS.Exec]
; this section contains special mappings for TSS metrics with format TSS.Exec
mfid:
*.user
; target mf ID: TSS.Exec.User
x.140:
x.140,e.test1.ip
; map to text metric and extension
67
Technical Reference
Please note that the sections [TSS.RAS-*] is used if [TSS.CIC-*] is not existing for compatibility with
previous versions.
5.1.9.3 Detailed parameter description for the mapping configuration file
Section [default]
The mapping configuration file may include one section default.
Known parameters in mapping.cfg configuration section [default]
mfid:
<text>
(string, optional)
Contains the target measurement format identifier. If not specified, the suffix '.user' will be
appended to the source measurement format ID.
m.<id>:
m.<id>,x.<id>,e.<ext>.<col>
(string, optional)
Mapping for numeric metrics. A metric can be mapped to an empty value (i.e. it will not be added to
the XML report) or to any combination of numeric metrics, text metrics or extensions.
Please note that if using extensions the extension table must exist in the QTS database, must be
mapped in the extension table and must contain the defined column.
x.<id>:
x.<id>,e.<ext>.<col>
(string, optional)
Mapping for text metrics. A text metric can be mapped to an empty value or to any combination of
text metrics or extensions. Mapping to numeric metrics is theoretically possibly, but will probably fail
as the metric's content cannot be converted to a numeric value.
Please note that if using extensions the extension table must exist in the QTS database, must be
mapped in the extension table and must contain the defined column.
Section [TSS.<mf>]
The mapping configuration file may include one section per known measurement format. The specific
sections contain the same parameters as the default section and override the default mapping if
present.
The sections TSS.CIC-Add and TSS.RAS-Add has a special function: it controls the metrics that are
added to tickets produced by other tools (e.g. PocketOptimizer, WebSpeedTest etc.).
8868
[Management]
Password:
DontReboot:
RabbitHole
true
[Routing]
AutoDelete:
;DontSetRoutes:
12h
true
[Directories]
LogFiles:
logs
[Log]
LogLevel:
P-Info
68
Technical Reference
LogFile:
LogFile-GPS:
LogRotate:
assistance.log
gps.log
1d
<int>
Defines the UDP port the service uses to listen for incoming control packets or 0 to disable the UDP
function. The TSS Assistance Client can be used to create UDP packets to set routes or reboot the
machine but the UDP method has been superseded by the TSS Management Server.
TcpService
<ip>:<port>
127.0.0.1:8868 (9018)
This is the port the service uses to communicate with the TSS assistance service. The function is not
required for a standalone installation. Set the value to off to disable the TCP server.
Broadcast-Port
<port>
8867 (9013)
This port is used as local and target port for UDP broadcast packets containing status information.
The broadcast packets can be used by a remote computer in the LAN to detect the available TSS
machines and determine their status. =0.0.12.6=
Broadcast-Port-TXL
<port>
This parameter overrides the local UDP port for the status broadcasts, i.e. the source port in the UDP
packets. It is only required for special purposes. =0.0.12.6=
Broadcast-Port-TXR
<port>
This parameter overrides the remote UDP port for status broadcasts, i.e. the destination port in the
UDP packets. It is only required for special purposes. =0.0.12.6=
Section [Management]
The assistance configuration file may include one section Management.
Known parameters in assistance.cfg configuration section [Management]
Password:
<pass>
(string, optional)
The password that has to be entered in the assistance client to reboot the machine.
DontReboot:
(True/False/Yes/No)
If this parameter is set to true, the background service will not initiate a system reboot if the TSS
scheduler is not running any more. Otherwise the service will reboot the machine if the scheduler is
not running for 10 minutes (if it was not running at all) of after 2 minutes (if it stopped running).
DontScanScheduler
bool
false
This parameter has to be set to true to disable monitoring of the TSS scheduler. If the parameter is
not set to true, the machine will be rebooted after 2 hours.
ShutdownDelay
<1d1h1m1s>
15s
Delay from the detection of a valid power down signal until a shutdown is initiated. Within this time
TSS is informed of a pending shutdown and has the chance to block shutdown to cancel the pending
job and execute the shutdown job. If TSS does not block, a system shutdown is initiated after the
given delay. Please note that the delay is triggered after PowerMonitor/ShutdownDelay expires.
=0.0.12.6=
ShutdownTimeout
<1d1h1m1s>
60s
Delay from the detection of a valid power down signal until a shutdown is forced. TSS cannot block
shutdown any more if this timeout expires. Please note that the delay is triggered after
PowerMonitor/ShutdownDelay expires. =0.0.12.6=
TSS 0.0.14.0 07.Nov.2011
69
Technical Reference
AutoUseRAS
<1d1h1m1s>
Set this parameter to a duration in form 1d1h1m1s to enable management over RAS devices. If not
configured, RAS connections will not be used for management to avoid influencing measurements. If
RAS connections shall be used, a delay can be specified with the parameter AutoUseRAS. If the
delay is greater than zero, a RAS connection will be used for management after the specified time
(starting with connection establishment).
RasUsbEnumServices
string
"ewusbnet"
A list of service names for NIC cards that shall be treated as RAS devices. Several values can be
separated by commas. USB network cards with the given service name will be treated as RAS
devices and not used for management automatically. The default value "ewusbnet" is suitable for
Huawei devices (e.g. E182E).
RasNicNames
string
"MBB*"
A list of network card names for NIC cards that shall be treated as RAS devices. Several values can
be separated by commas. Network cards following this naming convention will be treated as RAS
devices and not used for management automatically. Assign names like "MBB-Huawei" to your virtual
network cards to have them excluded from management with the default value of "MBB*".
Section [Routing]
The assistance configuration file may include one section Routing.
Known parameters in assistance.cfg configuration section [Routing]
AutoDelete:
(1d1h1m1s1ms)
(duration, default:12h)
This parameter specifies the maximum age of a custom route set by the assistance service. If a
special route is requested by the assistance client, the route is temporarily set by the service. It is
automatically removed if Windows is restarted or after the specified timeout expires.
DontSetRoutes
bool
false
If this parameter is set to true, the service does not set specific routes to the TSS Management
Server on the interfaces in use. This behavior can be required if running without administrative rights
or with UAC in Windows Vista or 7.
Section [Directories]
The assistance configuration file may include one section Directories
Known parameters in assistance.cfg configuration section [Directories]
LogFiles:
<dir>
(string, optional)
<level>
(string, default:P-Warn)
<file.log>
(string, optional)
Log file name. If log rotation is used, the date/time is appended to the file name.
LogFile-GPS:
<gps.log>
(string, optional)
GPS Log file name. If log rotation is used, the date/time is appended to the file name. =0.0.12.3=
LogRotate:
<1d1h1m1s1ms>
(duration, default:31d)
Log rotation period. A new log file is automatically created if the date/time enters a new log file
period.
Section [Installer]
The assistance configuration file may include one section Installer.
Known parameters in assistance.cfg configuration section [Installer]
service_name:
<name>
(string, optional)
This parameter is used by the installer to store the service name for future updates and the uninstall
routine.
70
Technical Reference
schedule-plan
container
schedule-plan/schedule
container
The schedule-plan element contains one or several schedule elements. Every schedule item is
assigned one or several jobs to be executed consecutively and an execution plan.
attribute schedule-plan/schedule.mode
string
string
If required a name can be assigned to the scheduled item. The name will be used in log files and the
progress display.
element
schedule-plan/schedule/jobs
container
The schedule element has to contain a single jobs element acting as a container for one or several
job elements.
attribute schedule-plan/schedule/jobs.inc-agentid
If the parameter is defined (> 0), the agent ID in the QTS tickets generated by the job is
incremented by the given value. Please note that the increment is applied to execution, RAS/CIC,
MPSW and measurement tickets, not to system tickets. Please refer to 4.9.3 for details. =0.0.13.2=
attribute schedule-plan/schedule/jobs.inc-scenarioid
If the parameter is defined (> 0), the scenario IDs in the QTS tickets generated by the job are
incremented by the given value. Please note that the increment is applied to execution, RAS/CIC,
MPSW and measurement tickets, not to system tickets. Please refer to 4.9.3 for details. =0.0.13.2=
element
schedule-plan/schedule/jobs/job
string
One or several TSS-jobs can be associated to the scheduled item. The jobs will be executed
consecutively. If a relative path is given, the files have to be located in %system\jobs% (usually
%system%\jobs).
TSS 0.0.14.0 07.Nov.2011
71
Technical Reference
element
schedule-plan/schedule/plan
The schedule element has to contain a single plan element in planned mode. The element is not
required in continuous mode.
element
schedule-plan/schedule/start
period-def
The plan element has to contain at least one start element. The content of the element can be:
o daily mode
the content can be a list of execution times in format hh:nn or hh:nn:ss,
separated by commas
o interval mode: the content has to be a period definition.
Period definitions are given in form P<days>T<sub-days>[+O<days>T<sub-days>]. Possible values
for days are nM (months), nW (weeks), nD (days), possible values for sub-days are nH (hours), nM
(minutes) and nS (seconds), not required values can be omitted. For example the period definition
PT1H+O15M leads to execution every 15 minutes after a full hour, e.g. 00:15, 01:15, 02:15 The
period definition P1D leads to execution every day at 00:00.
attribute schedule-plan/schedule/start.mode
schedule-plan/startup
container
schedule-plan/startup/jobs
container
Container for one or several job elements. These define the jobs to be executed at scheduler start.
=0.0.12.6=
element
schedule-plan/startup/jobs/job
container
schedule-plan/shutdown
container
schedule-plan/shutdown/jobs
container
Container for one or several job elements. These define the jobs to be executed at system
shutdown. =0.0.12.6=
Please note that a shutdown job will be executed if a system shutdown is signaled to the TSS
Assistance Service by a power monitor device or if a power button press is intercepted by TSS. This
requires the configuration parameter InterceptShutdown to be set to true. =0.0.12.10=
element
schedule-plan/shutdown/jobs/job
container
72
Technical Reference
The files are processed in the given order, i.e. if the same parameter is defined in the machine
configuration file, it overrides values in the application configuration file (and the other files).
A sample [user] section in machine.cfg could be:
[User]
Default-CIC-ConnId:
Default-CIC-User:
Default-CIC-Password:
Default-CIC-APN:
%Default-CIC-ConnId%
%@Default-CIC-User%
%@Default-CIC-Password%
%@Default-CIC-APN%
The previous sample defines local variables using the values from the configuration files. This
mechanism allows to change parameters for job execution in a single place at the top of the job file.
Please note the variables using %@...%: If a referenced variable is preceded by the @ character, no
error will occur if it is not defined. This allows for compatibility with old machine configuration files.
User defined variables in task sections
Variables can be defined in the section [task] of a job file. The variables are valid only for the current
task (and sub-jobs or task in case of a Sub-Job task). The variable names have to start with "User-".
5.3.2.4 Variable expansion
Variables are expanded when they are used. This chapter defines some additional rules when using
variables.
Nested variables and functions
Nested variables and functions are possible. An example is the use of a random user name for RAS
connections:
content in machine.cfg:
[User]
Default-CIC-ConnId:
Default-CIC-User:
Default-CIC-Password:
73
Technical Reference
Default-CIC-APN:
a1.net
%Default-CIC-ConnId%
%@Default-CIC-User%
%@Default-CIC-Password%
%@Default-CIC-APN%
The previous sample generates random user names with 8 random characters followed by
@a1plus.at.
Using undefined variables
If variables are used in form %name%, the variable has to be defined, otherwise an error will be
generated. If an empty string shall be used if a variable is not defined, the form %@name% has to be
used.
74
Technical Reference
Contacts a special server to get a public IP address. The task will only be executed if an active
interface is available.
Clean
Manages log and data files on the file system: adds files to .7z archives and the archive folders,
deletes excessive data files and copies files to the outbox folder.
Reboot
Initiates a system reboot.
ModemPowerCycle =0.0.12=
Run a modem power cycle (i.e. turn power off for 10 seconds) if an external modem power switch
(MPSW) is available.
Sniffer-Start and Sniffer-Stop =0.0.13.6=
Start or stop an external packet sniffer (NetCap, NMCap or TShark). Sniffer files can be shrinked
(i.e. reduce packet size) and compressed with 7-zip.
<job name>
(string, optional)
A job name can be specified that will be used in the user interface and the log files. If the parameter
is empty, the job's file name is used.
Loops:
<job loops>
(integer, default: 1)
If required, more than one loop iteration can be specified. In this case the sequence of tasks will be
executed more than one time. Please note that in this case scenario IDs will be used more than
once. Use the task ID in the XML report to distinguish the different job and task iterations.
Master-Timeout:
<1d1h1m1s1ms>
Master timeout for the entire job execution (including delays and all loop iterations). If the specified
timeout is reached, the current task is terminated and all remaining tasks are skipped.
Loop-Timeout:
<1d1h1m1s1ms>
Timeout for a single loop iteration (including delays and all tasks). If the specified timeout is
reached, the current task is terminated and the remaining tasks for the job loop iteration are
skipped. Execution is continued with the first task if more loop iterations are required.
Delay-Before:
<1d1h1m1s1ms>
(duration, optional)
An additional delay before the sequence of tasks is executed. The delay is inserted in every job
iteration.
Delay-After:
<1d1h1m1s1ms>
(duration, optional)
An additional delay after the sequence of tasks is executed. The delay is inserted in every job
iteration.
Duration:
<1d1h1m1s1ms>
(duration, optional)
Minimum duration for the execution of the entire task sequence.. If the tasks can be executed faster
than the specified duration, an additional pause is inserted to ensure constant execution time.
Inc-AgentID:
<int>
If the parameter is defined (> 0), the agent IDs in the QTS tickets generated by the job are
incremented by the given value. Please note that the increment is applied to execution, RAS/CIC,
MPSW and measurement tickets, not to system tickets. Please refer to 4.9.3 for details. =0.0.13.2=
Inc-ScenarioID:
<int>
If the parameter is defined (> 0), the scenario IDs in the QTS tickets generated by the job are
incremented by the given value. Please note that the increment is applied to execution, RAS/CIC,
MPSW and measurement tickets, not to system tickets. Please refer to 4.9.3 for details. =0.0.13.2=
Inc-AgentID-Loop:
<int>
<int>
<True/False/Yes/No>
This parameter can be used to skip the job execution. If the NeedCIC condition is true, the job or
sub-job is only executed if the internet connection specified by NeedCICID is active. If NeedCICID is
empty, the last dialed internet connection has to be active.
TSS 0.0.14.0 07.Nov.2011
75
Technical Reference
Please note that the parameter NeedCIC can only be used in sub-jobs, not in the main job.
NeedRAS:
<True/False/Yes/No>
This parameter can be used to skip the job execution. It is available for backward compatibility and
is a synonym for NeedCIC.
NeedCICID:
<CIC identifier>
This parameter is only used if NeedRAS or NeedCIC is true. If empty, the last dialed internet
connection is used, otherwise a special connection can be specified. The parameter has to be in form
<type>:<params>, e.g. RAS:<phonebook entry> or HwNd:<connection name>.
NeedRASEntry:
This parameter is only used if NeedRAS or NeedCIC is true. If empty, the last dialed internet
connection is used, otherwise a special RAS or CIC connection can be specified. The parameter can
contain a RAS phonebook entry or can be a full CIC identifier in form <type>:<params>.
User-*:
<any>
(string)
User defined parameters have to start with "user-", otherwise warnings will be generated. User
defined parameters can be used in any other parameter in any task or sub-job, e.g.
user-param1:
user-param2:
test
%user-param1%
<id>
(string, optional)
An optional text identifier for the task. The identifier will be used in the user interface, log files and
the internal task storage. You can use this parameter to distinguish several tasks of the same type
within a job file.
Type:
<type>
(string)
This parameter defines the task type, allowed task types are:
Pause, Sub-Job, CIC-Connect, CIC-Hangup, RAS-Connect, RAS-Hangup, AT-Command,
PocketOptimizer, WebSpeedTest, Execute, TimeSync, Report, SubmitLogs, FileSync, Registration,
IPConfig, Route, GetPublicIP, Clean, Reboot.
Custom-TaskId:
<type>
(string)
Use this parameter to define a custom task ID for the QTS ticket. Default ask IDs are automatically
generated as j(loop).t<idx>(loop) where loop numbers are omitted if not required. Typical task IDs
are thus j(00).t02(00) or j.t02.j.t03 (for task in a sub job).
As the QTS dashboard automatically groups by task ID, user defined task IDs can be used to obtain
human readable descriptions for special tasks occurring more than once in a job. Please note that
task IDs have to be unique within a job, the following variables are available if required: =0.0.13.2=
o %TaskIndex% current task index (starting with 1)
o %JobLoop% current job iteration (starting with 1)
o %TaskLoop% current task iteration (starting with 1)
o %Parent-TaskId% parent task ID (for sub-jobs)
OnError:
<error>
(string, default:continue)
<1d1h1m1s1ms>
(duration, optional)
An additional delay before the task is executed. The delay is inserted in every task iteration.
Delay-After:
<1d1h1m1s1ms>
(duration, optional)
An additional delay after the task is executed. The delay is inserted in every task iteration.
DelayUntil-Before:
<1d1h1m1s1ms>
Use this parameter to synchronize execution to a given time. If defined, an additional pause is
inserted after the pre-execution pause (i.e. after Delay-Before) until the given time (relative to the
TSS 0.0.14.0 07.Nov.2011
76
Technical Reference
scheduled time) is reached. A similar effect can be achieved by setting the parameter Duration for all
tasks before the current task, but synchronization to a given time can be configured in a single task.
=0.0.13.2=
Example:
scheduled time:
09:00:00 + 00:02:00
task start:
09:02:05
delay-before:
5s
-> delays until
09:02:10
delayuntil-before: 30s
-> target time
09:00:00 + 00:02:00 + 00:00:30 = 09:02:30
-> additional pause: 20s
DelayUntil-After:
<1d1h1m1s1ms>
Use this parameter to synchronize execution to a given time. If defined, an additional pause is
inserted after post-execution pause (i.e. after Delay-After) until the given time (relative to the
scheduled time) is reached. =0.0.13.2=
Duration:
<1d1h1m1s1ms>
(duration, optional)
Minimum duration for task execution. If the task can be executed faster than the specified duration,
an additional pause is inserted to ensure constant execution time. The duration is not executed if a
task is skipped due to conditions.
Exec-Estimation:
<1d1h1m1s1ms>
(duration, optional)
This parameter is used for the internal progress estimations. It should give the task execution time in
average situations to allow linear progress displays for average situations.
Timeout:
<1d1h1m1s1ms>
Hard timeout for the task execution. If the task execution for a single iteration (not including DelayBefore and Delay-After) exceeds the timeout, the task (and all sub-tasks or processes) are killed and
the task status is erroneous.
Inc-AgentID:
<int>
If the parameter is defined (> 0), the agent IDs in the QTS tickets generated by the task or sub jobs
are incremented by the given value. Please note that the increment is applied to RAS/CIC, MPSW
and measurement tickets, not to system tickets. Please refer to 4.9.3 for details. =0.0.13.2=
Inc-ScenarioID:
<int>
If the parameter is defined (> 0), the scenario IDs in the QTS tickets generated by the task or sub
jobs are incremented by the given value. Please note that the increment is applied to RAS/CIC,
MPSW and measurement tickets, not to system tickets. Please refer to 4.9.3 for details. =0.0.13.2=
Inc-AgentID-Loop:
<int>
<int>
<number of iterations>
(integer, default: 1)
More than one task iteration (i.e. repetition) can be specified if required. Please note that in case of
multiple iterations, the same scenario ID and execution ID, but different task IDs will be reported.
Max-Failures:
<number>
This parameter specifies the maximum number of consecutive failures until a reboot is required. A
value of 0 can be specified to indicate that no reboot shall be initiated. A value of 3 will result in a
machine reboot after the 4th consecutive error of the task. Please note that the reboot will be
initiated after the entire job is finished.
The status of all tasks (including the current and maximum failure count) can be viewed in the Tasks
tab and is dumped at the end of the execution log file.
Period:
<P1DT1H1M1S+O1DT1H1M1S>
(period, optional)
An additional period (e.g. PT1H) can be specified if the task shall be executed with lower frequency
than the job. Using this method, you can execute some tasks for example every 2 hours while the
other tasks (and the job) is executed every 15 minutes.
Please note that the task execution is only delayed if the last execution was successful. In case of a
task error, the task execution is not skipped.
Period-Persist:
<True/False/Yes/No>
If a period is used, this parameter defines if the last successful execution shall be persistent (i.e. be
preserved after a TSS restart). If a task is not persistent, TSS assumes it has not been executed
after a TSS restart and executes it in the first job execution after TSS startup. Persistent periods are
77
Technical Reference
required e.g. for periodic reboots, where a job execution shall only be executed every 12 hours and
not every 12 hours and after every TSS startup. =0.0.12=
Condition:
<condition>
(string, optional)
It is possible to skip the task execution in dependency of a known condition. Currently the following
conditions are possible:
o HasPublicIp The task is only executed if a public IP address is available.
o NoPublicIp
The task is not executed if a public IP address is available.
o Failed(Prev)
The task is only executed if the previous task failed.
o FailedOrSkipped(Prev)
The task is executed if the previous task was skipped or failed.
o Succeeded(Prev)
The task is executed if the previous task succeeded.
o SucceededOrSkipped(Prev) The task is executed if the previous task was skipped or succd.
o ReportPending
The task is executed if reports have to be submitted.
Note: a task is only executed if the Condition and the NeedCIC (or NeedRAS) condition are true.
NeedCIC:
<True/False/Yes/No>
This parameter is another condition to skip task execution. If the NeedCIC condition is true, the task
is only executed if the internet connection specified by NeedCICID is active. If NeedCICID is empty,
the last dialed internet connection has to be active.
Note: a task is only executed if the Condition and the NeedCIC (or NeedRAS) condition are true.
NeedRAS:
<True/False/Yes/No>
This parameter is another condition to skip task execution. It is available for backward compatibility
and is a synonym for NeedCIC.
Note: a task is only executed if the Condition and the NeedCIC (or NeedRAS) condition are true.
NeedCICID:
<CIC identifier>
This parameter is only used if NeedRAS or NeedCIC is true. If empty, the last dialed internet
connection is used, otherwise a special connection can be specified. The parameter has to be in form
<type>:<params>, e.g. RAS:<phonebook entry> or HwNd:<connection name>.
NeedRASEntry:
This parameter is only used if NeedRAS or NeedCIC is true. If empty, the last dialed internet
connection is used, otherwise a special RAS or CIC connection can be specified. The parameter can
contain a RAS phonebook entry or can be a full CIC identifier in form <type>:<params>.
User-*:
<any>
(string)
User defined parameters have to start with "user-", otherwise warnings will be generated. User
defined parameters can be used in any other parameter, e.g.
user-param1:
user-param2:
test
%user-param1%
<1d1h1m1s1ms>
(duration, optional)
This is the same parameter as the default task parameter Duration. Usually this parameter will
specify the exact task duration. If, however, the task parameter Manage-Interfaces is set, the task
might require more time as the management server has to be commanded to establish a
management connection for the interface.
Manage-Interfaces:
<item>[,<item>...]
This parameter defines a list of interfaces that are allowed to be used by the TSS Assistance Service
to connect to the TSS Management Server.
Note: Per default the TSS Assistance Service is configured to use LAN interfaces for management
purposes but to avoid RAS/CIC interfaces. If such an interface shall be used for management, it has
to be enabled with a delay task.
Possible values are:
*
<entry>
<name>
RAS:*
HwNd:*
RAS:<entry>
HwNd:<entry>
...
...
...
...
...
...
...
78
Technical Reference
Manage-Estimation:
<1d1h1m1s1ms>
(duration, optional)
The estimated time required by the TSS Assistance Service and the communication timeout. The
default value is 1000ms.
Manage-Shutdown:
<True/False/Yes/No>
If this parameter is set to true, management by the TSS Assistance Service is revoked after the
specified delay. If set to false, management will not be terminated after task execution and the TSS
Assistance Service will use the interface until it is shut down or re-connected (e.g. in the next job
execution).
<file name>
(string)
Specifies the job file name to be executed including the extension (.tss-job). If the file name is
relative, it is located in the configuration path system/jobs.
Combined-Success:
(All/Any)
RAS:RasConn01
Please note that RAS connections usually do not require user name and password as it can be
contained in the RAS phonebook entry. Huawei NDIS connections require user name, password and
APN. Please refer to chapter 4.7 for details.
This section describes dedicated parameters for the task CIC-Connect. Please note that common
parameters are available, too.
Known parameters for task 'CIC-Connect'
CIC-ConnID:
<type>:<params>
(string, mandatory)
The identifier of the custom internet connection in fully qualified form, i.e. <type>:<params>.
For RAS connections, the identifier is in form RAS:<entry>. The phonebook entry name can be found
in the Windows network connection list, please refer to chapter 4.7.2 for details.
For Huawei NDIS connections, the identifier is in form HwNd:<name>. The device name can be found in
the column device name in the Windows network connection list or in the Windows device manager,
please refer to chapter 4.7.2 for details. An asterisk (*) can be used as wildcard to define any HwNd
device (HwNd:*) or any HwNd device starting with the given text (HwNd:<name>*). =0.0.12=
CIC-Timeout:
<1d1h1m1s1ms>
Timeout to establish the internet connection. A connection attempt is cancelled after the timeout is
reached and a new retry is started. The maximum duration of the task is CIC-Timeout (1 + CICRetries).
CIC-Retries:
<int>
(integer, default: 3)
Maximum number of retries to establish an internet connection. The default value of 3 leads to a
maximum of 4 connection attempts (1 regular + 3 retries).
TSS 0.0.14.0 07.Nov.2011
79
Technical Reference
CIC-User:
<user name>
(string, optional)
Optional user name for the internet connection. If no user name and password is specified, the RAS
entries parameters are used. Non-RAS connections might require a user name in any case.
CIC-Password:
<password>
(string, optional)
Optional password for the internet connection. If no user name and password is specified, the RAS
entries parameters are used. Non-RAS connections might require a password in any case.
CIC-APN:
<apn>
(string, optional)
Optional APN for the internet connection. The parameter is required for NDIS connections. RAS
connections do not require this parameter as the APN is usually defined in the modem. If given for a
RAS connection, the custom init string at+cgdcont=1,"IP","<apn>" is applied to the modem before
the RAS connection is established.
CIC-APN-Method:
<method>:<params>
(string, optional)
Specifies the method to apply the APN. Possible methods are API and InitStr.
For NDIS connections the format is API:<param>, the default value is API:apn. If the method is given
in this form, the APN parameter value is applied to the API parameter param. There should not be a
requirement to set this parameter for NDIS connections.
For
RAS
connections
the
format
is
InitStr:<initstr>,
the
default
value
is
If given in this form, the APN is applied to the init string. If
additional commands shall be applied in the init string, they can be defined with this parameter. If
no init string shall be applied, the parameter can be set to "~".
InitStr:at+cgdcont=1,"IP","%apn%".
CIC-Ext-<param>
<value>
(string, optional)
Optional parameters for the NDIS driver. NDIS drivers might require additional parameters that can
be specified with these parameters. Currently no additional parameters are suppored.
HangupIfActive:
<True/False/Yes/No>
If this parameter is true, the internet connection will be terminated if active. Otherwise the existing
internet connection will be used, but the rating in the report ticket will be set to 0 as no
measurements are available.
HangupIfManaged:
<True/False/Yes/No>
If this parameter is true, the internet connection will not be terminated if the TSS Assistance Service
operates tunnel connections (such as for RDP, VNC etc). This means that the connection will be shut
down before connecting if it is not managed or just the management connection the TSS
Management Server is open. But if tunnel connections are active, the connection will not be closed
to keep the tunnel connections open.
DontHangup:
<True/False/Yes/No>
If this parameter is true, the internet connection will be kept open if no CIC-Hangup task is
executed. If the parameter is not specified, the connection will be terminated if the task terminates
(either on success or error). Please note that NDIS connections might always be terminated when
TSS is closed, depending on the API implementation.
FailIfMissing:
<True/False/Yes/No>
This parameter is only available for fallback jobs to ensure that the fallback job is executed even if
the internet connection is not available.
Scenario-ID:
<int>
(integer, default: 0)
The QTS scenario for the internet connection report ticket. If the parameter is 0, no ticket is
generated.
RateOnResponseOnly:
<True/False/Yes/No>
If this parameter is set to true, the ticket's rating will only be set to 1 if a connection attempt was
made AND the modem was responding to AT commands. Otherwise the rating will always be set to 1
if a connection attempt as made. The rating will always be set to 0 if an existing connection was
used. =0.0.12=
RateOnImsiImeiOnly:
<True/False/Yes/No>
If this parameter is set to true, the ticket's rating will only be set to 1 if both IMSI and IMEI are
valid. =0.0.12.7=
ClearMobileStatus:
<True/False/Yes/No>
If this parameter is true, the old content in the modem information storage will be cleared before
querying the modem information. Otherwise the old content will be maintained, but the validity
counter will be decremented by one.
80
Technical Reference
QueryModemStatus:
<True/False/Yes/No>
If this parameter is true, the modem status is queried before the internet connection is established.
On success, the new information is stored in the modem information storage, otherwise the validity
counter will be decremented by one.
QueryStatus-Timeout:
<1d1h1m1s1ms>
Timeout to query the modem status. If the status cannot be queried within the specified time, the
data is assumed to be invalid and the old data is kept as described above.
QueryStatus-ComPort:
<com>:<params>
(string, optional)
TSS automatically detects the COM port associated with a RAS entry or NDIS connection. This COM
port is used to query the modem status. If the automatic detection does not work or a different COM
port shall be used, use the parameter QueryStatus-ComPort to override it. =0.0.12.9=
Monitored:
<True/False/Yes/No>
Set this parameter to true to enable internet connection monitoring for this connection. Three
different monitoring modes are available:
o Connection monitoring: Passively monitors the NDIS or RAS connection using Windows API
calls. This method is always enabled if the parameter Monitored is true.
o ICMP monitoring: Actively monitors the connection by sending ICMP requests. This method is
only active if a host is specified with the parameter Test-ICMP-Host.
o AT command monitoring: the modem's status is queried periodically in a background thread.
This method requires an additional COM port to access the device during an active internet
connection. =0.0.13.5=
If connection monitoring is active, metrics m.1101..1129 are generated.
Test-ICMP-Host:
(string, optional)
Only required if Monitored is true. Specifies the IP address or host name to send ICMP ECHO
requests to. If the parameter is empty, ICMP monitoring is not used.
If ICMP monitoring is active, metrics m.1151..1179 are generated.
Test-ICMP-Period:
<1d1h1m1s1ms>
Period of ICMP bursts sent to the host (time from start of one burst to start of next burst).
Test-ICMP-Advance:
<1d1h1m1s1ms>
Time increment from on ICMP ECHO request transmission to the next within a burst..
Test-ICMP-Timeout:
<1d1h2m1s1ms>
<int>
(integer, default: 5)
<int>
<int>
<True/False/Yes/No>
Set this parameter to true to enable AT command monitoring (only if Monitored is true). If enabled,
a background thread will be started that periodically queries the modem and network status. If AT
command monitoring is active, metrics m.1200..1219 are generated. =0.0.13.5=
WatchStatus-ComPort:
<com>:<params>
(string, optional)
TSS automatically detects the secondary COM port for known devices (please refer to the description
of the MobilePorts sections in the modem configuration file). If automatic detection does not work or
a different COM port shall be used, the parameter WatchStatus-ComPort can be used to override it.
=0.0.13.5=
WatchStatus-CommandTimeout: <1d1h2m1s1ms>
Defines the timeout for a single AT command in the background thread. =0.0.13.5=
WatchStatus-Interval:
<1d1h2m1s1ms>
Defines the query interval for the background thread. Modem and network status is queried once per
query interval. =0.0.13.5=
UsePacketSniffer:
(True/False/Yes/No)
Start a packet sniffer for the current internet connection. Please note that UsePacketSniffer and
Sniffer-Enabled both have to be true to enable the packet sniffer. =0.0.13.6=
Sniffer-Type:
(NetCap/NMCap/TShark)
(string, optional)
Defines the packet sniffer tool to be used. Possible values are: =0.0.13.6=
TSS 0.0.14.0 07.Nov.2011
81
Technical Reference
o NetCap
o NMCap
o TShark
Sniffer-Tool:
(string, optional)
<args>
(string, optional)
Additional command line arguments for the packet sniffer tool. Arguments automatically applied are:
NetCap:
NMCap:
TShark:
Shrink-Type:
(TShark)
(string, optional)
Defines the capture file shrinking tool (only required if a .cap file shall be reduced in size by
truncating frames after N bytes). The only supported type is TShark using Wireshark's editcap.exe.
=0.0.13.6=
Shrink-Tool:
<exe-file>
(string, optional)
Defines the executable file name for the capture file shrinking tool (editcap.exe). =0.0.13.6=
Shrink-Args:
<args>
(string, optional)
Additional command line arguments for the capture file shrinking tool. =0.0.13.6=
Sniffer-Connection:
<type>:<id>
(string, optional)
(True/False/Yes/No)
This parameter has to be set to true to enable the packet sniffer. Can be used to disable the packet
sniffer while preserving all configuration parameters.
Sniffer-TruncBytes:
<bytes>
(integer, optional)
Define this parameter to reduce the number of bytes per captured frame and thus reduce the size of
the capture file while preserving the header information. Please note that TSS uses a different file
extension .scap for shrinked capture files. =0.0.13.6
The following header sizes have to be considered when shrinking capture files:
o MAC header 14 bytes
o IP header
20 bytes
o TCP header 20..32 bytes
A typical frame length of 86 thus results in 20..32 bytes of TCP payload data per frame.
Sniffer-TruncMode:
<MB>
(integer, optional)
Defines the buffer size for the packet sniffer. Some packet sniffers (NetCap and NMCap) use circular
buffers, i.e. the existing buffer bytes are overwritten once the buffer size is reached. In this case the
buffer size has to be chosen large enough to contain the entire data session. =0.0.13.6=
Sniffer-Compress:
(True/False/Yes/No)
Compress capture file with 7-zip. The smaller output file (either the .scap or .cap) can be
compressed with 7-zip before storage or submission. The input file is deleted after compression to
reduce file system usage. =0.0.13.6=
Sniffer-Submit:
Sniffer files can automatically be submitted via FTP data upload if required. Please note that in this
case the smallest sniffer file (.7z, .scap or .cap) will be copied to the outbox directory, upload has to
be done with a properly configured SubmitLogs task. Possible upload modes are =0.0.13.6=
TSS 0.0.14.0 07.Nov.2011
82
Technical Reference
o
o
o
o
Never
OnError
OnWarning
Always
Sniffer-MaxErrors:
<int>
Maximum number of errors (starting or stopping the packet sniffer) until a reboot is done.
Sniffer-AddLog:
(True/False/Yes/No)
Add sniffer tool's console output to execution log for debugging purposes.
SetNDISInterfaceMetric:
<int>
(integer, optional)
Use this parameter to set an NDIS interface's (routing) metric to a given value. This function can be
used to prefer the interface over other interfaces in the system. If, for example, all LAN interfaces
are set to a metric of 50, NDIS interfaces can be preferred if setting their metric to a lower metric
(e.g. 20). Note: the metric value is stored as user defined value in the system registry. =0.0.12.7=
ForceNDISDefaultMetric:
<int>
(integer, optional)
In some situations Windows 7 ignores the interface metric defined for NDIS dial-up interfaces. Use
this parameters to reduce the interface's default metric to the given value after the connection has
been initiated. If defined and less than the actual value, TSS removes the default gateway item for
the current interface from the routing table and creates a new one with the given metric. Please
note that this will fail if the metric is too low as Windows 7 does not allow route metrics less than the
interface metric (typically 20 for 3G data modems). =0.0.13.1=
<type>:<params>
(string, mandatory)
The identifier of the custom internet connection in fully qualified form, i.e. <type>:<params>.
For RAS connections, the identifier is in form RAS:<entry>. The phonebook entry name can be found
in the Windows network connection list, please refer to chapter 4.7.2 for details.
For Huawei NDIS connections, the identifier is in form HwNd:<name>. The device name can be found in
the column device name in the Windows network connection list or in the Windows device manager,
please refer to chapter 4.7.2 for details. An asterisk (*) can be used as wildcard to define any HwNd
device (HwNd:*) or any HwNd device starting with the given text (HwNd:<name>*). =0.0.12=
HangupIfManaged:
<True/False/Yes/No>
If this parameter is true, the internet connection will not be terminated if the TSS Assistance Service
operates tunnel connections (such as for RDP, VNC etc). This means that the connection will be shut
down if it is not managed or just the management connection the TSS Management Server is open.
But if tunnel connections are active, the connection will not be closed to keep the tunnel connections
open.
DontHangup:
<True/False/Yes/No>
If this parameter is true, the internet connection will be kept open, i.e. the Hangup-Task is ignored.
UsePacketSniffer:
(True/False/Yes/No)
Stop the packet sniffer associated with the internet connection. Please note that a running packet
sniffer is automatically stopped if this parameter is not explicitly set to false. =0.0.13.6=
RasConn01
83
Technical Reference
RAS:RasConn01
Please note that RAS connections usually do not require user name and password as it can be
contained in the RAS phonebook entry. Huawei NDIS connections require user name, password and
APN. Please refer to chapter 4.7 for details.
This section describes dedicated parameters for the task RAS-Connect. Please note that common
parameters are available, too.
Known parameters for task 'RAS-Connect'
RAS-Entry:
(string, mandatory)
The name of the RAS connection in the Windows RAS phonebook or a fully qualified CIC ID.
The phonebook name can be found in the Windows network connections list. The specified
connection must exist.
A CIC ID has to be in form <type>:<params>, e.g. RAS:<entry> or HwNd:<name>. Please refer to
chapter 4.7.2 for details. An asterisk (*) can be used as wildcard to define any HwNd device
(HwNd:*) or any HwNd device starting with the given text (HwNd:<name>*). =0.0.12=
RAS-Timeout:
<1d1h1m1s1ms>
Timeout to establish the RAS connection. A connection attempt is cancelled after the timeout is
reached and a new retry is started. The maximum duration of the task is RAS-Timeout (1 + RASRetries).
RAS-Retries:
<int>
(integer, default: 3)
Maximum number of retries to establish a RAS connection. The default value of 3 leads to a
maximum of 4 connection attempts (1 regular + 3 retries).
RAS-User:
<user name>
(string, optional)
Optional user name for the RAS connection. If no user name and password is specified, the RAS
entries parameters are used. Non-RAS connections might require a user name in any case.
RAS-Password:
<password>
(string, optional)
Optional password for the RAS connection. If no user name and password is specified, the RAS
entries parameters are used. Non-RAS connections might require a password in any case.
RAS-APN:
<apn>
(string, optional)
Optional APN for the RAS connection. The parameter has been added as it is required for NDIS
connections. RAS connections do not require this parameter as the APN is usually defined in the
modem. If given for a RAS connection, the custom init string at+cgdcont=1,"IP","<apn>" is applied
to the modem before the RAS connection is established.
RAS-InitString:
<AT-command>
(string, optional)
Optional RAS initialization string to be written to the modem associated with the RAS connection. If
the value is empty, the parameter is not changed, otherwise any value can be specified or use the
tilde (~) to clear an existing command. This parameter overrides RAS-APN if both parameters are
specified.
HangupIfActive:
<True/False/Yes/No>
If this parameter is true, the RAS connection will be terminated if active. Otherwise the existing RAS
connection will be used, but the rating in the report ticket will be set to 0 as no measurements are
available.
HangupIfManaged:
<True/False/Yes/No>
If this parameter is true, the internet connection will not be terminated if the TSS Assistance Service
operates tunnel connections (such as for RDP, VNC etc). This means that the connection will be shut
down before connecting if it is not managed or just the management connection the TSS
Management Server is open. But if tunnel connections are active, the connection will not be closed
to keep the tunnel connections open.
DontHangup:
<True/False/Yes/No>
If this parameter is true, the RAS connection will be kept open if no RAS-Hangup task is executed. If
the parameter is not specified, the connection will be terminated if the task terminates (either on
success or error).
84
Technical Reference
FailIfMissing:
<True/False/Yes/No>
This parameter is only available for fallback jobs to ensure that the fallback job is executed even if
the RAS connection is not available.
Scenario-ID:
<int>
(integer, default: 0)
The QTS scenario for the RAS connection report ticket. If the parameter is 0, no ticket is generated.
RateOnResponseOnly:
<True/False/Yes/No>
If this parameter is set to true, the ticket's rating will only be set to 1 if a connection attempt was
made AND the modem was responding to AT commands. Otherwise the rating will always be set to 1
if a connection attempt as made. The rating will always be set to 0 if an existing connection was
used. =0.0.12=
RateOnImsiImeiOnly:
<True/False/Yes/No>
If this parameter is set to true, the ticket's rating will only be set to 1 if both IMSI and IMEI are
valid. =0.0.12.7=
ClearMobileStatus:
<True/False/Yes/No>
If this parameter is true, the old content in the modem information storage will be cleared before
querying the modem information. Otherwise the old content will be maintained, but the validity
counter will be decremented by one.
QueryModemStatus:
<True/False/Yes/No>
If this parameter is true, the modem status is queried before the RAS connection is established. On
success, the new information is stored in the modem information storage, otherwise the validity
counter will be decremented by one.
QueryStatus-Timeout:
<1d1h1m1s1ms>
Timeout to query the modem status. If the status cannot be queried within the specified time, the
data is assumed to be invalid and the old data is kept as described above.
QueryStatus-ComPort:
<com>:<params>
(string, optional)
TSS automatically detects the COM port associated with a RAS entry or NDIS connection. This COM
port is used to query the modem status. If the automatic detection does not work or a different COM
port shall be used, use the parameter QueryStatus-ComPort to override it. =0.0.12.9=
Monitored:
<True/False/Yes/No>
Set this parameter to true to enable RAS connection monitoring for this connection. Three different
monitoring modes are available:
o RAS monitoring: Passively monitors the RAS connection using Windows API calls. This method
is always enabled if the parameter Monitored is true.
o ICMP monitoring: Actively monitors the RAS connection by sending ICMP requests. This
method is only active if a host is specified with the parameter Test-ICMP-Host.
o AT command monitoring: the modem's status is queried periodically in a background thread.
This method requires an additional COM port to access the device during an active internet
connection. =0.0.13.5=
Test-ICMP-Host:
(string, optional)
Only required if Monitored is true. Specifies the IP address or host name to send ICMP ECHO
requests to. If the parameter is empty, ICMP monitoring is not used.
Test-ICMP-Period:
<1d1h1m1s1ms>
Period of ICMP bursts sent to the host (time from start of one burst to start of next burst).
Test-ICMP-Advance:
<1d1h1m1s1ms>
Time increment from on ICMP ECHO request transmission to the next within a burst..
Test-ICMP-Timeout:
<1d1h2m1s1ms>
<int>
(integer, default: 5)
<int>
<int>
<True/False/Yes/No>
Set this parameter to true to enable AT command monitoring (only if Monitored is true). If enabled,
a background thread will be started that periodically queries the modem and network status
=0.0.13.5=
TSS 0.0.14.0 07.Nov.2011
85
Technical Reference
WatchStatus-ComPort:
<com>:<params>
(string, optional)
TSS automatically detects the secondary COM port for known devices (please refer to the description
of the MobilePorts sections in the modem configuration file). If automatic detection does not work or
a different COM port shall be used, the parameter WatchStatus-ComPort can be used to override it.
=0.0.13.5=
WatchStatus-CommandTimeout: <1d1h2m1s1ms>
Defines the timeout for a single AT command in the background thread. =0.0.13.5=
WatchStatus-Interval:
<1d1h2m1s1ms>
Defines the query interval for the background thread. Modem and network status is queried once per
query interval. =0.0.13.5=
UsePacketSniffer:
(True/False/Yes/No)
Start a packet sniffer for the current RAS connection. Please note that UsePacketSniffer and SnifferEnabled both have to be true to enable the packet sniffer. =0.0.13.6=
Sniffer-Type:
(NetCap/NMCap/TShark)
(string, optional)
Defines the packet sniffer tool to be used. Possible values are: =0.0.13.6=
o NetCap
Microsoft NetCap from XP support tools (Windows XP only)
o NMCap
Microsoft NMCap from Network Monitor 3.4 (Windows XP and Windows 7)
o TShark
Wireshark's TShark (Windows XP, LAN only in Windows 7)
Sniffer-Tool:
<exe-file>
(string, optional)
<args>
(string, optional)
Additional command line arguments for the packet sniffer tool. Arguments automatically applied are:
NetCap:
NMCap:
TShark:
Shrink-Type:
(TShark)
(string, optional)
Defines the capture file shrinking tool (only required if a .cap file shall be reduced in size by
truncating frames after N bytes). The only supported type is TShark using Wireshark's editcap.exe.
=0.0.13.6=
Shrink-Tool:
<exe-file>
(string, optional)
Defines the executable file name for the capture file shrinking tool (editcap.exe). =0.0.13.6=
Shrink-Args:
<args>
(string, optional)
Additional command line arguments for the capture file shrinking tool. =0.0.13.6=
Sniffer-Connection:
<type>:<id>
(string, optional)
(True/False/Yes/No)
This parameter has to be set to true to enable the packet sniffer. Can be used to disable the packet
sniffer while preserving all configuration parameters.
Sniffer-TruncBytes:
<bytes>
(integer, optional)
Define this parameter to reduce the number of bytes per captured frame and thus reduce the size of
the capture file while preserving the header information. Please note that TSS uses a different file
extension .scap for shrinked capture files. =0.0.13.6
The following header sizes have to be considered when shrinking capture files:
o MAC header 14 bytes
o IP header
20 bytes
o TCP header 20..32 bytes
A typical frame length of 86 thus results in 20..32 bytes of TCP payload data per frame.
Sniffer-TruncMode:
86
Technical Reference
o ShrinkCap
shrink while capturing if possible (only .scap file created)
o ShrinkReplace shrink after capturing, but delete .cap file (only .scap file created)
o ShrinkAdd
shrink after capturing, preserve .cap file (.cap and .scap files created)
Sniffer-BufferSize:
<MB>
(integer, optional)
Defines the buffer size for the packet sniffer. Some packet sniffers (NetCap and NMCap) use circular
buffers, i.e. the existing buffer bytes are overwritten once the buffer size is reached. In this case the
buffer size has to be chosen large enough to contain the entire data session. =0.0.13.6=
Sniffer-Compress:
(True/False/Yes/No)
Compress capture file with 7-zip. The smaller output file (either the .scap or .cap) can be
compressed with 7-zip before storage or submission. The input file is deleted after compression to
reduce file system usage. =0.0.13.6=
Sniffer-Submit:
Sniffer files can automatically be submitted via FTP data upload if required. Please note that in this
case the smallest sniffer file (.7z, .scap or .cap) will be copied to the outbox directory, upload has to
be done with a properly configured SubmitLogs task. Possible upload modes are =0.0.13.6=
o Never
do not upload sniffer files
o OnError
upload sniffer files in case of errors
o OnWarning
upload sniffer files in case of errors or warnings
o Always
always upload sniffer files
Sniffer-MaxErrors:
<int>
Maximum number of errors (starting or stopping the packet sniffer) until a reboot is done.
Sniffer-AddLog:
(True/False/Yes/No)
Add sniffer tool's console output to execution log for debugging purposes.
SetNDISInterfaceMetric:
<int>
(integer, optional)
Use this parameter to set an NDIS interface's (routing) metric to a given value. This function can be
used to prefer the interface over other interfaces in the system. E.g. if all LAN interfaces are set to a
metric of 50, NDIS interfaces can be preferred if setting their metric to a lower metric (e.g. 10).
=0.0.12.7=
ForceNDISDefaultMetric:
<int>
(integer, optional)
In some situations Windows 7 ignores the interface metric defined for NDIS dial-up interfaces. Use
this parameters to reduce the interface's default metric to the given value after the connection has
been initiated. If defined and less than the actual value, TSS removes the default gateway item for
the current interface from the routing table and creates a new one with the given metric. Please
note that this will fail if the metric is too low as Windows 7 does not allow route metrics less than the
interface metric (typically 20 for 3G data modems). =0.0.13.1=
(string, mandatory)
The name of the RAS connection in the Windows RAS phonebook or a fully qualified CIC ID.
The phonebook name can be found in the Windows network connections list. The specified
connection must exist.
A CIC ID has to be in form <type>:<params>, e.g. RAS:<entry> or HwNd:<name>. Please refer to
chapter 4.7.2 for details.
HangupIfManaged:
<True/False/Yes/No>
If this parameter is true, the internet connection will not be terminated if the TSS Assistance Service
operates tunnel connections (such as for RDP, VNC etc). This means that the connection will be shut
down if it is not managed or just the management connection the TSS Management Server is open.
But if tunnel connections are active, the connection will not be closed to keep the tunnel connections
open.
DontHangup:
<True/False/Yes/No>
If this parameter is true, the internet connection will be kept open, i.e. the Hangup-Task is ignored.
TSS 0.0.14.0 07.Nov.2011
87
Technical Reference
UsePacketSniffer:
(True/False/Yes/No)
Stop the packet sniffer associated with the internet connection. Please note that a running packet
sniffer is automatically stopped if this parameter is not explicitly set to false. =0.0.13.6=
<type>:<connection ID>
(string, optional)
The identifier of a custom internet connection. If possible, TSS uses the COM port assigned to the
RAS modem or NDIS connection. The COM port must not be used by RAS or any other process when
the AT-Command task is executed.
RAS-Entry:
(string, optional)
The name of the RAS connection in the windows RAS phonebook or the network connections. The
specified connection must exist. TSS uses the COM port assigned to the modem associated with the
RAS connection. The COM port must not be connected by RAS or any other process when the ATCommand task is executed.
COM-Port:
<COM port>
(string, optional)
The COM port to be used, e.g. COM12. The COM port must not be connected by RAS or any other
process when the AT-Command task is executed.
AT-Command-00:
<AT command>
(string)
First AT command to be executed. The command can either be a native command or a virtual
command defined in the file mobiles.cfg. Please refer to section xxxxx for details.
AT-Command-01..99:
<AT command>
(string)
<1d1h1m1s1ms>
<num retries>
(integer, default: 3)
Number of retries for the entire sequence of commands (of one command fails due to result code or
timeout).
AT-Continue:
(True/False/Yes/No)
If this parameter is true, all AT commands are executed, even if a command fails. If the parameter is
false, execution is stopped after an erroneous command and a retry is started for the entire
sequence.
LogCommunication:
(True/False/Yes/No)
If this parameter is true, the communication with the modem is added to the execution log.
Requirements
Exactly one of the parameters CIC-ConnID, RAS-Entry or COM-Port has to be specified.
<type>:<connection ID>
(string, optional)
The identifier of a custom internet connection. If possible, TSS uses the COM port assigned to the
RAS modem or NDIS connection. The COM port must not be used by RAS or any other process when
the CheckModem task is executed. =0.0.12.6=
RAS-Entry:
(string, optional)
The name of the RAS connection in the windows RAS phonebook or the network connections. The
specified connection must exist. TSS uses the COM port assigned to the modem associated with the
RAS connection. The COM port must not be connected by RAS or any other process when the
CheckModem task is executed. =0.0.12.6=
COM-Port:
<COM port>
(string, optional)
The COM port to be used, e.g. COM12. The COM port must not be connected by RAS or any other
process when the CheckModem task is executed. =0.0.12.6=
88
Technical Reference
AT-Single-Timeout:
<1d1h1m1s1ms>
<num retries>
(integer, default: 3)
(True/False/Yes/No)
Assume the modem has recently been turned off and on. Thus only wait for modem to be available
and registered, don't issue another power cycle if failing. =0.0.13.0=
ForceCheck:
(True/False/Yes/No)
Always check the mobile status, even if AlwaysReset is set to true. =0.0.12.6=
ResetIfNoNetwork:
(True/False/Yes/No)
(True/False/Yes/No)
Always reset mobile with MPSW, don't care for current status. =0.0.12.6=
ForceReboot:
(True/False/Yes/No)
<1d1h1m1s1ms>
Timeout for device and COM port to be established after MPSW cycle. =0.0.12.6=
RebootOnFailure:
(True/False/Yes/No)
Reboot if device or COM port does not re-appear after MPSW cycle. =0.0.12.6=
RegistrationTimeout:
<1d1h1m1s1ms>
<cid>[:<tid>]
(string, optional)
Scenario ID for dedicated ticket. If specified, a ticket is always generated per task execution
(regardless if an MPSW cycle was required or not). This does not affect the generation of MPSW
tickets after an MPSW cycle with the scenario ID defined in CID-MPSW. =0.0.12.8=
AltRebootMode:
Use this parameter to define an alternate reboot mode if the modem power cycle fails. =0.0.12.8=
UseExternalTool:
(True/False/Yes/No)
Set this parameter to true to force or disable the use of an external MPSW tool. =0.0.12.8=
ExternalToolName:
<file>
(string, optional)
Use this parameter to define an alternate external MPSW tool. The default tool is define in the
[Tools] section in the application config file. =0.0.12.8=
ImmediateShutdown:
(True/False/Yes/No)
<1d1h1m1s1ms>
<file.PO-job>
(string, mandatory)
The job file for PocketOptimizer including the extension (.PO-job). If the file name is relative, it is
located in the configuration path system/jobs/PO.
AppFileName:
<file.exe>
(string, optional)
This parameter overrides the tool configuration in Application.cfg. If the file name is relative, it is
located in the configuration directory system/apps. If the parameter is not specified, the executable
file name in for the tool named PocketOptimizer in Application.cfg is used.
Arguments:
<args>
(string, optional)
(True/False/Yes/No)
Set this parameter to true to add CIC metrics (mobile and cell information, connection IP address) to
the XML reports created by PocketOptimizer.
AddRASMetrics:
(True/False/Yes/No)
Set this parameter to true to add RAS metrics (Mobile information, connection IP address) to the
XML reports created by PocketOptimizer. The parameter is equal to AddCICMetrics.
TSS 0.0.14.0 07.Nov.2011
89
Technical Reference
AddCICMetricConnID:
<type>:<Conn ID>
(string, optional)
This parameter is only used if AddCICMetrics is true. If empty, the last dialed internet connection is
used, otherwise a special internet connection can be specified.
AddRASMetricEntry:
(string, optional)
This parameter is only used if AddCICMetrics is true. If empty, the last dialed internet connection is
used, otherwise a special RAS connection can be specified.
AutoBaseDir:
(True/False/Yes/No)
If this parameter is set, the default directory for execution is set to the application directory instead
of the working directory of TSS.
ReducePrivileges:
(True/False/Yes/No)
If this parameter is set to true, the privileges of the executed task are set to non-privileged,
otherwise it is executed with full admin rights. This behavior is only available in Windows Vista or 7
with active UAC. The default value for PocketOptimizer and WebSpeedTest is true as these
application don't require admin rights and to improve system security.
<url>
(string, mandatory)
<int>
(integer, default 0)
The scenario ID for the XML report created by WebSpeedTest. If 0, only log files but no XML report
will be created.
NoLogParams:
(True/False/Yes/No)
If this parameter is true, the default log file command line arguments will not be added to
WebSpeedTest's command line. In this case specific log file arguments can be provided in the
parameter Arguments.
AppFileName:
<file.exe>
(string, optional)
This parameter overrides the tool configuration in Application.cfg. If the file name is relative, it is
located in the configuration directory system/apps. If the parameter is not specified, the executable
file name in for the tool named WebSpeedTest in Application.cfg is used.
Arguments:
<args>
(string)
(True/False/Yes/No)
Set this parameter to true to add CIC metrics (mobile and cell information, connection IP address) to
the XML reports created by PocketOptimizer.
AddRASMetrics:
(True/False/Yes/No)
Set this parameter to true to add RAS metrics (Mobile information, connection IP address) to the
XML reports created by PocketOptimizer. The parameter is equal to AddCICMetrics.
AddCICMetricConnID:
<type>:<Conn ID>
(string, optional)
This parameter is only used if AddCICMetrics is true. If empty, the last dialed internet connection is
used, otherwise a special internet connection can be specified.
AddRASMetricEntry:
(string, optional)
This parameter is only used if AddCICMetrics is true. If empty, the last dialed internet connection is
used, otherwise a special RAS connection can be specified.
AutoBaseDir:
(True/False/Yes/No)
If this parameter is set, the default directory for execution is set to the application directory instead
of the working directory of TSS.
ReducePrivileges:
(True/False/Yes/No)
If this parameter is set to true, the privileges of the executed task are set to non-privileged,
otherwise it is executed with full admin rights. This behavior is only available in Windows Vista or 7
with active UAC. The default value for PocketOptimizer and WebSpeedTest is true as these
application don't require admin rights and to improve system security.
DontCheckReboot:
(True/False/Yes/No)
If this parameter is set to true, ===REBOOT messages from the tool are ignored. =0.0.12=
90
Technical Reference
<name>
(string)
The tool name as specified in the configuration file Applications.cfg. If the parameter is specified, the
corresponding entry in the application configuration file is used to determine the executable file
name.
AppFileName:
<file.exe>
(string)
If the parameter Tool is not used or the tool is not registered in Applications.cfg, this parameter can
be used to specify the executable file name directly. If the file name is not absolute, it has to be
relative to the configuration path %system\apps%, except if it starts with the prefix ~\. In this case,
the file name is not expanded and will be searched in the Windows search path.
ArgumentRule:
<rule>
(string, optional)
The argument rule can be used to automatically create the command line arguments from the
parameters ScriptFileName and Arguments. The argument rule can contain the placeholders $script$
and $args$ and any other text arguments. The output of the argument rule will be appended to the
application file name to generate the entire command line. If the parameter Tool is specified, the
argument rule can be fetched from the application configuration file.
Examples for argument rules for cmd.exe and perl are:
/c $script$ $args$
$script$ $args$
ScriptFileName:
<file.ext>
(string, optional)
This parameter can be used in conjunction with parameter ArgumentRule to allow tool execution just
with one of the following parameter combinations:
o Tool, ScriptFileName (ArgumentRule fetched from Application.cfg)
o AppFileName, ArgumentRule, ScriptFileName
Arguments:
<args>
(string, optional)
This parameter can either contain the entire command line (if Tool and AppFileName are not
specified), additional arguments for the argument rule (if specified or derived from the application
configuration file) or just the arguments for the executable file name.
SetEnvironment:
(True/False/Yes/No)
If this parameter is set to true, the environment of TSS and the system and user defined variables
will be set in the environment of the executed process.
UseShellExec:
(True/False/Yes/No)
If this parameter is set to true, the ShellExecute method will be used to create the process instead
of the CreateProcess method. ShellExecute can be used for data files, too, Windows will
automatically search the registered application for the file in this case. ShellExecute however does
not provide support for console redirection.
UseRedirect:
(True/False/Yes/No)
If this parameter is set to true, the console output (stdout and stderr) from the called process will be
directed to TSS. TSS will monitor special messages (===STATUS, ===ERROR, ===WARNING, ===PROGRESS)
and display the messages in the execution log.
UseResponseFile:
(True/False/Yes/No)
If this parameter is set to true, the executed process is assumed to write the messages to the
response file instead of the console output. The console file name is given by TSS and can be
accessed with the system defined variables %TempPath%\%ResponseFile%. The file name has to be
passed to the called process either with user defined command line arguments or by environment
variables (SetEnvironment switch).
UseControlFile:
(True/False/Yes/No)
If this parameter is set to true, the executed process is assumed to terminate if the control file is
created by TSS. The control file name is given by TSS and can be accessed with the system defined
variables %TempPath%\%ControlFile%. The file name has to be passed to the called process either with
user defined command line arguments or by environment variables (SetEnvironment switch).
UseHistoryFile:
(True/False/Yes/No)
If this parameter is set to true, a history file containing the log and report file names of all previously
executed tasks is created for the executed process. The tool can use the history file to locate these
TSS 0.0.14.0 07.Nov.2011
91
Technical Reference
files and extract information. The file name is given by TSS and can be accessed with the system
defined variables %TempPath%\%HistoryFile%. The file name has to be passed to the called process
either with user defined command line arguments or by environment variables (SetEnvironment
switch).
DontCheckAppFile:
(True/False/Yes/No)
If this parameter is set to true, TSS does not check if the tool file exists. This can be useful if the tool
is located in the Windows search path or the ShellExecute method is used for a script file.
DontCheckExitCode:
(True/False/Yes/No)
If this parameter is set to true, TSS does not check the tool's exit code (error level). Otherwise a tool
failure will be assumed if the exit code is different to 0.
DontNeedReportFile:
(True/False/Yes/No)
If this parameter is set to true, TSS does not expect the tool to create a report file. Otherwise an
XML report has to be created by the tool, a tool failure is assumed if it does not exist. The file name
for the report is given by TSS, it can be accessed with the system defined variables
%ReportPath%\%ReportFile%.
DontAddToHistoryFile:
(True/False/Yes/No)
If this parameter is set to true, the files created by the tool are not added to the history file.
AddCICMetrics:
(True/False/Yes/No)
Set this parameter to true to add CIC metrics (mobile and cell information, connection IP address) to
the XML reports created by PocketOptimizer.
AddRASMetrics:
(True/False/Yes/No)
Set this parameter to true to add RAS metrics (Mobile information, connection IP address) to the
XML reports created by PocketOptimizer. The parameter is equal to AddCICMetrics.
AddCICMetricConnID:
<type>:<Conn ID>
(string, optional)
This parameter is only used if AddCICMetrics is true. If empty, the last dialed internet connection is
used, otherwise a special internet connection can be specified.
AddRASMetricEntry:
(string, optional)
This parameter is only used if AddCICMetrics is true. If empty, the last dialed internet connection is
used, otherwise a special RAS connection can be specified.
DeleteResponseFile:
(True/False/Yes/No)
If this parameter is set to false, the response file created by the tool is not deleted automatically.
AutoBaseDir:
(True/False/Yes/No)
If this parameter is set, the default directory for execution is set to the application directory instead
of the working directory of TSS. This parameter is not available if shell execution is used.
ReducePrivileges:
(True/False/Yes/No)
If this parameter is set to true, the privileges of the executed task are set to non-privileged,
otherwise it is executed with full admin rights. This behavior is only available in Windows Vista or 7
with active UAC. The default value is false to maintain compatibility to Windows XP.
DontCheckReboot:
(True/False/Yes/No)
If this parameter is set to true, ===REBOOT messages from the tool are ignored. =0.0.12=
exec or http-gettime
Defines the time synchronization method to be used. The parameter can be used to override the
default setting in the configuration parameter [Methods].TimeSync-Method.
o exec ... use external SNTP client
o http-gettime ... use internal HTTP client and get-time request
GetTime-Server:
<url>
(string)
This parameter is only used if method is http-gettime. It can be used to override the default setting
in the configuration parameter [Communication].GetTime-Server. The QTS Ticket Receiver and Relay
support the get-time request, the URL should be in form http://server/get-time.
TSS 0.0.14.0 07.Nov.2011
92
Technical Reference
AppFileName:
<file.exe>
(string)
This parameter is only used if method is exec. It overrides the tool configuration [Tools].SNTP-Tool
in Application.cfg. If the file name is relative, it is located in the configuration directory system/apps.
NumRetries:
<int>
(integer, default: 2)
Only used if method is http-gettime. Number or retries for a single HTTP request to the public IP
server.
Timeout:
<1d1h1m1s1ms>
Timeout for a single HTTP request to the time server (if method is http-gettime) or for execution of
external sync tool (if method is exec).
Sync-Forced:
(True/False/Yes/No)
This parameter is only required if the configuration parameter Sync-Enabled is set to forced. In this
case synchronization is only allowed if a job is executed manually and the synchronization task's
Sync-Forced parameter is true. =0.0.13.1=
<int>
Maximum number of report files to be submitted per task execution. The youngest report files are
submitted first, this parameter can be used to limit the execution time of the reporting task.
MaxDuration:
<1d1h1m1s1ms>
Maximum time duration to start another submission of an XML report. The youngest report files are
submitted first, no further files are submitted after the maximum duration is reached. To avoid
additional error messages, the task's timeout should be larger than MaxDuration + HttpTimeout.
Report-Server:
<QTS url>
(string, optional)
The URL of the report server (QTS ticket receiver or relay). Usually this parameter is not required
and the URL is fetched from the system configuration file.
Report-Instance:
<QTS instance>
(string, optional)
The database instance name for the report server (QTS ticket receiver ore relay). Usually this
parameter is not required and the URL is fetched from the system configuration file.
Report-TIC:
<QTS TIC>
(integer, optional)
The ticket identification code for the report server (QTS ticket receiver or relay). Usually this
parameter is not required and the TIC is fetched from the system configuration file.
NumRetries:
<int>
Maximum number of submission attempts for a single report file. If the submission of a file is not
possible after the specified number of attempts, the file is moved to the error output directory and
no further submission attempts for this file will be started. Please note that submission attempts
without server reaction are not counted as failure, i.e. no report files are dropped if the report server
does not respond.
HttpTimeout:
<1d1h1m1s1ms>
Timeout for a single HTTP transfer. Please note that this is the entire timeout from the connection of
the TCP socket to the reception of the HTTP status code. The timeout has to be large enough to
allow transmission of the larges XML report files over the slowest possible connection.
<int>
Maximum number of report files to be submitted per task execution. The youngest files are
submitted first, this parameter can be used to limit the execution time of the reporting task.
MaxDuration:
<1d1h1m1s1ms>
Maximum time duration to start another submission of a files. The youngest files are submitted first,
no further files are submitted after the maximum duration is reached. To avoid additional error
messages, the task's timeout should be larger than MaxDuration + FtpTimeout.
93
Technical Reference
Log-Server:
<FTP url>
(string, optional)
URL of the FTP server to load the files onto. Usually this parameter is not required and the URL is
fetched from the system configuration file. The parameter %agentid% in the URL is replaced by the
agent ID provided in the registration data.
Log-User:
(string, optional)
FTP user name for the log server. Usually this parameter is not required and the user name is
fetched from the system configuration file.
Log-Pass:
<FTP password>
(string, optional)
FTP password for the log server. Usually this parameter is not required and the user name is fetched
from the system configuration file.
Log-Passive:
(True/False/Yes/No)
Set this parameter to true to use passive mode. If not defined, the corresponding parameter from
the system configuration file is used.
NumRetries:
<int>
Maximum number of submission attempts for a single file. If the submission of a file is not possible
after the specified number of attempts, the file is moved to the error output directory and no further
submission attempts for this file will be started. Please note that submission attempts without server
reaction are not counted as failure, i.e. no report files are dropped if the server does not respond.
FtpTimeout:
<1d1h1m1s1ms>
Timeout for a single FTP transfer. Please note that this is the entire timeout from the connection of
the TCP socket to the reception of the FTP status code. The timeout has to be large enough to allow
transmission of the larges report and data files over the slowest possible connection.
<HTTP url>
(string, optional)
This parameter can be used to override the default synchronization server in the system
configuration file.
Sync-Groups:
<group list>
(string, optional)
This parameter can be used to assign special synchronization groups to the machine. Usually this
parameter will not be required, in this case the parameter in the machine configuration file will be
used, or more likely the groups defined in the file synchronization.cfg on the synchronization server
(either for the current agent ID or for the default group '*').
DoDownload:
(True/False/Yes/No)
If this parameter is false, the files will not be downloaded. In this case TSS will install the files from
the repository to the application directory if the content of the repository is valid and complete. This
parameter can be used to split download and installation into different tasks.
DoInstall:
(True/False/Yes/No)
If this parameter is false, the files will not be installed. In this case TSS will check for new files to
download and will store them in the repository directory, but will not install them.
MaxDuration:
<1d1h1m1s1ms>
Maximum duration for downloads. This parameter can be used to limit the task duration. Download
of new files will be started until MaxDuration is reached. Please note that the files will only be
installed after the last required file has been loaded and the entire repository is valid and complete.
NumRetries:
<int>
Number of retries for a single file per task execution. The file will be loaded again in the next task
execution.
HttpTimeout:
<1d1h1m1s1ms>
Timeout for a single HTTP request. The value should be large enough to allow loading the largest
required file (approx. 2MB) over the slowest possible connection.
94
Technical Reference
(Backup/Restore/Set/Remove/Disable/Enable)
(string)
<list of interfaces>
(string)
Specifies filter criteria to restrict the interfaces to apply the modifications to. The filter consists of a
list of interface identifiers. If an identifier is preceded by an exclamation sign (!), it is excluded from
the filter, otherwise it is included.
Possible identifiers are:
o *
all active interfaces
o *NIC
all active network interfaces (not RAS or NDIS connections)
o *RAS
all active RAS connections (not network cards)
o *HwNd
... all Huawei NDIS interfaces
o NIC:<name>
... given network card
o RAS:<entry>
specified RAS connection
o HwNd:<name>
specified Huawei NDIS connection
o FN:<name>
... network connections with given friendly name
Parameters:
(GW,DNS)
<ip-addr,ip-addr>
(string)
A list of DNS server addresses separated by commas. This parameter is only used if mode is Set.
GwAddrs:
<ip-addr>
(string)
The default gateway's IP address. This parameter is only use if mode is Set.
DoBackup:
(True/False/Yes/No)
If this parameter is set to true, the existing value is stored in internal storage if mode is Set, Remove
or Disable.
DoOverwrite:
(True/False/Yes/No)
If this parameter is set to true, an existing backup value in the internal storage will be overwritten. If
the parameter is false, the existing backup value is kept.
UseGlobalStorage:
(True/False/Yes/No)
If this parameter is set to true, a global backup storage for the entire TSS process is used, otherwise
a local storage for the current job execution is used.
OnlyIfDhcp:
(True/False/Yes/No)
If this parameter is set to true, interface modifications are only executed if the interface is configured
by DHCP.
<list of interfaces>
Specifies filter criteria to restrict the interfaces to apply the modifications to. The filter consists of a
list of interface identifiers. If an identifier is preceded by an exclamation sign (!), it is excluded from
the filter, otherwise it is included.
Possible identifiers are:
TSS 0.0.14.0 07.Nov.2011
95
Technical Reference
o
o
o
o
o
o
o
o
*
*NIC
*RAS
*HwNd
NIC:<name>
RAS:<entry>
HwNd:<name>
FN:<name>
OnlyIfDhcp:
If this parameter is set to true, interface modifications are only executed if the interface is configured
by DHCP.
<HTTP url>
(string, optional)
This parameter can be used to override the configuration parameter in the system configuration file.
PublicIP-Name:
<string>
(string, optional)
If multiple public IP addresses are available, a name for the interface can be assigned to the task.
Please note that proper routing configuration has to be ensured with Route or IPConfig tasks before
running the GetPublicIP task in this case.
NumRetries:
<int>
(integer, default: 2)
<1d1h1m1s1ms>
<int>
On success the valid counter in the internal storage is set to this value. On failure, the valid counter
is reduced by one. A public IP address is assumed to be valid as long as the counter is > 0.
MustExist:
< True/False/Yes/No)
If this parameter is set to true, an error is generated if no public IP address is available. =0.0.12.3=
(varying)
(string, optional)
This parameter can be used to override settings in the platform configuration file. The parameter
name is formed by the prefix 'Clean-TempFiles.' and the path and parameter in the configuration file,
e.g. =0.0.12.3=
[TempFiles].Compress-Enabled
[TempFiles/Logs].Compress-Enabled
-> Clean-TempFiles.Compress-Enabled
-> Clean-TempFiles-Logs.Compress-Enabled
(True/False/Yes/No)
If this parameter is set to true, the reboot is executed immediately, otherwise after the job execution
has finished.
RebootMode:
(Soft/Win/Auto/Safe/Hard)
96
Technical Reference
(True/False/Yes/No)
Set this parameter to true to force or disable the use of an external reboot tool. =0.0.12=
ExternalToolName:
<file>
(string, optional)
Use this parameter to define an alternate external reboot tool. The default tool is defined in the
[Tools] section in the application config file. =0.0.12=
<None/Soft/Auto/Safe/Hard>
(string, optional)
Use this parameter to define an alternate reboot mode if the modem power cycle fails.
UseExternalTool:
Set this parameter to true to force or disable the use of an external MPSW tool.
ExternalToolName:
Use this parameter to define an alternate external MPSW tool. The default tool is define in the
[Tools] section in the application config file.
ImmediateShutdown:
Connection.
yyyymmdd-hhnnss-zzzz-pp-qq
(string)
The execution ID for the current job sequence. It contains the scheduled job start stamp (local time
including time zone) followed by a parallel ID (if multiple jobs are executed in parallel) and a
sequence ID (if the job sequence contains more than one job).
TaskId:
j[(ll)].tii[(ll)][...]
(string)
The current task ID in containing job loop (if more than one job), task index and task loop (if more
than one loop). For sub-jobs additional job and task IDs are added.
LogId:
[job/task info]
(string)
This is the long form of TaskId as used in the log file names.
Prefix:
<ExecId>.<LogId>
(string)
The log file prefix consisting of execution ID and log ID. Log files should be placed in the directory
%LogPath% using this prefix, data files in the directory %DataPath%.
97
Technical Reference
AgentId:
<agent-ID>
(integer)
<RAS entry>
(string)
The name of the last dialed RAS connection if used, empty otherwise. The parameter is deprecated.
RasIpAddr:
<ip>
(string)
The last dialed RAS connection's IP address if used, empty otherwise. The parameter is deprecated.
CicId:
<CIC identifier>
(string)
The identifier of the last dialed internet connection if used, empty otherwise.
CicIpAddr:
<ip>
(string)
<dir>
(string)
The path for TSS binary and configuration files (%system%). =0.0.13.0=
ToolPath:
<dir>
(string)
The path for TSS tools (%system\apps%, usually this is %system%\apps). =0.0.13.0=
ScriptPath:
<dir>
(string)
The path for script files (%system\scripts%, usually this is %system%\scripts). =0.0.13.0=
JobPath:
<dir>
(string)
The path for TSS job files (%system\jobs%, usually this is %system%\jobs). =0.0.13.0=
VarPath:
<dir>
(string)
<dir>
(string)
<dir>
(string)
The path for XML report files (%data\work\reports%, usually this is %data%\work\reports).
DataPath:
<dir>
(string)
The path for additional (binary) data files (%data\work\data%, usually this is %data%\work\data).
TempPath:
<dir>
(string)
<dir>
(string)
<execid>-control.dat
(string)
The control file for executed processes if used. If this file is created in the directory %TempPath%,
the process shall terminate.
ResponseFile:
<execid>-response.dat
(string)
The response file for console output if used (in the temp directory). The process can write console
output for TSS into this file.
IndexFile:
<execid>-index.dat
(string)
The index file. The process can write the output files and log levels into this file in the temp
directory.
HistoryFile:
<execid>-history.dat
(string)
The history file. The process can receive the list of the current job's executed tasks and the log and
data files. The file is placed in the temp directory by TSS.
ReportFile:
<execid>-report.xml
(string)
The process shall use this file name to store the XML report file in the %ReportPath% directory.
(string)
98
Technical Reference
- base64
<len>
%randi(<min>,<max>,[<step>],[<len>])%
(integer/string)
%date([<loc>],[<fmt>])%
(integer)
...
...
...
...
...
...
...
...
...
...
...
...
%time([<loc>],[<fmt>])%
(integer)
...
...
...
...
...
...
...
...
...
...
...
...
%dt([<loc>],[<fmt>])%
(integer)
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Please note that the sections [TSS.RAS-*] is used if [TSS.CIC-*] is not existing for compatibility with
previous versions.
99
Technical Reference
Ticket rating
(string)
(string)
Ticket status/error
(string)
Duration in seconds
(float)
Number or errors
(integer)
Contains the number of errors occurred during task execution (only for TSS execution tickets)
m.113:
Number or warnings
(integer)
Contains the number of warnings occurred during task execution (only for TSS execution tickets)
m.116:
Synchronization enabled
(integer)
Ticket rating
(string)
(string)
Ticket status/error
(string)
Duration in seconds
(float)
Always 10.0
comment:
Always 0
Metric groups
TSS information (100..109) without execution log file, refer to 5.5.10.1
Tool information (110..119) with TSS version information, refer to 5.5.10.2
Connection IP information (140..149), refer to 5.5.10.4
Public IP information (160..169), refer to 5.5.10.5
TSS assistance service information (250..259), refer to 5.5.10.7
TSS 0.0.14.0 07.Nov.2011
100
Technical Reference
Ticket rating
(string)
(string)
Ticket status/error
(string)
Duration in seconds
(float)
Always 0
Metric groups
TSS information (100..109) without execution log file, refer to 5.5.10.1
Tool information (110..119) with TSS version information, refer to 5.5.10.2
Public IP information (160..169), refer to 5.5.10.5
TSS health information (280..289), refer to 5.5.10.7
Metrics
x.114:
Reboot mode
(string)
Contains the reboot mode: "soft", "ext", "assist-hard", "assist-hard+mpsw", "assist-soft", "assistsoft+mpsw"
Ticket rating
(string)
(string)
Ticket status/error
(string)
Duration in seconds
(float)
Always 10.0
comment:
none
duration:
Always 0
Metric groups
TSS information (100..109) without execution log file, refer to 5.5.10.1
Tool information (110..119) with TSS version information, refer to 5.5.10.2
Public IP information (160..169), refer to 5.5.10.5
TSS assistance service information (250..259), refer to 5.5.10.7
TSS health information (280..289), refer to 5.5.10.7
Synchronization information (290..299), refer to 5.5.10.9
Registration information (300..399), refer to 5.5.10.10
Metrics
No additional metrics are generated.
TSS 0.0.14.0 07.Nov.2011
101
Technical Reference
Ticket rating
(string)
(string)
Ticket status/error
(string)
Duration in seconds
(float)
Always 10.0
comment:
Always 0
Metric groups
TSS information (100..109) without execution log file, refer to 5.5.10.1
Tool information (110..119) with TSS version information, refer to 5.5.10.2
Connection IP information (140..149), refer to 5.5.10.4
Public IP information (160..169), refer to 5.5.10.5
TSS assistance service information (250..259), refer to
TSS health information (280..289), refer to 5.5.10.7
Synchronization information (290..299), refer to 5.5.10.9
Registration information (300..399), refer to 5.5.10.10
Metrics
No additional metrics are generated.
Ticket rating
(string)
(string)
Ticket status/error
(string)
Duration in seconds
(float)
Always 0
Metric groups
TSS information (100..109) without execution log file, refer to 5.5.10.1
Tool information (110..119) with TSS version information, refer to 5.5.10.2
Public IP information (160..169), refer to 5.5.10.5
TSS health information (280..289), refer to 5.5.10.7
Metrics
No additional metrics are generated.
102
Technical Reference
Ticket rating
(string)
Default values
o 0 if CIC/RAS connection is already active (i.e. was not dialed)
o 1 otherwise (i.e. if a dial attempt was started)
If RateOnResponseOnly is true =0.0.12=
o 0 if the modem cannot be found or does not respond to AT commands (and connection fails)
If RateOnImsiImeiOnly is true =0.0.12.8=
o 0 if the modem does not provide valid IMSI and IMEI (and connection fails)
qi:
(string)
Ticket status/error
(string)
Duration in seconds
(float)
(float)
Internet connection failure ratio = 1.0 - 1.0 / num_attempts on success, 1.0 on failure
m.1001:
(integer)
(integer)
(float)
Connection activation time of last attempt in seconds, not including time to query modem status
m.1004:
(float)
Total activation time of all attempts in seconds, not including time to query modem status
x.1010:
CIC type
(string)
CIC name
(string)
Ticket rating
(string)
(string)
Always 1
qi:
103
Technical Reference
comment:
Ticket status/error
(string)
Duration in seconds
(float)
Not used
duration:
Always 0
Metric groups
TSS information (100..109) without execution log file, refer to 5.5.10.1
Tool information (110..119) with TSS version information, refer to 5.5.10.2
Mobile network information (120..139), refer to 5.5.10.3
Connection IP information (140..159), refer to 5.5.10.4
Public IP information (160..169), refer to 5.5.10.5
Metrics (generic)
x.1010:
CIC type
(string)
CIC name
(string)
(string)
(string)
(integer)
(string)
(string)
Last time stamp when connection was detected as active with API functions in XML date/time format
m.1113:
(float)
Total active time in seconds if available (i.e. if connection was established by TSS or the API provides
the start time or total duration)
m.1114:
(integer)
(integer)
(string)
The first time stamp when the internet connection was monitored. The value contains the activation
time stamp (if the connection was dialed) or the first monitored time stamp (if the connection was
already active) in XML date/time format.
m.1123:
(float)
Monitored active time for connection. This is the time from first monitored stamp until the
connection drop or CIC/RAS hang up task.
m.1124:
(integer)
The number of received bytes as provided by API (from connect until hang up task)
m.1125:
(integer)
The number of transmitted bytes as provided by API (from connect until hang up task)
Metrics (if ICMP monitoring is active)
These metrics are generated if the CIC parameters Monitored and Test-ICMP-Host are defined.
m.1151:
(integer)
0 if no drop was detected by ICMP monitoring, 1 if drop was detected by ICMP monitoring
x.1162:
(string)
Time stamp when last ICMP response was received in XML date/time format
m.1163:
(float)
Total active connection time in seconds as detected by ICMP monitoring. Only available if the
connection establishment time could be derived (if connection was dialed or provided by the API)
104
Technical Reference
x.1171:
(string)
(float)
RAT handovers
(integer)
RAT selects
(integer)
RAT drops
(integer)
Cell handovers
(integer)
# of inter cell handovers (i.e. changes from one cell ID to another cell ID)
m.1204:
Cell selects
(integer)
RAT types
(id list)
RAT usage
(id+duration list)
list of used RAT types and spent time in seconds, separated by commas, e.g. GSM(10),UMTS(50)
x.1212:
(id list)
(id+duration list)
list of used RAT sub-types and spent time in seconds, separated by commas e.g. UMTSHSPA+(50),UMTS-UMTS(10)
x.1214:
Cell list
(id list)
Cell usage
(id+duration list)
105
Technical Reference
TSS version
(string)
TSS execution ID
(string)
TSS task ID
(string)
(string)
(string)
(string)
(string)
Tool version
(string)
Contains the tool version (the TSS version if the ticket was generated by TSS)
x.111:
Tool/Task type
(string)
Reboot mode
(string)
IMSI
(string)
IMEI
(string)
(float)
MCC/MNC
(string)
LAC
(string)
The location area code as provided by the mobile in hex format (e.g. 426B)
x.126:
Cell ID
(string)
SysInfo
(string)
The system information as provided by the mobile in internal format (e.g. 2,3,0,5,1,,4)
TSS 0.0.14.0 07.Nov.2011
106
Technical Reference
x.128:
SysType
(string)
(string)
APN
(string)
Detected APN if specified for API calls or derived from mobile and configuration data. For RAS
connections the APN can only be defined if the MSISDN is in Form *99***1#. For *99# this is not
possible.
x.131:
Registration status
(string)
Local IP address
(string)
(string)
(string)
(string)
Wnd ... window size, 1323 ... RFC1323 options, MTU ... MTU size
x.144:
AFD parameters
(string)
drw ... default receive window, dss ... default send window, BSS ... small buffer size, bsm ... medium
buffer size, bsl ... large buffer size
x.145:
IE information
(string)
vers ... Internet Explorer version, mc ... max. parallel connections (HTTP 1.1) , mc_10 ... max.
parallel connections (HTTP 1.0)
5.5.10.5 Public IP information (160..169)
Public IP information contains IP information for a permanent IP connection.
x.160:
Public IP address
(string)
(string)
Windows version
(string)
Contains the current windows version (e.g. XP = 5.1, Vista = 6.0, Win7 = 6.1) =0.0.13.1=
x.161
EWF status
(string)
Contains the current EWF status or error information, typical values are: =0.0.13.1=
o EWF is disabled
o EWF manager not found
o Error detecting EWF state
o EWF is enabled, time zone unchanged
o Error committing EWF
o EWF commit initiated, new time zone -120
TSS 0.0.14.0 07.Nov.2011
107
Technical Reference
TAS Status
(string)
TAS Warning
(string)
WD Status
(string)
MPSW Status
(string)
(string)
The time stamp when the TSS application was started in XML date/time format.
m.281:
(string)
(string)
(string)
(string)
Sync status
(string)
(string)
Time stamp when repository was checked the last time in XML date/time format.
x.292:
(string)
Time stamp when repository files were installed the last time in XML date/time format.
x.293:
(string)
Latest time stamp from repository index files. The time stamp is generated from the latest date
header field in one of the index files. It is provided in XML date/time format.
5.5.10.10 Registration information (300..399)
This group contains tool registration information. Currently the registration information for 3 tools is
reported:
TSS (301..304)
PocketOptimizer (311..314)
TSS 0.0.14.0 07.Nov.2011
108
Technical Reference
WebSpeedTest (321..324)
x.300+n*10:
Tool version
(string)
Tool version
(string)
(string)
Tool expiration
(string)
The tool expiration date/time. Either a date/time in XML format or one of the following status codes
o unknown
o perpetual
x.304*n+10:
Tool checkout
(string)
The tool checkout date/time. Either the time when the registration was checked out from the server
or one of the following status codes:
o unknown
o perpetual
109
Technical Reference
Contents
Introduction................................................................................................................................................1
1.1 What is TSS ........................................................................................................................................1
1.2 Field of application ..............................................................................................................................1
1.3 Revision History ..................................................................................................................................2
1.4 Important notes for Windows XP, Vista and 7 .......................................................................................5
1.5 Known limitations................................................................................................................................5
1.6 This manual........................................................................................................................................5
1.7 System architecture ............................................................................................................................6
1.7.1 Service View .................................................................................................................................6
1.7.2 Functional View ............................................................................................................................6
1.7.3 Data view .....................................................................................................................................7
Installation ............................................................................................................................................... 10
2.1 System requirements......................................................................................................................... 10
2.2 Application startup ............................................................................................................................ 10
2.3 Removing previous installations ......................................................................................................... 10
2.3.1 Removing TSS Win32 Edition....................................................................................................... 10
2.4 Installing TSS ................................................................................................................................... 11
2.4.1 Installing TSS Win32 Edition ........................................................................................................ 11
2.4.2 Configuring Windows .................................................................................................................. 11
2.5 Registering TSS ................................................................................................................................ 12
2.5.1 Getting the Machine ID ............................................................................................................... 13
2.5.2 Automatic registration with license server..................................................................................... 13
2.5.3 Manual registration with license server ......................................................................................... 14
2.5.4 Manual registration with license utility (branded versions only) ...................................................... 14
2.6 Configuring TSS Tasks....................................................................................................................... 14
2.6.1 Configuring TSS without a server ................................................................................................. 14
2.6.2 Configuring TSS with a server...................................................................................................... 15
Operations Manual .................................................................................................................................... 16
3.1 The user front end ............................................................................................................................ 16
3.2 The TSS Assistance Service and Client................................................................................................ 17
3.2.1 Operation modes ........................................................................................................................ 17
3.2.2 Standalone operation .................................................................................................................. 18
3.2.3 Operation with TSS Management Server ...................................................................................... 19
Administrators Manual .............................................................................................................................. 20
4.1 TSS Functions ................................................................................................................................... 20
4.2 Directories ........................................................................................................................................ 20
4.2.1 Single directory scheme .............................................................................................................. 20
4.2.2 Dual directory scheme................................................................................................................. 21
4.3 Scheduler ......................................................................................................................................... 22
4.4 Execution unit and jobs ..................................................................................................................... 22
4.5 Tasks ............................................................................................................................................... 22
4.6 Job and task variables ....................................................................................................................... 23
4.6.1 System defined variables............................................................................................................. 23
4.6.2 System defined functions ............................................................................................................ 23
4.6.3 User defined variables ................................................................................................................. 24
4.6.4 Variable expansion...................................................................................................................... 24
4.7 Internet connections: RAS and CIC .................................................................................................... 24
4.7.1 Types of connections .................................................................................................................. 24
4.7.2 Connection identifiers.................................................................................................................. 25
4.7.3 CIC tasks and configuration ......................................................................................................... 26
4.7.4 RAS tasks and configuration ........................................................................................................ 27
4.8 Firewall rules .................................................................................................................................... 28
4.8.1 Communication overview............................................................................................................. 28
4.8.2 Protocol summary ....................................................................................................................... 29
4.8.3 Local/LAN firewall rules ............................................................................................................... 29
4.8.4 Internet/WAN firewall rules ......................................................................................................... 30
TSS 0.0.14.0 07.Nov.2011
110
Contents
111
Contents
112
Contents