iDirect Technical Note

Subject: NetModem II+ Console Commands

Date: 15-Jun-04
Applies To: Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state

Command Role Bootloader Description Input Sub-command Output/Result

help E Yes Display commands N/A N/A
sn EX Yes Read/write the board serial number [Serail Number] N/A
laninfo EX Yes Read/write LAN configuration information [<ip> [<netmask> [<gateway>]]] N/A
# EX Yes NOOP for running scripts from the console N/A N/A
delay EX Yes Sleep # in msec N/A
reset EX Yes Resets the board N/A N/A
ps E Yes Lists Threads N/A N/A
version EX Yes Display build information N/A N/A
xon EX Yes Allow messages from other processes N/A N/A
xoff EX Yes Disallow messages from other processes N/A N/A
options E Yes Read/write/modify option N/A help Show options
flash Write to flash
show [<group>] [<key>] Display entries
showgroups Display group names
set <group> <key> <value> [group] key = value
del <group> <key> remove key from group
del <group> remove entire group
rollback load backup options file
commit write options to backup
cpu EX Yes CPU performance monitoring and related commands N/A tick display uptime in milliseconds
runs benchmark - gives indication of
CPU Benchmark N/A benchmark overhead
enables idle task monitoring (% of time cpu is
CPU Monitoring N/A toggle idle
eth E Yes Ethernet Control N/A help Show options
stats Show/reset stats
trace [on|off|toggle] Trace control
dump-rx [on|off|toggle] Rx dump control
dump-tx [on|off|toggle] Tx dump control
status EX Yes Display remote status N/A N/A
zeroize CX - FIPS only Zeroize Security Parameters N/A N/A
ERROR_STATE C Manually enter Error State N/A N/A
passwd EX Change password Old password and new password N/A
ping E Ping utility IP address N/A

1
iDirect Technical Note
Subject: NetModem II+ Console Commands
Date: 15-Jun-04
Applies To: Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state

Command Role Bootloader Description Input Sub-command Output/Result

install H Install utility N/A help
[show]
set defaults
set modem sn [=] <value>
set modem type [=] {noise|hub|remote|peer|relay}
set eth0 {address|netmask|gateway} [=] <value>
set sat0 {address|netmask|gateway} [=] <value>
set rip enabled [=] {off|on}
set nat enabled [=] {off|on}
set dhcp enabled [=] {off|on}
set dhcp gateway [=] <value>
set dhcp {primary|secondary} dns [=] <value>
set dhcp range [=] <value>-<value>
set rx frequency [=] <value>
set rx acqrange [=] <value>
set rx bitrate [=] <value>
set rx mode [=] {scpc|tdma}
set rx modulation [=] {qpsk}
set rx fecrate [=] {128|512}
set rx scrambling [=] {off|idr}
set rx diff [=] {off|on}
set rx specinv [=] {normal|inverted}
set tx frequency [=] <value>
set tx bitrate [=] <value>
set tx mode [=] {scpc|tdma}
set tx modulation [=] {qpsk}
set tx fecrate [=] {128|512}
set tx scrambling [=] {off|idr}
set tx diff [=] {off|on}
set tx specinv [=] {normal|inverted}
set tx power [=] <value>
set odu music [=] {off|on}
set odu rx {power|10mhz} [=] {off|on}
set odu tx {power|10mhz} [=] {off|on}
set timeplan out {fecblocks|symbols} [=] <value>
set timeplan in {fecblocks|symbols|slots} [=] <value>
set dns enabled [=] {off|on}
set dns {primary|secondary} {server|address} [=] <value>
add route <network> <netmask> <gateway> <interface>
del route <network> <netmask>
save [[and] reset]

2
iDirect Technical Note
Subject: NetModem II+ Console Commands
Date: 15-Jun-04
Applies To: Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state

Command Role Bootloader Description Input Sub-command Output/Result

read HX read from the processor address space [options] address N/A
write HX write to the processor address space [options] address value N/A
phy HX read PHY status register N/A N/A
sigtest H - FIPS only Verify Signatures file N/A N/A
extras E read/write/modify extras N/A help Show extras
flash Write to flash
show [<group>] [<key>] Display entries
showgroups Display group names
set <group> <key> <value> [group] key = value
del <group> <key> remove key from group
del <group> remove entire group
key rmt HX - FIPS only view/import remote encryption key key N/A
key net HX - FIPS only view/import network encryption key key N/A
csp HX - FIPS only Csp maintainance N/A help Show options
show [<group>] [<key>] Display entries
showgroups Display group names
save Write to file
set <group> <key> <value> [group] key = value
del <group> <key> remove key from group
del <group> remove entire group
enable Allows CSPs to be viewed (via show)
sockets E Displays Socket Status N/A N/A
heap E Displays diab heap size N/A stats Show/reset stats
alloc [size] Allocation trial
frag [size] Return maxium fragment <= size
size Show heap size
fusion Heap usage tracking

3
iDirect Technical Note
Subject: NetModem II+ Console Commands
Date: 15-Jun-04
Applies To: Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state

Command Role Bootloader Description Input Sub-command Output/Result

rx msgs E Control Receiver Messages [on|off|toggle] N/A
rx power E Show Received Composite power N/A N/A
rx freq E Show Received Frequency N/A N/A
rx snr E Show rx SNR N/A N/A
rx iflDC E Show/Set Rx IFL DC Power [on|off] N/A
rx ifl10 E Show/Set Rx IFL 10 Mhz [on|off] N/A
rx tfm H Show/Set TFM-OE [on|off] N/A
rx enable H Enable/Disable Demodulator [on|toggle|off] N/A
rx init H Initialize the Demodulator N/A N/A
rx bitrate H Show/Set bit rate parameter [Bit rate] N/A
dqt level H Show/Set DQT Level [DQT level] N/A
wam H Toggles Wide Aperture Mode N/A N/A
hub_fsd E Show hub fsd N/A N/A
rx framelen E Show Rx frame length N/A N/A
rx tdmlost E Returns TDMFrameLockLost Count on Remote N/A N/A
rx pointing H Control Antenna Pointing Mode [on|toggle|off] N/A
rx cof E Show Rx carrier offset N/A N/A
tx cw H Turn CW pattern on or off on|off N/A
tx 10 H turn 10 pattern on or off on|off N/A
tx power H Show/Set Transmit Power Level [tx power] N/A
tx freq E Show/Set Transmit Frequency [tx freq] N/A
tx iflDC E Show/Set Tx IFL DC Power [on|off] N/A
tx ifl10 E Show?Set Tx IFL 10MHz [on|off] N/A
tx atten1 H Show/Set test value for TxAttn 1 [value] N/A
tx atten2 H Show/Set test value for TxAttn 2 [value] N/A
tx alcdac H Show/Set test value for TxAlcDAC [value] N/A
tx enable H Enable/Disable Modulator [on|toggle|off] N/A
tx init H Initialize the modulator N/A N/A
tx bitrate H Show/Set bit rate parameter [Bit rate] N/A
tx_fsd E Displays/Sets frame start delay [fsd value] N/A
tx burst H Control the TDMA Burst [on|off] N/A
tx pn H Turn PN on or off on|off N/A
offline E Takes the remote offline N/A N/A
online E Takes the remote online N/A N/A
btp stats E Show Burst Timeplan Stats N/A N/A
inroute_list E Show Inroute List N/A N/A
tx_pn H Turn PN on or off on|off N/A
tx_framelen E Show Tx frame length N/A N/A
tx_fwcfg E Show Tx fpga configuration N/A N/A
tx_bp_clk H Control backplane clock [on|off] N/A
tdma E Display/Reset TDMA statistics N/A N/A

4
iDirect Technical Note
Subject: NetModem II+ Console Commands
Date: 15-Jun-04
Applies To: Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state

Command Role Bootloader Description Input Sub-command Output/Result

scpc E Display/Reset SCPC statistics N/A N/A
dumpb E Dumps bursts received on hub <n> <options> N/A
scc E SCC control N/A stats Show/reset stats
trace Toggle trace
dma E DMA control N/A trace Toggle trace
dns E DNS control N/A start Start DNS
stats Show/reset stats
params Show params
reset Reset stats
cache Show cache list
flush Flush cache list
stop Quit running dns
flash E Yes Read flash information N/A imagetable Read the flash image table
pds Read all program descriptors
capacity Calculate flash capacity in bytes
used Calculate number of bytes used
erase <program id> Erase program
erase <image id> Erase image
defragment Attempt to reduce flash fragmentation
validate Validate and repair image table entries
latlong E Update LatLong Lat long information N/A
$ E Processes GPS NMEA message N/A N/A
rmtstat E Toggles printing Remote Status messages N/A N/A
prodtest E Production test mode control on|off N/A
dqt_config E Configure the DQT config values N/A
dqt_thresh E Set DQT input threshhold threshold N/A
dqt_cicshift E Set DQT CIC shifter value cic shift N/A
dqt_decrate E Set DQT decimation rate decimation rate N/A
dqt_demodkick E Control aquisition demod kick [on|off] N/A
uart E Yes Prints stats for uart N/A displays uart statistics
reset resets uart stats
pool E Yes MssgPool Control N/A stats Show/reset stats
total Show total
set total|free|low|high Set params
report Report
timer E Yes Timer control N/A list Timer report
mac E Yes MAC control N/A stats Show/reset stats
params Show params
arp E Yes ARP control N/A stats Show/reset ARP layer stats
params Show/set/reset ARP layer params
table Show ARP table

5
iDirect Technical Note
Subject: NetModem II+ Console Commands
Date: 15-Jun-04
Applies To: Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state

Command Role Bootloader Description Input Sub-command Output/Result

ip E Yes Router control N/A interfaces Show all interfaces
table Show routing table
lookup <ip> Routing lookup
add <addr> <mask> <gate> <if> [<metric>] Add static route
del <addr> <mask> <gate> [<if>] Delete route
<if> [stats|params] Show interface stats/params
igmp E Yes Multicast control N/A table Show igmp table
load E Yes TFTP control <address> <filename> N/A Load file with TFTP client utility
ll E Link Layer control N/A stats Show/reset stats
params Show/set/reset params
bounce Bounce LL
sar E SAR control N/A stats Show/reset stats
Show/set/reset params
vlan E Vlan control N/A stats Show/reset stats
params Show/set/reset params
spoof E TCP acceleration control N/A stats Show/reset stats
params Show/set/reset params
debug [level|on|off] Spoof debug control
dump Show active TCP session
udp E UDP control N/A stats Show/reset stats
params Show/set/reset params
debug [level|on|off] Udp debug control
dump Show active UDP session
ipv4 E IPv4 control N/A stats Show/set/reset params
params Show/reset stats
dhcp E DHCP server control N/A stats Show/reset stats
params Show params
leases DHCP lease
scans Show DHCP info
debug [level|on|off] Debug DHCP
mcvlan E MC-VLAN Layer Control N/A stats Show/reset stats
params Show/set/reset params
enc H Remote encryption control N/A enable Enable remote encryption
stats Show/reset stats
params Show/set/reset params
disable Disable remote encryption
debug [level|on|off] Debug control

6
iDirect Technical Note
Subject: NetModem II+ Console Commands
Date: 15-Jun-04
Applies To: Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state

Command Role Bootloader Description Input Sub-command Output/Result

encs H Remote encryption session control N/A stats Show/reset stats
params Show/set/reset params
debug [level|on|off] Debug control
bounce Bounce
update Update
nenc H Network encryption control N/A enable Enable network encryption
stats Show/reset stats
params Show/set/reset params
disable Disable network encryption
debug [level|on|off] Debug control
nencs H Network encryption session control N/A stats Show/reset stats
params Show/set/reset params
debug [level|on|off] Debug control
bounce Bounce
update Update
qos E QoS control N/A rules Show QoS rules
status [reset] Show/reset QoS stats
pad E PAD control N/A stats Show/reset stats
params Show/set/reset params
debug [level|on|off] Debug control
demand E Demand control N/A stats Show/reset stats
params Show params
oobc E OOBC control N/A stats Show/reset stats
params Show params
oob E OOB control N/A stats Show/reset stats
params Show params
demand Dump realtime demand
sweeplog E Toggles Sweep Log info N/A N/A
ucplog E Toggles Printing Transmitter Adjustments and DMATrailer N/A N/A
toggleucp E Toggles Printing UCP Command Received N/A N/A
remotestate E Displays the Current Remote State N/A N/A
nat E NAT control N/A stats Show/reset stats
params Show params
rules Dump NAT rules