Detailed description of spd commands (with examples)

spd command - overview

To use spd commands you can enter them on the cFosSpeed console, which can be open by
START/Programs/cFosSpeed/cFosSpeed Console

If you enter the command spd help you get the following list of commands:

set

set port specific variable (set <v> /? for help)

module <name> on/off

switch module <name> on or off

perf on/off

switch statistics display on/off

close

close LAN port

ping

send a echo request.

sethops

set the TTL for outgoing test pings.

speed

show current shaper settings.

medium

set connection characteristics (medium /? for help)

tsclear

clear the traffic shaping settings for this connection.

class

add a new traffic class or change settings on an existing one.

-speed <x>: sets the speed to <x>. use 'inf' to specify infinite speed.
-prio <x>: sets the priority to <x>
-dscp <x>: set DSCP value of packets to <x>. use 'none' to not set.
-clear: clears the stats.

cstat

print all classes with stats. accepts a wildcard like '*' or 'f*'. -clear clear stats afterwards.

filter

show/add/modify filters. -print prints filters after the operation.

<no option>: show all filters
-A <f>: append filter <f> at the end.
-D <num>: delete filter at position <num>
-I <num> <f>: insert filter <f> at position <num>
-R <num> <f>: replace filter at position <num> with filter <f>
-M <old> <new>: move filter from position <old> to <new>

reload

reload settings from ini file.

-filter: reload filters

save

save filter/class settings to ini file.

-class: save classes
-filter: save classes or filters.

addkey <section> <key>

add <key> to <section> in settings.ini

delkey <section> <key>

delete <key> from <section> in settings.ini

showsect <section>

show section <section> in settings.ini

fwstat

show firewall statistics (-clear to clear after display)

fstat

show all filter statistics (-clear to clear after display)

netstat

print global network protocol statistics

pingstat

print ping statistics (-clear clears stats after printing)

cons

list of tcp connections (-cps for cps, -vol for volume)

budget

show active budget's settings and stats

burst

start a burst of data to check line speed

ports

list all ports

pcnt

show packet counters

ver

print cFosSpeed version info

dump

on/off/in/out/net/app/ign/ip/ipr dump of network packets

gset

set global variable (-save to save it to ini file)

tvstat

print tcpview statistics

prognames

print known program names

reset_budget

reset online budget

Description of spd commands (with examples)

spd set

Mit spd kommando set können verschiedene cFosSpeed Werte manuell gesetzt werden. Eine Übersicht aller Werte erhält man durch einfache Eingabe von spd set. Möchte man einen Wert manuell ändern gilt folgende Befehlsstruktur: spd set = Wert.
Eine detaillierte Anleitung wird bei der Eingabe von set /? ausgegeben.

Example: Ausgabe von spd set

C:\Programme\cFosSpeed>spd set
add_overhead_rx = 0
add_overhead_tx = 0
addhops = 0 (ttl 2)
avg_time = 2000
data_compression_rx = 0
data_compression_tx = 0
easy = 10
easymax = 10
fixed = 1
fixed_speed = 1
had_bounce = 1
maxdelay = 498120
maxiplen = 1492
maxrx = 85395
maxrxmss = 1452
maxtxacked = 18053
maxtxmss = 1452
maxtxraw = 18053
medium = dsl_pppoe (1)
method = pppoe (1)
mindelay = 51447
msslimit = 65535 (65535)
pingcnt = 632
pongcnt = 630
regid = 1
txspeed = 19659
vj_compression_rx = 0
vj_compression_tx = 0
volrx = 1261719 (1232K)
voltxacked = 5244422 (5121K)
voltxraw = 5281441 (5157K)

Example: Ändern des fixed-Wertes auf 1

C:\Programme\cFosSpeed>spd set fixed=1
fixed = 1

spd ping

Das spd kommando ping versendet einen einzelnen Messping. Im numerischen cFosSpeed Statusfenster blinkt dann kurz der aktuelle Wert der Pingzeit auf. Im Beispiel ist dies der Wert 53 ms

Example

C:\Programme\cFosSpeed>spd ping

spd sethops

With the command sethops you can set the ttl value of the cFosSpeed measure pings. Just set the number i for the value. The output is: "addhops 2+i (ttl i)", where first you get the variation from the default value (2). Then you get the current and new ttl-value.

Hint: The command only works, if you are online. If you are not you will get the error message: cannot perform command; section name still unknown

Example: set ttl-value to 5

C:\Programs\cFosSpeed>spd sethops 5
add_hops = 3 (ttl 5)

spd speed

Mit dem spd kommando speed erhält man eine Übersicht über verschiedene Traffic Shaping-Werte. Die wichtigsten sind:

maxrx - maximale Download Bandbreite in cps
method - Angabe zur verwendeten Übertragungsmethode: PPPoE, PPPoA, PPPtP, Cable, etc.
addhops - hier wird der aktuelle ttl Wert im Klammern angezeigt.
pingcnt - Gesamtanzahl der gesendeten Pings
pongcnt - Gesamtanzahl der erhaltenen Ping-Antworten (Pongs)
txspeed - Upload bandbreite in cps

Example:

C:\Programme\cFosSpeed>spd speed
Current shaper settings:
maxtxraw=23108  maxtxacked=18045  maxrx=138542  mindelay=51068  maxdelay=22558281
regid=1  method=pppoe (1)  addhops=-1 (ttl=1)  msslimit=65535 (65535)  avg_time=2000
volrx=1071M  voltxraw=467.4M  voltxacked=436.1M
maxiplen=1492  maxrxmss=1452  maxtxmss=1452
pingcnt=38487  pongcnt=36101
txspeed=18041  fixed=0  had_bounce=1  easy=743/2000

spd tsclear

Mit dem Kommando spd tsclear löscht man die Traffic Shaping Einstellungen für die aktuellen Verbindungen. Es werden die aktuellen Daten in der entsprechenden Sektion der Datei data.ini gelöscht. Die Verbindung kann nun neu eingemessen werden.

Example:

C:\Programme\cFosSpeed>spd tsclear
traffic shaping settings cleared.

spd dump

With the dump command you can write a text file (dump.txt) that records all datapackets.

Example:

C:\Programme\cFosSpeed>spd dump ip
dump ip (64)
dump data: IP packets.

C:\Programme\cFosSpeed>spd dump off
dump off (0)

functions:

    on  : trrn on writing of dump file
    off : trrn of writing of dump file
    in  : dump only incoming data packets
    out : dump only outgoing data packets
    net :
    app :
    ign :
    ip  : dump IP packets (possibly fragmented)
    ipr : dump IP datagrams (after IP reassembly).

spd cstat

Mit dem Kommando cstat erhält man eine Upload-Statistik für versendete Datenpakete der einzelnen cFosSpeed Traffic Shaping Klassen (highest, higher, high, default, low und lowest).

In der ersten Zeile der Befehlsausgabe wir angegeben, ob Traffic Shaping aktiviert ist. Außerdem wir hier die Upload-Bandbreite in cps angegeben (txspeed) und der maximale queue overflow Wert.

Example:

C:\Programme\cFosSpeed>spd cstat
shaping is currently enabled; txspeed = 19659, max_queue_size = 58,977

class highest -prio 100
  sent            2,431 (  4%) packets         68,068 (  0%) bytes
  in queue            0        packets              0        bytes

class higher -prio 90
  sent           16,777 ( 34%) packets        671,716 (  3%) bytes
  in queue            0        packets              0        bytes

class high -prio 80
  sent           10,489 ( 21%) packets      1,235,682 (  5%) bytes
  in queue            0        packets              0        bytes

class default
  sent           14,593 ( 29%) packets     19,897,796 ( 90%) bytes
  in queue            0        packets              0        bytes

class low -prio 0 -speed 25%,-10
  sent            4,820 (  9%) packets        221,720 (  1%) bytes
  in queue            0        packets              0        bytes

class lowest -prio 0 -speed 25%,-30
  sent                0 (  0%) packets              0 (  0%) bytes
  in queue            0        packets              0        bytes

class drop
  dropped             0        packets              0        bytes

queue overflow        0        packets              0        bytes

spd ver

Mit dem Kommando spd ver werden Angaben zur aktuell installierten Version ausgegeben. Es werden Versionsnummer, build-Nummer und Installationsdatum inklusive des Installations-Zeitpunktes angezeigt. Außerdem erhält man Angaben zum verwendeten Betriebssystem und zum verwendeten Prozessor. Zum Schluss wird das aktuelle Installationsdatum angegeben.

Example:

C:\Programme\cFosSpeed>spd ver
This is cFosSpeed v3.01, build 1140 (Jun 27 2006, 16:46:53)
Copyright (c) 2003-2006 Chris Lueders, Martin Winkler -- http://www.cfos.de

OS: Microsoft Windows XP Uniprocessor Free v5.01 SP2, Build 2600, LangId 0407
OS build is known as 'Windows XP'
CPU: GenuineIntel; Type 0; Family 15, Model 2, Step 9; Features=bfebfbff
Time: 2006-06-30 10:05:44.921
Using performance counter running at 3.579 MHz

Homedir is 'C:\Programme\cFosSpeed\'

spd gset

With the copmmand spd gset some of the cFosSpeed variables are listed. They switched on (1), off (0) or set to certain value. To switch a function on and off or set it to a certain value you can use commands with the folowing structure spd gset <function>=X (where X is 1, 0 or the value to be set)

If you add -save you can save the settings and they will be also set after the next reboot of your system.

Enter spd gset and you will get:

C:\Programs\cFosSpeed>spd gset
analyze_rtp = 1
balloon_no_pings = 1
dump_arp = 1
dump_framing = 0
dump_sessions = 0
dump_tcp_data = 0
dump_udp_data = 1
firewall = 0
func_trace = 0
handle_mss = 1
l7_detect = 1
latency = 2
max_dump_size = 10485760 (10 M)
max_fwlog_size = 4194304 (4 M)
max_pinglog_size = 1048576 (1 M)
max_queue_time = 3000
max_session_dump_size = 100000
max_trace_size = 131072 (128 K)
mcast_router = 0
passthru = 0
pinglog = 0
port_close_time = 300
prioritize_ssl = 1
rtp_trace = 0
rx_shape = 1
shape = 0
strict_rtp_check = 1
tcp_warn = 0
traffic_stat = 1
udp_timeout = 10000

examples

Turn on the firewall:

d:\tools>spd gset firewall=1
firewall = 1

Turn off permanently Traffic Shaping:

C:\Programs\cFosSpeed>spd gset shape=0 -save
shape = 0
value saved.

Turn on/off packet passthru:

C:\Programs\cFosSpeed>spd gset passthru=1
passthru = 1

C:\Programs\cFosSpeed>spd gset passthru=0
passthru = 0

possible values:

     0 : off
     1 : ignore all packets, pass them on to the next driver immediately.
     2 : ignore all packets, send them through the cFosSpeed connection
         engine, but don't do anything with them.

Disable writing of firewall log file fwlog.txt:

C:\Programme\cFosSpeed>spd gset fwlog 0 -save
fwlog = 0
value saved.

prevent cFos / cFosSpeed from saving data.ini, budget and traffic stats every 10 minutes: spd gset save_in_session 0 -save

C:\Programme\cFosSpeed>spd gset save_in_session 0 -save
save_in_session = 0
value saved.

Specify after how many seconds of inactivity the LAN port (and status window) will be closed automatically: spd gset port_close_time 'n'

C:\Programme\cFosSpeed>spd gset port_close_time 5
port_close_time = 5

spd reset_budget

With the copmmand spd reset_budget [n] you can reset online budget with the number 'n' (n=0..9). If 'n' is ommitted the current budget is is reset.