Escolar Documentos
Profissional Documentos
Cultura Documentos
---------------------------------------------------------------------------
CM/CmHal>
man
CM/NonVol/CM Motorola NonVol>
CM/NonVol/CM Motorola NonVol> man read
CM/NonVol/CM Motorola NonVol> man read
COMMAND: read
USAGE: read [both|perm|dyn]
DESCRIPTION:
Reads the specified section of non-volatile settings from non-volatile
memory. If 'both' is specified or there are no parameters, then both
Permanent and Dynamic settings will be read. Otherwise, only the section
specified will be read. This will destroy any changes you have made if you
haven't written them!
EXAMPLES:
read -- Reads both Permanent and Dynamic sections of settings.
read perm -- Reads only the Permanent section of non-vol settings.
---------------------------------------------------------------------------
CM/CmHal>
man
CM/NonVol/HalIf NonVol>
CM/NonVol/HalIf NonVol> man tftp_write
CM/NonVol/HalIf NonVol> man tftp_write
COMMAND: tftp_write
USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
DESCRIPTION:
Causes the Permanent or Dynamic settings data to be written to a server via
TFTP. Normally, this will operate on all settings groups; if you specify -g
then it will operate only on the current group (e.g. if you are in the SNMP
nonvol dir, then -g will cause only the SNMP settings group to be written).
EXAMPLES:
tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/NonVol/CM DOCSIS NonVol>
CM/NonVol/CM DOCSIS NonVol> man del_extra_data
CM/NonVol/CM DOCSIS NonVol> man del_extra_data
COMMAND: del_extra_data
USAGE: del_extra_data [both|perm|dyn]
DESCRIPTION:
Gets rid of any extra data that is assiociated with the settings. The extra
data is usually caused by a downgrade, where settings written by a newer
version are not understood by the older version, but are stored so that they
will still exist when the new code is run. However, in some cases, it is
desirable to get rid of them if they are not going to be used.
EXAMPLES:
del_extra_data perm -- Gets rid of extra permanent data.
---------------------------------------------------------------------------
CM/EmbeddedTarget>
man
CM/DocsisCtl/dsxTest>
CM/DocsisCtl/dsxTest> man autoDsxTest
CM/DocsisCtl/dsxTest> man autoDsxTest
COMMAND: autoDsxTest
USAGE: autoDsxTest [-p] [-v] [-r] [-a] [-s StartIndex] [-e EndIndex] [-t Delay
TimeMs]
DESCRIPTION:
Initiate the automatic DSx test suite. This runs a fairly comprehensive
script to test a large number of DSx permutations. If the script encounters
a problem, it will stop unless auto-recovery is enabled. Parameters:
-p : just prints the steps that the script would take
-v : verbose, print extra information (settings values)
-r : enable auto-recovery
-a : causes Admitted and Active flow sets to be sent separately
-s : the start index (default=beginning of script)
-e : the end index (default=end of script)
-t : time to pause (in milliseconds) between steps in the script
When using -s and -e, note that some steps of the script may require previous
steps in order to run correctly; it is your responsibility to ensure that all
prerequisites are met.
EXAMPLES:
autoDsxTest -r -- Runs the whole test suite, auto-recover enabled
autoDsxTest -p -- Prints what the script would do
autoDsxTest -s4 -e7 -- Runs just steps 4-7 of the script
autoDsxTest -v -- Does verbose printing
autoDsxTest -t1000 -- Delays 1 second between each step
---------------------------------------------------------------------------
CM/DocsisCtl/dsxTest>
man
CM/Flash>
CM/Flash> man close
CM/Flash> man close
COMMAND: close
USAGE: close
DESCRIPTION:
Closes the flash driver, allowing the rest of the application to use it.
Calling this more than once has no effect.
EXAMPLES:
close --
---------------------------------------------------------------------------
CM/Flash>
man
CM/Forwarder>
CM/Forwarder> man filter_logging_show
CM/Forwarder> man filter_logging_show
COMMAND: filter_logging_show
USAGE: filter_logging_show
DESCRIPTION:
Display the packet filter logging settings (protocol, mac, ip, and port).
EXAMPLES:
filter_logging_show --
---------------------------------------------------------------------------
CM/Forwarder>
man
CM/IpHal>
CM/IpHal> man bootloader
CM/IpHal> man bootloader
COMMAND: bootloader
USAGE: bootloader [-f] IpAddress Filename{255}
DESCRIPTION:
Downloads the specified bootloader image from the TFTP server and stores it
to the bootloader region. The image must be valid for the platform, and must
have a ProgramStore header (but no compression).
EXAMPLES:
bootloader 11.24.4.3 bootloader3360_2_1_2_c0.bin -- Upgrades the
bootloader.
bootloader -f 11.24.4.3 bootloader3360_2_1_2_c0.bin -- Accepts a bootloader
with non-matching s
ignature.
---------------------------------------------------------------------------
CM/IpHal>
man
CM/Forwarder>
CM/Forwarder> man halif_show
CM/Forwarder> man halif_show
COMMAND: halif_show
USAGE: halif_show [-s] [-d]
DESCRIPTION:
Shows all of the HalIf objects that have been registered. If -s is
specified, then it also prints a table of the interfaces, showing who can
transmit to whom. Otherwise, it just prints the descriptions. If -d is
specified, then it prints the detailed HalIf object contents, including
counters, Snoops, etc.
EXAMPLES:
halif_show --
---------------------------------------------------------------------------
CM/Forwarder>
man
CM/NonVol/HalIf NonVol>
CM/NonVol/HalIf NonVol> man cm_ds_ref_freq
CM/NonVol/HalIf NonVol> man cm_ds_ref_freq
COMMAND: cm_ds_ref_freq
USAGE: cm_ds_ref_freq [frequency{1..4294967295}]
DESCRIPTION:
Allows you to specify the reference frequency that is being provided to the
CM downstream tuner. This depends on what oscillator/crystal is installed on
the modem board. This only takes effect at system startup; you will need to
reboot.
EXAMPLES:
cm_ds_ref_freq -- Shows the CM Downstream Reference Frequency.
cm_ds_ref_freq 24000000 -- Sets the CM Downstream Reference Frequency to 24
MHz.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/Ping>
CM/Ping> man verify_enable
CM/Ping> man verify_enable
COMMAND: verify_enable
USAGE: verify_enable [true|false]
DESCRIPTION:
Enables/disables verification of ping replies. If enabled, and if waiting
for replies is enabled, then if a reply is received, it will verify that it
matches the ping that was sent, and that all of the data is intact.
EXAMPLES:
verify_enable 1 -- Enables verification of the ping reply.
---------------------------------------------------------------------------
CM/Ping>
man
CM/NonVol/DOCSIS EventLog NonVol>
CM/NonVol/DOCSIS EventLog NonVol> man show
CM/NonVol/DOCSIS EventLog NonVol> man show
COMMAND: show
USAGE: show
DESCRIPTION:
Displays the current non-volatile settings values for both the Permanent and
Dynamic sections.
EXAMPLES:
show --
---------------------------------------------------------------------------
CM/NonVol/Factory NonVol>
man
CM/NonVol/HalIf NonVol>
CM/NonVol/HalIf NonVol> man zone
CM/NonVol/HalIf NonVol> man zone
COMMAND: zone
USAGE: zone [Bitmask{0xffff}]
DESCRIPTION:
Prints or sets the HAL debug zones; this determines what debug messages will
be displayed by HAL drivers. These bits correspond to the HAL debug zones:
0x0001 -- INIT
0x0002 -- TEST1
0x0004 -- TEST2
0x0008 -- TEST3
0x0010 -- TEST4
0x0020 -- TEST5
0x0040 -- TEST6
0x0080 -- BPI
0x0100 -- DOWNSTREAM
0x0200 -- UPSTREAM
0x0400 -- TUNER
0x0800 -- RANGING
0x1000 -- TESTSRAM
0x2000 -- TESTREG
0x4000 -- WARNING
0x8000 -- ERROR
EXAMPLES:
zone -- Shows the enabled HAL debug zones.
zone 0xffff -- Enables all HAL debug zones.
zone 0xc000 -- Enables Error and Warning zones.
zone 0 -- Disables all HAL debug zones.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/NonVol/User Interface NonVol>
CM/NonVol/User Interface NonVol> man password
CM/NonVol/User Interface NonVol> man password
COMMAND: password
USAGE: password [Password{15}]
DESCRIPTION:
Allows you to show/change the password that must be used when accessing the
console via remote access. If the password is empty, then none is required.
The password is case sensitive.
EXAMPLES:
password -- Shows the current password.
password CableModem -- Sets the password.
---------------------------------------------------------------------------
CM/CmHal>
man
CM/Forwarder>
CM/Forwarder> man port_filter_logging
CM/Forwarder> man port_filter_logging
COMMAND: port_filter_logging
USAGE: port_filter_logging [-s] [-d] [-b] [-c] [port_number]
DESCRIPTION:
port_filter_logging -s 67 - sets a filter for a source tcp/udp port.
port_filter_logging -d 68 - sets a filter for a destination tcp/udp port.
port_filter_logging -b 68 - sets a filter for both the src and dest tcp/udp
port.
port_filter_logging -c - clears all port filters.
EXAMPLES:
port_filter_logging -<flag> <port number> --
---------------------------------------------------------------------------
CM/Forwarder>
man
CM/NonVol/CM BPI NonVol>
CM/NonVol/CM BPI NonVol> man (bpi)
CM/NonVol/CM BPI NonVol> man (bpi)
! ? REM cd dir
find_command help history instances ls
man pwd sleep syntax system_time
usage
----
change_key clear_device code_access cvc_access defaults
del_extra_data {flush} key_location manufactured print
read show stats tftp_read tftp_write
write
----
CM/NonVol/CM BPI NonVol>
man
CM/NonVol/HalIf NonVol>
CM/NonVol/HalIf NonVol> man tftp_read
CM/NonVol/HalIf NonVol> man tftp_read
COMMAND: tftp_read
USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
DESCRIPTION:
Causes the Permanent or Dynamic settings data to be read from a server via
TFTP. The file must be generated correctly, with all of the headers, CRC,
and other information that would exist on the NonVol device. The file will
be read and evaluated for correctness before it is stored in the device. If
the file is rejected then the settings will be read from the device to undo
any changes. Normally, this will operate on all settings groups; if you
specify -g then it will operate only on the current group (e.g. if you are in
the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
read).
EXAMPLES:
tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/NonVol/User Interface NonVol>
CM/NonVol/User Interface NonVol> man (userif)
CM/NonVol/User Interface NonVol> man (userif)
! ? REM cd dir
find_command help history instances ls
man pwd sleep syntax system_time
usage
----
clear_device defaults del_extra_data dhcp_settings fields
{flush} http_acl_host_add http_acl_host_remove
http_acl_hosts_clear http_admin http_adv_ipstacks
http_enable http_ipstacks http_password_idle_timeout
http_password_seed http_socket_show http_user
inactivity_timeout ip_stack_number manufactured password
read severities show ssh_enable ssh_ipstacks
stats telnet_enable telnet_ipstacks tftp_read tftp_write
user_name write
----
CM/NonVol/User Interface NonVol>
man
CM/NonVol/CM SNMP NonVol>
CM/NonVol/CM SNMP NonVol> man clear_device
CM/NonVol/CM SNMP NonVol> man clear_device
COMMAND: clear_device
USAGE: clear_device [both|perm|dyn]
DESCRIPTION:
Tells the nonvol device to wipe out the specified settings section. All data
will be lost; the device should be restored to its 'virgin' state. For flash
devices, the flash block is erased; for disk devices, the file is erased.
EXAMPLES:
clear_device -- Clears both Permanent and Dynamic sections.
clear_device perm -- Clears only the Permanent section.
---------------------------------------------------------------------------
CM/Ping>
man
CM/NonVol/User Interface NonVol>
CM/NonVol/User Interface NonVol> man http_acl_hosts_clear
CM/NonVol/User Interface NonVol> man http_acl_hosts_clear
COMMAND: http_acl_hosts_clear
USAGE: http_acl_hosts_clear
DESCRIPTION:
Clear the remote hosts list
EXAMPLES:
http_acl_hosts_clear -- Clears the remote hosts list
---------------------------------------------------------------------------
CM/MsgLog>
man
CM/NonVol/CM SNMP NonVol>
CM/NonVol/CM SNMP NonVol> man docsDevSwAdminStatus
CM/NonVol/CM SNMP NonVol> man docsDevSwAdminStatus
COMMAND: docsDevSwAdminStatus
USAGE: docsDevSwAdminStatus [Number{1..3}]
DESCRIPTION:
Sets the docsDevSwAdminStatus value that will be reported via SNMP. Valid
values are:
1 -- upgradeFromMgt
2 -- allowProvisioningUpgrade
3 -- ignoreProvisioningUpgrade
EXAMPLES:
docsDevSwAdminStatus 2 --
---------------------------------------------------------------------------
CM/NonVol>
man
CM/NonVol/DOCSIS EventLog NonVol>
CM/NonVol/DOCSIS EventLog NonVol> man clear_device
CM/NonVol/DOCSIS EventLog NonVol> man clear_device
COMMAND: clear_device
USAGE: clear_device [both|perm|dyn]
DESCRIPTION:
Tells the nonvol device to wipe out the specified settings section. All data
will be lost; the device should be restored to its 'virgin' state. For flash
devices, the flash block is erased; for disk devices, the file is erased.
EXAMPLES:
clear_device -- Clears both Permanent and Dynamic sections.
clear_device perm -- Clears only the Permanent section.
---------------------------------------------------------------------------
CM/NonVol/DOCSIS EventLog NonVol>
man
CM/NonVol/HalIf NonVol>
CM/NonVol/HalIf NonVol> man cm_us_ref_freq
CM/NonVol/HalIf NonVol> man cm_us_ref_freq
COMMAND: cm_us_ref_freq
USAGE: cm_us_ref_freq [frequency{1..4294967295}]
DESCRIPTION:
Allows you to specify the reference frequency that is being provided to the
CM upstream amp. This depends on what oscillator/crystal is installed on the
modem board. This only takes effect at system startup; you will need to
reboot.
EXAMPLES:
cm_us_ref_freq -- Shows the CM Upstream Reference Frequency.
cm_us_ref_freq 24000000 -- Sets the CM Upstream Reference Frequency to 24
MHz.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/Ping>
CM/Ping> man time_between_pings
CM/Ping> man time_between_pings
COMMAND: time_between_pings
USAGE: time_between_pings [Milliseconds]
DESCRIPTION:
Sets or shows the number of milliseconds that the ping helper will wait
before sending the next ping. Note that this does not include time spent
waiting for the reply or verifying it, or for time spent printing status
information. The actual resolution and accuracy of this depends on the
system (pSOS generally runs with a 10ms clock tick, so 10ms is the same as
15ms on that system).
EXAMPLES:
time_between_pings 100 -- Waits 100ms before sending the next ping.
---------------------------------------------------------------------------
CM/Ping>
man
CM/NonVol/CM SNMP NonVol>
CM/NonVol/CM SNMP NonVol> man stats
CM/NonVol/CM SNMP NonVol> man stats
COMMAND: stats
USAGE: stats
DESCRIPTION:
Prints stats about buffer usage for Dynamic and Permanent settings.
EXAMPLES:
stats --
---------------------------------------------------------------------------
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/DocsisCtl>
CM/DocsisCtl> man copy_image
CM/DocsisCtl> man copy_image
COMMAND: copy_image
USAGE: copy_image SourceImage{1..2} DestinationImage{1..2}
DESCRIPTION:
This causes the specified source image (stored in flash memory) to be copied
to the specified destination image. The source image must be valid, and must
be small enough to fit in the dest image slot.
EXAMPLES:
copy_image 2 1 -- Copies image2 to the image1 slot.
---------------------------------------------------------------------------
CM/DocsisCtl>
man
CM/NonVol/User Interface NonVol>
CM/NonVol/User Interface NonVol> man tftp_read
CM/NonVol/User Interface NonVol> man tftp_read
COMMAND: tftp_read
USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
DESCRIPTION:
Causes the Permanent or Dynamic settings data to be read from a server via
TFTP. The file must be generated correctly, with all of the headers, CRC,
and other information that would exist on the NonVol device. The file will
be read and evaluated for correctness before it is stored in the device. If
the file is rejected then the settings will be read from the device to undo
any changes. Normally, this will operate on all settings groups; if you
specify -g then it will operate only on the current group (e.g. if you are in
the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
read).
EXAMPLES:
tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
---------------------------------------------------------------------------
CM/IpHal>
man
CM/DocsisCtl/PropaneCtl>
CM/DocsisCtl/PropaneCtl> man discovery
CM/DocsisCtl/PropaneCtl> man discovery
COMMAND: discovery
USAGE: discovery IpAddress PortNumber{0..65535}
DESCRIPTION:
Simulates the CMTS sending a Propane Discovery packet to the CM. You must
specify the IP address and TCP/UDP port number that the CMTS would have sent
the packet from.
EXAMPLES:
discovery 192.168.190.3 2345 --
---------------------------------------------------------------------------
CM/DocsisCtl/PropaneCtl>
man
CM/HeapManager>
CM/HeapManager> man bcheck_enable
CM/HeapManager> man bcheck_enable
COMMAND: bcheck_enable
USAGE: bcheck_enable [true|false]
DESCRIPTION:
Turns on-the-fly bounds checking on or off in the heap manager (if compiled
in). When this is on, we will validate pointers, seed values, and other heap
state during each alloc and free. When off, you must run bcheck manually to
detect errors.
EXAMPLES:
bcheck_enable true --
---------------------------------------------------------------------------
CM/HeapManager>
man
CM/NonVol/DOCSIS EventLog NonVol>
CM/NonVol/DOCSIS EventLog NonVol> man clear_event
CM/NonVol/DOCSIS EventLog NonVol> man clear_event
COMMAND: clear_event
USAGE: clear_event index{-1..2147483647}
DESCRIPTION:
Causes an event at the specified index to be cleared. If you specify -1,
then all will be cleared.
EXAMPLES:
clear_event 0 -- Clears the event at index 0.
---------------------------------------------------------------------------
CM/Forwarder>
man
CM/Event Log>
CM/Event Log> man read
CM/Event Log> man read
COMMAND: read
USAGE: read
DESCRIPTION:
Read the event log from NV storage and rebuild the table.
EXAMPLES:
read --
---------------------------------------------------------------------------
CM/Event Log>
man
CM/NonVol/DOCSIS EventLog NonVol>
CM/NonVol/DOCSIS EventLog NonVol> man (event_log)
CM/NonVol/DOCSIS EventLog NonVol> man (event_log)
! ? REM cd dir
find_command help history instances ls
man pwd sleep syntax system_time
usage
----
clear_device clear_event defaults del_extra_data event
{flush} manufactured read show stats
tftp_read tftp_write write
----
CM/NonVol/DOCSIS EventLog NonVol>
man
CM/DocsisCtl>
CM/DocsisCtl> man l2vpn_show
CM/DocsisCtl> man l2vpn_show
COMMAND: l2vpn_show
USAGE: l2vpn_show
DESCRIPTION:
Shows the current state of the L2VPN object.
EXAMPLES:
l2vpn_show --
---------------------------------------------------------------------------
CM/DocsisCtl>
man
CM/NonVol/HalIf NonVol>
CM/NonVol/HalIf NonVol> man eth_duplex_full
CM/NonVol/HalIf NonVol> man eth_duplex_full
COMMAND: eth_duplex_full
USAGE: eth_duplex_full [true|false]
DESCRIPTION:
Allows you to specify the default ethernet link duplex This only takes
effect at system startup, and only if ethernet autonegotiation is disabled.
If set to true, then the link will be full duplex; otherwise it will be half
duplex.
EXAMPLES:
eth_duplex_full -- Shows the default ethernet link duplex.
eth_duplex_full true -- Sets the default ethernet link to full duplex.
eth_duplex_full false -- Sets the default ethernet link to half duplex.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/NonVol/Ds Cal NonVol>
CM/NonVol/Ds Cal NonVol> man coef
CM/NonVol/Ds Cal NonVol> man coef
COMMAND: coef
USAGE: coef tuner|if|fine|eq rowIndex{0..255} coefIndex{0..255} [value]
DESCRIPTION:
Sets the coefficient value for the Tuner, IF, Fine, or Equalizer table, using
the row and coef index specified.
EXAMPLES:
coef tuner 2 1 -5.781 -- Sets coef for Tuner[2][1] to -5.781
---------------------------------------------------------------------------
CM/Ping>
man
CM/Flash>
CM/Flash> man readDirect
CM/Flash> man readDirect
COMMAND: readDirect
USAGE: readDirect Number{1..8192} Offset
DESCRIPTION:
Uses the read direct function to access the flash memory data directly,
printing to the console. You must specify the number of bytes to read and
the offset into the region to start.
EXAMPLES:
readDirect 128 0 -- Reads 128 bytes at the beginning of the region
---------------------------------------------------------------------------
CM/Flash>
man
CM/NonVol/User Interface NonVol>
CM/NonVol/User Interface NonVol> man http_ipstacks
CM/NonVol/User Interface NonVol> man http_ipstacks
COMMAND: http_ipstacks
USAGE: http_ipstacks [Bitmask{0xff}]
DESCRIPTION:
Sets the bitmask of IP stacks that the HTTP server will listen for
connections. Of course, the specified IP stacks must be enabled if you want
to be able to HTTP in. Once the IP stack has an address (either static or
DHCP), we create a listen socket and bind it to that address.
EXAMPLES:
http_ipstacks 0x2 -- Allow connections only on IP stack2
http_ipstacks 0x3 -- Allow connections only on IP stack1 and stack2
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/NonVol/User Interface NonVol>
CM/NonVol/User Interface NonVol> man http_user
CM/NonVol/User Interface NonVol> man http_user
COMMAND: http_user
USAGE: http_user [ID{31}] [password{31}]
DESCRIPTION:
Sets or displays the HTTP user ID and password.
EXAMPLES:
http_user foo bar -- Sets the HTTP user ID to 'foo' and password to 'bar'.
http_user "" "" -- Sets the HTTP user ID and password to empty strings.
---------------------------------------------------------------------------
CM/NonVol/User Interface NonVol>
man
CM/IpHal>
CM/IpHal> man ipconfig
CM/IpHal> man ipconfig
COMMAND: ipconfig
USAGE: ipconfig [-l Number] StackNumber{1..4294967295} renew|release|static [I
pAddress] [SubnetMask] [RouterIpAddr]
DESCRIPTION:
Configures the specified IP stack:
'renew' starts DHCP (if not started) or renews the current lease.
'release' causes the current lease to be released, shutting down the IP
stack.
'static' configures the stack with the IP address/subnet mask/router
specified.
When using 'static', you must specify the IP address parameter. The subnet
and router are optional, but desirable.
EXAMPLES:
ipconfig 3 renew -- Starts DHCP on
stack 3, or renews t
he lease.
ipconfig 3 release -- Releases the IP
address on stack 3, s
huts down the s
tack.
ipconfig 3 static 11.24.70.5 -- Configures stack 3
with the address s
pecified, no router o
r subnet.
ipconfig 3 static 11.24.70.5 255.255.255.0 11.24.70.1 -- Sets stack 3 with
all parameters.
---------------------------------------------------------------------------
CM/IpHal>
man
CM/NonVol/Factory NonVol>
CM/NonVol/Factory NonVol> man read
CM/NonVol/Factory NonVol> man read
COMMAND: read
USAGE: read [both|perm|dyn]
DESCRIPTION:
Reads the specified section of non-volatile settings from non-volatile
memory. If 'both' is specified or there are no parameters, then both
Permanent and Dynamic settings will be read. Otherwise, only the section
specified will be read. This will destroy any changes you have made if you
haven't written them!
EXAMPLES:
read -- Reads both Permanent and Dynamic sections of settings.
read perm -- Reads only the Permanent section of non-vol settings.
---------------------------------------------------------------------------
CM/NonVol/Factory NonVol>
man
CM/Flash>
CM/Flash> man deinit
CM/Flash> man deinit
COMMAND: deinit
USAGE: deinit
DESCRIPTION:
Deinitializes the flash driver, making it release resouces. Note that the
flash device will be unusable after this, until you run the init command.
EXAMPLES:
deinit --
---------------------------------------------------------------------------
CM/Flash>
man
CM/NonVol/HalIf NonVol>
CM/NonVol/HalIf NonVol> man STATHR
CM/NonVol/HalIf NonVol> man STATHR
COMMAND: STATHR
USAGE: STATHR [value{0..65535}]
DESCRIPTION:
Sets a CM AGC Control register; if you don't know what it means, then you
probably have no business reading or writing new values anyway...
EXAMPLES:
STATHR 0x18 -- Sets the value to 0x18.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/NonVol/Ds Cal NonVol>
CM/NonVol/Ds Cal NonVol> man num_freq
CM/NonVol/Ds Cal NonVol> man num_freq
COMMAND: num_freq
USAGE: num_freq [numFreq{0..255}]
DESCRIPTION:
Changes the size of the DsCal table, setting the number of frequency bands
that will be stored. NOTE: This causes all tables to be cleared!
EXAMPLES:
num_freq 14 -- Configures the table for 14 frequency bands.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/NonVol/CM DOCSIS NonVol>
CM/NonVol/CM DOCSIS NonVol> man doc10_mcastpromisc
CM/NonVol/CM DOCSIS NonVol> man doc10_mcastpromisc
COMMAND: doc10_mcastpromisc
USAGE: doc10_mcastpromisc [true|false]
DESCRIPTION:
Enables or disables DOCSIS 1.0 multicast promisc. support. This flag only has
an effect if the code is built with DOCSIS 1.0 IGMP support!
EXAMPLES:
doc10_mcastpromisc true -- .
---------------------------------------------------------------------------
CM/NonVol>
man
CM/NonVol/CM DOCSIS NonVol>
CM/NonVol/CM DOCSIS NonVol> man fake_reg
CM/NonVol/CM DOCSIS NonVol> man fake_reg
COMMAND: fake_reg
USAGE: fake_reg true|false
DESCRIPTION:
Configures the system to do real or fake registration, depending on whether
you specify true or false. If you specify true, DHCP/ToD/TFTP are disabled,
and canned reg is enabled. If you specify false, then things are reversed.
EXAMPLES:
fake_reg true -- Configures for fake registration.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/Snoop>
CM/Snoop> man show
CM/Snoop> man show
COMMAND: show
USAGE: show
DESCRIPTION:
Causes the Snoops to display their internal state.
EXAMPLES:
show --
---------------------------------------------------------------------------
CM/Snoop>
man
CM/SNMP>
CM/SNMP> man agent_core_show
CM/SNMP> man agent_core_show
COMMAND: agent_core_show
USAGE: agent_core_show
DESCRIPTION:
Print agent-core specific info to the console.
EXAMPLES:
agent_core_show --
---------------------------------------------------------------------------
CM/SNMP>
man
CM/IpHal>
CM/IpHal> man clientif_debug
CM/IpHal> man clientif_debug
COMMAND: clientif_debug
USAGE: clientif_debug StackNumber{1..4294967295} Enable
DESCRIPTION:
Turns on debugging for the specified DHCP ClientIf object. This will show
information related to processing leases, packet generation, packet
processing, and timeouts.
EXAMPLES:
clientif_debug 1 true -- Turns on debugging for the DHCP ClientIf object for
stack 1.
---------------------------------------------------------------------------
CM/IpHal>
man
CM/NonVol/CM SNMP NonVol>
CM/NonVol/CM SNMP NonVol> man docsDevSwFilename
CM/NonVol/CM SNMP NonVol> man docsDevSwFilename
COMMAND: docsDevSwFilename
USAGE: docsDevSwFilename [String{127}]
DESCRIPTION:
Sets the docsDevSwFilename string that will be reported via SNMP.
EXAMPLES:
docsDevSwFilename myfile.bin --
---------------------------------------------------------------------------
CM/SNMP>
man
CM/DocsisCtl/PropaneCtl>
CM/DocsisCtl/PropaneCtl> man dsx_complete
CM/DocsisCtl/PropaneCtl> man dsx_complete
COMMAND: dsx_complete
USAGE: dsx_complete Successful
DESCRIPTION:
Simulates the completion of the DSC, with the specified result
(success/fail).
EXAMPLES:
dsx_complete true -- Simulate DSC completing successfully
---------------------------------------------------------------------------
CM/DocsisCtl/PropaneCtl>
man
CM/NonVol/CM DOCSIS NonVol>
CM/NonVol/CM DOCSIS NonVol> man (docsis)
CM/NonVol/CM DOCSIS NonVol> man (docsis)
! ? REM cd dir
find_command help history instances ls
man pwd sleep syntax system_time
usage
----
bpi_version clear_device concat_thresh defaults del_extra_data
dhcp_settings doc10_mcastpromisc ds_frequency enable
fake_reg {flush} ip_stack_number manufactured max_concat
queues rate_shaping_time read rng_class
rng_class_extension show startup_context startup_dsfreq
startup_uschan stats tftp_read tftp_timeout tftp_write
timer_disable ugs_depth ugs_table_entries us_channel
us_power write
----
CM/NonVol/CM DOCSIS NonVol>
man
CM/EmbeddedTarget>
CM/EmbeddedTarget> man start_perf_counters
CM/EmbeddedTarget> man start_perf_counters
COMMAND: start_perf_counters
USAGE: start_perf_counters [-t TpId{0..1}] icache|dcache
DESCRIPTION:
Enables and starts the MIPS performance counters for event set specified.
The -t parameter selects the TP (for multi-core CPUs only).
EXAMPLES:
start_perf_counters icache -t1 -- Enables performance counters for the
ICache module on TP1.
---------------------------------------------------------------------------
CM/EmbeddedTarget>
man
CM/CmHal>
CM/CmHal> man show_halif
CM/CmHal> man show_halif
COMMAND: show_halif
USAGE: show_halif
DESCRIPTION:
Causes the HalIf object to display its state.
EXAMPLES:
show_halif --
---------------------------------------------------------------------------
CM/CmHal>
man
CM/NonVol/HalIf NonVol>
CM/NonVol/HalIf NonVol> man cm_adv_map_runahead
CM/NonVol/HalIf NonVol> man cm_adv_map_runahead
COMMAND: cm_adv_map_runahead
USAGE: cm_adv_map_runahead [true|false]
DESCRIPTION:
Enables/disables Advance Map RunAhead support on supported hardware
platforms. Advance Map RunAhead feature uses an additional Docsis Map
processor to provide advance notice of upstream transmit opportunities and
therefore enables more efficient use of concatenation.
EXAMPLES:
cm_adv_map_runahead true -- Enables Advance Map RunAhead support.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/Flash>
CM/Flash> man autoTest
CM/Flash> man autoTest
COMMAND: autoTest
USAGE: autoTest bootloader|image1|image2|perm|dyn [BlockNumber]
DESCRIPTION:
Does an automated test suite on the specified flash block (in the specified
region) to ensure that all of the flash driver functions work correctly.
NOTE: any data in the specified block will be erased! Choose a block that
is not being used for anything important! Use the 'show' command to list the
blocks and how they are allocated.
If you omit the BlockNumber parameter, the test will be run over all blocks
in the region (destroying any data that is in the blocks).
In July 2004, we had to change the flash driver in order to support multiple
flash devices. As a result, you can no longer just specify the block number;
you must also specify the region that the block is in (the region maps to a
flash device, and the block number within that device will be tested). If
you specify a region that does not contain the block, then the test will
fail.
EXAMPLES:
autoTest image2 33 -- Performs the test suite on block 33 (which is in the
image2 region)
autoTest image2 -- Performs the test suite on all blocks in the image2
region
---------------------------------------------------------------------------
CM/Flash>
man
CM/Ping>
CM/Ping> man ping
CM/Ping> man ping
COMMAND: ping
USAGE: ping [-s] [IpAddress]
DESCRIPTION:
Begins pinging the specified IP address, using the current settings. If the
IP address is missing, then it uses the one that was previously set. If you
specify -s, then pinging will happen int he background until you type stop.
Otherwise, it will poll for a keypress.
EXAMPLES:
ping 10.24.4.3 -- Ping until a key is pressed.
ping -s -- Ping until the user types stop.
---------------------------------------------------------------------------
CM/Ping>
man
CM/NonVol/Ds Cal NonVol>
CM/NonVol/Ds Cal NonVol> man (ds-cal)
CM/NonVol/Ds Cal NonVol> man (ds-cal)
! ? REM cd dir
find_command help history instances ls
man pwd sleep syntax system_time
usage
----
clear_device clear_tables coef defaults del_extra_data
{flush} frequency ldaix_time manufactured master
num_coef num_freq num_ldaix offset read
show stats tftp_read tftp_write tuner_step
write
----
CM/NonVol/Ds Cal NonVol>
man
CM/NonVol/CM DOCSIS NonVol>
CM/NonVol/CM DOCSIS NonVol> man us_channel
CM/NonVol/CM DOCSIS NonVol> man us_channel
COMMAND: us_channel
USAGE: us_channel [channel{0..255}]
DESCRIPTION:
Sets the upstream channel that is considered the last 'happy home'.
EXAMPLES:
us_channel 1 -- Sets the 'happy home' to channel 1.
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/NonVol/CM SNMP NonVol>
CM/NonVol/CM SNMP NonVol> man ip_def_ignore
CM/NonVol/CM SNMP NonVol> man ip_def_ignore
COMMAND: ip_def_ignore
USAGE: ip_def_ignore [true|false]
DESCRIPTION:
Sets the behaviour of IP filters with regard to docsDevFilterIpDefault when
there are no active filters for the interface/direction under consideration.
If true, the default will be applied only if there are filters. If false,
default will be applied even if there are no filters.
EXAMPLES:
ip_def_ignore true -- docsDevFilterIpDefault ignored if no filters.
---------------------------------------------------------------------------
CM/DocsisCtl>
man
CM/NonVol/Factory NonVol>
CM/NonVol/Factory NonVol> man defaults
CM/NonVol/Factory NonVol> man defaults
COMMAND: defaults
USAGE: defaults [both|perm|dyn]
DESCRIPTION:
Restores the settings to default values. NOTE: This does not write to
NonVol memory! You must do this manually. Also note that some settings do
not have good defaults, particularly the Permanent section! Use this command
with extreme care!
EXAMPLES:
defaults -- Sets both Permanent and Dynamic sections to defaults.
defaults perm -- Sets only the Permanent section to defaults.
---------------------------------------------------------------------------
CM/NonVol/Factory NonVol>
man
CM/DocsisCtl>
CM/DocsisCtl> man stop_download
CM/DocsisCtl> man stop_download
COMMAND: stop_download
USAGE: stop_download
DESCRIPTION:
If a software download is in progress, this will stop it in its tracks. The
storage for the partially downloaded image will be cleared.
EXAMPLES:
stop_download --
---------------------------------------------------------------------------
CM/DocsisCtl>
man
CM/HeapManager>
CM/HeapManager> man last_error
CM/HeapManager> man last_error
COMMAND: last_error
USAGE: last_error
DESCRIPTION:
Displays the last error that was detected by the heap manager.
EXAMPLES:
last_error --
---------------------------------------------------------------------------
CM/HeapManager>
man
CM/NonVol/Factory NonVol>
CM/NonVol/Factory NonVol> man show
CM/NonVol/Factory NonVol> man show
COMMAND: show
USAGE: show
DESCRIPTION:
Displays the current non-volatile settings values for both the Permanent and
Dynamic sections.
EXAMPLES:
show --
---------------------------------------------------------------------------
CM/NonVol/Factory NonVol>
man
CM/HeapManager>
CM/HeapManager> man maxAlloc
CM/HeapManager> man maxAlloc
COMMAND: maxAlloc
USAGE: maxAlloc
DESCRIPTION:
Displays the maximum number of bytes that can currently be allocated in a
single call to malloc. This takes into account all of the overhead for node
tracking and bounds checking, as well as the current fragmentation state of
the heap.
EXAMPLES:
maxAlloc --
---------------------------------------------------------------------------
CM/HeapManager>
man
CM/NonVol/HalIf NonVol>
CM/NonVol/HalIf NonVol> man stats
CM/NonVol/HalIf NonVol> man stats
COMMAND: stats
USAGE: stats
DESCRIPTION:
Prints stats about buffer usage for Dynamic and Permanent settings.
EXAMPLES:
stats --
---------------------------------------------------------------------------
CM/NonVol/HalIf NonVol>
man
CM/CmHal>
CM/CmHal> man tune
CM/CmHal> man tune
COMMAND: tune
USAGE: tune Frequency
DESCRIPTION:
Tune the tuner
EXAMPLES:
tune 327 -- Tune tuner to 327 MHz.
---------------------------------------------------------------------------
CM/CmHal>
man
CM/DocsisCtl/dsxTest>
CM/DocsisCtl/dsxTest> man dropDsxMsg
CM/DocsisCtl/dsxTest> man dropDsxMsg
COMMAND: dropDsxMsg
USAGE: dropDsxMsg [rx|tx] [DsaReq|DsaRsp|DsaAck|DscReq|DscRsp|DscAck|DsdReq|Ds
dRsp|all|none] [count{0..65535}]
DESCRIPTION:
Drops incoming/outgoing DSx messages of specified type to simulate message
loss.
Only outgoing MIB counters will increment.
EXAMPLES:
dropDsxMsg rx DsaReq -- drops all incoming DsaReq messages
dropDsxMsg tx DscRsp 2 -- drops the next 2 outgoing DsaRsp messages
dropDsxMsg tx all -- drops all outgoing DSx messages
dropDsxMsg rx none -- drops no incoming DSx messages
---------------------------------------------------------------------------
CM/DocsisCtl/dsxTest>
man
CM/NonVol/Ds Cal NonVol>
CM/NonVol/Ds Cal NonVol> man master
CM/NonVol/Ds Cal NonVol> man master
COMMAND: master
USAGE: master [dBmV{-327..327}]
DESCRIPTION:
Sets the master offset power value (in dBmV) for the modem. Each frequency
band in the table has an offset power adjustment that is applied to this
value when calculating the actual power level.
EXAMPLES:
master 58.25 --
---------------------------------------------------------------------------