iDirect Technical Note

Subject:
Date:
Applies To:

NetModem II+ Console Commands

15-Jun-04
Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state
Command
help
sn
laninfo
#
delay
reset
ps
version
xon
xoff
options

Role
E
EX
EX
EX
EX
EX
E
EX
EX
EX
E

Bootloader
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes

Description
Display commands
Read/write the board serial number
Read/write LAN configuration information
NOOP for running scripts from the console
Sleep
Resets the board
Lists Threads
Display build information
Allow messages from other processes
Disallow messages from other processes
Read/write/modify option

Input
N/A
[Serail Number]
[<ip> [<netmask> [<gateway>]]]
N/A
# in msec
N/A
N/A
N/A
N/A
N/A
N/A

cpu

EX

Yes

CPU performance monitoring and related commands

N/A

Sub-command
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
help
flash
show [<group>] [<key>]
showgroups
set <group> <key> <value>
del <group> <key>
del <group>
rollback
commit
tick

CPU Benchmark

N/A

benchmark

CPU Monitoring
Ethernet Control

N/A
N/A

Display remote status

Zeroize Security Parameters
Manually enter Error State
Change password
Ping utility

N/A
N/A
N/A
Old password and new password
IP address

toggle
help
stats
trace [on|off|toggle]
dump-rx [on|off|toggle]
dump-tx [on|off|toggle]
N/A
N/A
N/A
N/A
N/A

eth

Yes

status
zeroize
ERROR_STATE
passwd
ping

EX
CX - FIPS only
C
EX
E

Yes

Output/Result

Show options
Write to flash
Display entries
Display group names
[group] key = value
remove key from group
remove entire group
load backup options file
write options to backup
display uptime in milliseconds
runs benchmark - gives indication of
overhead
enables idle task monitoring (% of time cpu is
idle
Show options
Show/reset stats
Trace control
Rx dump control
Tx dump control

iDirect Technical Note

Subject:
Date:
Applies To:

NetModem II+ Console Commands

15-Jun-04
Version 5.0.0 and Later

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

Role
H

Bootloader

Description
Install utility

Input
N/A

Sub-command
Output/Result
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]

iDirect Technical Note

Subject:
Date:
Applies To:

NetModem II+ Console Commands

15-Jun-04
Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state
Command
read
write
phy
sigtest
extras

Role
HX
HX
HX
H - FIPS only
E

key rmt
key net
csp

sockets
heap

Bootloader

Description
read from the processor address space
write to the processor address space
read PHY status register
Verify Signatures file
read/write/modify extras

Input
[options] address
[options] address value
N/A
N/A
N/A

HX - FIPS only
HX - FIPS only
HX - FIPS only

view/import remote encryption key

view/import network encryption key
Csp maintainance

key
key
N/A

E
E

Displays Socket Status

Displays diab heap size

N/A
N/A

Sub-command
N/A
N/A
N/A
N/A
help
flash
show [<group>] [<key>]
showgroups
set <group> <key> <value>
del <group> <key>
del <group>
N/A
N/A
help
show [<group>] [<key>]
showgroups
save
set <group> <key> <value>
del <group> <key>
del <group>
enable
N/A
stats
alloc [size]
frag [size]
size
fusion

Output/Result

Show extras
Write to flash
Display entries
Display group names
[group] key = value
remove key from group
remove entire group

Show options
Display entries
Display group names
Write to file
[group] key = value
remove key from group
remove entire group
Allows CSPs to be viewed (via show)
Show/reset stats
Allocation trial
Return maxium fragment <= size
Show heap size
Heap usage tracking

iDirect Technical Note

Subject:
Date:
Applies To:

NetModem II+ Console Commands

15-Jun-04
Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state
Command
rx msgs
rx power
rx freq
rx snr
rx iflDC
rx ifl10
rx tfm
rx enable
rx init
rx bitrate
dqt level
wam
hub_fsd
rx framelen
rx tdmlost
rx pointing
rx cof
tx cw
tx 10
tx power
tx freq
tx iflDC
tx ifl10
tx atten1
tx atten2
tx alcdac
tx enable
tx init
tx bitrate
tx_fsd
tx burst
tx pn
offline
online
btp stats
inroute_list
tx_pn
tx_framelen
tx_fwcfg
tx_bp_clk
tdma

Role
E
E
E
E
E
E
H
H
H
H
H
H
E
E
E
H
E
H
H
H
E
E
E
H
H
H
H
H
H
E
H
H
E
E
E
E
H
E
E
H
E

Bootloader

Description
Control Receiver Messages
Show Received Composite power
Show Received Frequency
Show rx SNR
Show/Set Rx IFL DC Power
Show/Set Rx IFL 10 Mhz
Show/Set TFM-OE
Enable/Disable Demodulator
Initialize the Demodulator
Show/Set bit rate parameter
Show/Set DQT Level
Toggles Wide Aperture Mode
Show hub fsd
Show Rx frame length
Returns TDMFrameLockLost Count on Remote
Control Antenna Pointing Mode
Show Rx carrier offset
Turn CW pattern on or off
turn 10 pattern on or off
Show/Set Transmit Power Level
Show/Set Transmit Frequency
Show/Set Tx IFL DC Power
Show?Set Tx IFL 10MHz
Show/Set test value for TxAttn 1
Show/Set test value for TxAttn 2
Show/Set test value for TxAlcDAC
Enable/Disable Modulator
Initialize the modulator
Show/Set bit rate parameter
Displays/Sets frame start delay
Control the TDMA Burst
Turn PN on or off
Takes the remote offline
Takes the remote online
Show Burst Timeplan Stats
Show Inroute List
Turn PN on or off
Show Tx frame length
Show Tx fpga configuration
Control backplane clock
Display/Reset TDMA statistics

Input
[on|off|toggle]
N/A
N/A
N/A
[on|off]
[on|off]
[on|off]
[on|toggle|off]
N/A
[Bit rate]
[DQT level]
N/A
N/A
N/A
N/A
[on|toggle|off]
N/A
on|off
on|off
[tx power]
[tx freq]
[on|off]
[on|off]
[value]
[value]
[value]
[on|toggle|off]
N/A
[Bit rate]
[fsd value]
[on|off]
on|off
N/A
N/A
N/A
N/A
on|off
N/A
N/A
[on|off]
N/A

Sub-command
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A

Output/Result

iDirect Technical Note

Subject:
Date:
Applies To:

NetModem II+ Console Commands

15-Jun-04
Version 5.0.0 and Later

Role Key:
E = Everyone
C = Crypto officer
H = Highest level
X = Error state
Command
scpc
dumpb
scc

Role
E
E
E

dma
dns

E
E

flash

latlong
$
rmtstat
prodtest
dqt_config
dqt_thresh
dqt_cicshift
dqt_decrate
dqt_demodkick
uart

E
E
E
E
E
E
E
E
E
E

Bootloader

Description
Display/Reset SCPC statistics
Dumps bursts received on hub
SCC control

Input
N/A
<n> <options>
N/A

DMA control
DNS control

N/A
N/A

Yes

Read flash information

N/A

Yes

Update LatLong
Processes GPS NMEA message
Toggles printing Remote Status messages
Production test mode control
Configure the DQT
Set DQT input threshhold
Set DQT CIC shifter value
Set DQT decimation rate
Control aquisition demod kick
Prints stats for uart

Lat long information

N/A
N/A
on|off
config values
threshold
cic shift
decimation rate
[on|off]
N/A

pool

Yes

MssgPool Control

N/A

timer
mac

E
E

Yes
Yes

Timer control
MAC control

N/A
N/A

arp

Yes

ARP control

N/A

Sub-command
N/A
N/A
stats
trace
trace
start
stats
params
reset
cache
flush
stop
imagetable
pds
capacity
used
erase <program id>
erase <image id>
defragment
validate
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
reset
stats
total
set total|free|low|high
report
list
stats
params
stats
params
table

Output/Result

Show/reset stats
Toggle trace
Toggle trace
Start DNS
Show/reset stats
Show params
Reset stats
Show cache list
Flush cache list
Quit running dns
Read the flash image table
Read all program descriptors
Calculate flash capacity in bytes
Calculate number of bytes used
Erase program
Erase image
Attempt to reduce flash fragmentation
Validate and repair image table entries

displays uart statistics

resets uart stats
Show/reset stats
Show total
Set params
Report
Timer report
Show/reset stats
Show params
Show/reset ARP layer stats
Show/set/reset ARP layer params
Show ARP table

iDirect Technical Note

Subject:
Date:
Applies To:

NetModem II+ Console Commands

15-Jun-04
Version 5.0.0 and Later

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

Role
E

Bootloader
Yes

Description
Router control

Input
N/A

igmp
load
ll

E
E
E

Yes
Yes

Multicast control
TFTP control
Link Layer control

N/A
<address> <filename>
N/A

sar

SAR control

N/A

vlan

Vlan control

N/A

spoof

TCP acceleration control

N/A

udp

UDP control

N/A

ipv4

IPv4 control

N/A

dhcp

DHCP server control

N/A

mcvlan

MC-VLAN Layer Control

N/A

enc

Remote encryption control

N/A

Sub-command
interfaces
table
lookup <ip>
add <addr> <mask> <gate> <if> [<metric>]
del <addr> <mask> <gate> [<if>]
<if> [stats|params]
table
N/A
stats
params
bounce
stats
stats
params
stats
params
debug [level|on|off]
dump
stats
params
debug [level|on|off]
dump
stats
params
stats
params
leases
scans
debug [level|on|off]
stats
params
enable
stats
params
disable
debug [level|on|off]

Output/Result
Show all interfaces
Show routing table
Routing lookup
Add static route
Delete route
Show interface stats/params
Show igmp table
Load file with TFTP client utility
Show/reset stats
Show/set/reset params
Bounce LL
Show/reset stats
Show/set/reset params
Show/reset stats
Show/set/reset params
Show/reset stats
Show/set/reset params
Spoof debug control
Show active TCP session
Show/reset stats
Show/set/reset params
Udp debug control
Show active UDP session
Show/set/reset params
Show/reset stats
Show/reset stats
Show params
DHCP lease
Show DHCP info
Debug DHCP
Show/reset stats
Show/set/reset params
Enable remote encryption
Show/reset stats
Show/set/reset params
Disable remote encryption
Debug control

iDirect Technical Note

Subject:
Date:
Applies To:

NetModem II+ Console Commands

15-Jun-04
Version 5.0.0 and Later

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

Role
H

nenc

Bootloader

Description
Remote encryption session control

Input
N/A

Network encryption control

N/A

nencs

Network encryption session control

N/A

qos

QoS control

N/A

pad

PAD control

N/A

demand

Demand control

N/A

oobc

OOBC control

N/A

oob

OOB control

N/A

sweeplog
ucplog
toggleucp
remotestate
nat

E
E
E
E
E

Toggles Sweep Log info

Toggles Printing Transmitter Adjustments and DMATrailer
Toggles Printing UCP Command Received
Displays the Current Remote State
NAT control

N/A
N/A
N/A
N/A
N/A

Sub-command
stats
params
debug [level|on|off]
bounce
update
enable
stats
params
disable
debug [level|on|off]
stats
params
debug [level|on|off]
bounce
update
rules
status [reset]
stats
params
debug [level|on|off]
stats
params
stats
params
stats
params
demand
N/A
N/A
N/A
N/A
stats
params
rules

Output/Result
Show/reset stats
Show/set/reset params
Debug control
Bounce
Update
Enable network encryption
Show/reset stats
Show/set/reset params
Disable network encryption
Debug control
Show/reset stats
Show/set/reset params
Debug control
Bounce
Update
Show QoS rules
Show/reset QoS stats
Show/reset stats
Show/set/reset params
Debug control
Show/reset stats
Show params
Show/reset stats
Show params
Show/reset stats
Show params
Dump realtime demand

Show/reset stats
Show params
Dump NAT rules