1. DPQ 3925 Diag Telnet commands
  3. CM> man
  5. COMMAND: man
  7. USAGE: man [-t|-l|-s|-i|-a|-lr] [command [...]{126}]
  9. DESCRIPTION:
  10. Alias for 'help'. Type 'help help' for more information.
  12. EXAMPLES:
  13. No examples available...
  15. ---------------------------------------------------------------------------
  17. CM> man -lr
  19. TABLE: built-in
  21. COMMAND: !
  23. USAGE: ! [Number{0..15}] [command{31}]
  25. DESCRIPTION:
  26. Executes the last command that was entered. If a command (or history number)
  27. is specified, then it executes that command from the history buffer. This
  28. works like the Unix '!' command
  30. EXAMPLES:
  31. ! -- This repeats the last command that was entered.
  32. ! cd -- This repeats the last 'cd' command that was entered.
  34. ------------------------------------------------------------------------------
  36. TABLE: built-in
  38. COMMAND: ?
  40. USAGE: ? [-t|-l|-s|-i|-a|-lr] [command [...]{126}]
  42. DESCRIPTION:
  43. Alias for 'help'. Type 'help help' for more information.
  45. EXAMPLES:
  46. No examples available...
  48. ------------------------------------------------------------------------------
  50. TABLE: built-in
  52. COMMAND: REM
  54. USAGE: REM [Remark text{126}]
  56. DESCRIPTION:
  57. Ignores the text that follows; used for remarks, scripting, etc.
  59. EXAMPLES:
  60. REM Started test here. --
  62. ------------------------------------------------------------------------------
  64. TABLE: built-in
  66. COMMAND: cd
  68. USAGE: cd [subtable | .. | \ | /{31}]
  70. DESCRIPTION:
  71. Sets the specified command table as the active table. This works like the
  72. DOS or Unix 'cd' command where '..' takes you to the previous table, and '\'
  73. or '/' takes you to the root table. If no parameters are specified, then it
  74. shows the name of the currently active command table.
  76. EXAMPLES:
  77. cd classifiers -- Makes the specified subtable the active command table.
  78. cd \ -- Makes the main command table active.
  79. cd .. -- Makes the previous (parent) command table active.
  80. cd -- Shows the name of the active command table.
  81. cd \non\doc -- You can specify partial names, and mutliple subdirs.
  83. ------------------------------------------------------------------------------
  85. TABLE: built-in
  87. COMMAND: dir
  89. USAGE: dir [-t|-l|-s|-i|-a|-lr] [command [...]{126}]
  91. DESCRIPTION:
  92. Alias for 'help'. Type 'help help' for more information.
  94. EXAMPLES:
  95. No examples available...
  97. ------------------------------------------------------------------------------
  99. TABLE: built-in
  101. COMMAND: find_command
  103. USAGE: find_command command{31}
  105. DESCRIPTION:
  106. Displays the name of all subdirectories which contain the specified command.
  108. EXAMPLES:
  109. find_command show --
  111. ------------------------------------------------------------------------------
  113. TABLE: built-in
  115. COMMAND: help
  117. USAGE: help [-t|-l|-s|-i|-a|-lr] [command [...]{126}]
  119. DESCRIPTION:
  120. Shows usage information about the specified command(s), or lists the set of
  121. commands available in the active table. If no parameters are specified, then
  122. an abbreviated list of all commands and subtables is displayed.
  124. -t -- Shows the entire tree of command tables and commands (in
  125. abbreviated form).
  126. -l -- Shows detailed information about all commands and subtables (this
  127. can print a LOT of information)!
  128. -s -- Shows detailed information on just the subtables.
  129. -i -- Shows detailed information on just the registered instances for
  130. the active table.
  131. -a -- Does everything that the -l, -s, and -i options do.
  133. Command is the name (or partial name) of one or more commands and subtables
  134. for which you want detailed help to be displayed.
  136. EXAMPLES:
  137. help -- This shows an abbreviated list of all commands and
  138. subtables.
  139. help cd -- This shows detailed help on the 'cd' command.
  140. help cd ! diag -- This shows detailed help on the 2 commands and subtable
  141. listed.
  142. help -l -- Shows detailed help on all available commands and
  143. subtables.
  145. ------------------------------------------------------------------------------
  147. TABLE: built-in
  149. COMMAND: history
  151. USAGE: history
  153. DESCRIPTION:
  154. Shows a list of commands that were previously typed.
  156. EXAMPLES:
  157. history --
  159. ------------------------------------------------------------------------------
  161. TABLE: built-in
  163. COMMAND: instances
  165. USAGE: instances [name{31}]
  167. DESCRIPTION:
  168. Shows the set of object instances that have registered with the active table.
  169. This is the same as 'help -i', except that it lets you specify a partial
  170. instance name in order to limit the list that is displayed (only instances
  171. whose names match the partial string are shown). The name is not case
  172. sensitive.
  174. EXAMPLES:
  175. instances -- Shows all instances registered with the command table.
  176. instances p -- Shows all instances whose name begins with 'p' or 'P'.
  178. ------------------------------------------------------------------------------
  180. TABLE: built-in
  182. COMMAND: ls
  184. USAGE: ls [-t|-l|-s|-i|-a|-lr] [command [...]{126}]
  186. DESCRIPTION:
  187. Alias for 'help'. Type 'help help' for more information.
  189. EXAMPLES:
  190. No examples available...
  192. ------------------------------------------------------------------------------
  194. TABLE: built-in
  196. COMMAND: man
  198. USAGE: man [-t|-l|-s|-i|-a|-lr] [command [...]{126}]
  200. DESCRIPTION:
  201. Alias for 'help'. Type 'help help' for more information.
  203. EXAMPLES:
  204. No examples available...
  206. ------------------------------------------------------------------------------
  208. TABLE: built-in
  210. COMMAND: pwd
  212. USAGE: pwd
  214. DESCRIPTION:
  215. Shows the name of the currently active command table. This is like the Unix
  216. 'pwd' command.
  218. EXAMPLES:
  219. pwd --
  221. ------------------------------------------------------------------------------
  223. TABLE: built-in
  225. COMMAND: sleep
  227. USAGE: sleep Milliseconds
  229. DESCRIPTION:
  230. Causes the console to sleep for the specified number of milliseconds. This
  231. is useful for scripting, where you want to delay between commands.
  233. EXAMPLES:
  234. sleep 1000 -- Makes the console sleep for 1 second
  236. ------------------------------------------------------------------------------
  238. TABLE: built-in
  240. COMMAND: syntax
  242. USAGE: syntax
  244. DESCRIPTION:
  245. Displays detailed information on command line syntax and how the parser
  246. works.
  248. EXAMPLES:
  249. syntax --
  251. ------------------------------------------------------------------------------
  253. TABLE: built-in
  255. COMMAND: system_time
  257. USAGE: system_time
  259. DESCRIPTION:
  260. Displays the current system millisecond tick counter.
  262. EXAMPLES:
  263. system_time --
  265. ------------------------------------------------------------------------------
  267. TABLE: built-in
  269. COMMAND: usage
  271. USAGE: usage
  273. DESCRIPTION:
  274. Displays information about how the console works, and how to use it.
  276. EXAMPLES:
  277. usage --
  279. ------------------------------------------------------------------------------
  281. TABLE: built-in
  283. COMMAND: bcm_version
  285. USAGE: bcm_version
  287. DESCRIPTION:
  288. Displays the current Broadcom software version and feature codes by printing
  289. the startup banner. This allows the user to view the current version
  290. information without having to restart the application.
  292. EXAMPLES:
  293. bcm_version --
  295. ------------------------------------------------------------------------------
  297. TABLE: built-in
  299. COMMAND: con_high
  301. USAGE: con_high
  303. DESCRIPTION:
  304. Boosts the console thread priority so that you can use the console while the
  305. system is busy. Normally, the console priority is low so that it doesn't
  306. interfere with normal system operation.
  308. EXAMPLES:
  309. con_high --
  311. ------------------------------------------------------------------------------
  313. TABLE: built-in
  315. COMMAND: emta_console
  317. USAGE: emta_console
  319. DESCRIPTION:
  320. Gives control of the console to the EMTA.
  322. EXAMPLES:
  323. emta_console
  325. ------------------------------------------------------------------------------
  327. TABLE: built-in
  329. COMMAND: exit
  331. USAGE: exit
  333. DESCRIPTION:
  334. For Telnet/ssh clients, this lets the user log out cleanly.
  336. EXAMPLES:
  337. exit
  339. ------------------------------------------------------------------------------
  341. TABLE: built-in
  343. COMMAND: mbufShow
  345. USAGE: mbufShow
  347. DESCRIPTION:
  348. Displays current mbuf allocation.
  350. EXAMPLES:
  351. mbufShow --
  353. ------------------------------------------------------------------------------
  355. TABLE: built-in
  357. COMMAND: memShow
  359. USAGE: memShow
  361. DESCRIPTION:
  362. Displays current memory allocation.
  364. EXAMPLES:
  365. memShow --
  367. ------------------------------------------------------------------------------
  369. TABLE: built-in
  371. COMMAND: mutex_debug
  373. USAGE: mutex_debug
  375. DESCRIPTION:
  376. Shows mutex debug information for debugging deadlocks.
  378. EXAMPLES:
  379. mutex_debug
  381. ------------------------------------------------------------------------------
  383. TABLE: built-in
  385. COMMAND: ping
  387. USAGE: ping IpAddress
  389. DESCRIPTION:
  390. Pings the specified target IP address, sending 3 64-byte packets, and waiting
  391. up to 5 seconds for a response. This is a basic 'standard' ping. For more
  392. options or control over ping parameters and behavior, you will need to go to
  393. the Ping Command table ('cd pingHelper').
  395. In order for this to work, the CM must either have successfully completed
  396. DHCP, or must otherwise have been configured with a valid IP address.
  398. Note that this command causes the ping options to be reset to their default
  399. state.
  401. This may be disabled if the platform doesn't provide an implementation of
  402. ping.
  404. EXAMPLES:
  405. ping 11.24.4.3 -- Ping IP address 11.24.4.3.
  407. ------------------------------------------------------------------------------
  409. TABLE: built-in
  411. COMMAND: read_memory
  413. USAGE: read_memory [-p] [-c] [-s ElementSize{1..4}] [-n NumberOfBytes{1..16384}] [StartAddress]
  415. DESCRIPTION:
  416. Displays the contents of memory (in hex and ASCII) to the console.
  418. StartAddress : the address to start displaying (can be memory, registers,
  419. etc).
  420. -s : sets the element size to be read (1, 2, or 4 bytes). Most useful for
  421. registers; defaults to 1.
  422. -n : sets the number of bytes to be read. Defaults to 16. Note that this
  423. will always be padded out to a multiple of the element size.
  424. -c : increments the start address by the number of bytes before reading.
  425. This is most useful for continuing the previous read (with the same
  426. parameters).
  427. -p : prints the current options (which would be used if not otherwise
  428. supplied).
  430. If no parameters are specified, it will perform the last read again.
  432. NOTE - the parameters are remembered from one read to the next; e.g. if you
  433. set the element size to 4 bytes, then all subsequent reads will use this,
  434. unless explicitly overridden.
  436. WARNING - it may be possible to make the system hang or crash if you read
  437. from an illegal address!
  439. EXAMPLES:
  440. read_memory -s 4 -n 64 0x80001234 -- Reads 64 bytes as 32-bit values.
  441. read_memory -n 32 0x80001234 -- Reads 32 bytes starting with the
  442. specified address.
  443. read_memory -c -- Reads the next 32 bytes, continuing
  444. from the previous read.
  446. ------------------------------------------------------------------------------
  448. TABLE: built-in
  450. COMMAND: reset
  452. USAGE: reset
  454. DESCRIPTION:
  455. Causes the application to exit, shutting everything down and cleaning up
  456. resources. On embedded platforms, this usually also triggers the internal
  457. CPU reset logic, causing the h/w to reboot.
  459. EXAMPLES:
  460. reset --
  462. ------------------------------------------------------------------------------
  464. TABLE: built-in
  466. COMMAND: routeShow
  468. USAGE: routeShow
  470. DESCRIPTION:
  471. Displays current routing information.
  473. EXAMPLES:
  474. routeShow --
  476. ------------------------------------------------------------------------------
  478. TABLE: built-in
  480. COMMAND: run_app
  482. USAGE: run_app
  484. DESCRIPTION:
  485. If the application was stopped at the console (either via keypress or via
  486. non-vol setting that automatically stopped it), then this command will allow
  487. it to start running. If the application is already running, this will cause
  488. it to start over again.
  490. EXAMPLES:
  491. run_app --
  493. ------------------------------------------------------------------------------
  495. TABLE: built-in
  497. COMMAND: shell
  499. USAGE: shell
  501. DESCRIPTION:
  502. Causes the application to jump to eCos shell.
  504. EXAMPLES:
  505. shell --
  507. ------------------------------------------------------------------------------
  509. TABLE: built-in
  511. COMMAND: stackShow
  513. USAGE: stackShow
  515. DESCRIPTION:
  516. Displays current tasks stack information.
  518. EXAMPLES:
  519. stackShow --
  521. ------------------------------------------------------------------------------
  523. TABLE: built-in
  525. COMMAND: start_idle_profiling
  527. USAGE: start_idle_profiling
  529. DESCRIPTION:
  530. Clears the idle loop profiling counter.
  532. EXAMPLES:
  533. start_idle_profiling --
  535. ------------------------------------------------------------------------------
  537. TABLE: built-in
  539. COMMAND: stop_idle_profiling
  541. USAGE: stop_idle_profiling
  543. DESCRIPTION:
  544. Displays the idle loop profiling counter.
  546. EXAMPLES:
  547. stop_idle_profiling --
  549. ------------------------------------------------------------------------------
  551. TABLE: built-in
  553. COMMAND: taskDelete
  555. USAGE: taskDelete
  557. DESCRIPTION:
  558. Deletes a specific task.
  560. EXAMPLES:
  561. taskDelete --
  563. ------------------------------------------------------------------------------
  565. TABLE: built-in
  567. COMMAND: taskInfo
  569. USAGE: taskInfo
  571. DESCRIPTION:
  572. Displays a specific task information.
  574. EXAMPLES:
  575. taskInfo --
  577. ------------------------------------------------------------------------------
  579. TABLE: built-in
  581. COMMAND: taskPrioritySet
  583. USAGE: taskPrioritySet
  585. DESCRIPTION:
  586. Changes a specific task priority.
  588. EXAMPLES:
  589. taskPrioritySet --
  591. ------------------------------------------------------------------------------
  593. TABLE: built-in
  595. COMMAND: taskResume
  597. USAGE: taskResume
  599. DESCRIPTION:
  600. Resumes a specific task.
  602. EXAMPLES:
  603. taskResumes --
  605. ------------------------------------------------------------------------------
  607. TABLE: built-in
  609. COMMAND: taskShow
  611. USAGE: taskShow
  613. DESCRIPTION:
  614. Displays current tasks information.
  616. EXAMPLES:
  617. taskShow --
  619. ------------------------------------------------------------------------------
  621. TABLE: built-in
  623. COMMAND: taskSuspend
  625. USAGE: taskSuspend
  627. DESCRIPTION:
  628. Suspends a specific task.
  630. EXAMPLES:
  631. taskSuspend --
  633. ------------------------------------------------------------------------------
  635. TABLE: built-in
  637. COMMAND: taskTrace
  639. USAGE: taskTrace
  641. DESCRIPTION:
  642. Displays a stack trace of a task.
  644. EXAMPLES:
  645. taskTrace --
  647. ------------------------------------------------------------------------------
  649. TABLE: built-in
  651. COMMAND: traceroute
  653. USAGE: traceroute [-s [IpAddress]] [-m [Number{0..255}]] [-p [Number{1..65534}]] [-l [Number{0..65535}]] [-r] TargetIpAddress{127}
  655. DESCRIPTION:
  656. traceroute - displays the hops from the router to a destination target
  657. (host) hostname or IP address to trace the route to
  658. -m maximum number of hops to find target (default 255)
  659. -l set the data size in bytes of each probe packet (default 32)
  660. -p set base UDP port used in probes (default 33434)
  661. -r resolve host IP addresses for each hop (default off) -s specify the
  662. source ip address to run traceroute (default route table)
  665. EXAMPLES:
  666. traceroute www.yahoo.com -- Performs traceroute with default
  667. parameters.
  668. traceroute -s 10.15.6.3 www.yahoo.com -- Perform traceroute from
  669. 10.15.6.3.
  670. traceroute -m 10 www.yahoo.com -- Performs traceroute with MaxTTL
  671. 10.
  672. traceroute -l 64 -p 65000 www.yahoo.com -- Performs traceroute using port
  673. 65000 and data len 64 bytes.
  676. ------------------------------------------------------------------------------
  678. TABLE: built-in
  680. COMMAND: usfsShow
  682. USAGE: usfsShow
  684. DESCRIPTION:
  685. Displays the current USFS Table.
  687. EXAMPLES:
  688. usfsShow --
  690. ------------------------------------------------------------------------------
  692. TABLE: built-in
  694. COMMAND: version
  696. USAGE: version
  698. DESCRIPTION:
  699. Displays the current software version and feature codes by printing the
  700. startup banner. This allows the user to view the current version information
  701. without having to restart the application.
  703. EXAMPLES:
  704. version --
  706. ------------------------------------------------------------------------------
  708. TABLE: built-in
  710. COMMAND: write_memory
  712. USAGE: write_memory [-s ElementSize{1..4}] Address Value
  714. DESCRIPTION:
  715. Writes the specified value to the specified address.
  717. Address : the address to write to (can be memory, registers, etc).
  718. Value : the value to write.
  719. -s : sets the element size to be written (1, 2 or 4 bytes). If not
  720. specified, the default is 1 byte.
  722. NOTE - unlike read_memory, the parameters are not remembered from one write
  723. to the next.
  725. WARNING - it is possible to make the system hang or crash if you write to an
  726. illegal address (or write over the application code)!
  728. EXAMPLES:
  729. write_memory 0x80001234 0x56 -- Write a byte to the address.
  730. write_memory -s 4 0x80001234 0x12345678 -- Write 32 bits.
  732. ------------------------------------------------------------------------------
  734. TABLE: built-in
  736. COMMAND: zone
  738. USAGE: zone [Bitmask{0xffff}]
  740. DESCRIPTION:
  741. Prints or sets the HAL debug zones; this determines what debug messages will
  742. be displayed by HAL drivers. These bits correspond to the HAL debug zones:
  743. 0x0001 -- INIT
  744. 0x0002 -- TEST1
  745. 0x0004 -- TEST2
  746. 0x0008 -- TEST3
  747. 0x0010 -- TEST4
  748. 0x0020 -- TEST5
  749. 0x0040 -- TEST6
  750. 0x0080 -- BPI
  751. 0x0100 -- DOWNSTREAM
  752. 0x0200 -- UPSTREAM
  753. 0x0400 -- TUNER
  754. 0x0800 -- RANGING
  755. 0x1000 -- TESTSRAM
  756. 0x2000 -- TESTREG
  757. 0x4000 -- WARNING
  758. 0x8000 -- ERROR
  760. EXAMPLES:
  761. zone 0xc000 -- Enables ERROR and WARNING levels.
  763. ------------------------------------------------------------------------------
  765. TABLE: 80211_hal
  767. COMMAND: antenna
  769. USAGE: antenna [AntSelect]
  771. DESCRIPTION:
  772. Causes the 802.11 HAL to set/display its current antenna setting.
  774. EXAMPLES:
  775. antenna 0 --
  777. ------------------------------------------------------------------------------
  779. TABLE: 80211_hal
  781. COMMAND: assoclist
  783. USAGE: assoclist
  785. DESCRIPTION:
  786. Causes the 802.11 HAL to display the current list of associated stations.
  788. EXAMPLES:
  789. assoclist 0 --
  791. ------------------------------------------------------------------------------
  793. TABLE: 80211_hal
  795. COMMAND: bssid
  797. USAGE: bssid
  799. DESCRIPTION:
  800. Causes the 802.11 HAL to display the current BSSID address.
  802. EXAMPLES:
  803. bssid 0 --
  805. ------------------------------------------------------------------------------
  807. TABLE: 80211_hal
  809. COMMAND: channel
  811. USAGE: channel [ChanNum]
  813. DESCRIPTION:
  814. Causes the 802.11 HAL to set/display its current channel setting.
  816. EXAMPLES:
  817. channel 2 --
  819. ------------------------------------------------------------------------------
  821. TABLE: 80211_hal
  823. COMMAND: clr_counts
  825. USAGE: clr_counts
  827. DESCRIPTION:
  828. Causes the 802.11 HAL to clear driver maintained statistics.
  830. EXAMPLES:
  831. cmr_counts --
  833. ------------------------------------------------------------------------------
  835. TABLE: 80211_hal
  837. COMMAND: csenable
  839. USAGE: csenable [CsEn]
  841. DESCRIPTION:
  842. Causes the 802.11 HAL to set/display the carrier suppression transmit
  843. setting.
  845. EXAMPLES:
  846. csenable 0 --
  848. ------------------------------------------------------------------------------
  850. TABLE: 80211_hal
  852. COMMAND: hal_show
  854. USAGE: hal_show
  856. DESCRIPTION:
  857. Causes the 802.11 HAL to display its internal state.
  859. EXAMPLES:
  860. hal_show --
  862. ------------------------------------------------------------------------------
  864. TABLE: 80211_hal
  866. COMMAND: led
  868. USAGE: led
  870. DESCRIPTION:
  871. Shows Wifi Led thread info.
  873. EXAMPLES:
  874. led --
  876. ------------------------------------------------------------------------------
  878. TABLE: 80211_hal
  880. COMMAND: long
  882. USAGE: long
  884. DESCRIPTION:
  885. Simulates a long push SES button press.
  887. EXAMPLES:
  888. long --
  890. ------------------------------------------------------------------------------
  892. TABLE: 80211_hal
  894. COMMAND: regdomain
  896. USAGE: regdomain
  898. DESCRIPTION:
  899. Causes the 802.11 HAL to display the current regulatory domain.
  901. EXAMPLES:
  902. regdomain 0 --
  904. ------------------------------------------------------------------------------
  906. TABLE: 80211_hal
  908. COMMAND: rxfer
  910. USAGE: rxfer
  912. DESCRIPTION:
  913. Causes the 802.11 HAL to display the current FER counter.
  915. EXAMPLES:
  916. rxfer 0 --
  918. ------------------------------------------------------------------------------
  920. TABLE: 80211_hal
  922. COMMAND: short
  924. USAGE: short
  926. DESCRIPTION:
  927. Simulates a short push SES button press.
  929. EXAMPLES:
  930. short --
  932. ------------------------------------------------------------------------------
  934. TABLE: 80211_hal
  936. COMMAND: show
  938. USAGE: show
  940. DESCRIPTION:
  941. Causes the HalIf object to display its state.
  943. EXAMPLES:
  944. show --
  946. ------------------------------------------------------------------------------
  948. TABLE: 80211_hal
  950. COMMAND: ssid
  952. USAGE: ssid
  954. DESCRIPTION:
  955. Causes the 802.11 HAL to display its current SSID string.
  957. EXAMPLES:
  958. ssid --
  960. ------------------------------------------------------------------------------
  962. TABLE: 80211_hal
  964. COMMAND: wl
  966. USAGE: wl [CmdLine{63}]
  968. DESCRIPTION:
  969. Sends commands to the 802.11 diagnostic and manufacturing utility.
  971. EXAMPLES:
  972. wl [command line parms] --
  974. ------------------------------------------------------------------------------
  976. TABLE: 80211_hal
  978. COMMAND: wpa
  980. USAGE: wpa
  982. DESCRIPTION:
  983. Shows WPA-NAS thread info.
  985. EXAMPLES:
  986. wpa --
  988. ------------------------------------------------------------------------------
  990. TABLE: Console
  992. COMMAND: exit
  994. USAGE: exit
  996. DESCRIPTION:
  997. End the current telnet or ssh interactive session
  999. EXAMPLES:
  1000. exit
  1002. ------------------------------------------------------------------------------
  1004. TABLE: Console
  1006. COMMAND: reset
  1008. USAGE: reset
  1010. DESCRIPTION:
  1011. Resets the system
  1013. EXAMPLES:
  1014. reset
  1016. ------------------------------------------------------------------------------
  1018. TABLE: Console
  1020. COMMAND: set
  1022. USAGE: set [username|password]
  1024. DESCRIPTION:
  1025. Sets the username/password for telnet/ssh logins
  1028. EXAMPLES:
  1029. set username -- Sets the username
  1030. set password -- Sets the password
  1033. ------------------------------------------------------------------------------
  1035. TABLE: Console
  1037. COMMAND: show
  1039. USAGE: show [ip|reset|uptime|version]
  1041. DESCRIPTION:
  1042. Shows state of the system.
  1045. EXAMPLES:
  1046. show ip -- All IP addresses in the system
  1047. show reset -- Reset reason history log
  1048. show uptime -- Time that system has been up
  1049. show version -- SW filename, version, and build info
  1052. ------------------------------------------------------------------------------
  1054. TABLE: Console/battery
  1056. COMMAND: set
  1058. USAGE: set [ethernetDelay|usbDelay|wifiDelay]
  1060. DESCRIPTION:
  1061. Shows state of the battery
  1063. EXAMPLES:
  1064. set ethernetDelay -- Seconds after loosing A/C to disable the ethernet
  1065. interface
  1066. set usbDelay -- Seconds after loosing A/C to disable the USB
  1067. interface
  1068. set wifiDelay -- Seconds after loosing A/C to disable the Wi-fi
  1069. interface
  1072. ------------------------------------------------------------------------------
  1074. TABLE: Console/battery
  1076. COMMAND: show
  1078. USAGE: show [battery]
  1080. DESCRIPTION:
  1081. Shows state of the battery
  1084. EXAMPLES:
  1085. show battery -- Shows the state of the battery
  1087. ------------------------------------------------------------------------------
  1089. TABLE: Console/cm
  1091. COMMAND: diag
  1093. USAGE: diag [downstream|upstream] [Parm2]
  1095. DESCRIPTION:
  1096. Executes diag commands of the CM.
  1099. EXAMPLES:
  1100. diag downstream 525000000 -- Changes downstream frequency
  1101. diag upstream 125000000 -- Changes upstream frequency
  1104. ------------------------------------------------------------------------------
  1106. TABLE: Console/cm
  1108. COMMAND: log
  1110. USAGE: log [dsx|ranging|zone|off] [Log Setting{0..65535}]
  1112. DESCRIPTION:
  1113. Enables or disables real-time logging of specified message types or events
  1116. EXAMPLES:
  1117. log dsx 1 -- Enables DSx message logging
  1118. log dsx 0 -- Disables DSx message logging
  1119. log ranging 1 -- Enables ranging message logging
  1120. log ranging 0 -- Disables ranging message logging
  1121. log zone 0xFFFF -- Enables all zone message logging
  1122. log zone 0x0000 -- Disables all zone message logging
  1123. log off -- Disables all CM logging
  1126. ------------------------------------------------------------------------------
  1128. TABLE: Console/cm
  1130. COMMAND: ping
  1132. USAGE: ping IpAddress
  1134. DESCRIPTION:
  1135. Pings the specified target IP address from the CM IP stack
  1137. EXAMPLES:
  1138. ping 11.24.4.3 -- Ping IP address 11.24.4.3.
  1140. ------------------------------------------------------------------------------
  1142. TABLE: Console/cm
  1144. COMMAND: set
  1146. USAGE: set [firewall]
  1148. DESCRIPTION:
  1149. Sets the state of the CM.
  1151. EXAMPLES:
  1152. set firewall -- enables or disables the firewall
  1154. ------------------------------------------------------------------------------
  1156. TABLE: Console/cm
  1158. COMMAND: show
  1160. USAGE: show [all|arp|bpi|certs|cls|cfg|cpe|ds|dscwer|dsx|event|flows|lease|route|status|tod|ucd|us|counters|debug]
  1162. DESCRIPTION:
  1163. shows the state of the cablemodem
  1165. EXAMPLES:
  1166. show all -- ALL options of this command
  1167. show arp -- ARP table
  1168. show bpi -- BPI status
  1169. show certs -- CM certificates
  1170. show cls -- Docsis classifiers
  1171. show cfg -- CM config file name and contents
  1172. show cpe -- CPE info/table
  1173. show ds -- Downstream status and signal quality
  1174. show dscwer -- Downstream Codeword Error Rate
  1175. show dsx -- DSx message history
  1176. show event -- CM event log
  1177. show flows -- Docsis service flows
  1178. show lease -- CM IP and DHCP options
  1179. show route -- The routing table
  1180. show status -- Docsis registration Status
  1181. show tod -- Time of day
  1182. show ucd -- Upstream descriptors
  1183. show us -- Upstream status
  1184. show counters -- HW Counters
  1185. show debug -- Hal debug
  1188. ------------------------------------------------------------------------------
  1190. TABLE: Console/emta
  1192. COMMAND: diag
  1194. USAGE: diag loopback|lineReset|lineTest|ncsMsg|offHookSim|ring|logEvent|forceProcAssert|voiceStatsInterval|bosStatusDetail|socket|logHistory|hapi
  1196. DESCRIPTION:
  1197. Runs various MTA diagnostics.
  1200. EXAMPLES:
  1201. diag loopback -- Enable analog loopback on a line
  1202. diag lineReset -- Reset a line
  1203. diag lineTest -- run line diagnostics and report results
  1204. diag ncsMsg -- Sends HD and HU NCS message to the call agent
  1205. diag offHookSim -- Simulates line off hook for a short interval of
  1206. time
  1207. diag ring -- Ring a line
  1208. diag logEvent -- Triggers a Log Event in the MTA, sending a SysLog
  1209. or SNMP Trap if necessary
  1210. diag forceProcAssert -- Force one of the processor to assert and crash
  1211. diag voiceStatsInterval -- Prints voice statistics at specified intervals
  1212. diag bosStatusDetail -- Enable BOS Status detail mode
  1213. diag socket -- Configure socket status timer for un-serviced
  1214. socket check
  1215. diag logHistory -- Configure log history setting
  1216. diag hapi -- Configure HAPI log module setting
  1219. ------------------------------------------------------------------------------
  1221. TABLE: Console/emta
  1223. COMMAND: log
  1225. USAGE: log [bhal|bos|calc|cmgr|cas|dhcp|dns|ept|hapi|hbt|hdsp|krb|log|nat|ncs|net|prov|rtp|sip|snmp|tpd|util|xdrv|all|bhal-h|bos-h|calc-h|cmgr-h|cas-h|dhcp-h|dns-h|ept-h|hapi-h|hbt-h|hdsp-h|krb-h|log-h|nat-h|ncs-h|net-h|prov-h|rtp-h|sip-h|snmp-h|tpd-h|util-h|xdrv-h|all-h] [hdr|default|on|off|crit|warn|info] [sev|mod|time|thread|all] [on|off|tick|utc]
  1227. DESCRIPTION:
  1228. Setup logging options (log header fields, log severity support) for a given
  1229. EMTA log module.
  1232. EXAMPLES:
  1233. log -- show current log settings
  1234. log dns warn -- enables warning and critical DNS message logging
  1235. log krb info -- enables informational, warning and critical KERBEROS
  1236. message logging
  1237. log prov off -- disables PROV message logging
  1238. log all off -- disables ALL EMTA message logging
  1239. log all on -- enables ALL EMTA message logging (including debug,
  1240. informational, warning and critical logs)
  1243. ------------------------------------------------------------------------------
  1245. TABLE: Console/emta
  1247. COMMAND: ping
  1249. USAGE: ping IpAddress
  1251. DESCRIPTION:
  1252. Pings the specified target IP address from the EMTA IP stack
  1254. EXAMPLES:
  1255. ping 11.24.4.3 -- Ping IP address 11.24.4.3.
  1257. ------------------------------------------------------------------------------
  1259. TABLE: Console/emta
  1261. COMMAND: reset
  1263. USAGE: reset
  1265. DESCRIPTION:
  1266. Reset the MTA now.
  1268. EXAMPLES:
  1269. reset
  1271. ------------------------------------------------------------------------------
  1273. TABLE: Console/emta
  1275. COMMAND: set
  1277. USAGE: set dhcpOption|dloadInhibit|dtmfRelay|faxRelay|firewall|jitterBuf|lineMaint|loopCurrentBoost|maxCpeInclude|phs|lockstep|quarantineMode|queueDepth|ringOffset|rtpPort|telRoot|logEvents|toneDetection|resetTickets|ringWaveform|dqosLite|powerMgmtDelay|ugsAd|emtaRouterPingTest
  1279. DESCRIPTION:
  1280. Sets the state of the MTA. You may be prompted for additional option
  1281. specific parameters.
  1284. EXAMPLES:
  1285. set dhcpOption -- Set requested DHCP option number [122|177]
  1286. set dloadInhibit -- Inhibit SW download during call
  1287. set dtmfRelay -- RFC2833 DTMF Tone Relay
  1288. set faxRelay -- T.38 Fax Relay
  1289. set firewall -- Enable the EMTA IP stack firewall
  1290. set jitterBuf -- Jitter buffer type + parameters
  1291. set lineMaint -- Line voltage maintenance on reboot, sync
  1292. loss,
  1293. -- CMS down
  1294. set loopCurrentBoost -- Boosted loop current
  1295. set maxCpeInclude -- Inclusion of MTA in CM max CPE limit
  1296. set phs -- Set up PHS enabled and suppressed fields
  1297. set lockstep -- Set MGCP lockstep and quarantine behavior
  1298. set quarantineMode -- Set MGCP quarantine mode
  1299. set queueDepth -- Set depth of the NCS message quarantine
  1300. buffer
  1301. set ringOffset -- Ring with DC offset
  1302. set rtpPort -- RTP port number for MTA
  1303. set telRoot -- Root certificate for use during provisioning
  1304. set logEvents -- Enable the logging of extended Events
  1305. set toneDetection -- Enhanced tone detection control on an
  1306. endpoint
  1307. set resetTickets -- Reset (CMS / Prov) Kerberos tickets
  1308. set ringWaveform -- Set Ring Waveform shape to sinusoidal(1) or
  1309. -- trapezoidal(2)
  1310. set dqosLite -- Enable or Disable DQoS-lite for the EMTA
  1311. set powerMgmtDelay -- Set the delay in seconds before Power Mgmt
  1312. Mode
  1313. set ugsAd -- Enable or Disable UGS-AD Control for the EMTA
  1314. set emtaRouterPingTest -- Configure Emta Router Keep Alive Setting
  1317. ------------------------------------------------------------------------------
  1319. TABLE: Console/emta
  1321. COMMAND: show
  1323. USAGE: show all|unservicedSocket|socket|callHistory|certs|codecs|cfg|kerb|lastKerbMsg|lease|line|ncsHist|ncsDigitMap|phs|prov|rtp|security|setting|status|country|bosStatus|lastCall|processorInfo|ipcStats|faxrStats|hbState|ecanStats|logHistory|callclient|hgcp|transaction
  1325. DESCRIPTION:
  1326. shows the state of the MTA
  1328. EXAMPLES:
  1329. show all -- ALL options of this command
  1330. show unservicedSocket -- Show unserviced socket stats
  1331. show socket -- Show opened socket
  1332. show callHistory -- Call history/count
  1333. show certs -- MTA certificates
  1334. show codecs -- supported codec list
  1335. show cfg -- MTA config file contents
  1336. show kerb -- Kerberos ticket and state
  1337. show lastKerbMsg -- Last Kerberos message
  1338. show lease -- MTA IP address and DHCP options for the
  1339. current lease
  1340. show line -- Line states
  1341. show ncsHist -- NCS message history
  1342. show ncsDigitMap -- NCS Digit map
  1343. show phs -- Shows PHS settings for voice calls
  1344. show prov -- Provisioning state
  1345. show rtp -- RTP info
  1346. show security -- Security association info
  1347. show setting -- Emta settings
  1348. show status -- State of any NCS connections
  1349. show country -- Show list of supported countries and active
  1350. country
  1351. show bosStatus -- Show the status of all EMTA BOS synchronized
  1352. task resources
  1353. show lastCall -- Show list of last calls info stored (not run
  1354. in show all)
  1355. show processorInfo -- Show processor debug information (not run in
  1356. show all)
  1357. show ipcStats -- Show IPC Statistics for a channel (not run in
  1358. show all)
  1359. show faxrStats -- Show FAXR Statistics for a channel (not run in
  1360. show all)
  1361. show hbState -- Show heartbeat state for a channel (not run in
  1362. show all)
  1363. show ecanStats -- Show ECAN state for a channel (not run in show
  1364. all)
  1365. show logHistory -- Show save log history (not run in show all)
  1366. show callclient -- Show call client state information (not run in
  1367. show all)
  1368. show hgcp -- Show HGCP info (not run in show all)
  1369. show transaction -- Show HGCP transaction state info (not run in
  1370. show all)
  1373. ------------------------------------------------------------------------------
  1375. TABLE: Console/ethernet
  1377. COMMAND: diag
  1379. USAGE: diag [readmii|writemii] [Parm2] [Parm3] [Parm4]
  1381. DESCRIPTION:
  1382. Executes diag commands of the Ethernet interface
  1385. EXAMPLES:
  1386. diag readmii 0 0x18 -- Reads from ethernet registers
  1387. diag writemii 0 0x18 0x400 -- Writes to ethernet registers
  1390. ------------------------------------------------------------------------------
  1392. TABLE: Console/ethernet
  1394. COMMAND: show
  1396. USAGE: show [debug]
  1398. DESCRIPTION:
  1399. Shows debug state of the Ethernet interface
  1402. EXAMPLES:
  1403. show debug -- Shows debug state of ethernet RX/TX DMA rings.
  1405. ------------------------------------------------------------------------------
  1407. TABLE: Console/ftpLite
  1409. COMMAND: ftp
  1411. USAGE: ftp
  1413. DESCRIPTION:
  1414. Begins FTP to the specified IP address, using the current settings.
  1416. EXAMPLES:
  1417. ftp -- Initiates FTP until a key is pressed.
  1420. ------------------------------------------------------------------------------
  1422. TABLE: Console/pingHelper
  1424. COMMAND: all_sizes
  1426. USAGE: all_sizes
  1428. DESCRIPTION:
  1429. Configures the settings for sweeping all packet sizes from 64-1518, with
  1430. waiting and verification enabled. The time between pings is set to 0 ms, the
  1431. verbosity is set to full, and the reply wait time is set to 1/2 second. The
  1432. IP address is not changed.
  1434. EXAMPLES:
  1435. all_sizes --
  1437. ------------------------------------------------------------------------------
  1439. TABLE: Console/pingHelper
  1441. COMMAND: end_size
  1443. USAGE: end_size [size{64..1518}]
  1445. DESCRIPTION:
  1446. Sets or shows the size of the largest ping packet that will be sent
  1447. (including LLC and IP header overhead). After the packet size is increased
  1448. by the step amount, if it is larger than this value, then the size is reset
  1449. to the start size. This must be between start_size..1518 (MTU), inclusive.
  1451. EXAMPLES:
  1452. end_size 1518 -- Sets the end size to the maximum allowed.
  1454. ------------------------------------------------------------------------------
  1456. TABLE: Console/pingHelper
  1458. COMMAND: hs_nowait
  1460. USAGE: hs_nowait
  1462. DESCRIPTION:
  1463. Configures the settings for doing high-speed pings (infinite), without
  1464. waiting for the reply. The display verbosity is set to 2 (display only a
  1465. 'p'), the time between pings is set to 0, and waiting for replies is
  1466. disabled. None of the other settings are changed.
  1468. EXAMPLES:
  1469. hs_nowait --
  1471. ------------------------------------------------------------------------------
  1473. TABLE: Console/pingHelper
  1475. COMMAND: hs_wait
  1477. USAGE: hs_wait
  1479. DESCRIPTION:
  1480. Configures the settings for doing high-speed pings (infinite), waiting for
  1481. the reply. The display verbosity is set to 2 (display only a 'p'), the time
  1482. between pings is set to 0, and waiting for replies is enabled. None of the
  1483. other settings are changed.
  1485. EXAMPLES:
  1486. hs_wait --
  1488. ------------------------------------------------------------------------------
  1490. TABLE: Console/pingHelper
  1492. COMMAND: ip_address
  1494. USAGE: ip_address [IpAddress]
  1496. DESCRIPTION:
  1497. Sets or shows the IP address of the device to be pinged.
  1499. EXAMPLES:
  1500. ip_address 10.24.4.3 --
  1502. ------------------------------------------------------------------------------
  1504. TABLE: Console/pingHelper
  1506. COMMAND: ip_stack
  1508. USAGE: ip_stack [Number{0..255}]
  1510. DESCRIPTION:
  1511. Sets the IP stack number that the pings should be sent to. If 0, then the
  1512. default stack will be used. The stackNum parameter must correspond to a
  1513. valid IP stack that has been installed and initialized with an IP address.
  1515. EXAMPLES:
  1516. ip_stack 2 -- Forces pings to go out IP stack 2.
  1518. ------------------------------------------------------------------------------
  1520. TABLE: Console/pingHelper
  1522. COMMAND: ip_sweep
  1524. USAGE: ip_sweep Subnet StartingIp
  1526. DESCRIPTION:
  1527. Pings all IP addresses on the specified subnet, starting with the address
  1528. specified, reporting success or failure for each one. It changes the ping
  1529. settings so that only a single ping is sent. This is often used to discover
  1530. all of the IP addresses on the subnet. The address will be incremented from
  1531. 1..254, skipping .0 and .255 since these are often used for local broadcast
  1532. addresses.
  1534. EXAMPLES:
  1535. ip_sweep 255.255.255.0 10.24.4.5 -- Pings 10.24.4.5 through 10.24.4.254.
  1537. ------------------------------------------------------------------------------
  1539. TABLE: Console/pingHelper
  1541. COMMAND: number_of_pings
  1543. USAGE: number_of_pings [Number{-1..2147483647}]
  1545. DESCRIPTION:
  1546. Sets or shows the number of pings to be sent. Note that 0 means infinite
  1547. (you will need to press a key or type 'stop' to abort). A value of -1 causes
  1548. the number of pings to be calculated based on the end size, start size, and
  1549. step amount, so that it will span the range exactly once; num = (end - start
  1550. + 1) / step.
  1552. EXAMPLES:
  1553. number_of_pings 3 -- Limits the number of pings to 3.
  1554. number_of_pings 0 -- Sets the number of pings to infinite.
  1555. number_of_pings -1 -- Calculates the number of pings to span the range.
  1557. ------------------------------------------------------------------------------
  1559. TABLE: Console/pingHelper
  1561. COMMAND: ping
  1563. USAGE: ping [-s] [IpAddress]
  1565. DESCRIPTION:
  1566. Begins pinging the specified IP address, using the current settings. If the
  1567. IP address is missing, then it uses the one that was previously set. If you
  1568. specify -s, then pinging will happen int he background until you type stop.
  1569. Otherwise, it will poll for a keypress.
  1571. EXAMPLES:
  1572. ping 10.24.4.3 -- Ping until a key is pressed.
  1573. ping -s -- Ping until the user types stop.
  1575. ------------------------------------------------------------------------------
  1577. TABLE: Console/pingHelper
  1579. COMMAND: restore_defaults
  1581. USAGE: restore_defaults
  1583. DESCRIPTION:
  1584. Restores all of the options to their default values (excluding the IP
  1585. address, which is not modified). The default values cause ping to behave
  1586. like most host-based ping utilities (3 packets, 64 bytes, wait 5 seconds,
  1587. etc.).
  1589. EXAMPLES:
  1590. restore_defaults --
  1592. ------------------------------------------------------------------------------
  1594. TABLE: Console/pingHelper
  1596. COMMAND: show_settings
  1598. USAGE: show_settings
  1600. DESCRIPTION:
  1601. Displays the current ping settings.
  1603. EXAMPLES:
  1604. show_settings --
  1606. ------------------------------------------------------------------------------
  1608. TABLE: Console/pingHelper
  1610. COMMAND: start_size
  1612. USAGE: start_size [size{64..1518}]
  1614. DESCRIPTION:
  1615. Sets or shows the size of the first ping packet that will be sent (including
  1616. LLC and IP header overhead). The packet size will be increased by the step
  1617. amount for each packet. This must be between 64..end_size, inclusive.
  1619. EXAMPLES:
  1620. start_size 64 -- Sets the start size to the minimum allowed.
  1622. ------------------------------------------------------------------------------
  1624. TABLE: Console/pingHelper
  1626. COMMAND: stats
  1628. USAGE: stats
  1630. DESCRIPTION:
  1631. Displays the ping statistics summary from the last set of pings. This is the
  1632. same summary that is displayed at the end of the pings (if verbosity is > 0).
  1634. EXAMPLES:
  1635. stats --
  1637. ------------------------------------------------------------------------------
  1639. TABLE: Console/pingHelper
  1641. COMMAND: step_amount
  1643. USAGE: step_amount [size]
  1645. DESCRIPTION:
  1646. Sets or shows the amount that the packet size will be increased for each
  1647. packet. This can be any number (including 0, which means to keep the size
  1648. constant for every packet). Note that if you set it too large, then the
  1649. packet size will wrap around to the start size every time, since it will
  1650. never be allowed to be larger than the end_size. You can also specify a
  1651. negative number which causes the ping size to start with the end size
  1652. parameter and step down to the start size, then wrap back around to the end
  1653. size.
  1655. EXAMPLES:
  1656. step_amount 1 -- Increases the packet size by 1 each time.
  1657. step_amount -1 -- Decreases the packet size by 1 each time.
  1659. ------------------------------------------------------------------------------
  1661. TABLE: Console/pingHelper
  1663. COMMAND: stop
  1665. USAGE: stop
  1667. DESCRIPTION:
  1668. Stops the ping that is currently running. This is necessary if you used the
  1669. -s parameter with ping.
  1671. EXAMPLES:
  1672. stop -- Stops the ping that is running.
  1674. ------------------------------------------------------------------------------
  1676. TABLE: Console/pingHelper
  1678. COMMAND: time_between_pings
  1680. USAGE: time_between_pings [Milliseconds]
  1682. DESCRIPTION:
  1683. Sets or shows the number of milliseconds that the ping helper will wait
  1684. before sending the next ping. Note that this does not include time spent
  1685. waiting for the reply or verifying it, or for time spent printing status
  1686. information. The actual resolution and accuracy of this depends on the
  1687. system (pSOS generally runs with a 10ms clock tick, so 10ms is the same as
  1688. 15ms on that system).
  1690. EXAMPLES:
  1691. time_between_pings 100 -- Waits 100ms before sending the next ping.
  1693. ------------------------------------------------------------------------------
  1695. TABLE: Console/pingHelper
  1697. COMMAND: verbosity
  1699. USAGE: verbosity [Number{0..3}]
  1701. DESCRIPTION:
  1702. Sets the level of information that will be displayed while pinging. A higher
  1703. number provides more information, but also slows down the rate at which pings
  1704. can be sent. Most host-based ping utilities provide output equivalent to 3.
  1705. For high-performance, high packet rate pings, values of 1 or 2 are best.
  1707. EXAMPLES:
  1708. verbosity 0 -- Disables printing of all ping status output.
  1709. verbosity 1 -- Displays only the summary of statistics at the end.
  1710. verbosity 2 -- Displays a 'p' every second to show progress, and the
  1711. summary.
  1712. verbosity 3 -- Displays full ping info for every packet, and the summary.
  1714. ------------------------------------------------------------------------------
  1716. TABLE: Console/pingHelper
  1718. COMMAND: verify_enable
  1720. USAGE: verify_enable [true|false]
  1722. DESCRIPTION:
  1723. Enables/disables verification of ping replies. If enabled, and if waiting
  1724. for replies is enabled, then if a reply is received, it will verify that it
  1725. matches the ping that was sent, and that all of the data is intact.
  1727. EXAMPLES:
  1728. verify_enable 1 -- Enables verification of the ping reply.
  1730. ------------------------------------------------------------------------------
  1732. TABLE: Console/pingHelper
  1734. COMMAND: wait_enable
  1736. USAGE: wait_enable [true|false]
  1738. DESCRIPTION:
  1739. Enables/disables waiting for ping replies. If enabled, the ping helper will
  1740. wait a number of milliseconds for the reply, and will process it if received.
  1741. This is true even if the timeout is 0ms; it will always check for and process
  1742. the response. If disabled, then no attempt will be made to check for or
  1743. process a response. This is generally only of interest when you need to send
  1744. data very quickly, with no variability.
  1746. EXAMPLES:
  1747. wait_enable 1 -- Enables waiting for the ping reply.
  1749. ------------------------------------------------------------------------------
  1751. TABLE: Console/pingHelper
  1753. COMMAND: wait_time
  1755. USAGE: wait_time [Milliseconds]
  1757. DESCRIPTION:
  1758. Sets or shows the number of milliseconds that the ping helper will wait for a
  1759. ping response before continuing. This only takes effect if waiting is
  1760. enabled. The actual resolution and accuracy of this depends on the system
  1761. (pSOS generally runs with a 10ms clock tick, so 10ms is the same as 15ms on
  1762. that system).
  1764. EXAMPLES:
  1765. wait_time 5000 -- Sets the reply wait timeout to 5 seconds.
  1767. ------------------------------------------------------------------------------
  1769. TABLE: Console/system
  1771. COMMAND: diag
  1773. USAGE: diag [-p] [-c] [-s ParmSValue] [-n ParmNValue] [readmem|writemem|clear_debug_counters|show_debug_counters|set_debug_flow] [Parm2] [Parm3]
  1775. DESCRIPTION:
  1776. Executes diag commands of the system
  1779. EXAMPLES:
  1780. readmem -s 4 -n 64 0x80001234 -- Reads 64 bytes as 32-bit values.
  1781. writemem 0x80001234 0x56 -- Write a byte to the address.
  1782. clear_debug_counters -- Clear UTP debug counters.
  1783. show_debug_counters -- Show debug counters for a selected flow.
  1784. set_debug_flow 0 -- Enable debug counters for the selected
  1785. flow.
  1788. ------------------------------------------------------------------------------
  1790. TABLE: Console/system
  1792. COMMAND: pktlog
  1794. USAGE: pktlog [-s] [true|false] [from_interfaces] [to_interfaces]
  1796. DESCRIPTION:
  1797. This enables/disables logging for packets received from the specified
  1798. interfaces and being sent to the specified interfaces. If enabled, then the
  1799. contents of the packet will be displayed, and the forwarder will show info
  1800. about the HalIf on which it was received/sent, as well as why the packet was
  1801. dropped. If the from/to interfaces parameters are missing, then all will be
  1802. done. The interfaces are a bitmask where 0x01 corresponds to the interface
  1803. at index 0, 0x04 corresponds to the interface at index 2, etc.
  1805. EXAMPLES:
  1806. pktlog true -- Enables packet logging for all interfaces.
  1807. pktlog false 0x2 -- Disables logging of packets from interface 1 (to
  1808. any).
  1809. pktlog true 0x1 0x6 -- Enables logging of packets received from interface 0
  1810. and destined to interfaces 1 or 2.
  1811. pktlog -- Shows the enable/disable state for all interfaces.
  1812. pktlog -s true -- Enables non-verbose logging of packets.
  1815. ------------------------------------------------------------------------------
  1817. TABLE: Console/system
  1819. COMMAND: set
  1821. USAGE: set [wdog|exception]
  1823. DESCRIPTION:
  1824. Set state of the system and system functionality.
  1827. EXAMPLES:
  1828. set wdog -- Enables/disable the watchdog timer
  1829. set exception -- Enables/Disables exception logging
  1832. ------------------------------------------------------------------------------
  1834. TABLE: Console/system
  1836. COMMAND: show
  1838. USAGE: show [flash|memory|threads|forwarder|blocks|ecos|sockets|fpm|dqm|nonvol]
  1840. DESCRIPTION:
  1841. Shows state of the system.
  1844. EXAMPLES:
  1845. show flash -- Show flash memory info
  1846. show memory -- Show RAM and buffer info
  1847. show threads -- Shows the state of active threads in the system
  1848. show forwarder -- Shows the forwarder's learning tables and forwarder's
  1849. HAL interfaces
  1850. show blocks -- Shows the number of serial driver writes blocked due
  1851. to transmiting too much at once
  1852. show ecos -- Shows the eCos ip/tcp/udp statistics
  1853. show sockets -- Shows the eCos socket out of mbuf/cluster socket
  1854. history tracking logs
  1855. show fpm -- Displays the configuration settings and statistics of
  1856. the Hardware Free Pool Manager Object
  1857. show dqm -- Displays the internal state of the DQM interface
  1858. show nonvol -- Displays the current non-volatile settings values for
  1859. both the permanent and dynamic sections
  1862. ------------------------------------------------------------------------------
  1864. TABLE: Console/wifi
  1866. COMMAND: wl
  1868. USAGE: wl [CmdLine{63}]
  1870. DESCRIPTION:
  1871. Sends commands to the 802.11 diagnostic and manufacturing utility.
  1873. EXAMPLES:
  1874. wl [command line parms] --
  1876. ------------------------------------------------------------------------------
  1878. TABLE: HeapManager
  1880. COMMAND: bcheck
  1882. USAGE: bcheck
  1884. DESCRIPTION:
  1885. Runs a bounds check in the heap manager (if compiled in).
  1887. EXAMPLES:
  1888. bcheck --
  1890. ------------------------------------------------------------------------------
  1892. TABLE: HeapManager
  1894. COMMAND: bcheck_crash
  1896. USAGE: bcheck_crash [true|false]
  1898. DESCRIPTION:
  1899. Sets the behavior when an on-the-fly bounds checking error is detected.
  1900. Turning this on will cause the offending thread to crash after we print
  1901. relevant information.
  1903. EXAMPLES:
  1904. bcheck_crash true -- Enables crashing after on-the-fly bcheck error
  1905. detected.
  1907. ------------------------------------------------------------------------------
  1909. TABLE: HeapManager
  1911. COMMAND: bcheck_enable
  1913. USAGE: bcheck_enable [true|false]
  1915. DESCRIPTION:
  1916. Turns on-the-fly bounds checking on or off in the heap manager (if compiled
  1917. in). When this is on, we will validate pointers, seed values, and other heap
  1918. state during each alloc and free. When off, you must run bcheck manually to
  1919. detect errors.
  1921. EXAMPLES:
  1922. bcheck_enable true --
  1924. ------------------------------------------------------------------------------
  1926. TABLE: HeapManager
  1928. COMMAND: last_error
  1930. USAGE: last_error
  1932. DESCRIPTION:
  1933. Displays the last error that was detected by the heap manager.
  1935. EXAMPLES:
  1936. last_error --
  1938. ------------------------------------------------------------------------------
  1940. TABLE: HeapManager
  1942. COMMAND: maxAlloc
  1944. USAGE: maxAlloc
  1946. DESCRIPTION:
  1947. Displays the maximum number of bytes that can currently be allocated in a
  1948. single call to malloc. This takes into account all of the overhead for node
  1949. tracking and bounds checking, as well as the current fragmentation state of
  1950. the heap.
  1952. EXAMPLES:
  1953. maxAlloc --
  1955. ------------------------------------------------------------------------------
  1957. TABLE: HeapManager
  1959. COMMAND: memShow
  1961. USAGE: memShow
  1963. DESCRIPTION:
  1964. Displays summary of available heap.
  1966. EXAMPLES:
  1967. memShow --
  1969. ------------------------------------------------------------------------------
  1971. TABLE: HeapManager
  1973. COMMAND: stats
  1975. USAGE: stats
  1977. DESCRIPTION:
  1978. Displays detailed heap manager counters and statistics.
  1980. EXAMPLES:
  1981. stats --
  1983. ------------------------------------------------------------------------------
  1985. TABLE: HeapManager
  1987. COMMAND: threadUsage
  1989. USAGE: threadUsage
  1991. DESCRIPTION:
  1992. Displays total allocated memory per thread
  1994. EXAMPLES:
  1995. threadUsage --
  1997. ------------------------------------------------------------------------------
  1999. TABLE: HeapManager
  2001. COMMAND: trace
  2003. USAGE: trace tid [size]
  2005. DESCRIPTION:
  2006. Enables debug tracing for the specified thread ID or all threads if the
  2007. parameter is 0
  2009. EXAMPLES:
  2010. trace 0x80b0a0a0 24 - enable 24 byte alloc tracing for the thread with TID
  2011. 0x80b0a0a0
  2012. trace 0x80b0a0a0 - enable all alloc tracing for the thread with TID
  2013. 0x80b0a0a0
  2014. trace 0 - disable alloc tracing --
  2016. ------------------------------------------------------------------------------
  2018. TABLE: HeapManager
  2020. COMMAND: walk
  2022. USAGE: walk
  2024. DESCRIPTION:
  2025. Displays all of the free memory blocks.
  2027. EXAMPLES:
  2028. walk --
  2030. ------------------------------------------------------------------------------
  2032. TABLE: HeapManager
  2034. COMMAND: walk_alloc
  2036. USAGE: walk_alloc
  2038. DESCRIPTION:
  2039. Displays all of the allocated memory blocks. WARNING: This can print a LOT
  2040. of information!
  2042. EXAMPLES:
  2043. walk_alloc --
  2045. ------------------------------------------------------------------------------
  2047. TABLE: HostDqm
  2049. COMMAND: show
  2051. USAGE: show
  2053. DESCRIPTION:
  2054. Causes the HostDqm IF to display its internal state.
  2056. EXAMPLES:
  2057. show --
  2059. ------------------------------------------------------------------------------
  2061. TABLE: SA
  2063. COMMAND: SendOldOption61Enabled {hidden}
  2065. USAGE: SendOldOption61Enabled [Number{0..1}]
  2067. DESCRIPTION:
  2068. SendOldOption61Enabled <0|1>
  2070. EXAMPLES:
  2071. SendOldOption61Enabled 1
  2073. ------------------------------------------------------------------------------
  2075. TABLE: SA
  2077. COMMAND: bcm5325m_enable {hidden}
  2079. USAGE: bcm5325m_enable [Number{0..1}]
  2081. DESCRIPTION:
  2082. bcm5325m_enable <0|1>
  2084. EXAMPLES:
  2085. bcm5325m_enable 0 -- ethernet power down.
  2086. bcm5325m_enable 1 -- ethernet power up.
  2089. ------------------------------------------------------------------------------
  2091. TABLE: SA
  2093. COMMAND: chkMtaDevKey
  2095. USAGE: chkMtaDevKey
  2097. DESCRIPTION:
  2098. chkMtaDevKey -- verify MtaDevPrivateKey
  2100. EXAMPLES:
  2101. chkMtaDevKey
  2104. ------------------------------------------------------------------------------
  2106. TABLE: SA
  2108. COMMAND: dc_offset
  2110. USAGE: dc_offset [Number{0..65535}]
  2112. DESCRIPTION:
  2113. dc_offset (0~65535)
  2115. EXAMPLES:
  2116. dc_offset
  2118. ------------------------------------------------------------------------------
  2120. TABLE: SA
  2122. COMMAND: enableASAPMessage
  2124. USAGE: enableASAPMessage [Number{0..1}]
  2126. DESCRIPTION:
  2127. enableASAPMessage <0|1>
  2129. EXAMPLES:
  2130. enableASAPMessage
  2132. ------------------------------------------------------------------------------
  2134. TABLE: SA
  2136. COMMAND: enableDNSDecode
  2138. USAGE: enableDNSDecode [Number{0..1}]
  2140. DESCRIPTION:
  2141. enableDnsDecode <0|1>
  2143. EXAMPLES:
  2144. enableDnsDecode
  2146. ------------------------------------------------------------------------------
  2148. TABLE: SA
  2150. COMMAND: enableDsxDecode
  2152. USAGE: enableDsxDecode [Number{0..1}]
  2154. DESCRIPTION:
  2155. enableDsxDecode <0|1>
  2157. EXAMPLES:
  2158. enableDsxDecode
  2160. ------------------------------------------------------------------------------
  2162. TABLE: SA
  2164. COMMAND: enableNCSTimestamp
  2166. USAGE: enableNCSTimestamp [Number{0..1}]
  2168. DESCRIPTION:
  2169. enableNCSTimestamp <0|1>
  2171. EXAMPLES:
  2172. enableNCSTimestamp
  2174. ------------------------------------------------------------------------------
  2176. TABLE: SA
  2178. COMMAND: getAR8316PhyRegVal
  2180. USAGE: getAR8316PhyRegVal PhyAddr RegAddr
  2182. DESCRIPTION:
  2183. Reads AR8316 phy register value
  2185. EXAMPLES:
  2186. getAR8316PhyRegVal 0x1 0x0 -- reads the control register of first CPE
  2187. ethernet interface
  2190. ------------------------------------------------------------------------------
  2192. TABLE: SA
  2194. COMMAND: getAR8316RegVal
  2196. USAGE: getAR8316RegVal RegAddr
  2198. DESCRIPTION:
  2199. Reads AR8316 internal register value
  2201. EXAMPLES:
  2202. getAR8316RegVal 0x0 -- reads the mask control register
  2205. ------------------------------------------------------------------------------
  2207. TABLE: SA
  2209. COMMAND: gpio_on {hidden}
  2211. USAGE: gpio_on [Number{0..36}] [true|false]
  2213. DESCRIPTION:
  2214. gpio_on <GPIO number> <true/false>.
  2216. EXAMPLES:
  2217. gpio_on 2 true -- Turn GPIO 2 On.
  2218. gpio_on 4 false -- Turn GPIO 4 Off.
  2221. ------------------------------------------------------------------------------
  2223. TABLE: SA
  2225. COMMAND: gr303
  2227. USAGE: gr303 [Number{0..1}]
  2229. DESCRIPTION:
  2230. gr303 <0|1>
  2232. EXAMPLES:
  2233. gr303
  2235. ------------------------------------------------------------------------------
  2237. TABLE: SA
  2239. COMMAND: gw_startup
  2241. USAGE: gw_startup
  2243. DESCRIPTION:
  2244. Start up the Gateway
  2246. EXAMPLES:
  2247. gw_startup
  2249. ------------------------------------------------------------------------------
  2251. TABLE: SA
  2253. COMMAND: line_prov_status
  2255. USAGE: line_prov_status
  2257. DESCRIPTION:
  2258. Show Line Provision Status
  2260. EXAMPLES:
  2261. line_prov_status
  2263. ------------------------------------------------------------------------------
  2265. TABLE: SA
  2267. COMMAND: mta_cfg_show
  2269. USAGE: mta_cfg_show
  2271. DESCRIPTION:
  2272. mta_cfg_show
  2274. EXAMPLES:
  2275. mta_cfg_show
  2277. ------------------------------------------------------------------------------
  2279. TABLE: SA
  2281. COMMAND: ncs_log_show
  2283. USAGE: ncs_log_show
  2285. DESCRIPTION:
  2286. Show the NCS Log Table
  2288. EXAMPLES:
  2289. ncs_log_show
  2291. ------------------------------------------------------------------------------
  2293. TABLE: SA
  2295. COMMAND: reorder
  2297. USAGE: reorder
  2299. DESCRIPTION:
  2300. Send Re-Order Signal to endpoints
  2302. EXAMPLES:
  2303. ro
  2305. ------------------------------------------------------------------------------
  2307. TABLE: SA
  2309. COMMAND: ring_scale
  2311. USAGE: ring_scale [Number{0..65535}]
  2313. DESCRIPTION:
  2314. ring_scale (0~65535, default=0x39d8=14808)
  2316. EXAMPLES:
  2317. ring_scale
  2319. ------------------------------------------------------------------------------
  2321. TABLE: SA
  2323. COMMAND: rtpport
  2325. USAGE: rtpport [CNX{0..3}] [RTPPortNumber{1024..65520}]
  2327. DESCRIPTION:
  2328. Get/Set RTP Port Number /t rtpport <CNX> <RTPPortNumber>
  2330. EXAMPLES:
  2331. rtpport 0 53456
  2332. rtpport 1 53458
  2335. ------------------------------------------------------------------------------
  2337. TABLE: SA
  2339. COMMAND: sa_test_command
  2341. USAGE: sa_test_command
  2343. DESCRIPTION:
  2344. sa test command
  2346. EXAMPLES:
  2347. sa_test_command
  2349. ------------------------------------------------------------------------------
  2351. TABLE: SA
  2353. COMMAND: setAR8316PhyRegVal
  2355. USAGE: setAR8316PhyRegVal PhyAddr RegAddr Value
  2357. DESCRIPTION:
  2358. Sets AR8316 phy register value
  2360. EXAMPLES:
  2361. setAR8316PhyRegVal 0x1 0x0 0x1 -- sets the control register of first CPE
  2362. ethernet interface to 0x1
  2365. ------------------------------------------------------------------------------
  2367. TABLE: SA
  2369. COMMAND: setAR8316RegVal
  2371. USAGE: setAR8316RegVal RegAddr Value
  2373. DESCRIPTION:
  2374. Sets AR8316 internal register value
  2376. EXAMPLES:
  2377. setAR8316RegVal 0x0 0x1 -- sets the mask control register to 0x1
  2380. ------------------------------------------------------------------------------
  2382. TABLE: SA
  2384. COMMAND: setNotificationMode
  2386. USAGE: setNotificationMode [Number{0..1}]
  2388. DESCRIPTION:
  2389. setNotificationMode <0|1> .... 0-Lockstep Mode, 1-Loop Mode
  2391. EXAMPLES:
  2392. setNotificationMode 0
  2393. setNotificationMode 1
  2395. ------------------------------------------------------------------------------
  2397. TABLE: SA
  2399. COMMAND: setQuarantineBuffer
  2401. USAGE: setQuarantineBuffer [Number{0..100}]
  2403. DESCRIPTION:
  2404. setQuarantineBuffer <0..100>
  2405. 0.........Follow PacketCable compliant Quarantine buffer handling
  2406. 1~100.....The number of events to maintain in the quarantine buffer before
  2407. flushing
  2409. EXAMPLES:
  2410. setQuarantineBuffer 0
  2411. setQuarantineBuffer 99
  2413. ------------------------------------------------------------------------------
  2415. TABLE: SA
  2417. COMMAND: showCallCounter
  2419. USAGE: showCallCounter
  2421. DESCRIPTION:
  2422. showCallCounter
  2424. EXAMPLES:
  2425. showCallCounter
  2427. ------------------------------------------------------------------------------
  2429. TABLE: SA
  2431. COMMAND: showCmCfgTlv
  2433. USAGE: showCmCfgTlv
  2435. DESCRIPTION:
  2436. showCmCfgTlv
  2438. EXAMPLES:
  2439. showCmCfgTlv
  2441. ------------------------------------------------------------------------------
  2443. TABLE: SA
  2445. COMMAND: showCmConfigFile
  2447. USAGE: showCmConfigFile
  2449. DESCRIPTION:
  2450. showCmConfigFile
  2452. EXAMPLES:
  2453. showCmConfigFile
  2455. ------------------------------------------------------------------------------
  2457. TABLE: SA
  2459. COMMAND: showCmConfigIP
  2461. USAGE: showCmConfigIP
  2463. DESCRIPTION:
  2464. showCmConfigIP
  2466. EXAMPLES:
  2467. showCmConfigIP
  2469. ------------------------------------------------------------------------------
  2471. TABLE: SA
  2473. COMMAND: showDsSignal
  2475. USAGE: showDsSignal
  2477. DESCRIPTION:
  2478. showDsSignal
  2480. EXAMPLES:
  2481. showDsSignal
  2483. ------------------------------------------------------------------------------
  2485. TABLE: SA
  2487. COMMAND: showMtaConfigFile
  2489. USAGE: showMtaConfigFile
  2491. DESCRIPTION:
  2492. showMtaConfigFile
  2494. EXAMPLES:
  2495. showMtaConfigFile
  2497. ------------------------------------------------------------------------------
  2499. TABLE: SA
  2501. COMMAND: showMtaConfigIP
  2503. USAGE: showMtaConfigIP
  2505. DESCRIPTION:
  2506. showMtaConfigIP
  2508. EXAMPLES:
  2509. showMtaConfigIP
  2511. ------------------------------------------------------------------------------
  2513. TABLE: SA
  2515. COMMAND: showMtaProvState
  2517. USAGE: showMtaProvState
  2519. DESCRIPTION:
  2520. showMtaProvState
  2522. EXAMPLES:
  2523. showMtaProvState
  2525. ------------------------------------------------------------------------------
  2527. TABLE: SA
  2529. COMMAND: showNCSConnection
  2531. USAGE: showNCSConnection
  2533. DESCRIPTION:
  2534. showNCSConnection
  2536. EXAMPLES:
  2537. showNCSConnection
  2539. ------------------------------------------------------------------------------
  2541. TABLE: SA
  2543. COMMAND: showNumberOfCpes
  2545. USAGE: showNumberOfCpes
  2547. DESCRIPTION:
  2548. showNumberOfCpes
  2550. EXAMPLES:
  2551. showNumberOfCpes
  2553. ------------------------------------------------------------------------------
  2555. TABLE: SA
  2557. COMMAND: showResetEvents
  2559. USAGE: showResetEvents
  2561. DESCRIPTION:
  2562. showResetEvents
  2564. EXAMPLES:
  2565. showResetEvents
  2567. ------------------------------------------------------------------------------
  2569. TABLE: SA
  2571. COMMAND: showSFStatistics
  2573. USAGE: showSFStatistics
  2575. DESCRIPTION:
  2576. showSFStatistics
  2578. EXAMPLES:
  2579. showSFStatistics
  2581. ------------------------------------------------------------------------------
  2583. TABLE: SA
  2585. COMMAND: showScrSwDl
  2587. USAGE: showScrSwDl
  2589. DESCRIPTION:
  2590. showScrSwDl
  2592. EXAMPLES:
  2593. showScrSwDl
  2595. ------------------------------------------------------------------------------
  2597. TABLE: SA
  2599. COMMAND: showSwLoadName
  2601. USAGE: showSwLoadName
  2603. DESCRIPTION:
  2604. showSwLoadName
  2606. EXAMPLES:
  2607. showSwLoadName
  2609. ------------------------------------------------------------------------------
  2611. TABLE: SA
  2613. COMMAND: showSystemTime
  2615. USAGE: showSystemTime
  2617. DESCRIPTION:
  2618. showSystemTime
  2620. EXAMPLES:
  2621. showSystemTime
  2623. ------------------------------------------------------------------------------
  2625. TABLE: SA
  2627. COMMAND: showUsSignal
  2629. USAGE: showUsSignal
  2631. DESCRIPTION:
  2632. showUsSignal
  2634. EXAMPLES:
  2635. showUsSignal
  2637. ------------------------------------------------------------------------------
  2639. TABLE: SA
  2641. COMMAND: t38_sram
  2643. USAGE: t38_sram [Number{0..1}]
  2645. DESCRIPTION:
  2646. t38_sram <0|1>
  2648. EXAMPLES:
  2649. t38_sram
  2651. ------------------------------------------------------------------------------
  2653. TABLE: SA
  2655. COMMAND: tel_reset
  2657. USAGE: tel_reset
  2659. DESCRIPTION:
  2660. tel_reset
  2662. EXAMPLES:
  2663. tel_reset -- Reset Telephone line port.
  2666. ------------------------------------------------------------------------------
  2668. TABLE: SA
  2670. COMMAND: tl08
  2672. USAGE: tl08
  2674. DESCRIPTION:
  2675. tl08
  2677. EXAMPLES:
  2678. tl08
  2680. ------------------------------------------------------------------------------
  2682. TABLE: battery
  2684. COMMAND: clearChgErrs
  2686. USAGE: clearChgErrs A|B
  2688. DESCRIPTION:
  2689. Clears existing charge errors for the specified battery
  2691. EXAMPLES:
  2692. clearChgErrs A
  2694. ------------------------------------------------------------------------------
  2696. TABLE: battery
  2698. COMMAND: diagErrors
  2700. USAGE: diagErrors A|B errors{-1..4}
  2702. DESCRIPTION:
  2703. Instructs the battery controller to report the number of charger errors as
  2704. the specified number of errors. This is strictly a diagnostic tool to
  2705. evaluate system behavior without the need for a defective battery. Note that
  2706. setting this to -1 will disable the diagnostic mode and return the system to
  2707. reporting the actual number of errors.
  2709. EXAMPLES:
  2710. diagErrors 1 -- Set the diagnostic error count for the specified battery to
  2711. 1.
  2712. diagErrors -1 -- Disable diagnostic mode, return to real error count.
  2715. ------------------------------------------------------------------------------
  2717. TABLE: battery
  2719. COMMAND: diagTemp
  2721. USAGE: diagTemp [degrees C{-20..101}]
  2723. DESCRIPTION:
  2724. Instructs the battery controller to report the measured temperature as the
  2725. specified temperature. This is strictly a diagnostic tool to evaluate system
  2726. behavior without the need for an environmental chamber. Note that setting
  2727. this to 101 degrees C will disable the diagnostic mode and return the system
  2728. to reporting the actual measured temperature.
  2730. EXAMPLES:
  2731. diagTemp 60 -- Set the diagnostic temperature to 60 degrees C.
  2732. diagTemp 101 -- Disable diagnostic mode, return to real temp.
  2735. ------------------------------------------------------------------------------
  2737. TABLE: battery
  2739. COMMAND: diagnoseState
  2741. USAGE: diagnoseState
  2743. DESCRIPTION:
  2744. Attempts to diagnose the current state of the microcontroller.
  2746. EXAMPLES:
  2747. diagnoseState
  2749. ------------------------------------------------------------------------------
  2751. TABLE: battery
  2753. COMMAND: enableCharge
  2755. USAGE: enableCharge [enable]
  2757. DESCRIPTION:
  2758. Enable or disable battery charging.
  2760. EXAMPLES:
  2761. enableCharge true -- Enable charging.
  2762. enableCharge false -- Disable charging.
  2764. ------------------------------------------------------------------------------
  2766. TABLE: battery
  2768. COMMAND: event
  2770. USAGE: event [utility|battery]
  2772. DESCRIPTION:
  2773. Simulates battery system events. utility - publish event indicating switch
  2774. to utility power battery - publish event indicating switch to battery
  2775. powerNote that this is a simulation by way of the battery system event
  2776. publisher and does *NOT* affect the actual system state. As a result,
  2777. command 'event battery' will publish the event, and thereby invoke power save
  2778. mode, however a 'show' command in this directory will still display the
  2779. actual current power source and other measured information.
  2781. EXAMPLES:
  2782. event battery -- Publish an event indicating transition to battery power.
  2783. event utility -- Publish an event indicating transition to utility power.
  2786. ------------------------------------------------------------------------------
  2788. TABLE: battery
  2790. COMMAND: forcedCharge
  2792. USAGE: forcedCharge A|B FCVTERM{0..100}
  2794. DESCRIPTION:
  2795. Instructs the battery controller to start forced charge on a given battery up
  2796. to the specified percentage.
  2798. EXAMPLES:
  2799. forcedCharge A 80.4 -- Forced charge battery A to 80.4%
  2801. ------------------------------------------------------------------------------
  2803. TABLE: battery
  2805. COMMAND: forcedDchg
  2807. USAGE: forcedDchg A|B FDVTERM{0..12.6}
  2809. DESCRIPTION:
  2810. Instructs the battery controller to start forced discharge on a given battery
  2811. down to a specified voltage.
  2813. EXAMPLES:
  2814. forcedDchg A 7.0 -- Forced discharge battery A
  2816. ------------------------------------------------------------------------------
  2818. TABLE: battery
  2820. COMMAND: init
  2822. USAGE: init
  2824. DESCRIPTION:
  2825. Initialize the battery HW.
  2827. EXAMPLES:
  2828. init
  2830. ------------------------------------------------------------------------------
  2832. TABLE: battery
  2834. COMMAND: logData
  2836. USAGE: logData [enable]
  2838. DESCRIPTION:
  2839. Enable or disable battery logging mode. In logging mode, data retrieved from
  2840. battery updates will be logged to the console.
  2843. EXAMPLES:
  2844. logData true -- Enable data logging.
  2845. logData false -- Disable data logging.
  2847. ------------------------------------------------------------------------------
  2849. TABLE: battery
  2851. COMMAND: packTemp
  2853. USAGE: packTemp A|B
  2855. DESCRIPTION:
  2856. Returns the current pack temperature for the specified pack (LPV modems) or
  2857. board temperature (non-LPV modems).
  2859. EXAMPLES:
  2860. packTemp A -- Pack temperature for battery A
  2862. ------------------------------------------------------------------------------
  2864. TABLE: battery
  2866. COMMAND: profileDchg
  2868. USAGE: profileDchg [enable]
  2870. DESCRIPTION:
  2871. Enable or disable battery discharge profiling mode.
  2874. EXAMPLES:
  2875. profileDchg true -- Enable discharge profiling.
  2876. profileDchg false -- Disable discharge profiling.
  2878. ------------------------------------------------------------------------------
  2880. TABLE: battery
  2882. COMMAND: readEprom
  2884. USAGE: readEprom A|B NumberOfBytes{1..128}
  2886. DESCRIPTION:
  2887. Read the battery eeprom and display content in hex and ascii.
  2889. EXAMPLES:
  2890. readEprom A 32 -- Read first 32 bytes of EEPROM from battery A.
  2891. readEprom B 64 -- Read first 64 bytes of EEPROM from battery B.
  2894. ------------------------------------------------------------------------------
  2896. TABLE: battery
  2898. COMMAND: samplesShow
  2900. USAGE: samplesShow
  2902. DESCRIPTION:
  2903. Display battery voltage sample history.
  2905. EXAMPLES:
  2906. samplesShow
  2908. ------------------------------------------------------------------------------
  2910. TABLE: battery
  2912. COMMAND: show
  2914. USAGE: show
  2916. DESCRIPTION:
  2917. Display battery information.
  2919. EXAMPLES:
  2920. show
  2922. ------------------------------------------------------------------------------
  2924. TABLE: battery
  2926. COMMAND: stopCharge
  2928. USAGE: stopCharge
  2930. DESCRIPTION:
  2931. Instructs the battery charger to stop charge battery.
  2933. EXAMPLES:
  2934. stopCharge -- Stop in-progess charge
  2936. ------------------------------------------------------------------------------
  2938. TABLE: battery
  2940. COMMAND: stopForcedDchg
  2942. USAGE: stopForcedDchg
  2944. DESCRIPTION:
  2945. Instructs the battery charger to stop forced discharge battery.
  2947. EXAMPLES:
  2948. stopForcedDchg -- Stop in-progess forced discharge
  2950. ------------------------------------------------------------------------------
  2952. TABLE: battery
  2954. COMMAND: threadShow
  2956. USAGE: threadShow
  2958. DESCRIPTION:
  2959. Display battery thread information.
  2961. EXAMPLES:
  2962. threadShow
  2964. ------------------------------------------------------------------------------
  2966. TABLE: battery
  2968. COMMAND: timers
  2970. USAGE: timers
  2972. DESCRIPTION:
  2973. Display battery thread timer information.
  2975. EXAMPLES:
  2976. timers
  2978. ------------------------------------------------------------------------------
  2980. TABLE: battery/ate
  2982. COMMAND: dumDchgTbl
  2984. USAGE: dumDchgTbl A|B
  2986. DESCRIPTION:
  2987. Dump the specified discharge table.
  2989. EXAMPLES:
  2990. dumDchgTbl A
  2992. ------------------------------------------------------------------------------
  2994. TABLE: battery/ate
  2996. COMMAND: forceWDtimeout
  2998. USAGE: forceWDtimeout
  3000. DESCRIPTION:
  3001. Forces a battery microcontroller watchdog timeout.
  3003. EXAMPLES:
  3004. forceWDtimeout -- Force battery microcontroller watchdog timeout
  3006. ------------------------------------------------------------------------------
  3008. TABLE: battery/ate
  3010. COMMAND: rawPicoState
  3012. USAGE: rawPicoState
  3014. DESCRIPTION:
  3015. Retrieve the raw battery microcontroller state.
  3017. EXAMPLES:
  3018. rawPicoState
  3020. ------------------------------------------------------------------------------
  3022. TABLE: battery/ate
  3024. COMMAND: suspCharge
  3026. USAGE: suspCharge [enable]
  3028. DESCRIPTION:
  3029. Suspend or re-allow battery charging.
  3031. EXAMPLES:
  3032. suspCharge true -- Suspend charging.
  3033. suspCharge false -- Re-allow charging.
  3035. ------------------------------------------------------------------------------
  3037. TABLE: cablemedea
  3039. COMMAND: arp_show
  3041. USAGE: arp_show
  3043. DESCRIPTION:
  3044. arp_show
  3046. EXAMPLES:
  3047. arp_show -- Displays the current ARP table information.
  3049. ------------------------------------------------------------------------------
  3051. TABLE: cablemedea
  3053. COMMAND: arppacket_show
  3055. USAGE: arppacket_show
  3057. DESCRIPTION:
  3058. arppacket_show
  3060. EXAMPLES:
  3061. arppacket_show -- Displays the current ARP Packet information.
  3063. ------------------------------------------------------------------------------
  3065. TABLE: cablemedea
  3067. COMMAND: capt_show
  3069. USAGE: capt_show
  3071. DESCRIPTION:
  3072. capt_show
  3074. EXAMPLES:
  3075. capt_show -- Displays the current CAPT (Passthrough) contents.
  3077. ------------------------------------------------------------------------------
  3079. TABLE: cablemedea
  3081. COMMAND: debug_kerb
  3083. USAGE: debug_kerb DebugLevel{0..3360}
  3085. DESCRIPTION:
  3086. debug_kerb -- Sets the Kerberos debug level where level is an int from
  3087. -- 0 (silent) to 9 (verbose).
  3089. EXAMPLES:
  3090. debug_kerb 1
  3092. ------------------------------------------------------------------------------
  3094. TABLE: cablemedea
  3096. COMMAND: fwr_show
  3098. USAGE: fwr_show
  3100. DESCRIPTION:
  3101. fwr_show
  3103. EXAMPLES:
  3104. fwr_show -- Displays current firewall ruleset.
  3106. ------------------------------------------------------------------------------
  3108. TABLE: cablemedea
  3110. COMMAND: k_prin_name
  3112. USAGE: k_prin_name [String{19}]
  3114. DESCRIPTION:
  3115. Change the Kerberos principal name.
  3118. EXAMPLES:
  3119. k_prin_name [PrincipalName]
  3120. example:
  3121. k_prin_name PSElement
  3123. ------------------------------------------------------------------------------
  3125. TABLE: cablemedea
  3127. COMMAND: kerb_test
  3129. USAGE: kerb_test String{19} IpAddress [IpAddress]
  3131. DESCRIPTION:
  3132. kerb_test -- Start kerberos for SNMP (debug).
  3134. EXAMPLES:
  3135. kerbtest [Realm] [KDC IP Addr] [ProvServer IP Addr]
  3136. example:
  3137. kerb_test BROADCOM.COM 10.24.33.123 10.24.33.123
  3139. ------------------------------------------------------------------------------
  3141. TABLE: cablemedea
  3143. COMMAND: lan_add_interface
  3145. USAGE: lan_add_interface
  3147. DESCRIPTION:
  3148. lan_add_interface
  3150. EXAMPLES:
  3151. lan_add_interface -- This command will add a network interface to the
  3152. managed interface table.
  3154. ------------------------------------------------------------------------------
  3156. TABLE: cablemedea
  3158. COMMAND: lan_network_add
  3160. USAGE: lan_network_add
  3162. DESCRIPTION:
  3163. lan_network_add - This command will prompt the user for a network
  3164. configuration
  3165. to be applied to a specific local (LAN) interface.
  3166. Each interface can be configured as a passthrough,
  3167. a NAPT, or a public routable interface.
  3170. EXAMPLES:
  3171. lan_network_add
  3173. ------------------------------------------------------------------------------
  3175. TABLE: cablemedea
  3177. COMMAND: lan_network_clearall
  3179. USAGE: lan_network_clearall
  3181. DESCRIPTION:
  3182. lan_network_clearall
  3184. EXAMPLES:
  3185. lan_network_clearall -- This command will clear all managed network
  3186. interface configurations.
  3188. ------------------------------------------------------------------------------
  3190. TABLE: cablemedea
  3192. COMMAND: lan_network_remove
  3194. USAGE: lan_network_remove
  3196. DESCRIPTION:
  3197. lan_network_remove
  3199. EXAMPLES:
  3200. lan_network_remove -- This command will remove a LAN network.
  3202. ------------------------------------------------------------------------------
  3204. TABLE: cablemedea
  3206. COMMAND: lan_network_show
  3208. USAGE: lan_network_show
  3210. DESCRIPTION:
  3211. lan_network_show
  3213. EXAMPLES:
  3214. lan_network_show -- Displays the current LAN network configuration per
  3215. interface.
  3217. ------------------------------------------------------------------------------
  3219. TABLE: cablemedea
  3221. COMMAND: lan_remove_interface
  3223. USAGE: lan_remove_interface
  3225. DESCRIPTION:
  3226. lan_remove_interface
  3228. EXAMPLES:
  3229. lan_remove_interface -- This command will add a network interface to the
  3230. managed interface table.
  3232. ------------------------------------------------------------------------------
  3234. TABLE: cablemedea
  3236. COMMAND: nat_show
  3238. USAGE: nat_show
  3240. DESCRIPTION:
  3241. nat_show
  3243. EXAMPLES:
  3244. nat_show -- Displays the current NAT info.
  3246. ------------------------------------------------------------------------------
  3248. TABLE: cablemedea
  3250. COMMAND: traceroute
  3252. USAGE: traceroute [-s [IpAddress]] [-m [Number{0..255}]] [-p [Number{1..65534}]] [-l [Number{0..65535}]] [-r] TargetIpAddress{127}
  3254. DESCRIPTION:
  3255. traceroute - displays the hops from the router to a destination target
  3256. (host) hostname or IP address to trace the route to
  3257. -m maximum number of hops to find target (default 255)
  3258. -l set the data size in bytes of each probe packet (default 32)
  3259. -p set base UDP port used in probes (default 33434)
  3260. -r resolve host IP addresses for each hop (default off) -s specify the
  3261. source ip address to run traceroute (default route table)
  3264. EXAMPLES:
  3265. traceroute www.yahoo.com -- Performs traceroute with default
  3266. parameters.
  3267. traceroute -s 10.15.6.3 www.yahoo.com -- Perform traceroute from
  3268. 10.15.6.3.
  3269. traceroute -m 10 www.yahoo.com -- Performs traceroute with MaxTTL
  3270. 10.
  3271. traceroute -l 64 -p 65000 www.yahoo.com -- Performs traceroute using port
  3272. 65000 and data len 64 bytes.
  3275. ------------------------------------------------------------------------------
  3277. TABLE: cablemedea
  3279. COMMAND: usfs_show
  3281. USAGE: usfs_show
  3283. DESCRIPTION:
  3284. usfs_show
  3286. EXAMPLES:
  3287. usfs_show -- Displays the current USFS table contents.
  3289. ------------------------------------------------------------------------------
  3291. TABLE: cablemedea
  3293. COMMAND: wandata_show
  3295. USAGE: wandata_show
  3297. DESCRIPTION:
  3298. wandata_show
  3300. EXAMPLES:
  3301. wandata_show -- Displays the current Wan Data Address table contents.
  3303. ------------------------------------------------------------------------------
  3305. TABLE: cablemedea/dhcps
  3307. COMMAND: add_lease
  3309. USAGE: add_lease
  3311. DESCRIPTION:
  3312. add_lease
  3314. EXAMPLES:
  3315. add_lease -- Adds a Dhcp server lease associating client id with Ip address.
  3317. ------------------------------------------------------------------------------
  3319. TABLE: cablemedea/dhcps
  3321. COMMAND: enable
  3323. USAGE: enable [true|false]
  3325. DESCRIPTION:
  3326. Enables or disables the DHCP server
  3328. EXAMPLES:
  3329. enable true - enables the DHCP server for provisioning.
  3332. ------------------------------------------------------------------------------
  3334. TABLE: cablemedea/dhcps
  3336. COMMAND: remove_lease
  3338. USAGE: remove_lease
  3340. DESCRIPTION:
  3341. remove_lease
  3343. EXAMPLES:
  3344. remove_lease -- Removes a Dhcp server lease, the user will be prompted for a
  3345. client id
  3347. ------------------------------------------------------------------------------
  3349. TABLE: cablemedea/dhcps
  3351. COMMAND: show
  3353. USAGE: show
  3355. DESCRIPTION:
  3356. show
  3358. EXAMPLES:
  3359. show -- Displays the current DHCP server information.
  3361. ------------------------------------------------------------------------------
  3363. TABLE: cablemedea/dns
  3365. COMMAND: dns_debug
  3367. USAGE: dns_debug [Number{0..1}]
  3369. DESCRIPTION:
  3370. Enables/Disables DNS debug information.
  3372. EXAMPLES:
  3373. dns_debug 1 -- Enable DNS debug.
  3374. dns_debug 0 -- Disabled DNS debug.
  3376. ------------------------------------------------------------------------------
  3378. TABLE: cablemedea/dns
  3380. COMMAND: dns_show
  3382. USAGE: dns_show
  3384. DESCRIPTION:
  3385. dns_show
  3387. EXAMPLES:
  3388. dns_show -- Displays current DNS information.
  3390. ------------------------------------------------------------------------------
  3392. TABLE: cablemedea/dns
  3394. COMMAND: gethostbyaddr
  3396. USAGE: gethostbyaddr [Host]
  3398. DESCRIPTION:
  3399. Queries the configured DNS resolver for the host address.
  3401. EXAMPLES:
  3402. gethostbyaddr 1.2.3.4 --
  3404. ------------------------------------------------------------------------------
  3406. TABLE: cablemedea/dns
  3408. COMMAND: gethostbyname
  3410. USAGE: gethostbyname [Host{63}]
  3412. DESCRIPTION:
  3413. Queries the configured DNS resolver for the host name.
  3415. EXAMPLES:
  3416. gethostbyname host --
  3418. ------------------------------------------------------------------------------
  3420. TABLE: cablemedea/hnap
  3422. COMMAND: control_if
  3424. USAGE: control_if [UUID{127}] [true|false]
  3426. DESCRIPTION:
  3427. control_if (device/service urn) true/false
  3429. EXAMPLES:
  3430. control_if urn:schemas-upnp-org:service:WANIPConnection:1 false -- Disables
  3431. the W
  3432. anIpConnect
  3433. ion s
  3434. ervice.
  3436. ------------------------------------------------------------------------------
  3438. TABLE: cablemedea/hnap
  3440. COMMAND: device_discovery
  3442. USAGE: device_discovery
  3444. DESCRIPTION:
  3445. device_discovery
  3447. EXAMPLES:
  3448. device_discovery -- Performs Hnap discovery via ssdp:all.
  3450. ------------------------------------------------------------------------------
  3452. TABLE: cablemedea/hnap
  3454. COMMAND: discovery_show
  3456. USAGE: discovery_show
  3458. DESCRIPTION:
  3459. discovery_show
  3461. EXAMPLES:
  3462. discovery_show -- Displays current discovered Hnap devices.
  3464. ------------------------------------------------------------------------------
  3466. TABLE: cablemedea/hnap
  3468. COMMAND: enable
  3470. USAGE: enable [true|false]
  3472. DESCRIPTION:
  3473. enable true/false to control the runtime-operation of the Hnap service.
  3475. EXAMPLES:
  3476. enable true -- Enables the runtime operation of the Hnap service.
  3478. ------------------------------------------------------------------------------
  3480. TABLE: cablemedea/hnap
  3482. COMMAND: notify_show
  3484. USAGE: notify_show
  3486. DESCRIPTION:
  3487. notify_show
  3489. EXAMPLES:
  3490. notify_show -- Displays control point notifications.
  3492. ------------------------------------------------------------------------------
  3494. TABLE: cablemedea/hnap
  3496. COMMAND: show
  3498. USAGE: show
  3500. DESCRIPTION:
  3501. show
  3503. EXAMPLES:
  3504. show -- Displays current Hnap (Universal Plug-n-Plug) settings.
  3506. ------------------------------------------------------------------------------
  3508. TABLE: cablemedea/rip
  3510. COMMAND: rip_show
  3512. USAGE: rip_show
  3514. DESCRIPTION:
  3515. rip_show
  3517. EXAMPLES:
  3518. rip_show -- Displays current RIP (Routing Information Protocol) settings.
  3520. ------------------------------------------------------------------------------
  3522. TABLE: cablemedea/route
  3524. COMMAND: reload_route_service
  3526. USAGE: reload_route_service
  3528. DESCRIPTION:
  3529. reload_route_service
  3531. EXAMPLES:
  3532. reload_route_service -- This reconfigures the route service using the
  3533. current non-vol settings.
  3535. ------------------------------------------------------------------------------
  3537. TABLE: cablemedea/route
  3539. COMMAND: route_show
  3541. USAGE: route_show
  3543. DESCRIPTION:
  3544. route_show
  3546. EXAMPLES:
  3547. route_show -- Displays current route service settings.
  3549. ------------------------------------------------------------------------------
  3551. TABLE: cablemedea/upnp
  3553. COMMAND: control_if
  3555. USAGE: control_if [UUID{127}] [true|false]
  3557. DESCRIPTION:
  3558. control_if (device/service urn) true/false
  3560. EXAMPLES:
  3561. control_if urn:schemas-upnp-org:service:WANIPConnection:1 false -- Disables
  3562. the W
  3563. anIpConnect
  3564. ion s
  3565. ervice.
  3567. ------------------------------------------------------------------------------
  3569. TABLE: cablemedea/upnp
  3571. COMMAND: device_discovery
  3573. USAGE: device_discovery
  3575. DESCRIPTION:
  3576. device_discovery
  3578. EXAMPLES:
  3579. device_discovery -- Performs UPnP discovery via ssdp:all.
  3581. ------------------------------------------------------------------------------
  3583. TABLE: cablemedea/upnp
  3585. COMMAND: discovery_show
  3587. USAGE: discovery_show
  3589. DESCRIPTION:
  3590. discovery_show
  3592. EXAMPLES:
  3593. discovery_show -- Displays current discovered UPnP devices.
  3595. ------------------------------------------------------------------------------
  3597. TABLE: cablemedea/upnp
  3599. COMMAND: enable
  3601. USAGE: enable [true|false]
  3603. DESCRIPTION:
  3604. enable true/false to control the runtime-operation of the UPnP service.
  3606. EXAMPLES:
  3607. enable true -- Enables the runtime operation of the UPnP service.
  3609. ------------------------------------------------------------------------------
  3611. TABLE: cablemedea/upnp
  3613. COMMAND: notify_show
  3615. USAGE: notify_show
  3617. DESCRIPTION:
  3618. notify_show
  3620. EXAMPLES:
  3621. notify_show -- Displays control point notifications.
  3623. ------------------------------------------------------------------------------
  3625. TABLE: cablemedea/upnp
  3627. COMMAND: qos_active_show
  3629. USAGE: qos_active_show
  3631. DESCRIPTION:
  3632. qos_active_show
  3634. EXAMPLES:
  3635. qos_active_show -- Displays active discovered QoS devices.
  3637. ------------------------------------------------------------------------------
  3639. TABLE: cablemedea/upnp
  3641. COMMAND: qos_int_device_show
  3643. USAGE: qos_int_device_show
  3645. DESCRIPTION:
  3646. qos_int_device_show
  3648. EXAMPLES:
  3649. qos_int_device_show -- Displays info. of the PS internal QoS device service.
  3651. ------------------------------------------------------------------------------
  3653. TABLE: cablemedea/upnp
  3655. COMMAND: qos_policy_table_show
  3657. USAGE: qos_policy_table_show
  3659. DESCRIPTION:
  3660. qos_policy_table_show
  3662. EXAMPLES:
  3663. qos_policy_table_show -- Displays the QoS policy table contents.
  3665. ------------------------------------------------------------------------------
  3667. TABLE: cablemedea/upnp
  3669. COMMAND: show
  3671. USAGE: show
  3673. DESCRIPTION:
  3674. show
  3676. EXAMPLES:
  3677. show -- Displays current UPnP (Universal Plug-n-Plug) settings.
  3679. ------------------------------------------------------------------------------
  3681. TABLE: cablemedea/vpn
  3683. COMMAND: dump
  3685. USAGE: dump
  3687. DESCRIPTION:
  3688. Dumps the SAD and SPD
  3690. EXAMPLES:
  3691. dump
  3693. ------------------------------------------------------------------------------
  3695. TABLE: cablemedea/vpn
  3697. COMMAND: ike_test_connect
  3699. USAGE: ike_test_connect [tunnel]
  3701. DESCRIPTION:
  3702. {No command help available...}
  3704. EXAMPLES:
  3705. ike_test_connect tunnel
  3707. ------------------------------------------------------------------------------
  3709. TABLE: cablemedea/vpn
  3711. COMMAND: ike_test_disconnect
  3713. USAGE: ike_test_disconnect [tunnel]
  3715. DESCRIPTION:
  3716. {No command help available...}
  3718. EXAMPLES:
  3719. ike_test_disconnect tunnel
  3721. ------------------------------------------------------------------------------
  3723. TABLE: cablemedea/vpn
  3725. COMMAND: ike_test_start_keyneg
  3727. USAGE: ike_test_start_keyneg [spid]
  3729. DESCRIPTION:
  3730. {No command help available...}
  3732. EXAMPLES:
  3733. ike_test_start_keyneg <spid>
  3735. ------------------------------------------------------------------------------
  3737. TABLE: cablemedea/vpn
  3739. COMMAND: start
  3741. USAGE: start
  3743. DESCRIPTION:
  3744. Starts IKE
  3746. EXAMPLES:
  3747. start
  3749. ------------------------------------------------------------------------------
  3751. TABLE: cablemedea/vpn
  3753. COMMAND: stop
  3755. USAGE: stop
  3757. DESCRIPTION:
  3758. Stops IKE
  3760. EXAMPLES:
  3761. stop
  3763. ------------------------------------------------------------------------------
  3765. TABLE: cm_hal
  3767. COMMAND: D3PowerSave
  3769. USAGE: D3PowerSave on/off{0..1}
  3771. DESCRIPTION:
  3772. Turns on/off D3 power save mode.
  3774. EXAMPLES:
  3775. D3PowerSave 1 -- Turns on Docsis 3 power save mode features
  3777. ------------------------------------------------------------------------------
  3779. TABLE: cm_hal
  3781. COMMAND: PowerSave
  3783. USAGE: PowerSave idleMode{0..3} CPUFreq{1..2000} Amp{0..1} Sdram{0..1}
  3785. DESCRIPTION:
  3786. Turns on power save mode. The first parameter is the power save mode: 0 =
  3787. off 1=disable ETH and USB 2=mode1 plus CPU Halt on idle. The second
  3788. parameter is the CPU freq (50, 100, 150, or 200 mHz). The third parameter (0
  3789. or 1) controls disabling the upstream amp. The fourth parm (0 or 1) controls
  3790. disabling the SDRAM
  3792. EXAMPLES:
  3793. PowerSave 1 50 1 1 -- Power Save mode 1, CPU 50 MHz, Amp, and SDRAM
  3794. disabled
  3796. ------------------------------------------------------------------------------
  3798. TABLE: cm_hal
  3800. COMMAND: ackcel_show
  3802. USAGE: ackcel_show [-0]
  3804. DESCRIPTION:
  3805. Prints AckCel state/counters. Use the -0 flag to clear the counters after
  3806. they are displayed.
  3808. EXAMPLES:
  3809. ackcel_show -- Shows AckCel state/counters
  3810. ackcel_show -0 -- Shows AckCel state and clears counters
  3812. ------------------------------------------------------------------------------
  3814. TABLE: cm_hal
  3816. COMMAND: add_dsid
  3818. USAGE: add_dsid DSID
  3820. DESCRIPTION:
  3821. Calls the CM HAL to add a multicast DSID to the DS MAC receive filter
  3823. EXAMPLES:
  3824. multicast_table --
  3826. ------------------------------------------------------------------------------
  3828. TABLE: cm_hal
  3830. COMMAND: bcmalloc_show
  3832. USAGE: bcmalloc_show [-c]
  3834. DESCRIPTION:
  3835. Displays a snapshot of the current BcmAlloc memory pool statistics. If -c is
  3836. specified, then the counters are also cleared.
  3838. EXAMPLES:
  3839. bcmalloc_show --
  3841. ------------------------------------------------------------------------------
  3843. TABLE: cm_hal
  3845. COMMAND: bist_test
  3847. USAGE: bist_test
  3849. DESCRIPTION:
  3850. Runs the CM MAC h/w BIST Tests.
  3852. EXAMPLES:
  3853. bist_test --
  3855. ------------------------------------------------------------------------------
  3857. TABLE: cm_hal
  3859. COMMAND: change
  3861. USAGE: change [-s] [-c] cos|cls|phs|flow [index]
  3863. DESCRIPTION:
  3864. Changes information about Classifiers, Service Flows, PHS, DOCSIS 1.0 Class
  3865. of Service, and other objects in the system.
  3867. cos -- Selects the DOCSIS 1.0 Class of Service object.
  3868. cls -- Selects Classifiers.
  3869. phs -- Selects PHS Rules.
  3870. flow -- Selects Service Flows.
  3871. -s -- Changes the settings for the selected object (you will be
  3872. prompted for the values).
  3873. -c -- Clears the counters for the selected object.
  3874. index -- Selects a specific instance of the object type.
  3876. The index is shown when you list the objects with the 'show' command. You
  3877. must specify one of each of the object type and -s or -c parameters; there
  3878. are no defaults. The index is optional; if missing, all instances are
  3879. changed.
  3881. EXAMPLES:
  3882. change cls -c 2 -- Clears the counters for the specified Classifier.
  3883. change cls -c -- Clears the counters for all Classifiers.
  3884. change flow -s 1 -- Changes the settings for the specified Service Flow.
  3886. ------------------------------------------------------------------------------
  3888. TABLE: cm_hal
  3890. COMMAND: counters
  3892. USAGE: counters
  3894. DESCRIPTION:
  3895. Causes the CM HAL to print the hardware counter values.
  3897. EXAMPLES:
  3898. counters --
  3900. ------------------------------------------------------------------------------
  3902. TABLE: cm_hal
  3904. COMMAND: cpe_add
  3906. USAGE: cpe_add MacAddress
  3908. DESCRIPTION:
  3909. Adds the specified MAC address to the CPE learning table. An SNMP MIB item
  3910. is created for it, and it is added to the downstream data CAM. The address
  3911. is added unassociated, since there isn't a good way to specify the HalIf that
  3912. it should be associated with. The assoc will be locked in on the first
  3913. packet that goes upstream.
  3915. EXAMPLES:
  3916. cpe_add 00:10:18:00:11:22 --
  3918. ------------------------------------------------------------------------------
  3920. TABLE: cm_hal
  3922. COMMAND: cpe_del
  3924. USAGE: cpe_del [MacAddress] [index{-1..2147483647}]
  3926. DESCRIPTION:
  3927. Removes the CPE with the specified MAC address/table index from the learning
  3928. table. The SNMP MIB item is also deleted. The index is 0-based, as printed
  3929. by cpe_print. If you specify -1, all will be removed.
  3931. EXAMPLES:
  3932. cpe_del 00:10:18:00:11:22 -- Removes the specified CPE MAC addr.
  3933. cpe_del 2 -- Removes the CPE at index 2.
  3935. ------------------------------------------------------------------------------
  3937. TABLE: cm_hal
  3939. COMMAND: cpe_max
  3941. USAGE: cpe_max [maxCpe]
  3943. DESCRIPTION:
  3944. Sets/gets the max CPEs that can be added to the learning table.
  3946. EXAMPLES:
  3947. cpe_max --
  3949. ------------------------------------------------------------------------------
  3951. TABLE: cm_hal
  3953. COMMAND: cpe_print
  3955. USAGE: cpe_print
  3957. DESCRIPTION:
  3958. Prints the CPE learning table.
  3960. EXAMPLES:
  3961. cpe_print --
  3963. ------------------------------------------------------------------------------
  3965. TABLE: cm_hal
  3967. COMMAND: delete_dsid
  3969. USAGE: delete_dsid DSID
  3971. DESCRIPTION:
  3972. Calls the CM HAL to delete a multicast DSID from the DS MAC receive filter
  3974. EXAMPLES:
  3975. multicast_table --
  3977. ------------------------------------------------------------------------------
  3979. TABLE: cm_hal
  3981. COMMAND: dpm
  3983. USAGE: dpm ChannelNumber{0..7}
  3985. DESCRIPTION:
  3986. Measure downstream power for the specified ds channel number
  3988. EXAMPLES:
  3989. dpm 1 -- Measure downstream power for DS channel 1.
  3991. ------------------------------------------------------------------------------
  3993. TABLE: cm_hal
  3995. COMMAND: drw_show
  3997. USAGE: drw_show
  3999. DESCRIPTION:
  4000. Shows everything related to the Dynamic Range Window.
  4002. EXAMPLES:
  4003. drw_show
  4005. ------------------------------------------------------------------------------
  4007. TABLE: cm_hal
  4009. COMMAND: ds_state
  4011. USAGE: ds_state
  4013. DESCRIPTION:
  4014. Prints the state of the DOCSIS downstream (frequency, modulation, etc.).
  4016. EXAMPLES:
  4017. ds_state --
  4019. ------------------------------------------------------------------------------
  4021. TABLE: cm_hal
  4023. COMMAND: dsb_reset
  4025. USAGE: dsb_reset DSID
  4027. DESCRIPTION:
  4028. Causes the DS Bonding session with the specified DSID to be reset (deleted
  4029. and added again with the same parameters).
  4031. EXAMPLES:
  4032. dsb_reset 0x01 -- Resets the DS Bonding session with DSID 0x01
  4034. ------------------------------------------------------------------------------
  4036. TABLE: cm_hal
  4038. COMMAND: dsid_helper
  4040. USAGE: dsid_helper
  4042. DESCRIPTION:
  4043. Prints out the DSID helper.
  4045. EXAMPLES:
  4046. dsid_helper --
  4048. ------------------------------------------------------------------------------
  4050. TABLE: cm_hal
  4052. COMMAND: errors
  4054. USAGE: errors
  4056. DESCRIPTION:
  4057. Displays the errored, unerroredm and corrected counters
  4059. EXAMPLES:
  4060. errors --
  4062. ------------------------------------------------------------------------------
  4064. TABLE: cm_hal
  4066. COMMAND: fft_dump
  4068. USAGE: fft_dump
  4070. DESCRIPTION:
  4071. Dumps the recently stored FFT data to the screen
  4073. EXAMPLES:
  4074. fft_dump -- Dumps the recently stored FFT data to the screen
  4076. ------------------------------------------------------------------------------
  4078. TABLE: cm_hal
  4080. COMMAND: fft_store
  4082. USAGE: fft_store ChannelNumber{0..3}
  4084. DESCRIPTION:
  4085. Runs a FFT on DS samples, lets you specify a ds channel number
  4087. EXAMPLES:
  4088. fft_store 1 -- Takes 64K samples from DS channel 1.
  4090. ------------------------------------------------------------------------------
  4092. TABLE: cm_hal
  4094. COMMAND: fpga_amp
  4096. USAGE: fpga_amp AmpValue AttValue{0..31}
  4098. DESCRIPTION:
  4099. Specify the amplifier and attenuator values for the FPGA board.
  4101. EXAMPLES:
  4102. fpga_amp 20 10 --
  4104. ------------------------------------------------------------------------------
  4106. TABLE: cm_hal
  4108. COMMAND: hal_show
  4110. USAGE: hal_show [-l] [-s] [-c] [flow|descr|queue|all] [index]
  4112. DESCRIPTION:
  4113. Displays information about the CM DOCSIS HAL internal state: Service Flows,
  4114. DMA descriptors, Counters, HW/SW Queues. These are what the parameters mean:
  4116. flow -- Selects Upstream Service Flow info
  4117. descr -- Selects DMA Descriptor info
  4118. queue -- Selects Hardware/Software Queue info
  4120. -l -- lists the selected object(s)
  4121. -s -- shows settings for the selected object(s)
  4122. -c -- shows counters for the selected object(s)
  4124. index -- selects a specific instance of the object type
  4126. The index is shown when you list the objects; it is not valid with 'all' or
  4127. with -l. 'all' and '-l' are the default options if none are specified.
  4129. EXAMPLES:
  4130. hal_show all -l -- Lists all CM HAL objects in the system.
  4131. hal_show -- Same as above.
  4132. hal_show descr -- Lists the DMA Descriptors in the system.
  4133. hal_show flow -c -- Shows the counters for all Service Flows.
  4135. ------------------------------------------------------------------------------
  4137. TABLE: cm_hal
  4139. COMMAND: ldaix_read
  4141. USAGE: ldaix_read [numTimes{1..4294967295}]
  4143. DESCRIPTION:
  4144. Prints the current values for the LDAIT, LDAII, and LDAIF registers. This is
  4145. primarily used for downstream power calibration. You can have it repeat the
  4146. read/print very quickly, in case you are concerned that the values change
  4147. during the read. It is up to you to decide what to do with the values
  4148. (average, median, etc.).
  4150. EXAMPLES:
  4151. ldaix_read --
  4153. ------------------------------------------------------------------------------
  4155. TABLE: cm_hal
  4157. COMMAND: lna_read
  4159. USAGE: lna_read Register{0..60}
  4161. DESCRIPTION:
  4162. Dumps the contents of a lna registers
  4164. EXAMPLES:
  4165. lna_read 0x10 -- Reads the value in lna register 0x10
  4167. ------------------------------------------------------------------------------
  4169. TABLE: cm_hal
  4171. COMMAND: lna_write
  4173. USAGE: lna_write Register{0..36} Value
  4175. DESCRIPTION:
  4176. Write a value to a specified lna register
  4178. EXAMPLES:
  4179. lna_write 0x10 0x25 -- Writes the value 0x25 to lna register 0x10
  4181. ------------------------------------------------------------------------------
  4183. TABLE: cm_hal
  4185. COMMAND: lock_ds
  4187. USAGE: lock_ds Frequency [numTimes{1..4294967295}] [ChannelNumber]
  4189. DESCRIPTION:
  4190. Causes the CM HAL to lock to the Ds Freq specified. If the numTimes
  4191. parameter is present, the CM will try to lock that number of times, and will
  4192. print a success rate at the conclusion of the testing. Selecting a freq of 0
  4193. will just check the lock status without re-running the scripts. Use only in
  4194. test mode!
  4196. EXAMPLES:
  4197. lock_ds 405 10 1 -- Locks tuner 1 to the CMTS at 405 MHz 10 times.
  4199. ------------------------------------------------------------------------------
  4201. TABLE: cm_hal
  4203. COMMAND: log
  4205. USAGE: log [Bitmask{0x40007f}]
  4207. DESCRIPTION:
  4208. Configures the message log settings for this class to enable or disable
  4209. various app-specific severities. These are the bits supported:
  4211. 0x000001 -- Tx MacMgt Msg Packet
  4212. 0x000002 -- Rx MacMgt Msg Packet
  4213. 0x000004 -- Tx Data Packet
  4214. 0x000008 -- Rx Data Packet
  4215. 0x000010 -- Add/Chng/Del Service Flow
  4216. 0x000020 -- MIB Filters
  4217. 0x000040 -- Downstream Scan
  4218. 0x400000 -- Other API calls into the HalIf
  4220. EXAMPLES:
  4221. log 0x10 -- Enable logging of Service Flow Add/Chng/Del.
  4223. ------------------------------------------------------------------------------
  4225. TABLE: cm_hal
  4227. COMMAND: mac_diag
  4229. USAGE: mac_diag DiagPorts{0..65535}
  4231. DESCRIPTION:
  4232. Eanbles the CM MAC diag port to go out the GPIO ports; this is only useful on
  4233. an S-Board where the GPIOs can be accessed. You just need to enter the diag
  4234. port selection for the MAC, which will come from John, Beth, or Scott. This
  4235. is equivalent to the following commands:
  4237. write -s 4 0xfffe041c 0x00000000
  4238. write -s 1 0xfffe001b 0xc0
  4239. write -s 2 0xfffe3020 {DiagPorts}
  4241. EXAMPLES:
  4242. mac_diag 0x2221 -- Selects John's downstream state machines on the diag
  4243. port.
  4245. ------------------------------------------------------------------------------
  4247. TABLE: cm_hal
  4249. COMMAND: mac_reset
  4251. USAGE: mac_reset
  4253. DESCRIPTION:
  4254. Resets the Docsis MAC, saves h/w and s/w state and restores for continued
  4255. operation.
  4257. EXAMPLES:
  4258. mac_reset --
  4260. ------------------------------------------------------------------------------
  4262. TABLE: cm_hal
  4264. COMMAND: map_lead_time_show
  4266. USAGE: map_lead_time_show
  4268. DESCRIPTION:
  4269. Causes the CM HAL to print the internal Map Lead Time hardware counter
  4270. values.
  4272. EXAMPLES:
  4273. map_lead_time_show --
  4275. ------------------------------------------------------------------------------
  4277. TABLE: cm_hal
  4279. COMMAND: multicast_table
  4281. USAGE: multicast_table
  4283. DESCRIPTION:
  4284. Prints out the Multicast Table.
  4286. EXAMPLES:
  4287. multicast_table --
  4289. ------------------------------------------------------------------------------
  4291. TABLE: cm_hal
  4293. COMMAND: packets_queued
  4295. USAGE: packets_queued [sfid]
  4297. DESCRIPTION:
  4298. Queries the HAL for the number of packets queued on the specified upstream
  4299. flow. If the SFID is 0 or missing, then it prints the number of packets
  4300. queued on all flows.
  4302. EXAMPLES:
  4303. packets_queued -- Queries all flows.
  4304. packets_queued 0x401 -- Queries the flow with SFID 0x401.
  4306. ------------------------------------------------------------------------------
  4308. TABLE: cm_hal
  4310. COMMAND: qam_lock
  4312. USAGE: qam_lock Modulation [ChannelNumber]
  4314. DESCRIPTION:
  4315. Run QAM lock but don't tune.
  4317. EXAMPLES:
  4318. qam_lock 64 0 -- Try downstream QAM lock in 64 QAM on downstream channel 0.
  4320. ------------------------------------------------------------------------------
  4322. TABLE: cm_hal
  4324. COMMAND: qosParms
  4326. USAGE: qosParms [-p priority{0..7}] [-r maxRateBps] [-b maxBurstBytes{1522..4294967295}] [-c maxConcatBurstBytes{0..65535}] [-t reqTransPolicyBits{0x1ff}] index{1..4294967295}
  4328. DESCRIPTION:
  4329. Changes the QoS parameters associated with the specified service flow.
  4331. Request/Transmit Policy bits:
  4332. 0x0001 -- Disable bcast request
  4333. 0x0002 -- Disable priority request
  4334. 0x0004 -- Disable req/data for requests
  4335. 0x0008 -- Disable req/data for data
  4336. 0x0010 -- Disable piggyback request
  4337. 0x0020 -- Disable concatenation
  4338. 0x0040 -- Disable fragmentation
  4339. 0x0080 -- Disable PHS
  4340. 0x0100 -- Drop UGS packets too big
  4342. EXAMPLES:
  4343. qosParms -p 5 -r 64000 -b 3000 -c 2000 -t 0x1ff 1 -- Configure all parms for
  4344. flow 1.
  4346. ------------------------------------------------------------------------------
  4348. TABLE: cm_hal
  4350. COMMAND: read_mbr
  4352. USAGE: read_mbr opcode numBytes{1..4}
  4354. DESCRIPTION:
  4355. Reads the multibyte register specified by the 'read' opcode, displaying the
  4356. number of bytes specified. You MUST specify a valid read opcode, and the
  4357. number of bytes must be valid; failure to do this can lead to unpredictable
  4358. results!
  4360. EXAMPLES:
  4361. read_mbr 0x86 3 -- Reads the 3-byte LDAIT register.
  4363. ------------------------------------------------------------------------------
  4365. TABLE: cm_hal
  4367. COMMAND: scan_ds
  4369. USAGE: scan_ds Frequency [ScanMode{0..2}]
  4371. DESCRIPTION:
  4372. Causes the Scan Thread to try to acquire the Ds Freq specified. If the
  4373. frequency parameter is 0, then the Scan Thread selects the starting frequency
  4374. on its own. The ScanMode parameter tells the thread how to limit the
  4375. frequency selection:
  4376. 0 - Scan all frequencies until stopped (default)
  4377. 1 - Scan specified frequency once
  4378. 2 - Scan specified frequency until stopped.
  4380. EXAMPLES:
  4381. scan_ds 405 -- Starts scanning at 405 MHz.
  4382. scan_ds 765 1 -- Scans 765 MHz once, then stops.
  4384. ------------------------------------------------------------------------------
  4386. TABLE: cm_hal
  4388. COMMAND: scan_stop
  4390. USAGE: scan_stop
  4392. DESCRIPTION:
  4393. Causes the Scan Thread to stop scanning downstream frequencies.
  4395. EXAMPLES:
  4396. scan_stop -- Stops the downstream scan.
  4398. ------------------------------------------------------------------------------
  4400. TABLE: cm_hal
  4402. COMMAND: set_drw
  4404. USAGE: set_drw pktCount{0..500000}
  4406. DESCRIPTION:
  4407. Sets the dynamic range window (Pload_min_set) in units of 1/4 dB
  4410. EXAMPLES:
  4411. set_drw 20 - sets Pload_min_set to 5 dB
  4413. ------------------------------------------------------------------------------
  4415. TABLE: cm_hal
  4417. COMMAND: set_mode
  4419. USAGE: set_mode OID true|false
  4421. DESCRIPTION:
  4422. Calls the CM HAL SetMode entrypoint with the specified BFC_HAL_MODE OID and
  4423. the specified true/false value. The mode OID values come from BfcHal.h or
  4424. CblmodemHal.h.
  4426. EXAMPLES:
  4427. set_mode 0x50 true -- Turns the READY LED on
  4429. ------------------------------------------------------------------------------
  4431. TABLE: cm_hal
  4433. COMMAND: show
  4435. USAGE: show [-l] [-s] [-c] [cos|cls|phs|flow|all] [index]
  4437. DESCRIPTION:
  4438. Displays information about Classifiers, Service Flows, PHS, DOCSIS 1.0 Class
  4439. of Service, and other objects in the system.
  4441. cos -- Selects the DOCSIS 1.0 Class of Service object info.
  4442. cls -- Selects Classifier info.
  4443. phs -- Selects PHS info.
  4444. flow -- Selects Service Flow info.
  4445. all -- Selects all DOCSIS objects in the system.
  4446. -l -- Lists the selected object(s).
  4447. -s -- Shows settings for the selected object(s).
  4448. -c -- Shows counters for the selected object(s).
  4449. index -- Selects a specific instance of the object type.
  4451. The index is shown when you list the objects; it is not valid with 'all' or
  4452. with -l. 'all' and '-l' are the default options if none are specified.
  4454. EXAMPLES:
  4455. show all -l -- Lists all DOCSIS objects in the system.
  4456. show -- Same as above.
  4457. show cls -- Lists the Classifiers in the system.
  4458. show cls -s 5 -- Shows the settings for the specified Classifier.
  4459. show flow -c -- Shows the counters for all Service Flows.
  4461. ------------------------------------------------------------------------------
  4463. TABLE: cm_hal
  4465. COMMAND: show_halif
  4467. USAGE: show_halif
  4469. DESCRIPTION:
  4470. Causes the HalIf object to display its state.
  4472. EXAMPLES:
  4473. show_halif --
  4475. ------------------------------------------------------------------------------
  4477. TABLE: cm_hal
  4479. COMMAND: transmit
  4481. USAGE: transmit [-s PacketSize{64..1518}] [-t NumSeconds] [-r TimeBetweenPacketsMs] [-p FillPattern{0..255}]
  4483. DESCRIPTION:
  4484. Transmits packets out the upstream interface. The packets will have a
  4485. reasonable UDP/IP header, but otherwise have garbage data in them, so you
  4486. probably don't want to do this on a live network. Packets will be sent as
  4487. fast as possible unless overridden by the -r flag; you can specify the packet
  4488. size and/or the number of seconds over which to send packets. If not
  4489. otherwise specified, it will send 1518 byte packets until the system is power
  4490. cycled.
  4492. Flags:
  4493. -s : The packet size; if not specified, 1518 bytes.
  4494. -t : Number of seconds you want to transmit; default (0) = infinite.
  4495. -r : Controls the packet rate. Specify the time (in ms) between each
  4496. packet. Note that this value will be quantized based on the OS clock
  4497. tick resolution (usually 10ms), so 1ms, 8ms, and 12ms are all the same
  4498. as 10ms. A value of 0 means 'as fast as possible', i.e. no delay
  4499. between packets.
  4500. -p : Specifies the fill pattern for the buffer. The value specified will
  4501. be used to fill the buffer. If not specified, then the buffer is
  4502. filled with increasing values.
  4504. EXAMPLES:
  4505. transmit -- Sends 1518 byte packets until power cycled.
  4506. transmit -s 64 -- Sends 64 byte packets until power cycled.
  4507. transmit -t 60 -- Sends 1518 byte packets for 1 minute.
  4508. transmit -r 1000 -- Sends 1518 byte packets once a second.
  4509. transmit -r 10 -- Sends 1518 byte packets at 100 packets per second.
  4510. transmit -p 0xaa -- Fills the 1518 byte packet with 0xaa values.
  4512. ------------------------------------------------------------------------------
  4514. TABLE: cm_hal
  4516. COMMAND: tune
  4518. USAGE: tune Frequency [ChannelNumber]
  4520. DESCRIPTION:
  4521. Tune the tuner
  4523. EXAMPLES:
  4524. tune 327 0 -- Tune tuner 0 to 327 MHz.
  4526. ------------------------------------------------------------------------------
  4528. TABLE: cm_hal
  4530. COMMAND: tune_band
  4532. USAGE: tune_band StartFrequency EndFrequency StepSize [ChannelNumber]
  4534. DESCRIPTION:
  4535. Tune the tuner, starting at startFreq and going to endFreq in steps of
  4536. stepSize
  4538. EXAMPLES:
  4539. tune_band 327 789 6 0 -- Tune tuner 0 from 327 MHz to 789 MHz in 6 MHz steps
  4541. ------------------------------------------------------------------------------
  4543. TABLE: cm_hal
  4545. COMMAND: tuner_module
  4547. USAGE: tuner_module ModuleNum{0..4} FreqMHz{22..1150}
  4549. DESCRIPTION:
  4550. Tunes a tuner module to a specified freq - selecting module 0 tunes both
  4551. modules back to back
  4553. EXAMPLES:
  4554. tuner_module 1 327 -- Sets tuner module 1 to 327 MHz
  4556. ------------------------------------------------------------------------------
  4558. TABLE: cm_hal
  4560. COMMAND: tuner_read
  4562. USAGE: tuner_read [ChannelNumber{0..3}]
  4564. DESCRIPTION:
  4565. Dumps the contents of the tuner registers
  4567. EXAMPLES:
  4568. tuner_read tuner_number
  4570. ------------------------------------------------------------------------------
  4572. TABLE: cm_hal
  4574. COMMAND: tuner_write
  4576. USAGE: tuner_write Register{0..58} Value{0..255} [ChannelNumber{0..3}]
  4578. DESCRIPTION:
  4579. Write a value to a specified tuner register
  4581. EXAMPLES:
  4582. tuner_write 0x10 0x25 1 -- Writes the value 0x25 to tuner register 0x10 in
  4583. tuner number 1
  4585. ------------------------------------------------------------------------------
  4587. TABLE: cm_hal
  4589. COMMAND: us30_clear_debug_counters
  4591. USAGE: us30_clear_debug_counters
  4593. DESCRIPTION:
  4594. Clear UTP debug counters.
  4596. EXAMPLES:
  4597. us30_clear_debug_counters
  4599. ------------------------------------------------------------------------------
  4601. TABLE: cm_hal
  4603. COMMAND: us30_debug_counters
  4605. USAGE: us30_debug_counters
  4607. DESCRIPTION:
  4608. Dump debug counters for a selected flow. The default flow is 0.
  4609. Use utp_set_debug_counter to select a flow[0 thru 15].
  4611. EXAMPLES:
  4612. us30_debug_counters
  4614. ------------------------------------------------------------------------------
  4616. TABLE: cm_hal
  4618. COMMAND: us30_set_debug_flow
  4620. USAGE: us30_set_debug_flow flow{0..15}
  4622. DESCRIPTION:
  4623. Enable debug counters for the selected flow.
  4625. EXAMPLES:
  4626. us30_set_debug_flow 1 -- Enable debug counters for flow 1.
  4628. ------------------------------------------------------------------------------
  4630. TABLE: cm_hal
  4632. COMMAND: us_burst
  4634. USAGE: us_burst qpsk|8qam|16qam|32qam|64qam|128qam|256qam symbolRate Frequency power_dB RS_N RS_T ChannelNumber [3140]
  4636. DESCRIPTION:
  4637. Causes the CM HAL to cinstantly burst data upstream with the specified
  4638. QAM/QPSK mode, symbol rate, frequency, and power level. The next to last
  4639. parameter is the upstream phy channel number. The last (optional and for 3349
  4640. only) parameter changes the preamble to support the 3140. The 3348 supports
  4641. programmable RS_N and RS_T values. Use only in test mode!
  4643. EXAMPLES:
  4644. us_burst 16qam 1.28 7.5 40.0 76 1 0 3140 --
  4646. ------------------------------------------------------------------------------
  4648. TABLE: cm_hal
  4650. COMMAND: us_cw_transmit
  4652. USAGE: us_cw_transmit Frequency power_dB [ChannelNum]
  4654. DESCRIPTION:
  4655. Causes the CM HAL to constantly transmit a CW upstream at a specified
  4656. frequency and power level. Use only in test mode!
  4658. EXAMPLES:
  4659. us_cw_transmit 7.5 40.0 0 --
  4661. ------------------------------------------------------------------------------
  4663. TABLE: cm_hal
  4665. COMMAND: us_debug
  4667. USAGE: us_debug qpsk|8qam|16qam|32qam|64qam|128qam|256qam symbolRate Frequency power_dB
  4669. DESCRIPTION:
  4670. Causes the CM HAL to run an upstream debug sequence with the specified
  4671. QAM/QPSK mode, symbol rate, frequency, and power level. Use only in test
  4672. mode!
  4674. EXAMPLES:
  4675. us_debug 16qam 1.28 7.5 40.0 --
  4677. ------------------------------------------------------------------------------
  4679. TABLE: cm_hal
  4681. COMMAND: us_reset
  4683. USAGE: us_reset
  4685. DESCRIPTION:
  4686. Reset the upstream mac
  4688. EXAMPLES:
  4689. us_reset --
  4691. ------------------------------------------------------------------------------
  4693. TABLE: cm_hal
  4695. COMMAND: us_sweep
  4697. USAGE: us_sweep startFreqMHz endFreqMHz stepFreqMHz power_dB sweepTimeSecs numberOfIter [ChannelNum]
  4699. DESCRIPTION:
  4700. Causes the CM HAL to send an upstream sweep. The starting/ending
  4701. frequencies, and the step size are specified in MHz. The duration of the
  4702. sweep from start to end is specified in seconds. Power is in dB. Use only
  4703. in test mode!
  4705. EXAMPLES:
  4706. us_sweep 5 42 1 40 5 2 0 -- Sweep from 5 to 42 in 1 Mhz steps, power = 40,
  4707. take 5 secs to do it, and do it twice on channel 0
  4709. ------------------------------------------------------------------------------
  4711. TABLE: cm_hal
  4713. COMMAND: us_transmit
  4715. USAGE: us_transmit qpsk|8qam|16qam|32qam|64qam|128qam|256qam symbolRate Frequency power_dB tdma|scdma [ChannelNumber]
  4717. DESCRIPTION:
  4718. Causes the CM HAL to constantly transmit a PRBS23 pattern upstream with the
  4719. specified QAM/QPSK mode, symbol rate, frequency, power level, QAM mode, and
  4720. upstream channel number. Use only in test mode!
  4722. EXAMPLES:
  4723. us_transmit 16qam 1.28 7.5 40.0 tdma 0 --
  4725. ------------------------------------------------------------------------------
  4727. TABLE: cm_hal
  4729. COMMAND: utp_speedtest
  4731. USAGE: utp_speedtest pktCount{0..500000}
  4733. DESCRIPTION:
  4734. UTP speed test.
  4737. EXAMPLES:
  4738. utp_speedtest 50
  4740. ------------------------------------------------------------------------------
  4742. TABLE: cm_hal
  4744. COMMAND: utp_status
  4746. USAGE: utp_status
  4748. DESCRIPTION:
  4749. Display UTP status and info.
  4752. EXAMPLES:
  4753. utp_status
  4755. ------------------------------------------------------------------------------
  4757. TABLE: cm_hal
  4759. COMMAND: write_mbr
  4761. USAGE: write_mbr opcode numBytes{1..4} value
  4763. DESCRIPTION:
  4764. Writes the multibyte register specified by the 'write' opcode, sending the
  4765. value and number of bytes specified. You MUST specify a valid write opcode,
  4766. and the number of bytes must be valid; failure to do this can lead to
  4767. unpredictable results!
  4769. EXAMPLES:
  4770. write_mbr 0x84 3 0x012345 -- Writes the 3-byte STAIT register.
  4772. ------------------------------------------------------------------------------
  4774. TABLE: docsis_ctl
  4776. COMMAND: ClearCmCert
  4778. USAGE: ClearCmCert
  4780. DESCRIPTION:
  4781. Clears the Cable Modem Certificate.
  4783. EXAMPLES:
  4784. ClearCmCert --
  4786. ------------------------------------------------------------------------------
  4788. TABLE: docsis_ctl
  4790. COMMAND: binarySfid
  4792. USAGE: binarySfid [true|false]
  4794. DESCRIPTION:
  4795. Use binary SFID encoding in CM initiated DSD REQ.
  4797. EXAMPLES:
  4798. binarySfid true --
  4800. ------------------------------------------------------------------------------
  4802. TABLE: docsis_ctl
  4804. COMMAND: bpiShow
  4806. USAGE: bpiShow
  4808. DESCRIPTION:
  4809. Prints the BPI State Machine Parameters.
  4811. EXAMPLES:
  4812. bpiShow --
  4814. ------------------------------------------------------------------------------
  4816. TABLE: docsis_ctl
  4818. COMMAND: cfg_hex_show
  4820. USAGE: cfg_hex_show
  4822. DESCRIPTION:
  4823. Prints last config file in ASCII hex format. eof byte 0xFF is omitted.
  4825. EXAMPLES:
  4826. cfg_hex_show --
  4828. ------------------------------------------------------------------------------
  4830. TABLE: docsis_ctl
  4832. COMMAND: cfg_tlv_show
  4834. USAGE: cfg_tlv_show
  4836. DESCRIPTION:
  4837. Prints last config file in TLV format. eof byte 0xFF is omitted.
  4839. EXAMPLES:
  4840. cfg_tlv_show --
  4842. ------------------------------------------------------------------------------
  4844. TABLE: docsis_ctl
  4846. COMMAND: clear_image
  4848. USAGE: clear_image [-i Number]
  4850. DESCRIPTION:
  4851. This causes the specified image (stored in flash memory) to be erased. The
  4852. -i parameter specifies the image number to be cleared (number of images
  4853. depends on the platform). WARNING: If you clear all images, then the system
  4854. won't run!
  4856. EXAMPLES:
  4857. clear_image -- Clears default image from flash memory.
  4858. clear_image -i1 -- Clears image1 from flash memory.
  4860. ------------------------------------------------------------------------------
  4862. TABLE: docsis_ctl
  4864. COMMAND: cm_ctrl
  4866. USAGE: cm_ctrl
  4868. DESCRIPTION:
  4869. Inject a CM-CTRL-REQ into the CM
  4871. EXAMPLES:
  4872. cm_ctrl
  4875. ------------------------------------------------------------------------------
  4877. TABLE: docsis_ctl
  4879. COMMAND: comp_mac_to_phy
  4881. USAGE: comp_mac_to_phy [-v] mac_bytes iuc{1..15}
  4883. DESCRIPTION:
  4884. Runs the UCD-based MAC-to-PHY computation for the specified number of MAC
  4885. bytes on the specified IUC code. If -v is specified, then verbose debug
  4886. output will be displayed.
  4888. EXAMPLES:
  4889. comp_mac_to_phy -v 1518 5 -- Does verbose computation for 1518 bytes on the
  4890. Short Data IUC.
  4892. ------------------------------------------------------------------------------
  4894. TABLE: docsis_ctl
  4896. COMMAND: comp_phy_to_mac
  4898. USAGE: comp_phy_to_mac [-v] phy_mslots iuc{1..15}
  4900. DESCRIPTION:
  4901. Runs the UCD-based PHY-to-MAC computation for the specified number of PHY
  4902. minislots on the specified IUC code. If -v is specified, then verbose debug
  4903. output will be displayed.
  4905. EXAMPLES:
  4906. comp_phy_to_mac -v 20 5 -- Does verbose computation for 20 mslots on the
  4907. Short Data IUC.
  4909. ------------------------------------------------------------------------------
  4911. TABLE: docsis_ctl
  4913. COMMAND: copy_image
  4915. USAGE: copy_image SourceImage{1..2} DestinationImage{1..2}
  4917. DESCRIPTION:
  4918. This causes the specified source image (stored in flash memory) to be copied
  4919. to the specified destination image. The source image must be valid, and must
  4920. be small enough to fit in the dest image slot.
  4922. EXAMPLES:
  4923. copy_image 2 1 -- Copies image2 to the image1 slot.
  4925. ------------------------------------------------------------------------------
  4927. TABLE: docsis_ctl
  4929. COMMAND: dbc_msg_inject
  4931. USAGE: dbc_msg_inject
  4933. DESCRIPTION:
  4934. Inject an arbitrary DBC-REQ message into the CM
  4936. EXAMPLES:
  4937. dbc_msg_inject
  4940. ------------------------------------------------------------------------------
  4942. TABLE: docsis_ctl
  4944. COMMAND: dload
  4946. USAGE: dload [-i Number] [-s] [-l] [-f] [IpAddress] [Filename{127}]
  4948. DESCRIPTION:
  4949. Causes the CM DOCSIS Control thread to download and store the specified image
  4950. file via TFTP from the specified TFTP Server IP address. When the download
  4951. is completed, the next reboot will run this image. If you omit the filename
  4952. and/or IP address parameters, then we will use the ones stored in non-vol
  4953. settings. The -i parameter specifies the image number to be overwritten
  4954. (number of images depends on the platform). If omitted then the default
  4955. image for the platform will be used. If present, the -s causes Secure
  4956. Download to be used. The -l flag selects image1 as the target and allows a
  4957. large image to be loaded, if allowed by the flash driver. The -f flag forces
  4958. the image to be loaded even if the signature or compression types are not
  4959. valid for the platform.
  4961. EXAMPLES:
  4962. dload 11.24.4.3 ram_sto.bin -- TFTPs ram_sto.bin from the server.
  4963. dload -i1 11.24.4.3 ram_sto.bin -- Same, but downloads to image1.
  4964. dload -- Uses the file/server from non-vol
  4965. settings.
  4966. dload -s 11.24.4.3 ram_sto.bin -- Secure download.
  4967. dload -l 11.24.4.3 ram_sto.bin -- Download large image to image1.
  4968. dload -f 11.24.4.3 ram3360_sto.bin -- Loads a 3360 image onto a 3345 modem.
  4970. ------------------------------------------------------------------------------
  4972. TABLE: docsis_ctl
  4974. COMMAND: dsdiag
  4976. USAGE: dsdiag
  4978. DESCRIPTION:
  4979. Shows concise information about the downstream state.
  4981. EXAMPLES:
  4982. dsdiag --
  4984. ------------------------------------------------------------------------------
  4986. TABLE: docsis_ctl
  4988. COMMAND: dsx_show
  4990. USAGE: dsx_show
  4992. DESCRIPTION:
  4993. Shows the current state of the DSx Helper object.
  4995. EXAMPLES:
  4996. dsx_show --
  4998. ------------------------------------------------------------------------------
  5000. TABLE: docsis_ctl
  5002. COMMAND: event_censor
  5004. USAGE: event_censor
  5006. DESCRIPTION:
  5007. Prints the Event Censor object
  5009. EXAMPLES:
  5010. event_censor
  5013. ------------------------------------------------------------------------------
  5015. TABLE: docsis_ctl
  5017. COMMAND: goto_ds
  5019. USAGE: goto_ds Frequency
  5021. DESCRIPTION:
  5022. Causes the CM to move to the Ds Freq specified. If the CM fails to lock at
  5023. the specified frequency, then it will continue scanning. When it locks on a
  5024. valid downstream, it will then range, perform IP initialization, and
  5025. register. The value can be in units of Hz or MHz (if the value is less than
  5026. 10,000, then it is assumed to be MHz).
  5028. EXAMPLES:
  5029. goto_ds 405000000 -- Goes to the CMTS at 405 MHz.
  5030. goto_ds 327 -- Goes to the CMTS at 327 MHz.
  5032. ------------------------------------------------------------------------------
  5034. TABLE: docsis_ctl
  5036. COMMAND: goto_us
  5038. USAGE: goto_us US Channel{0..255}
  5040. DESCRIPTION:
  5041. Causes the CM to move to the US Channel specified, staying on the current
  5042. downstream frequency. The CM must be locked to a downstream channel for this
  5043. to work.
  5045. NOTE: Some CMTSs may not support this, though they all should.
  5047. EXAMPLES:
  5048. goto_us 3 -- Goes to upstream channel 3.
  5050. ------------------------------------------------------------------------------
  5052. TABLE: docsis_ctl
  5054. COMMAND: igmpShow
  5056. USAGE: igmpShow
  5058. DESCRIPTION:
  5059. Prints the IGMP Group Statistics.
  5061. EXAMPLES:
  5062. igmpShow --
  5064. ------------------------------------------------------------------------------
  5066. TABLE: docsis_ctl
  5068. COMMAND: ip_initialize
  5070. USAGE: ip_initialize [dhcp|adv|dhcpv6]
  5072. DESCRIPTION:
  5073. This causes the IP stack to lock in it's canned DHCP settings (IP and router
  5074. addresses), and enables forwarding of packets to all interfaces. If you use
  5075. the 'dhcp' parameter, then it will do DHCPv4 to get the address; if you use
  5076. the 'adv' parameter it will do a router solicitation for IPv6; if you use the
  5077. 'dhcpv6' parameter, it will do DHCPv6 to get the address; otherwise, it will
  5078. use the DHCP settings from non-vol memory.
  5080. EXAMPLES:
  5081. ip_initialize dhcp -- Forces the IP stack to to do DHCP.
  5083. ------------------------------------------------------------------------------
  5085. TABLE: docsis_ctl
  5087. COMMAND: ip_show
  5089. USAGE: ip_show
  5091. DESCRIPTION:
  5092. Shows the DHCP settings that are being used by the IP stack.
  5094. EXAMPLES:
  5095. ip_show --
  5097. ------------------------------------------------------------------------------
  5099. TABLE: docsis_ctl
  5101. COMMAND: log_messages
  5103. USAGE: log_messages [Bitmask{0xffff}]
  5105. DESCRIPTION:
  5106. Enables/disables logging of DOCSIS MAC Management messages, along with TLV
  5107. parsing/generation associated with them. You can enable logging of multiple
  5108. messages by setting their bits to 1. These are the bit definitions:
  5110. 0x0001 -- UCD
  5111. 0x0002 -- RNG-REQ/RSP
  5112. 0x0004 -- CM-CTRL-REQ/RSP
  5113. 0x0008 -- Config file contents
  5114. 0x0010 -- REG-REQ/RSP/ACK
  5115. 0x0020 -- UCC-REQ/RSP, DCC-REQ/RSP/ACK, MD-DS-SG discovery
  5116. 0x0040 -- DSx-REQ/RSP/ACK
  5117. 0x0080 -- MDD, DCI-REQ/RSP
  5118. 0x0100 -- UP-DIS, unknown MAC msg type
  5119. 0x0200 -- gathering set of useable UCD's
  5120. 0x0400 -- TST-REQ
  5121. 0x0800 -- US phy overhead computations
  5122. 0x1000 -- on the fly UCD change
  5123. 0x2000 -- DBC-REQ/RSP/ACK
  5124. 0x4000 -- Log raw message octets
  5125. 0x8000 -- Show TLV parsing/generation
  5127. EXAMPLES:
  5128. log_messages -- Shows the bitmask of enabled message logging.
  5129. log_messages 0x01 -- Enables logging of UCD messages.
  5130. log_messages 0x8001 -- Enables logging of UCD message TLV parsing.
  5132. ------------------------------------------------------------------------------
  5134. TABLE: docsis_ctl
  5136. COMMAND: map_debug
  5138. USAGE: map_debug NumberOfMaps{0..32} [SID{0..16383}]
  5140. DESCRIPTION:
  5141. Enables logging of DOCSIS MAP messages; because there are a lot of MAPs on
  5142. the downstream, you are required to enter a limited number of MAP messages to
  5143. be logged. This keeps the system from crashing or otherwise misbehaving due
  5144. to the amount of output. Additionally, you can filter the output on a
  5145. particular SID, displaying only 'interesting' MAPs.
  5147. EXAMPLES:
  5148. map_debug 10 -- Logs the next 10 MAP messages.
  5149. map_debug 10 0x104 -- Logs the next 10 MAPs with grants to SID 0x104.
  5151. ------------------------------------------------------------------------------
  5153. TABLE: docsis_ctl
  5155. COMMAND: mdd_modify
  5157. USAGE: mdd_modify
  5159. DESCRIPTION:
  5160. Modified the current MDD settings
  5162. EXAMPLES:
  5163. mdd_modify
  5166. ------------------------------------------------------------------------------
  5168. TABLE: docsis_ctl
  5170. COMMAND: mdd_sets_show
  5172. USAGE: mdd_sets_show
  5174. DESCRIPTION:
  5175. Prints current MAC domain settings.
  5177. EXAMPLES:
  5178. mdd_sets_show --
  5180. ------------------------------------------------------------------------------
  5182. TABLE: docsis_ctl
  5184. COMMAND: modem_caps
  5186. USAGE: modem_caps
  5188. DESCRIPTION:
  5189. Prints the modem capabilities from the REG-RSP.
  5191. EXAMPLES:
  5192. modem_caps --
  5194. ------------------------------------------------------------------------------
  5196. TABLE: docsis_ctl
  5198. COMMAND: publish_event
  5200. USAGE: publish_event [DsLockFail|DsLockRescue|MddFail|MddRescue|DataSeqFail|DataSeqRescue|T4Fail|T4Rescue|MaxT3Fail|MaxT3Rescue] chan or dsid{0..1048575}
  5202. DESCRIPTION:
  5203. Publishes the event with uint parameter on behalf of CmDocsisCtlThread
  5205. EXAMPLES:
  5206. publish_event DsLockFail 1 - publishes kCmNonPriDsLockFailMsg for channel 1
  5209. ------------------------------------------------------------------------------
  5211. TABLE: docsis_ctl
  5213. COMMAND: rate_shaping_enable
  5215. USAGE: rate_shaping_enable [true|false]
  5217. DESCRIPTION:
  5218. This enables/disables DOCSIS 1.0 Class of Service or DOCSIS 1.1 QoS rate
  5219. shaping. If disabled, then no rate shaping will be performed.
  5221. EXAMPLES:
  5222. rate_shaping_enable true -- Enable CoS/QoS rate shaping.
  5224. ------------------------------------------------------------------------------
  5226. TABLE: docsis_ctl
  5228. COMMAND: rng_rsp
  5230. USAGE: rng_rsp [true|false]
  5232. DESCRIPTION:
  5233. Enables/disables the one-line RNG-RSP messages that are displayed when a
  5234. ranging response message is received from the CMTS.
  5236. EXAMPLES:
  5237. rng_rsp false -- Disables the RNG-RSP messages.
  5239. ------------------------------------------------------------------------------
  5241. TABLE: docsis_ctl
  5243. COMMAND: scan_stop
  5245. USAGE: scan_stop
  5247. DESCRIPTION:
  5248. Causes the CM to stop scanning for a downstream channel. You must use
  5249. goto_ds to start scanning again.
  5251. EXAMPLES:
  5252. scan_stop --
  5254. ------------------------------------------------------------------------------
  5256. TABLE: docsis_ctl
  5258. COMMAND: showFlows
  5260. USAGE: showFlows
  5262. DESCRIPTION:
  5263. Prints the current Dynamic Flow STDs.
  5265. EXAMPLES:
  5266. showFlows --
  5268. ------------------------------------------------------------------------------
  5270. TABLE: docsis_ctl
  5272. COMMAND: state
  5274. USAGE: state
  5276. DESCRIPTION:
  5277. Shows the current state of the CM DOCSIS Control Thread.
  5279. EXAMPLES:
  5280. state --
  5282. ------------------------------------------------------------------------------
  5284. TABLE: docsis_ctl
  5286. COMMAND: stop_download
  5288. USAGE: stop_download
  5290. DESCRIPTION:
  5291. If a software download is in progress, this will stop it in its tracks. The
  5292. storage for the partially downloaded image will be cleared.
  5294. EXAMPLES:
  5295. stop_download --
  5297. ------------------------------------------------------------------------------
  5299. TABLE: docsis_ctl
  5301. COMMAND: ucdShow
  5303. USAGE: ucdShow
  5305. DESCRIPTION:
  5306. Prints the current upstream channel description being used.
  5308. EXAMPLES:
  5309. ucdShow --
  5311. ------------------------------------------------------------------------------
  5313. TABLE: docsis_ctl
  5315. COMMAND: ucddiag
  5317. USAGE: ucddiag
  5319. DESCRIPTION:
  5320. Shows concise information about the UCD state.
  5322. EXAMPLES:
  5323. ucddiag --
  5325. ------------------------------------------------------------------------------
  5327. TABLE: docsis_ctl
  5329. COMMAND: up_dis
  5331. USAGE: up_dis [-t Number]
  5333. DESCRIPTION:
  5334. Causes the DOCSIS state to be reset, deleting all flows, stopping BPI,
  5335. deregistering from CMTS, stopping ranging, etc. This is equivalent to
  5336. receiving an UP-DIS message. RFI-N-01049 added the timeout paramer, which
  5337. you can specify with the -t parameter.
  5339. EXAMPLES:
  5340. up_dis -- Simulates an UP-DIS message (timeout=forever)
  5341. up_dis -t 20 -- Simulates an UP-DIS message (timeout=20 ms).
  5343. ------------------------------------------------------------------------------
  5345. TABLE: docsis_ctl
  5347. COMMAND: us_phy_oh_show
  5349. USAGE: us_phy_oh_show
  5351. DESCRIPTION:
  5352. Prints computed upstream phy overhead settings.
  5354. EXAMPLES:
  5355. us_phy_oh_show --
  5357. ------------------------------------------------------------------------------
  5359. TABLE: docsis_ctl
  5361. COMMAND: usdiag
  5363. USAGE: usdiag
  5365. DESCRIPTION:
  5366. Shows concise information about the upstream state.
  5368. EXAMPLES:
  5369. usdiag --
  5371. ------------------------------------------------------------------------------
  5373. TABLE: docsis_ctl/dsxTest
  5375. COMMAND: addConfigFile
  5377. USAGE: addConfigFile [IpAddress] [Filename{127}]
  5379. DESCRIPTION:
  5380. TFTPs specified config file and DSAs the service flows specified.
  5382. EXAMPLES:
  5383. addConfigFile 10.24.17.36 cfg.bin --
  5385. ------------------------------------------------------------------------------
  5387. TABLE: docsis_ctl/dsxTest
  5389. COMMAND: autoDsxTest
  5391. USAGE: autoDsxTest [-p] [-v] [-r] [-a] [-s StartIndex] [-e EndIndex] [-t DelayTimeMs]
  5393. DESCRIPTION:
  5394. Initiate the automatic DSx test suite. This runs a fairly comprehensive
  5395. script to test a large number of DSx permutations. If the script encounters
  5396. a problem, it will stop unless auto-recovery is enabled. Parameters:
  5398. -p : just prints the steps that the script would take
  5399. -v : verbose, print extra information (settings values)
  5400. -r : enable auto-recovery
  5401. -a : causes Admitted and Active flow sets to be sent separately
  5402. -s : the start index (default=beginning of script)
  5403. -e : the end index (default=end of script)
  5404. -t : time to pause (in milliseconds) between steps in the script
  5406. When using -s and -e, note that some steps of the script may require previous
  5407. steps in order to run correctly; it is your responsibility to ensure that all
  5408. prerequisites are met.
  5410. EXAMPLES:
  5411. autoDsxTest -r -- Runs the whole test suite, auto-recover enabled
  5412. autoDsxTest -p -- Prints what the script would do
  5413. autoDsxTest -s4 -e7 -- Runs just steps 4-7 of the script
  5414. autoDsxTest -v -- Does verbose printing
  5415. autoDsxTest -t1000 -- Delays 1 second between each step
  5417. ------------------------------------------------------------------------------
  5419. TABLE: docsis_ctl/dsxTest
  5421. COMMAND: changeConfigFile
  5423. USAGE: changeConfigFile [IpAddress] [Filename{127}]
  5425. DESCRIPTION:
  5426. TFTPs specified config file and DSCs the existing flows identied by flow
  5427. reference.
  5429. EXAMPLES:
  5430. changeConfigFile 10.24.17.36 cfg.bin --
  5432. ------------------------------------------------------------------------------
  5434. TABLE: docsis_ctl/dsxTest
  5436. COMMAND: delRef
  5438. USAGE: delRef REF1{0..65535} [REF2{0..65535}]
  5440. DESCRIPTION:
  5441. Deletes up to 2 flows by their references.
  5443. EXAMPLES:
  5444. delRef 1 2 -- Deletes flows with refs 1 and 2.
  5445. delRef 1 -- Deletes flow with ref 1.
  5447. ------------------------------------------------------------------------------
  5449. TABLE: docsis_ctl/dsxTest
  5451. COMMAND: delSfids
  5453. USAGE: delSfids SFID1{0..65535} [SFID2{0..65535}]
  5455. DESCRIPTION:
  5456. Deletes up to 2 SFIDs in a single DSD transaction.
  5458. EXAMPLES:
  5459. delSfids 1 2 -- Deletes SFIDs 1 and 2.
  5460. delSfids 1 -- Deletes SFID 1.
  5462. ------------------------------------------------------------------------------
  5464. TABLE: docsis_ctl/dsxTest
  5466. COMMAND: dropDsxMsg
  5468. USAGE: dropDsxMsg [rx|tx] [DsaReq|DsaRsp|DsaAck|DscReq|DscRsp|DscAck|DsdReq|DsdRsp|all|none] [count{0..65535}]
  5470. DESCRIPTION:
  5471. Drops incoming/outgoing DSx messages of specified type to simulate message
  5472. loss.
  5473. Only outgoing MIB counters will increment.
  5475. EXAMPLES:
  5476. dropDsxMsg rx DsaReq -- drops all incoming DsaReq messages
  5477. dropDsxMsg tx DscRsp 2 -- drops the next 2 outgoing DsaRsp messages
  5478. dropDsxMsg tx all -- drops all outgoing DSx messages
  5479. dropDsxMsg rx none -- drops no incoming DSx messages
  5482. ------------------------------------------------------------------------------
  5484. TABLE: docsis_ctl/dsxTest
  5486. COMMAND: dscLocal
  5488. USAGE: dscLocal [DscReq|DsaRsp|DscRsp] [count{0..65535}]
  5490. DESCRIPTION:
  5491. Initiate DscLocal trans upon rx of DSx message
  5493. EXAMPLES:
  5494. dscLocal DsaReq 1 -- starts generating DscLocal trans when DsaReq is rx
  5495. dscLocal DscRsp 0 -- stops generating DscLocal trans when DscRsp is rx
  5498. ------------------------------------------------------------------------------
  5500. TABLE: docsis_ctl/dsxTest
  5502. COMMAND: dsdLocal
  5504. USAGE: dsdLocal [rx|tx] [DsaReq|DsaRsp|DscReq|DscRsp] [count{0..65535}]
  5506. DESCRIPTION:
  5507. Initiate DSD local transaction upon rx/tx of DSx message
  5509. EXAMPLES:
  5510. dsdLocal tx DsaReq 1 -- generate DsdLocal trans when next DsaReq is tx
  5511. dsdLocal rx DscRsp 2 -- generate DsdLocal trans when next 2 DscRsp are rx
  5514. ------------------------------------------------------------------------------
  5516. TABLE: docsis_ctl/dsxTest
  5518. COMMAND: show
  5520. USAGE: show
  5522. DESCRIPTION:
  5523. Shows the current state of the test object.
  5525. EXAMPLES:
  5526. show --
  5528. ------------------------------------------------------------------------------
  5530. TABLE: docsis_ctl/propane_ctl
  5532. COMMAND: debug
  5534. USAGE: debug [Enable]
  5536. DESCRIPTION:
  5537. Enables/disables internal Propane library debug printing.
  5539. EXAMPLES:
  5540. debug true --
  5542. ------------------------------------------------------------------------------
  5544. TABLE: docsis_ctl/propane_ctl
  5546. COMMAND: discovery
  5548. USAGE: discovery IpAddress PortNumber{0..65535}
  5550. DESCRIPTION:
  5551. Simulates the CMTS sending a Propane Discovery packet to the CM. You must
  5552. specify the IP address and TCP/UDP port number that the CMTS would have sent
  5553. the packet from.
  5555. EXAMPLES:
  5556. discovery 192.168.190.3 2345 --
  5558. ------------------------------------------------------------------------------
  5560. TABLE: docsis_ctl/propane_ctl
  5562. COMMAND: dsx_complete
  5564. USAGE: dsx_complete Successful
  5566. DESCRIPTION:
  5567. Simulates the completion of the DSC, with the specified result
  5568. (success/fail).
  5570. EXAMPLES:
  5571. dsx_complete true -- Simulate DSC completing successfully
  5573. ------------------------------------------------------------------------------
  5575. TABLE: docsis_ctl/propane_ctl
  5577. COMMAND: oper_caps
  5579. USAGE: oper_caps IpAddress PortNumber{0..65535} PropaneVersion{0..65535} PropaneCaps
  5581. DESCRIPTION:
  5582. Simulates the CMTS sending a Propane Operational Capabilities packet to the
  5583. CM. You must specify the IP address and TCP/UDP port number that the CMTS
  5584. would have sent the packet from. See the Propane protocol docs for the
  5585. version and caps values.
  5587. EXAMPLES:
  5588. oper_caps 192.168.190.3 2345 0 0x01 --
  5590. ------------------------------------------------------------------------------
  5592. TABLE: docsis_ctl/propane_ctl
  5594. COMMAND: port_number
  5596. USAGE: port_number [Number{0..65535}]
  5598. DESCRIPTION:
  5599. Sets the TCP/UDP port number that we will bind our socket to. This takes
  5600. effect the next time we get an IP Address Acquired event.
  5602. EXAMPLES:
  5603. port_number 0x1234 -- Sets the port number to 0x1234
  5605. ------------------------------------------------------------------------------
  5607. TABLE: docsis_ctl/propane_ctl
  5609. COMMAND: psi_grant
  5611. USAGE: psi_grant IpAddress PortNumber{0..65535} TransactionId SFID NumberOfPsis{1..255}
  5613. DESCRIPTION:
  5614. Simulates the CMTS sending a Propane PSI response packet to the CM. The PSI
  5615. values are chosen automatically. You must specify the IP address and TCP/UDP
  5616. port number that the CMTS would have sent the packet from.
  5618. EXAMPLES:
  5619. psi_grant 192.168.190.3 2345 0x1234 0x101 8 -- Grants 8 PSIs, XID 0x1234,
  5620. SFID 0x101
  5622. ------------------------------------------------------------------------------
  5624. TABLE: docsis_ctl/propane_ctl
  5626. COMMAND: release_psis
  5628. USAGE: release_psis TransactionId SFID NumberOfPsis{1..255}
  5630. DESCRIPTION:
  5631. Simulates a request from the Propane Library to release PSIs back to the
  5632. CMTS. This causes a PSI Release packet to be sent. The PSI values are
  5633. chosen automatically.
  5635. EXAMPLES:
  5636. release_psis 0x1234 0x101 8 -- Releases 8 PSIs, XID 0x1234, SFID 0x101
  5638. ------------------------------------------------------------------------------
  5640. TABLE: docsis_ctl/propane_ctl
  5642. COMMAND: request_psis
  5644. USAGE: request_psis TransactionId SFID NumberOfPsis{1..255}
  5646. DESCRIPTION:
  5647. Simulates a request from the Propane Library to get more PSIs from the CMTS.
  5648. This causes a PSI Request packet to be sent.
  5650. EXAMPLES:
  5651. request_psis 0x1234 0x101 8 -- Requests 8 PSIs, XID 0x1234, SFID 0x101
  5653. ------------------------------------------------------------------------------
  5655. TABLE: docsis_ctl/propane_ctl
  5657. COMMAND: show
  5659. USAGE: show
  5661. DESCRIPTION:
  5662. Shows the current state of the CM Propane Control Thread.
  5664. EXAMPLES:
  5665. show --
  5667. ------------------------------------------------------------------------------
  5669. TABLE: docsis_ctl/propane_ctl
  5671. COMMAND: simulate
  5673. USAGE: simulate exit|ip_acq|ip_lost|cm_oper|not_oper
  5675. DESCRIPTION:
  5676. Sends the specified simulated event to the CM Propane Control Thread.
  5678. EXAMPLES:
  5679. simulate ip_acq -- Simulates an IP Addr Acquired event
  5681. ------------------------------------------------------------------------------
  5683. TABLE: embedded_target
  5685. COMMAND: bcmalloc_show
  5687. USAGE: bcmalloc_show [-c]
  5689. DESCRIPTION:
  5690. Displays a snapshot of the current BcmAlloc memory pool statistics. If -c is
  5691. specified, then the counters are also cleared.
  5693. EXAMPLES:
  5694. bcmalloc_show --
  5696. ------------------------------------------------------------------------------
  5698. TABLE: embedded_target
  5700. COMMAND: bcmalloc_walk
  5702. USAGE: bcmalloc_walk
  5704. DESCRIPTION:
  5705. Displays information about the allocated and free BcmAlloc buffers. NOTE:
  5706. This can print a LOT of information!
  5708. EXAMPLES:
  5709. bcmalloc_walk --
  5711. ------------------------------------------------------------------------------
  5713. TABLE: embedded_target
  5715. COMMAND: cache_test
  5717. USAGE: cache_test
  5719. DESCRIPTION:
  5720. Tests DCache flush/invalidate performance.
  5722. EXAMPLES:
  5723. cache_test --
  5725. ------------------------------------------------------------------------------
  5727. TABLE: embedded_target
  5729. COMMAND: cp0_read
  5731. USAGE: cp0_read [-s RegisterSelect{0..7}] RegisterNumber{0..31}
  5733. DESCRIPTION:
  5734. Displays the contents of the coprocessor 0 register to the console.
  5736. RegisterNumber : the register number.
  5737. -s : the register select (defaults to 0)
  5740. EXAMPLES:
  5741. cp0_read 12 -- Reads the interrupt Status register.
  5742. cp0_read 16 -s 1 -- Reads the cache Config1 register.
  5744. ------------------------------------------------------------------------------
  5746. TABLE: embedded_target
  5748. COMMAND: cp0_write
  5750. USAGE: cp0_write [-s RegisterSelect{0..7}] RegisterNumber{0..31} RegisterValue
  5752. DESCRIPTION:
  5753. Writes the specified value to the specified coprocessor 0 register.
  5755. RegisterNumber : the register number.
  5756. -s : the register select (defaults to 0).
  5757. RegisterValue : the value to be written.
  5758. WARNING - it is possible to make the system hang or crash if you write to a
  5759. nonexistent register or write an invalid value!
  5761. EXAMPLES:
  5762. cp0_write 12 0x1000fc00 -- Writes to the interrupt Status register.
  5763. cp0_write 22 -s 5 0x20 -- Writes to register 22, select 5 (branch
  5764. prediction).
  5766. ------------------------------------------------------------------------------
  5768. TABLE: embedded_target
  5770. COMMAND: dcache
  5772. USAGE: dcache [off|thru|back]
  5774. DESCRIPTION:
  5775. Turns the DCache off, or turns it on in writethru or writeback mode, as
  5776. specified. The DCache will be flushed and invalidated so that any dirty
  5777. cache lines will be sent to RAM.
  5779. EXAMPLES:
  5780. dcache off -- Turns the DCache off
  5782. ------------------------------------------------------------------------------
  5784. TABLE: embedded_target
  5786. COMMAND: fpm_show
  5788. USAGE: fpm_show
  5790. DESCRIPTION:
  5791. Displays the configuration settings and statistics of the Hardware Free Pool
  5792. Manager Object.
  5794. EXAMPLES:
  5795. fpm_show --
  5797. ------------------------------------------------------------------------------
  5799. TABLE: embedded_target
  5801. COMMAND: icache
  5803. USAGE: icache [off|on]
  5805. DESCRIPTION:
  5806. Turns the ICache on or off, as specified.
  5808. EXAMPLES:
  5809. icache off -- Turns the ICache off
  5811. ------------------------------------------------------------------------------
  5813. TABLE: embedded_target
  5815. COMMAND: sdram_test
  5817. USAGE: sdram_test bufferSize
  5819. DESCRIPTION:
  5820. Runs the SDRAM tests (stepping 1's on cached/uncached space). NOTE: This
  5821. test runs forever! You must reboot to stop it.
  5823. EXAMPLES:
  5824. sdram_test 524288 -- 512k buffer
  5826. ------------------------------------------------------------------------------
  5828. TABLE: embedded_target
  5830. COMMAND: start_perf_counters
  5832. USAGE: start_perf_counters [-t TpId{0..1}] icache|dcache
  5834. DESCRIPTION:
  5835. Enables and starts the MIPS performance counters for event set specified.
  5837. The -t parameter selects the TP (for multi-core CPUs only).
  5839. EXAMPLES:
  5840. start_perf_counters icache -t1 -- Enables performance counters for the
  5841. ICache module on TP1.
  5843. ------------------------------------------------------------------------------
  5845. TABLE: embedded_target
  5847. COMMAND: stop_perf_counters
  5849. USAGE: stop_perf_counters
  5851. DESCRIPTION:
  5852. Stops the MIPS performance counters and displays the counter values.
  5854. EXAMPLES:
  5855. stop_perf_counters --
  5857. ------------------------------------------------------------------------------
  5859. TABLE: embedded_target
  5861. COMMAND: test_bcmalloc
  5863. USAGE: test_bcmalloc
  5865. DESCRIPTION:
  5866. Tests the BcmAlloc/BcmFree module.
  5868. EXAMPLES:
  5869. test_bcmalloc --
  5871. ------------------------------------------------------------------------------
  5873. TABLE: emta
  5875. COMMAND: acquire_lease
  5877. USAGE: acquire_lease
  5879. DESCRIPTION:
  5880. Acquire lease for EMTA
  5882. EXAMPLES:
  5883. acquire_lease
  5885. ------------------------------------------------------------------------------
  5887. TABLE: emta
  5889. COMMAND: announcementDload
  5891. USAGE: announcementDload [serverIP] [filename{254}] [index]
  5893. DESCRIPTION:
  5894. TFTP the specified announcement file from specified serer into buffer with
  5895. specified index
  5898. EXAMPLES:
  5899. announcementDload 10.24.192.200 myfile.bin 2 - tftp file into index 2
  5902. ------------------------------------------------------------------------------
  5904. TABLE: emta
  5906. COMMAND: anti_spoof
  5908. USAGE: anti_spoof [true|false]
  5910. DESCRIPTION:
  5911. Enable DHCP anti-spoofing measures for EMTAs IP stack
  5913. EXAMPLES:
  5914. anti_spoof
  5916. ------------------------------------------------------------------------------
  5918. TABLE: emta
  5920. COMMAND: call_in_progress
  5922. USAGE: call_in_progress [true|false]
  5924. DESCRIPTION:
  5925. Make-believe there is a call in progress, or not. This is mainly provided to
  5926. test certain features which behave different ways when a call is up.
  5928. EXAMPLES:
  5929. call_in_progress true
  5931. ------------------------------------------------------------------------------
  5933. TABLE: emta
  5935. COMMAND: cfgfile
  5937. USAGE: cfgfile [IP] [path{254}]
  5939. DESCRIPTION:
  5940. Load the specified config file. If IP or path are not specified, then the
  5941. settings from DOCSIS NV / dhcp settings will be used.
  5944. EXAMPLES:
  5945. cfgfile 10.24.192.200 /home/broadcom/cu.cfg
  5948. ------------------------------------------------------------------------------
  5950. TABLE: emta
  5952. COMMAND: dataAccessorGet
  5954. USAGE: dataAccessorGet [DataItemId{254}]
  5956. DESCRIPTION:
  5957. Get an MTA data value.
  5959. EXAMPLES:
  5960. dataAccessorGet -- Show accessor ID descriptors
  5961. dataAccessorGet 0 -- Get all accessor ID's.
  5962. dataAccessorGet 6 -- Get the line #1 Name
  5964. ------------------------------------------------------------------------------
  5966. TABLE: emta
  5968. COMMAND: dataAccessorSet
  5970. USAGE: dataAccessorSet [DataItemId{254}] [Value{254}] [Value2{254}]
  5972. DESCRIPTION:
  5973. Get an MTA data value.
  5975. EXAMPLES:
  5976. dataAccessorSet -- Show accessor ID
  5977. dataAccessorSet <ID> -- Show accessor valid inputs
  5978. dataAccessorSet 58 50 -- Set the NCS queue length to 50.
  5980. ------------------------------------------------------------------------------
  5982. TABLE: emta
  5984. COMMAND: dhcp_init
  5986. USAGE: dhcp_init
  5988. DESCRIPTION:
  5989. Sets up EMTA DHCP event callback to a function that prints the events when
  5990. received
  5992. EXAMPLES:
  5993. dhcp_init
  5995. ------------------------------------------------------------------------------
  5997. TABLE: emta
  5999. COMMAND: dump
  6001. USAGE: dump
  6003. DESCRIPTION:
  6004. Dumps the SAD and SPD
  6006. EXAMPLES:
  6007. dump
  6009. ------------------------------------------------------------------------------
  6011. TABLE: emta
  6013. COMMAND: emtaApiLog
  6015. USAGE: emtaApiLog [Bitmask{0x40007f}]
  6017. DESCRIPTION:
  6018. Configures the message log settings for this class to enable or disable
  6019. various
  6020. app-specific severities. These settings are inherited only when a call is
  6021. started.
  6022. These are the bits supported:
  6024. 0x01 -- Service flow setup info
  6025. 0x02 -- EMTA buffer allocation failures
  6026. 0x04 -- Detailed QoS flow settings
  6029. EXAMPLES:
  6030. emtaApiLog 0x2 -- Enable logging when EMTA voice packet buffer allocation
  6031. fails
  6033. ------------------------------------------------------------------------------
  6035. TABLE: emta
  6037. COMMAND: emta_console
  6039. USAGE: emta_console
  6041. DESCRIPTION:
  6042. Gives control of the console to the EMTA.
  6044. EXAMPLES:
  6045. ip_initialize dhcp -- Forces the IP stack to to do DHCP.
  6046. ip_initialize -- Inits with non-vol settings.
  6048. ------------------------------------------------------------------------------
  6050. TABLE: emta
  6052. COMMAND: firewallEnable
  6054. USAGE: firewallEnable [true|false]
  6056. DESCRIPTION:
  6057. Enables or disables the firewall snoop
  6060. EXAMPLES:
  6061. firewallEnable true
  6064. ------------------------------------------------------------------------------
  6066. TABLE: emta
  6068. COMMAND: ifEntry
  6070. USAGE: ifEntry
  6072. DESCRIPTION:
  6073. Add an EMTA ifEntry as for a voice line.
  6075. EXAMPLES:
  6076. ifEntry
  6078. ------------------------------------------------------------------------------
  6080. TABLE: emta
  6082. COMMAND: initState
  6084. USAGE: initState dhcp|snmp_tftp|rsip|normal|prov|noprov
  6086. DESCRIPTION:
  6087. Sets the MTA init state
  6090. EXAMPLES:
  6091. initState dhcp
  6092. initState snmp_tftp
  6093. initState rsip
  6094. initState normal
  6097. ------------------------------------------------------------------------------
  6099. TABLE: emta
  6101. COMMAND: ip_get
  6103. USAGE: ip_get
  6105. DESCRIPTION:
  6106. Get the EMTA DHCP IP address
  6108. EXAMPLES:
  6109. ip_get
  6111. ------------------------------------------------------------------------------
  6113. TABLE: emta
  6115. COMMAND: ip_initialize
  6117. USAGE: ip_initialize [dhcp]
  6119. DESCRIPTION:
  6120. This causes the IP stack to lock in it's canned DHCP settings (IP and router
  6121. addresses), and enables forwarding of packets to all interfaces. If you use
  6122. the 'dhcp' parameter, then it will do DHCP to get the address; otherwise, it
  6123. will use the DHCP settings from non-vol memory.
  6125. EXAMPLES:
  6126. ip_initialize dhcp -- Forces the IP stack to to do DHCP.
  6128. ------------------------------------------------------------------------------
  6130. TABLE: emta
  6132. COMMAND: lineState
  6134. USAGE: lineState 1|2|3|4 on|off|fault|operational|nonoperational
  6136. DESCRIPTION:
  6137. Sets the line state
  6140. EXAMPLES:
  6141. lineState 1 on
  6142. lineState 2 off
  6143. lineState 1 fault
  6146. ------------------------------------------------------------------------------
  6148. TABLE: emta
  6150. COMMAND: logTimestampFlag
  6152. USAGE: logTimestampFlag
  6154. DESCRIPTION:
  6155. Deprecated. Use 'Console/emta/log <module> hdr time <value>' instead.
  6157. EXAMPLES:
  6160. ------------------------------------------------------------------------------
  6162. TABLE: emta
  6164. COMMAND: mtaInfoGet
  6166. USAGE: mtaInfoGet
  6168. DESCRIPTION:
  6169. Show a collection of MTA Information such as FQDN, IP, Prov. State, etc.
  6171. EXAMPLES:
  6172. mtaInfoGet
  6174. ------------------------------------------------------------------------------
  6176. TABLE: emta
  6178. COMMAND: new_line
  6180. USAGE: new_line
  6182. DESCRIPTION:
  6183. Adds an instance of the ETMA call simulator. A subtable will be added
  6184. dynamically to this table to control all instances of the line simulator.
  6186. EXAMPLES:
  6187. new_line -- Create 1 new instance.
  6189. ------------------------------------------------------------------------------
  6191. TABLE: emta
  6193. COMMAND: option_get
  6195. USAGE: option_get [optionCode]
  6197. DESCRIPTION:
  6198. Get an EMTA DHCP option
  6200. EXAMPLES:
  6201. option_get 1
  6203. ------------------------------------------------------------------------------
  6205. TABLE: emta
  6207. COMMAND: release_lease
  6209. USAGE: release_lease
  6211. DESCRIPTION:
  6212. Release lease for EMTA
  6214. EXAMPLES:
  6215. release_lease
  6217. ------------------------------------------------------------------------------
  6219. TABLE: emta
  6221. COMMAND: renew_lease
  6223. USAGE: renew_lease
  6225. DESCRIPTION:
  6226. Renew lease for EMTA
  6228. EXAMPLES:
  6229. renew_lease
  6231. ------------------------------------------------------------------------------
  6233. TABLE: emta
  6235. COMMAND: reset {disabled}
  6237. USAGE: reset
  6239. DESCRIPTION:
  6240. Reset the MTA now.
  6242. EXAMPLES:
  6243. reset
  6245. ------------------------------------------------------------------------------
  6247. TABLE: emta
  6249. COMMAND: run_app
  6251. USAGE: run_app
  6253. DESCRIPTION:
  6254. If the EMTA application was stopped at the console (either via keypress or
  6255. via non-vol setting that automatically stopped it), then this command will
  6256. allow it to start running. This command is not available if the application
  6257. is already running.
  6259. EXAMPLES:
  6260. run_app --
  6262. ------------------------------------------------------------------------------
  6264. TABLE: emta
  6266. COMMAND: server_get
  6268. USAGE: server_get
  6270. DESCRIPTION:
  6271. Get the DHCP server IP address
  6273. EXAMPLES:
  6274. server_get
  6276. ------------------------------------------------------------------------------
  6278. TABLE: emta
  6280. COMMAND: setCountry
  6282. USAGE: setCountry [Code{254}]
  6284. DESCRIPTION:
  6285. Sets current country code.
  6287. EXAMPLES:
  6288. setCountry -- Display current country code.
  6289. setCountry 0 -- Set country code to NORTH_AMERICA.
  6291. ------------------------------------------------------------------------------
  6293. TABLE: emta
  6295. COMMAND: setclkdiv
  6297. USAGE: setclkdiv Maximum{1..8} Moderate{1..8}
  6299. DESCRIPTION:
  6300. Sets the Powersave Maximum(OnHook) and Moderate(OffHook) Mips Clock Dividers
  6301. (1,2,4,8)
  6304. EXAMPLES:
  6305. SetClkDividers <maximum> <moderate>
  6306. SetClkDividers 8 2
  6309. ------------------------------------------------------------------------------
  6311. TABLE: emta
  6313. COMMAND: showAnnounce
  6315. USAGE: showAnnounce
  6317. DESCRIPTION:
  6318. Shows the currently downloaded announcements
  6321. EXAMPLES:
  6322. showAnnounce
  6325. ------------------------------------------------------------------------------
  6327. TABLE: emta
  6329. COMMAND: showFirewallState
  6331. USAGE: showFirewallState
  6333. DESCRIPTION:
  6334. Shows the current state of the firewall
  6337. EXAMPLES:
  6338. showFirewallState
  6341. ------------------------------------------------------------------------------
  6343. TABLE: emta
  6345. COMMAND: showTelrootCert
  6347. USAGE: showTelrootCert
  6349. DESCRIPTION:
  6350. Show TelRootCert being used (for verifying as-replies).
  6352. EXAMPLES:
  6353. showTelrootCert
  6355. ------------------------------------------------------------------------------
  6357. TABLE: emta
  6359. COMMAND: snmpOperMode
  6361. USAGE: snmpOperMode [Mode{254}]
  6363. DESCRIPTION:
  6364. SNMP Operation Mode (PacketCable Prov. Flow).
  6366. EXAMPLES:
  6367. snmpOperMode 0 -- Secure - SNMPv3.
  6368. snmpOperMode 1 -- BASIC.1 - SNMPv2.
  6369. snmpOperMode 2 -- BASIC.2 - SNMPv2.
  6370. snmpOperMode 3 -- HYBRID.1 - SNMPv2.
  6371. snmpOperMode 4 -- HYBRID.2 - SNMPv2.
  6373. ------------------------------------------------------------------------------
  6375. TABLE: emta
  6377. COMMAND: snmpV2ComNamRO
  6379. USAGE: snmpV2ComNamRO [Name{254}]
  6381. DESCRIPTION:
  6382. Get or Set the Read-Only SNMPv2 Community Name.
  6384. EXAMPLES:
  6385. snmpV2ComNamRO -- Show the RO community name.
  6386. snmpV2ComNamRO NULL -- Clear the RO community name.
  6387. snmpV2ComNamRO CommunityName -- Set the RO community name to CommunityName.
  6389. ------------------------------------------------------------------------------
  6391. TABLE: emta
  6393. COMMAND: snmpV2ComNamRW
  6395. USAGE: snmpV2ComNamRW [Name{254}]
  6397. DESCRIPTION:
  6398. Get or Set the Read-Write SNMPv2 Community Name.
  6400. EXAMPLES:
  6401. snmpV2ComNamRW -- Show the RW community name.
  6402. snmpV2ComNamRW NULL -- Clear the RW community name.
  6403. snmpV2ComNamRW CommunityName -- Set the RW community name to CommunityName.
  6405. ------------------------------------------------------------------------------
  6407. TABLE: emta
  6409. COMMAND: soft_reset
  6411. USAGE: soft_reset
  6413. DESCRIPTION:
  6414. Perform an EMTA soft reset.
  6416. EXAMPLES:
  6417. soft_reset
  6419. ------------------------------------------------------------------------------
  6421. TABLE: emta
  6423. COMMAND: suboption_get
  6425. USAGE: suboption_get
  6427. DESCRIPTION:
  6428. Get a CM DHCP suboption
  6430. EXAMPLES:
  6431. suboption_get 2
  6433. ------------------------------------------------------------------------------
  6435. TABLE: emta
  6437. COMMAND: test_v2
  6439. USAGE: test_v2
  6441. DESCRIPTION:
  6442. {No command help available...}
  6444. EXAMPLES:
  6447. ------------------------------------------------------------------------------
  6449. TABLE: emta
  6451. COMMAND: test_v3
  6453. USAGE: test_v3
  6455. DESCRIPTION:
  6456. {No command help available...}
  6458. EXAMPLES:
  6461. ------------------------------------------------------------------------------
  6463. TABLE: emta/endpt
  6465. COMMAND: apmSts
  6467. USAGE: apmSts
  6469. DESCRIPTION:
  6470. Display APM status information.
  6472. EXAMPLES:
  6473. apmSts -- Display APM status information.
  6475. ------------------------------------------------------------------------------
  6477. TABLE: emta/endpt
  6479. COMMAND: bcmRing
  6481. USAGE: bcmRing Endpoint(0 Referenced){254} Value{254}
  6483. DESCRIPTION:
  6484. Toggle ringing on a particular endpoint.
  6486. EXAMPLES:
  6487. ring 0 0 -- Stop ringing on endpoint number 1.
  6488. ring 0 1 -- Start ringing on endpoint number 1.
  6490. ------------------------------------------------------------------------------
  6492. TABLE: emta/endpt
  6494. COMMAND: checkAssert
  6496. USAGE: checkAssert
  6498. DESCRIPTION:
  6499. Check the DSP assert stack pointer.
  6501. EXAMPLES:
  6502. checkAssert -- Check the DSP assert stack pointer.
  6504. ------------------------------------------------------------------------------
  6506. TABLE: emta/endpt
  6508. COMMAND: configNetwTest
  6510. USAGE: configNetwTest
  6512. DESCRIPTION:
  6513. Removes the ingress switchboard connection and adds an egress switchboard
  6514. connection
  6515. between the line and gateway VHD for all endpoints.
  6517. EXAMPLES:
  6518. configNetwTest -- Setup an egree switchboard connection between line and GW
  6519. VHD.
  6521. ------------------------------------------------------------------------------
  6523. TABLE: emta/endpt
  6525. COMMAND: dlbConfig
  6527. USAGE: dlbConfig timeMsec{254}
  6529. DESCRIPTION:
  6530. Set load balancing throttle duration.
  6532. EXAMPLES:
  6533. dlbConfig 200 -- Set load balancing throttle to 200ms duration.
  6535. ------------------------------------------------------------------------------
  6537. TABLE: emta/endpt
  6539. COMMAND: dlbEnable
  6541. USAGE: dlbEnable Enable{254}
  6543. DESCRIPTION:
  6544. Toggle load balancing.
  6546. EXAMPLES:
  6547. dlbEnable 1 -- Enable load balancing.
  6548. dlbEnable 0 -- Disable load balancing.
  6550. ------------------------------------------------------------------------------
  6552. TABLE: emta/endpt
  6554. COMMAND: dlbStatic
  6556. USAGE: dlbStatic Enable{254}
  6558. DESCRIPTION:
  6559. Toggle static load balancing.
  6561. EXAMPLES:
  6562. dlbStatic 1 -- Enable static load balancing.
  6563. dlbStatic 0 -- Disable static load balancing.
  6565. ------------------------------------------------------------------------------
  6567. TABLE: emta/endpt
  6569. COMMAND: dlbStats
  6571. USAGE: dlbStats
  6573. DESCRIPTION:
  6574. Display load balancing statstics.
  6576. EXAMPLES:
  6577. dlbStats -- Display load balancing statstics.
  6579. ------------------------------------------------------------------------------
  6581. TABLE: emta/endpt
  6583. COMMAND: fAssert
  6585. USAGE: fAssert
  6587. DESCRIPTION:
  6588. Force a DSP Assert (Note: This will crash the DSP).
  6590. EXAMPLES:
  6591. fAssert -- Force a DSP Assert.
  6593. ------------------------------------------------------------------------------
  6595. TABLE: emta/endpt
  6597. COMMAND: faxrStats
  6599. USAGE: faxrStats Handle{254}
  6601. DESCRIPTION:
  6602. Display fax relay stats (handle must be in hex).
  6604. EXAMPLES:
  6605. faxrStats 0x52 -- Display fax relay stats for handle number 0x52.
  6607. ------------------------------------------------------------------------------
  6609. TABLE: emta/endpt
  6611. COMMAND: forceDrop
  6613. USAGE: forceDrop
  6615. DESCRIPTION:
  6616. Force drop line voltage.
  6618. EXAMPLES:
  6619. forceDrop Drop line voltage.
  6621. ------------------------------------------------------------------------------
  6623. TABLE: emta/endpt
  6625. COMMAND: getBuff
  6627. USAGE: getBuff
  6629. DESCRIPTION:
  6630. Display DSP buffer pool status.
  6632. EXAMPLES:
  6633. getBuff -- Display DSP buffer pool status.
  6635. ------------------------------------------------------------------------------
  6637. TABLE: emta/endpt
  6639. COMMAND: getCaps
  6641. USAGE: getCaps
  6643. DESCRIPTION:
  6644. Display DSP capacity information.
  6646. EXAMPLES:
  6647. getCaps -- Display DSP capacity information.
  6649. ------------------------------------------------------------------------------
  6651. TABLE: emta/endpt
  6653. COMMAND: getCnt
  6655. USAGE: getCnt
  6657. DESCRIPTION:
  6658. Display DSP debug counters
  6660. EXAMPLES:
  6661. getCnt -- Display DSP debug counters.
  6663. ------------------------------------------------------------------------------
  6665. TABLE: emta/endpt
  6667. COMMAND: getRegs
  6669. USAGE: getRegs
  6671. DESCRIPTION:
  6672. Get a snapshot of the DSP registers.
  6674. EXAMPLES:
  6675. getRegs -- Get a snapshot of the DSP registers.
  6677. ------------------------------------------------------------------------------
  6679. TABLE: emta/endpt
  6681. COMMAND: hapInetCfgSet
  6683. USAGE: hapInetCfgSet Handle{254} Offset{254} Value{254}
  6685. DESCRIPTION:
  6686. Set configuration register of NET service at offset for VHD handle(hex) to a
  6687. value.
  6689. EXAMPLES:
  6690. hapInetCfgSet 0x3 5 2 -- Set handle 3 at offset of 5 to a value of 2.
  6692. ------------------------------------------------------------------------------
  6694. TABLE: emta/endpt
  6696. COMMAND: icpCalibrateProfiler
  6698. USAGE: icpCalibrateProfiler
  6700. DESCRIPTION:
  6701. Calibrate DSP idle CPU profiler.
  6703. EXAMPLES:
  6704. icpCalibrateProfiler -- Calibrate DSP idle CPU profiler.
  6706. ------------------------------------------------------------------------------
  6708. TABLE: emta/endpt
  6710. COMMAND: icpStart
  6712. USAGE: icpStart [Verbose{254}] [Seconds{254}]
  6714. DESCRIPTION:
  6715. Start DSP idle CPU profiler.
  6717. EXAMPLES:
  6718. icpStart 1 2 -- Start CPU profiler with verbose output and 2 second
  6719. interval.
  6720. icpStart 0 2 -- Start CPU profiler with no verbosity with a 2 second
  6721. interval.
  6723. ------------------------------------------------------------------------------
  6725. TABLE: emta/endpt
  6727. COMMAND: icpStop
  6729. USAGE: icpStop
  6731. DESCRIPTION:
  6732. Stop DSP idle CPU profiler.
  6734. EXAMPLES:
  6735. icpStop -- Stop DSP idle CPU profiler.
  6737. ------------------------------------------------------------------------------
  6739. TABLE: emta/endpt
  6741. COMMAND: ipcStats
  6743. USAGE: ipcStats Handle{254} Mode{254}
  6745. DESCRIPTION:
  6746. Display IPC statistics for all or specific channel.
  6748. EXAMPLES:
  6749. ipcStats 0x52 0 -- Display IPC statistics for handle 0x52.
  6750. ipcStats 0x52 1 -- Display entire IPC channel for handle 0x52.
  6751. ipcStats all 0 -- Display IPC statistics for all handles.
  6753. ------------------------------------------------------------------------------
  6755. TABLE: emta/endpt
  6757. COMMAND: pwr
  6759. USAGE: pwr Module{254} Mode{254} Channel{254}
  6761. DESCRIPTION:
  6762. Power control command.
  6764. EXAMPLES:
  6765. pwr [Module] [Mode] [Channel]
  6766. Module = vpm|afe
  6767. Mode = 0|1 (0-full speed|OFF; 1-sleep|ON)
  6768. Channel = 0..2 for Module=afe
  6769. pwr vpm 0 1 -- Set power module vpm full speed mode for channel number 1.
  6770. pwr afe 1 1 -- Set power module afe sleep mode for channel 1.
  6772. ------------------------------------------------------------------------------
  6774. TABLE: emta/endpt
  6776. COMMAND: readHookState
  6778. USAGE: readHookState Endpoint(0 Referenced){254}
  6780. DESCRIPTION:
  6781. Read current hook status for a particular endpoint.
  6783. EXAMPLES:
  6784. readHookState 0 -- Display hook status for endpoint number 1.
  6786. ------------------------------------------------------------------------------
  6788. TABLE: emta/endpt
  6790. COMMAND: readMem
  6792. USAGE: readMem Address{254} Length{254}
  6794. DESCRIPTION:
  6795. Read internal DSP data memory (addr must be 16-bit hex).
  6797. EXAMPLES:
  6798. readMem 0x8000 20 -- Display 20 bytes of memory at 0x8000.
  6800. ------------------------------------------------------------------------------
  6802. TABLE: emta/endpt
  6804. COMMAND: readSlicMem
  6806. USAGE: readSlicMem Endpoint(0 Referenced){254} Address{254}
  6808. DESCRIPTION:
  6809. Read SLIC memory from a particular address.
  6811. EXAMPLES:
  6812. readSlicMem 0 0x50 -- Read SLIC memory from endpoint 1 at address 0x50.
  6813. readSlicMem 1 0x80 -- Read SLIC memory from endpoint 2 at address 0x80.
  6815. ------------------------------------------------------------------------------
  6817. TABLE: emta/endpt
  6819. COMMAND: ring
  6821. USAGE: ring Endpoint(0 Referenced){254} Value{254}
  6823. DESCRIPTION:
  6824. ring ch# with pattern (patt#=0-7; patt#=8+ => ring off)
  6826. EXAMPLES:
  6827. ring 0 8 -- Stop ringing on endpoint number 1.
  6828. ring 0 1 -- Start ringing pattern 1 on endpoint number 1.
  6830. ------------------------------------------------------------------------------
  6832. TABLE: emta/endpt
  6834. COMMAND: rxGain
  6836. USAGE: rxGain Endpoint{254} [Gain{254}]
  6838. DESCRIPTION:
  6839. Get or Set the Rx gain on the endpoint.
  6841. EXAMPLES:
  6842. rxGain 1 -- Get the Rx gain on the endpoint.
  6843. rxGain 1 20 -- Set the Rx gain on endpoint 1 to 20db.
  6845. ------------------------------------------------------------------------------
  6847. TABLE: emta/endpt
  6849. COMMAND: stackShow
  6851. USAGE: stackShow
  6853. DESCRIPTION:
  6854. Display DSP stack usage statistics.
  6856. EXAMPLES:
  6857. stackShow -- Display DSP stack usage statistics.
  6859. ------------------------------------------------------------------------------
  6861. TABLE: emta/endpt
  6863. COMMAND: tpd
  6865. USAGE: tpd Endpoint(0 Referenced){254} TestList{254}
  6867. DESCRIPTION:
  6868. Execute PC 1.5 TPD Tests.
  6870. EXAMPLES:
  6871. tpd 0 0x0020 -- Execute TPD 0x0020 tests on endpoint #1.
  6873. ------------------------------------------------------------------------------
  6875. TABLE: emta/endpt
  6877. COMMAND: tr57Enable
  6879. USAGE: tr57Enable Enable{254}
  6881. DESCRIPTION:
  6882. Toggle the TR57 test mode.
  6884. EXAMPLES:
  6885. tr57Enable 0 -- Disable TR57 test mode.
  6886. tr57Enable 1 -- Enable TR57 test mode.
  6888. ------------------------------------------------------------------------------
  6890. TABLE: emta/endpt
  6892. COMMAND: txGain
  6894. USAGE: txGain Endpoint{254} [Gain{254}]
  6896. DESCRIPTION:
  6897. Get or Set the Tx gain on the endpoint.
  6899. EXAMPLES:
  6900. txGain 1 -- Get the Tx gain on the endpoint.
  6901. txGain 1 10 -- Set the Tx gain on endpoint 1 to 10db.
  6903. ------------------------------------------------------------------------------
  6905. TABLE: emta/endpt
  6907. COMMAND: vhdInfo
  6909. USAGE: vhdInfo
  6911. DESCRIPTION:
  6912. Display info for all VHDs.
  6914. EXAMPLES:
  6915. vhdInfo -- Display info for all VHDs.
  6917. ------------------------------------------------------------------------------
  6919. TABLE: emta/endpt
  6921. COMMAND: vhdJBRegs
  6923. USAGE: vhdJBRegs Handle{254}
  6925. DESCRIPTION:
  6926. Display cnx VHD JB parms (handle in hex).
  6928. EXAMPLES:
  6929. vhdJBRegs 0x52 -- Display cnx VHD JB parms for handle number 0x52.
  6931. ------------------------------------------------------------------------------
  6933. TABLE: emta/endpt
  6935. COMMAND: vhdLoopback
  6937. USAGE: vhdLoopback Enable{254}
  6939. DESCRIPTION:
  6940. Toggle VHD loopback between channels.
  6942. EXAMPLES:
  6943. vhdLoopback 0 -- Disable VHD loopback.
  6944. vhdLoopback 1 -- Enable VHD loopback.
  6946. ------------------------------------------------------------------------------
  6948. TABLE: emta/endpt
  6950. COMMAND: vhdStats
  6952. USAGE: vhdStats Endpoint(0 Reference){254}
  6954. DESCRIPTION:
  6955. Display all cnx VHD stats on the endpt.
  6957. EXAMPLES:
  6958. vhdStats 1 -- Display cnx VHD stats for endpoint number 1.
  6960. ------------------------------------------------------------------------------
  6962. TABLE: emta/endpt
  6964. COMMAND: writeSlicMem
  6966. USAGE: writeSlicMem Endpoint(0 Referenced){254} Address{254} Value{254}
  6968. DESCRIPTION:
  6969. Write SLIC memory to a particular address.
  6971. EXAMPLES:
  6972. writeSlicMem 0 0x50 2 -- Write SLIC memory from endpoint 1 at address 0x50
  6973. with a value of 2.
  6974. writeSlicMem 1 0x80 3 -- Write SLIC memory from endpoint 2 at address 0x80
  6975. with a value of 3.
  6977. ------------------------------------------------------------------------------
  6979. TABLE: enet_hal
  6981. COMMAND: autoneg
  6983. USAGE: autoneg [true|false]
  6985. DESCRIPTION:
  6986. Turns Ethernet AutoNegotiation on or off.
  6988. EXAMPLES:
  6989. autoneg true -- Enables Ethernet AutoNegotiation
  6991. ------------------------------------------------------------------------------
  6993. TABLE: enet_hal
  6995. COMMAND: down
  6997. USAGE: down
  6999. DESCRIPTION:
  7000. Sets the interface administratively down (equivalent to setting ifAdminStatus
  7001. to 'down')
  7003. EXAMPLES:
  7004. down --
  7006. ------------------------------------------------------------------------------
  7008. TABLE: enet_hal
  7010. COMMAND: eth_powerdown
  7012. USAGE: eth_powerdown [true|false]
  7014. DESCRIPTION:
  7015. Putting the Ethernet IF into powerdown mode does the following in the
  7016. specified order:
  7018. 1 -- Suspends the Ethernet link monitoring task
  7019. 2 -- Disables interrupts from the EMAC
  7020. 3 -- Disables the EMAC core
  7021. 4 -- Disables the clock to the EMAC
  7023. The Ethernet IF is returned to operation state by negating these actions in
  7024. reverse order
  7026. EXAMPLES:
  7027. eth_powerdown true -- Puts the Ethernet IF in powerdown mode.
  7028. eth_powerdown false -- Restores the Ethernet IF to operational state.
  7030. ------------------------------------------------------------------------------
  7032. TABLE: enet_hal
  7034. COMMAND: force_link
  7036. USAGE: force_link [true|false]
  7038. DESCRIPTION:
  7039. Enables/disables the link detection logic, forcing the PHY to think that
  7040. there is a link when there really isn't.
  7042. EXAMPLES:
  7043. force_link -- Queries the link-forced state.
  7044. force_link true -- Forces the link.
  7045. force_link false -- Reverts to normal link detection.
  7047. ------------------------------------------------------------------------------
  7049. TABLE: enet_hal
  7051. COMMAND: full_duplex
  7053. USAGE: full_duplex [true|false]
  7055. DESCRIPTION:
  7056. If autoneg is off, sets the Ethernet duplex to full/half.
  7058. EXAMPLES:
  7059. full_duplex true -- Sets the link to full duplex
  7061. ------------------------------------------------------------------------------
  7063. TABLE: enet_hal
  7065. COMMAND: hal_show
  7067. USAGE: hal_show
  7069. DESCRIPTION:
  7070. Causes the Ethernet HAL to display its internal state.
  7072. EXAMPLES:
  7073. hal_show --
  7075. ------------------------------------------------------------------------------
  7077. TABLE: enet_hal
  7079. COMMAND: read_mii
  7081. USAGE: read_mii PhyAddr RegAddr
  7083. DESCRIPTION:
  7084. Reads the specified ethernet MII register from the PHY specified.
  7086. EXAMPLES:
  7087. read_mii 0x1 0x00 -- Reads the port Control REG from the internal PHY.
  7089. ------------------------------------------------------------------------------
  7091. TABLE: enet_hal
  7093. COMMAND: read_switch
  7095. USAGE: read_switch RegAddr
  7097. DESCRIPTION:
  7098. Reads the specified register from the Switch.
  7100. EXAMPLES:
  7101. read_switch 0x300 -- Reads of the Port 2 Status Register from the Switch
  7102. Core.
  7104. ------------------------------------------------------------------------------
  7106. TABLE: enet_hal
  7108. COMMAND: show
  7110. USAGE: show
  7112. DESCRIPTION:
  7113. Causes the HalIf object to display its state.
  7115. EXAMPLES:
  7116. show --
  7118. ------------------------------------------------------------------------------
  7120. TABLE: enet_hal
  7122. COMMAND: speed
  7124. USAGE: speed [10|100|1000]
  7126. DESCRIPTION:
  7127. If autoneg is off, sets the Ethernet link speed.
  7129. EXAMPLES:
  7130. speed 100 -- Sets the link speed to 100 Mbps
  7132. ------------------------------------------------------------------------------
  7134. TABLE: enet_hal
  7136. COMMAND: transmit
  7138. USAGE: transmit [-s PacketSize{64..1518}] [-t NumSeconds] [-r TimeBetweenPacketsMs] [-p FillPattern{0..255}]
  7140. DESCRIPTION:
  7141. Transmits packets out the ethernet interface. The packets will have garbage
  7142. data in them, so you probably don't want to do this on a live network.
  7143. Packets will be sent as fast as possible unless overridden by the -r flag;
  7144. you can specify the packet size and/or the number of seconds over which to
  7145. send packets. If not otherwise specified, it will send 1518 byte packets
  7146. until the system is power cycled.
  7148. Flags:
  7149. -s : The packet size; if not specified, 1518 bytes.
  7150. -t : Number of seconds you want to transmit; default (0) = infinite.
  7151. -r : Controls the packet rate. Specify the time (in ms) between each
  7152. packet. Note that this value will be quantized based on the OS clock
  7153. tick resolution (usually 10ms), so 1ms, 8ms, and 12ms are all the same
  7154. as 10ms. A value of 0 means 'as fast as possible', i.e. no delay
  7155. between packets.
  7156. -p : Specifies the fill pattern for the buffer. The value specified will
  7157. be used to fill the buffer. If not specified, then the buffer is
  7158. filled with increasing values.
  7160. EXAMPLES:
  7161. transmit -- Sends 1518 byte packets until power cycled.
  7162. transmit -s 64 -- Sends 64 byte packets until power cycled.
  7163. transmit -t 60 -- Sends 1518 byte packets for 1 minute.
  7164. transmit -r 1000 -- Sends 1518 byte packets once a second.
  7165. transmit -r 10 -- Sends 1518 byte packets at 100 packets per second.
  7166. transmit -p 0xaa -- Fills the 1518 byte packet with 0xaa values.
  7168. ------------------------------------------------------------------------------
  7170. TABLE: enet_hal
  7172. COMMAND: up
  7174. USAGE: up
  7176. DESCRIPTION:
  7177. Sets the interface administratively up (equivalent to setting ifAdminStatus
  7178. to 'up')
  7180. EXAMPLES:
  7181. up --
  7183. ------------------------------------------------------------------------------
  7185. TABLE: enet_hal
  7187. COMMAND: write_mii
  7189. USAGE: write_mii PhyAddr RegAddr Value
  7191. DESCRIPTION:
  7192. Writes the specified value to the ethernet MII register, using the PHY
  7193. specified. Note that if you want to mask bits on or off, then you will need
  7194. to do the math yourself, using read_mii to show the current value.
  7196. EXAMPLES:
  7197. write_mii 0x01 0x00 0x1000 -- Sets the port Control Reg (using the internal
  7198. PHY).
  7200. ------------------------------------------------------------------------------
  7202. TABLE: enet_hal
  7204. COMMAND: write_switch
  7206. USAGE: write_switch RegAddr Value
  7208. DESCRIPTION:
  7209. Writes the specified value to the Switch register specified
  7211. EXAMPLES:
  7212. write_switch 0x300 0x2b0 -- Sets the Port 2 Status Register to 0x2b0.
  7214. ------------------------------------------------------------------------------
  7216. TABLE: event_log
  7218. COMMAND: control
  7220. USAGE: control [level{0..8}] [reporting{0..255}]
  7222. DESCRIPTION:
  7223. Show or modify the contents of the control table.
  7225. EXAMPLES:
  7226. control -- show the control table
  7227. control 1 0x80 -- set reporting for level 1 to 0x80
  7228. control 0 0x00 -- set reporting for all levels to 0
  7231. ------------------------------------------------------------------------------
  7233. TABLE: event_log
  7235. COMMAND: flush
  7237. USAGE: flush
  7239. DESCRIPTION:
  7240. Flush the contents of the event log, including stored events.
  7242. EXAMPLES:
  7243. flush --
  7245. ------------------------------------------------------------------------------
  7247. TABLE: event_log
  7249. COMMAND: log_event
  7251. USAGE: log_event eventId{15} [evParm1{127}] [evParm2{127}] [evParm3{127}] [evParm4{127}] [evParm5{127}]
  7253. DESCRIPTION:
  7254. Log an event with the specified event id to the event log. The event may
  7255. have up to 4 event-specific text parameters; if your parameter has a space,
  7256. then enclose it in quotes (e.g. "this is parm 1").
  7258. EXAMPLES:
  7259. log_event E102.0 basic.cfg -- Logs event E102.0, with the cfg file as
  7260. evParm1.
  7262. ------------------------------------------------------------------------------
  7264. TABLE: event_log
  7266. COMMAND: read
  7268. USAGE: read
  7270. DESCRIPTION:
  7271. Read the event log from NV storage and rebuild the table.
  7273. EXAMPLES:
  7274. read --
  7276. ------------------------------------------------------------------------------
  7278. TABLE: event_log
  7280. COMMAND: show
  7282. USAGE: show
  7284. DESCRIPTION:
  7285. Dump the contents of the event log to the console
  7286. NOTE: for more debug info, turn on log events from the SNMP directory.
  7288. EXAMPLES:
  7289. show --
  7291. ------------------------------------------------------------------------------
  7293. TABLE: event_log
  7295. COMMAND: silent
  7297. USAGE: silent true|false [element{31}]
  7299. DESCRIPTION:
  7300. If set to true, makes the specified event log element silent (ie nothing
  7301. printed to the console). Elements which may be specified are 'events',
  7302. 'traps', and 'syslogs'. If no element is specified, then events, traps, and
  7303. syslogs will all be affected.
  7305. EXAMPLES:
  7306. silent true -- make events, traps, and syslogs all silent.
  7307. silent true events -- make events silent.
  7308. silent true traps -- make traps silent.
  7309. silent true syslogs -- make syslog messages silent.
  7312. ------------------------------------------------------------------------------
  7314. TABLE: event_log
  7316. COMMAND: stop_stress
  7318. USAGE: stop_stress
  7320. DESCRIPTION:
  7321. Stop a stress test if one is in progress.
  7323. EXAMPLES:
  7324. stop_stress --
  7326. ------------------------------------------------------------------------------
  7328. TABLE: event_log
  7330. COMMAND: stress
  7332. USAGE: stress [numevents{0..65535}] [silent]
  7334. DESCRIPTION:
  7335. Start a stress test for the selected event log object. If the silent
  7336. parameter is set to true, events will not be printed to the console. If the
  7337. number of events is set to 0 (or unspecified), the stress will continue until
  7338. a stop_stress command is issued. Otherwise, the number of events specified
  7339. will be logged, then the stress will conclude.
  7341. EXAMPLES:
  7342. stress silent --
  7344. ------------------------------------------------------------------------------
  7346. TABLE: event_log
  7348. COMMAND: syslog
  7350. USAGE: syslog [IpAddress]
  7352. DESCRIPTION:
  7353. Set the IP address of the syslog server. Use 0.0.0.0 to inhibit.
  7355. EXAMPLES:
  7356. syslog 11.24.4.3 --
  7358. ------------------------------------------------------------------------------
  7360. TABLE: event_log
  7362. COMMAND: verbose_show
  7364. USAGE: verbose_show
  7366. DESCRIPTION:
  7367. Print the event log in a more verbose style that does not truncate event text
  7370. EXAMPLES:
  7371. verbose_show --
  7373. ------------------------------------------------------------------------------
  7375. TABLE: flash
  7377. COMMAND: autoTest
  7379. USAGE: autoTest bootloader|image1|image2|perm|dyn [BlockNumber]
  7381. DESCRIPTION:
  7382. Does an automated test suite on the specified flash block (in the specified
  7383. region) to ensure that all of the flash driver functions work correctly.
  7384. NOTE: any data in the specified block will be erased! Choose a block that
  7385. is not being used for anything important! Use the 'show' command to list the
  7386. blocks and how they are allocated.
  7388. If you omit the BlockNumber parameter, the test will be run over all blocks
  7389. in the region (destroying any data that is in the blocks).
  7391. In July 2004, we had to change the flash driver in order to support multiple
  7392. flash devices. As a result, you can no longer just specify the block number;
  7393. you must also specify the region that the block is in (the region maps to a
  7394. flash device, and the block number within that device will be tested). If
  7395. you specify a region that does not contain the block, then the test will
  7396. fail.
  7398. EXAMPLES:
  7399. autoTest image2 33 -- Performs the test suite on block 33 (which is in the
  7400. image2 region)
  7401. autoTest image2 -- Performs the test suite on all blocks in the image2
  7402. region
  7404. ------------------------------------------------------------------------------
  7406. TABLE: flash
  7408. COMMAND: cfi_show
  7410. USAGE: cfi_show bootloader|image1|image2|perm|dyn
  7412. DESCRIPTION:
  7413. Displays the CFI database for the flash device associated with the specified
  7414. region (if the device is CFI-compliant).
  7416. EXAMPLES:
  7417. cfi_show image2 -- Displays CFI info for the flash device associated with
  7418. image2
  7420. ------------------------------------------------------------------------------
  7422. TABLE: flash
  7424. COMMAND: close
  7426. USAGE: close
  7428. DESCRIPTION:
  7429. Closes the flash driver, allowing the rest of the application to use it.
  7430. Calling this more than once has no effect.
  7432. EXAMPLES:
  7433. close --
  7435. ------------------------------------------------------------------------------
  7437. TABLE: flash
  7439. COMMAND: configRegion
  7441. USAGE: configRegion bootloader|image1|image2|perm|dyn SizeBytes
  7443. DESCRIPTION:
  7444. Configures the minimum acceptable size for a region. This takes effect the
  7445. next time the driver is initialzied. Specifying a size of 0 restores the
  7446. default built in to the driver.
  7448. EXAMPLES:
  7449. configRegion perm 65536 -- Configures Perm NonVol to require a minimum of
  7450. 64k
  7452. ------------------------------------------------------------------------------
  7454. TABLE: flash
  7456. COMMAND: deinit
  7458. USAGE: deinit
  7460. DESCRIPTION:
  7461. Deinitializes the flash driver, making it release resouces. Note that the
  7462. flash device will be unusable after this, until you run the init command.
  7464. EXAMPLES:
  7465. deinit --
  7467. ------------------------------------------------------------------------------
  7469. TABLE: flash
  7471. COMMAND: erase
  7473. USAGE: erase [-b BlockNumber] [-a Offset] [-r]
  7475. DESCRIPTION:
  7476. Erases the flash block specified by the block number (-b), address offset
  7477. (-a) or erases all blocks in the region (-r).
  7479. EXAMPLES:
  7480. erase -b 3 -- Erases block number 3 (the fourth block)
  7482. ------------------------------------------------------------------------------
  7484. TABLE: flash
  7486. COMMAND: init
  7488. USAGE: init
  7490. DESCRIPTION:
  7491. Initializes the flash driver, making it detect the flash device. This is
  7492. usually done for you at system startup, but may be needed if you deinit the
  7493. driver. This command has no effect if the driver is already initialized.
  7495. EXAMPLES:
  7496. init --
  7498. ------------------------------------------------------------------------------
  7500. TABLE: flash
  7502. COMMAND: open
  7504. USAGE: open bootloader|image1|image2|perm|dyn
  7506. DESCRIPTION:
  7507. Opens the flash driver for use by the console (locking out the rest of the
  7508. application!) so that you can use the read/write/erase commands. NOTE: If
  7509. you do something that would cause the driver to be opened again (write
  7510. nonvol, dload an image, etc), then the operation will be blocked until you
  7511. run the close command, or it may fail.
  7513. EXAMPLES:
  7514. open image2 -- Opens the image2 region for read/write/erase
  7516. ------------------------------------------------------------------------------
  7518. TABLE: flash
  7520. COMMAND: read
  7522. USAGE: read Size{1..4} Number{1..8192} Offset
  7524. DESCRIPTION:
  7525. Uses the read functions to access data in the flash device, printing to the
  7526. console. You must specify the size of the read (1, 2, or 4 bytes), the
  7527. number of bytes to read, and the offset into the region to start. The offset
  7528. should be aligned correctly for the size specified.
  7530. EXAMPLES:
  7531. read 1 4 0 -- Reads 4 bytes at the beginning of the region
  7532. read 4 8 1024 -- Reads 2 dwords at offset 1k in the region
  7534. ------------------------------------------------------------------------------
  7536. TABLE: flash
  7538. COMMAND: readDirect
  7540. USAGE: readDirect Number{1..8192} Offset
  7542. DESCRIPTION:
  7543. Uses the read direct function to access the flash memory data directly,
  7544. printing to the console. You must specify the number of bytes to read and
  7545. the offset into the region to start.
  7547. EXAMPLES:
  7548. readDirect 128 0 -- Reads 128 bytes at the beginning of the region
  7550. ------------------------------------------------------------------------------
  7552. TABLE: flash
  7554. COMMAND: show
  7556. USAGE: show
  7558. DESCRIPTION:
  7559. Causes the flash driver to display its internal state.
  7561. EXAMPLES:
  7562. show --
  7564. ------------------------------------------------------------------------------
  7566. TABLE: flash
  7568. COMMAND: write
  7570. USAGE: write Size{1..4} Offset Value
  7572. DESCRIPTION:
  7573. Uses the write functions to store data to the flash device. You must specify
  7574. the size of the write (1, 2, or 4 bytes), the offset into the region to
  7575. write, and the value. The offset should be aligned correctly for the size
  7576. specified. The value will only be stored if the block was previously erased,
  7577. or a bit is being changed from 1 to 0.
  7579. EXAMPLES:
  7580. write 1 0 0x12 -- Writes the byte value 0x12 to the beginning of
  7581. the region
  7582. write 4 1024 0x12345678 -- Writes the dword value to offset 1k in the region
  7584. ------------------------------------------------------------------------------
  7586. TABLE: flash
  7588. COMMAND: writeArray
  7590. USAGE: writeArray Number{1..131072} Offset
  7592. DESCRIPTION:
  7593. Uses the write array function to store an array of data (incrementing bytes)
  7594. to the flash memory. You must specify the number of bytes to write and the
  7595. offset into the region to start.
  7597. EXAMPLES:
  7598. writeArray 128 0 -- Writes 128 bytes at the beginning of the region
  7600. ------------------------------------------------------------------------------
  7602. TABLE: forwarder
  7604. COMMAND: filter_logging_enable
  7606. USAGE: filter_logging_enable [true|false]
  7608. DESCRIPTION:
  7609. Enables or disables the packet logging filtering (protocol, mac, ip, and
  7610. port).
  7612. EXAMPLES:
  7613. filter_logging_enable true --
  7615. ------------------------------------------------------------------------------
  7617. TABLE: forwarder
  7619. COMMAND: filter_logging_show
  7621. USAGE: filter_logging_show
  7623. DESCRIPTION:
  7624. Display the packet filter logging settings (protocol, mac, ip, and port).
  7626. EXAMPLES:
  7627. filter_logging_show --
  7629. ------------------------------------------------------------------------------
  7631. TABLE: forwarder
  7633. COMMAND: halif_show
  7635. USAGE: halif_show [-s] [-d]
  7637. DESCRIPTION:
  7638. Shows all of the HalIf objects that have been registered. If -s is
  7639. specified, then it also prints a table of the interfaces, showing who can
  7640. transmit to whom. Otherwise, it just prints the descriptions. If -d is
  7641. specified, then it prints the detailed HalIf object contents, including
  7642. counters, Snoops, etc.
  7644. EXAMPLES:
  7645. halif_show --
  7647. ------------------------------------------------------------------------------
  7649. TABLE: forwarder
  7651. COMMAND: ip_filter_logging
  7653. USAGE: ip_filter_logging [-s] [-d] [-b] [-c] [IpAddress]
  7655. DESCRIPTION:
  7656. ip_filter_logging -s 192.168.0.1 - sets a filter for a source ip addr.
  7657. ip_filter_logging -d 192.168.0.1 - sets a filter for a destination ip addr.
  7658. ip_filter_logging -b 192.168.0.1 - sets a filter for a src and dest ip addr.
  7659. ip_filter_logging -c - clears all ip filters.
  7662. EXAMPLES:
  7663. ip_filter_logging -<flag> <ip address> --
  7665. ------------------------------------------------------------------------------
  7667. TABLE: forwarder
  7669. COMMAND: log_packets
  7671. USAGE: log_packets [-s] [true|false] [from_interfaces] [to_interfaces]
  7673. DESCRIPTION:
  7674. This enables/disables logging for packets received from the specified
  7675. interfaces and being sent to the specified interfaces. If enabled, then the
  7676. contents of the packet will be displayed, and the forwarder will show info
  7677. about the HalIf on which it was received/sent, as well as why the packet was
  7678. dropped. If the from/to interfaces parameters are missing, then all will be
  7679. done. The interfaces are a bitmask where 0x01 corresponds to the interface
  7680. at index 0, 0x04 corresponds to the interface at index 2, etc.
  7682. EXAMPLES:
  7683. log_packets true -- Enables packet logging for all interfaces.
  7684. log_packets false 0x2 -- Disables logging of packets from interface 1 (to
  7685. any).
  7686. log_packets true 0x1 0x6 -- Enables logging of packets received from
  7687. interface 0 and destined to interfaces 1 or 2.
  7688. log_packets -- Shows the enable/disable state for all
  7689. interfaces.
  7690. log_packets -s true -- Enables non-verbose logging of packets.
  7693. ------------------------------------------------------------------------------
  7695. TABLE: forwarder
  7697. COMMAND: lt_add
  7699. USAGE: lt_add mac_addr halif [static]
  7701. DESCRIPTION:
  7702. Adds an association between the specified MAC address and HalIf.
  7704. EXAMPLES:
  7705. lt_add 00:10:18:00:10:36 2 -- Adds a dynamic association for HalIf 2.
  7706. lt_add 00:10:18:00:10:37 2 true -- Adds a static association for HalIf 2.
  7709. ------------------------------------------------------------------------------
  7711. TABLE: forwarder
  7713. COMMAND: lt_clear
  7715. USAGE: lt_clear
  7717. DESCRIPTION:
  7718. Clears out the learning table, removing all MAC->HalIf associations.
  7720. EXAMPLES:
  7721. lt_clear --
  7723. ------------------------------------------------------------------------------
  7725. TABLE: forwarder
  7727. COMMAND: lt_delete
  7729. USAGE: lt_delete [mac_addr] [index]
  7731. DESCRIPTION:
  7732. Deletes the association between the specified MAC address and its HalIf.
  7734. EXAMPLES:
  7735. lt_delete 00:10:18:00:10:36 -- Removes the MAC address from the table.
  7736. lt_delete 3 -- Removes the 3rd entry from the learning
  7737. table.
  7739. ------------------------------------------------------------------------------
  7741. TABLE: forwarder
  7743. COMMAND: lt_max_entries
  7745. USAGE: lt_max_entries [max_entries]
  7747. DESCRIPTION:
  7748. Gets or sets the maximum number of learning table entries that will be
  7749. allowed. If this is 0, then the number of entries is limited only by memory.
  7750. Note that the IP stack occupies one entry, so if you want to allow 2 CPE
  7751. devices, then you must specify a value of 3. Also note that no entries will
  7752. be removed, even if you specify a value that is smaller than the number of
  7753. entries that currently exist in the learning table.
  7755. EXAMPLES:
  7756. lt_max_entries -- Shows the number of learning table entries.
  7757. lt_max_entries 8 -- Sets the number of learning table entries to 8.
  7759. ------------------------------------------------------------------------------
  7761. TABLE: forwarder
  7763. COMMAND: lt_show
  7765. USAGE: lt_show
  7767. DESCRIPTION:
  7768. Displays the contents of the learning table.
  7770. EXAMPLES:
  7771. lt_show --
  7773. ------------------------------------------------------------------------------
  7775. TABLE: forwarder
  7777. COMMAND: mac_filter_logging
  7779. USAGE: mac_filter_logging [-s] [-d] [-b] [-c] [MacAddress]
  7781. DESCRIPTION:
  7782. mac_filter_logging -s 00:11:22:33:44:55 - sets a filter for a source mac
  7783. addr.
  7784. mac_filter_logging -d 00:11:22:33:44:55 - sets a filter for a destination mac
  7785. addr.
  7786. mac_filter_logging -b 00:11:22:33:44:55 - sets a filter for both the src and
  7787. dest mac addr.
  7788. mac_filter_logging -c - clears all mac filters.
  7791. EXAMPLES:
  7792. mac_filter_logging -<flag> <mac address> --
  7794. ------------------------------------------------------------------------------
  7796. TABLE: forwarder
  7798. COMMAND: port_filter_logging
  7800. USAGE: port_filter_logging [-s] [-d] [-b] [-c] [port_number]
  7802. DESCRIPTION:
  7803. port_filter_logging -s 67 - sets a filter for a source tcp/udp port.
  7804. port_filter_logging -d 68 - sets a filter for a destination tcp/udp port.
  7805. port_filter_logging -b 68 - sets a filter for both the src and dest tcp/udp
  7806. port.
  7807. port_filter_logging -c - clears all port filters.
  7810. EXAMPLES:
  7811. port_filter_logging -<flag> <port number> --
  7813. ------------------------------------------------------------------------------
  7815. TABLE: forwarder
  7817. COMMAND: proto_filter_logging
  7819. USAGE: proto_filter_logging [bitmask{0x6fffff}]
  7821. DESCRIPTION:
  7822. No Adv. Filters 0x0000000
  7823. Mulitcast 0x0000001
  7824. Broadcast 0x0000002
  7825. Unicast 0x0000004
  7826. Icmp 0x0000008
  7827. Arp 0x0000010
  7828. Ip 0x0000020
  7829. Udp 0x0000040
  7830. Tcp 0x0000080
  7831. Igmp 0x0000100
  7832. MacFilters 0x0000200
  7833. IpAddressFilters 0x0000400
  7834. PortFilters 0x0000800
  7837. EXAMPLES:
  7838. proto_filter_logging 0x18 -- turns on Arp and Icmp logging
  7841. ------------------------------------------------------------------------------
  7843. TABLE: forwarder
  7845. COMMAND: show
  7847. USAGE: show
  7849. DESCRIPTION:
  7850. Displays a frame's path through fowarder with snoop details.
  7852. EXAMPLES:
  7853. show --
  7855. ------------------------------------------------------------------------------
  7857. TABLE: ftpLite
  7859. COMMAND: clear_counters
  7861. USAGE: clear_counters
  7863. DESCRIPTION:
  7864. Clear the FTP counters from the FTP transfer.
  7866. EXAMPLES:
  7867. clear_counters --
  7869. ------------------------------------------------------------------------------
  7871. TABLE: ftpLite
  7873. COMMAND: counters
  7875. USAGE: counters
  7877. DESCRIPTION:
  7878. Displays the FTP counters summary from the FTP transfer.
  7880. EXAMPLES:
  7881. counters --
  7883. ------------------------------------------------------------------------------
  7885. TABLE: ftpLite
  7887. COMMAND: ftp
  7889. USAGE: ftp
  7891. DESCRIPTION:
  7892. Begins FTP to the specified IP address, using the current settings.
  7894. EXAMPLES:
  7895. ftp -- Initiates FTP until a key is pressed.
  7898. ------------------------------------------------------------------------------
  7900. TABLE: ftpLite
  7902. COMMAND: show_settings
  7904. USAGE: show_settings
  7906. DESCRIPTION:
  7907. Displays the current FTP Lite settings.
  7909. EXAMPLES:
  7910. show_settings --
  7912. ------------------------------------------------------------------------------
  7914. TABLE: ip_hal
  7916. COMMAND: advertise
  7918. USAGE: advertise
  7920. DESCRIPTION:
  7921. Print bound IP addresses for this net iface to the console.
  7923. EXAMPLES:
  7924. ip_addr_show --
  7926. ------------------------------------------------------------------------------
  7928. TABLE: ip_hal
  7930. COMMAND: bootloader
  7932. USAGE: bootloader [-f] IpAddress Filename{255}
  7934. DESCRIPTION:
  7935. Downloads the specified bootloader image from the TFTP server and stores it
  7936. to the bootloader region. The image must be valid for the platform, and must
  7937. have a ProgramStore header (but no compression).
  7939. EXAMPLES:
  7940. bootloader 11.24.4.3 bootloader3360_2_1_2_c0.bin -- Upgrades the
  7941. bootloader.
  7942. bootloader -f 11.24.4.3 bootloader3360_2_1_2_c0.bin -- Accepts a bootloader
  7943. with non-matching s
  7944. ignature.
  7946. ------------------------------------------------------------------------------
  7948. TABLE: ip_hal
  7950. COMMAND: clientif_debug
  7952. USAGE: clientif_debug StackNumber{1..4294967295} Enable
  7954. DESCRIPTION:
  7955. Turns on debugging for the specified DHCP ClientIf object. This will show
  7956. information related to processing leases, packet generation, packet
  7957. processing, and timeouts.
  7959. EXAMPLES:
  7960. clientif_debug 1 true -- Turns on debugging for the DHCP ClientIf object for
  7961. stack 1.
  7963. ------------------------------------------------------------------------------
  7965. TABLE: ip_hal
  7967. COMMAND: dhcpc_debug
  7969. USAGE: dhcpc_debug Enable
  7971. DESCRIPTION:
  7972. Turns on debugging for the DHCP client thread. This will show information
  7973. about timeouts and packets received from the network (but not the contents of
  7974. the packets).
  7976. EXAMPLES:
  7977. dhcpc_debug true -- Turns on debugging for the DHCP client thread.
  7979. ------------------------------------------------------------------------------
  7981. TABLE: ip_hal
  7983. COMMAND: dhcpc_show
  7985. USAGE: dhcpc_show StackNumber{1..4294967295}
  7987. DESCRIPTION:
  7988. Shows the state of the DHCP ClientIf objects. You must specify the stack
  7989. number of the ClientIf object.
  7991. EXAMPLES:
  7992. dhcpc_show 1 -- Shows the state of the DHCP ClientIf for stack 1.
  7994. ------------------------------------------------------------------------------
  7996. TABLE: ip_hal
  7998. COMMAND: dhcpv6_debug
  8000. USAGE: dhcpv6_debug Enable
  8002. DESCRIPTION:
  8003. Turns on debugging for the specified DHCPv6 ClientIf object. This will show
  8004. information related to processing leases, packet generation, packet
  8005. processing, and timeouts.
  8007. EXAMPLES:
  8008. dhcpv6_debug (0) true -- Turns on debugging for the DHCPv6 ClientIf object
  8009. fo
  8010. r
  8011. st
  8012. ac
  8013. k
  8014. 1.
  8015. dh
  8016. cp
  8017. v6
  8018. _d
  8019. eb
  8020. ug
  8021. (2
  8022. )
  8023. fa
  8024. ls
  8025. e --
  8026. Tu
  8027. rn
  8028. s
  8029. of
  8030. f
  8031. de
  8032. bu
  8033. gg
  8034. in
  8035. g
  8036. fo
  8037. r
  8038. th
  8039. e
  8040. DH
  8041. CP
  8042. v6
  8043. Cl
  8044. ie
  8045. nt
  8046. If
  8047. ob
  8048. je
  8049. ct
  8050. fo
  8051. r
  8052. st
  8053. ac
  8054. k
  8055. 3.
  8057. ------------------------------------------------------------------------------
  8059. TABLE: ip_hal
  8061. COMMAND: discover
  8063. USAGE: discover [IpAddress]
  8065. DESCRIPTION:
  8066. Print bound IP addresses for this net iface to the console.
  8068. EXAMPLES:
  8069. ip_addr_show --
  8071. ------------------------------------------------------------------------------
  8073. TABLE: ip_hal
  8075. COMMAND: dload
  8077. USAGE: dload [-i Number] [-l] [-f] IpAddress Filename{255}
  8079. DESCRIPTION:
  8080. Downloads the specified s/w image from the TFTP server and stores it in the
  8081. image slot specified. The image must be valid for the platform, and must not
  8082. contain any security, encryption, or digital signatures. It must be a simple
  8083. image file with only the normal ProgramStore compression header. Parameters:
  8085. -i -- Specifies the image slot to store the image to.
  8086. -l -- Allows a large image to be stored, spanning images 1 and 2, if
  8087. allowed by the flash driver configuration.
  8088. -f -- Forces the given image to be accepted, as long as the CRCs are
  8089. valid.
  8091. Note that you must always specify the TFTP server address and filename;
  8092. unlike the dload command in the Docsis directory, this command doesn't make
  8093. use of any Docsis-specific nonvol settings, so it can't remember the last
  8094. values used.
  8096. EXAMPLES:
  8097. dload 11.24.4.3 vxram_sto.bin -- Stores the image to the default image
  8098. slot.
  8099. dload -i 1 11.24.4.3 vxram_sto.bin -- Store the image to slot 1.
  8101. ------------------------------------------------------------------------------
  8103. TABLE: ip_hal
  8105. COMMAND: hal_show
  8107. USAGE: hal_show
  8109. DESCRIPTION:
  8110. Causes the IP Stack HAL to display its internal state.
  8112. EXAMPLES:
  8113. hal_show --
  8115. ------------------------------------------------------------------------------
  8117. TABLE: ip_hal
  8119. COMMAND: ip_addr_show
  8121. USAGE: ip_addr_show
  8123. DESCRIPTION:
  8124. Print bound IP addresses for this net iface to the console.
  8126. EXAMPLES:
  8127. ip_addr_show --
  8129. ------------------------------------------------------------------------------
  8131. TABLE: ip_hal
  8133. COMMAND: ipconfig
  8135. USAGE: ipconfig [-l Number] StackNumber{1..4294967295} renew|release|static [IpAddress] [SubnetMask] [RouterIpAddr]
  8137. DESCRIPTION:
  8138. Configures the specified IP stack:
  8139. 'renew' starts DHCP (if not started) or renews the current lease.
  8140. 'release' causes the current lease to be released, shutting down the IP
  8141. stack.
  8142. 'static' configures the stack with the IP address/subnet mask/router
  8143. specified.
  8145. When using 'static', you must specify the IP address parameter. The subnet
  8146. and router are optional, but desirable.
  8148. EXAMPLES:
  8149. ipconfig 3 renew -- Starts DHCP on
  8150. stack 3, or renews t
  8151. he lease.
  8152. ipconfig 3 release -- Releases the IP
  8153. address on stack 3, s
  8154. huts down the s
  8155. tack.
  8156. ipconfig 3 static 11.24.70.5 -- Configures stack 3
  8157. with the address s
  8158. pecified, no router o
  8159. r subnet.
  8160. ipconfig 3 static 11.24.70.5 255.255.255.0 11.24.70.1 -- Sets stack 3 with
  8161. all parameters.
  8163. ------------------------------------------------------------------------------
  8165. TABLE: ip_hal
  8167. COMMAND: ipv6config
  8169. USAGE: ipv6config renew|release|static|remove_static|reconfigure|linklocal [IpAddress]
  8171. DESCRIPTION:
  8172. Configures the specified IPv6 stack:
  8173. 'renew' starts DHCP (if not started) or renews the current lease.
  8174. 'release' causes the current lease to be released, shutting down the IP
  8175. stack.
  8176. 'static' configures the stack with the IP address specified.
  8177. 'remove_static' removes a previously configured static IP address.
  8178. 'reconfigure' simulates the server sending a Reconfigure message to us.
  8180. When using 'static' or 'remove_static', you must specify the IP address
  8181. parameter.
  8183. EXAMPLES:
  8184. ipconfig static fe80::0123 -- Configures the stack with the address
  8185. specified.
  8187. ------------------------------------------------------------------------------
  8189. TABLE: ip_hal
  8191. COMMAND: kill_remote_dhcp_server
  8193. USAGE: kill_remote_dhcp_server
  8195. DESCRIPTION:
  8196. Sends a special packet to a remote DHCP server that is giving out bogus
  8197. leases (192.168.100.x). This feature was added in February 2004, and doesn't
  8198. work with older code.
  8200. EXAMPLES:
  8201. kill_remote_dhcp_server --
  8203. ------------------------------------------------------------------------------
  8205. TABLE: ip_hal
  8207. COMMAND: lease_show
  8209. USAGE: lease_show StackNumber{1..4294967295} [LeaseIndex]
  8211. DESCRIPTION:
  8212. Shows the state of the lease controlled by the DHCP ClientIf object. You
  8213. must specify the stack number of the ClientIf object, and the 0-based index
  8214. of the lease. The lease index is shown via dhcpc_show. If you want to show
  8215. all leases for the ClientIf, leave out the LeaseIndex parameter.
  8217. EXAMPLES:
  8218. lease_show 1 2 -- Shows the state of 3rd lease owned by the DHCP ClientIf
  8219. for stack 1.
  8220. lease_show 3 -- Shows all leases owned by the DHCP ClientIf for stack 3.
  8222. ------------------------------------------------------------------------------
  8224. TABLE: ip_hal
  8226. COMMAND: print_nd
  8228. USAGE: print_nd
  8230. DESCRIPTION:
  8231. Print bound IP addresses for this net iface to the console.
  8233. EXAMPLES:
  8234. ip_addr_show --
  8236. ------------------------------------------------------------------------------
  8238. TABLE: ip_hal
  8240. COMMAND: show
  8242. USAGE: show
  8244. DESCRIPTION:
  8245. Causes the HalIf object to display its state.
  8247. EXAMPLES:
  8248. show --
  8250. ------------------------------------------------------------------------------
  8252. TABLE: ip_hal
  8254. COMMAND: test
  8256. USAGE: test all|clientid|settings|lease|other
  8258. DESCRIPTION:
  8259. Runs tests on the specified component of the DHCP Client system.
  8261. EXAMPLES:
  8262. test settings -- Runs the test for DHCP Lease Settings.
  8263. test all -- Runs all tests.
  8265. ------------------------------------------------------------------------------
  8267. TABLE: msgLog
  8269. COMMAND: fields
  8271. USAGE: fields [Bitmask{0x7f}]
  8273. DESCRIPTION:
  8274. Displays or sets the different message fields that are enabled for display.
  8275. Message field bit definitions:
  8277. 0x01 -- The severity of the message (INFO, WARNING, ERROR, etc.)
  8278. 0x02 -- The instance name of the object that generated the message.
  8279. 0x04 -- The function/method in which the message was generated.
  8280. 0x08 -- The name of the module/class in which the message was
  8281. generated.
  8282. 0x10 -- The system timestamp (Time of Day).
  8283. 0x20 -- The thread Id.
  8284. 0x40 -- The system timestamp (millisecond, in hex).
  8286. EXAMPLES:
  8287. fields 0 -- Turns off all optional fields.
  8288. fields 0x7f -- Turns on all optional fields.
  8290. ------------------------------------------------------------------------------
  8292. TABLE: msgLog
  8294. COMMAND: severities
  8296. USAGE: severities [Bitmask]
  8298. DESCRIPTION:
  8299. Displays or sets the different message severity levels that are enabled for
  8300. display. Message logging bit definitions:
  8302. 0x00000001 -- Fatal Errors
  8303. 0x00000002 -- Errors
  8304. 0x00000004 -- Warnings
  8305. 0x00000008 -- Initialization
  8306. 0x00000010 -- Function entry/exit
  8307. 0x00000020 -- Informational
  8308. 0xffffffff -- All messages
  8310. EXAMPLES:
  8311. severities 0 -- Turns off all messages.
  8312. severities 0xffffffff -- Turns on all messages.
  8314. ------------------------------------------------------------------------------
  8316. TABLE: msgLog
  8318. COMMAND: show_settings
  8320. USAGE: show_settings
  8322. DESCRIPTION:
  8323. Displays the current Message Log Settings.
  8325. EXAMPLES:
  8326. show_settings --
  8328. ------------------------------------------------------------------------------
  8330. TABLE: msgLog/remoteAccess
  8332. COMMAND: read_default_settings
  8334. USAGE: read_default_settings telnet|ssh
  8336. DESCRIPTION:
  8337. Causes the Remote Access server to read and use the default settings from
  8338. nonvol. Any existing connections are not changed. This undoes any
  8339. configuration changes that were made at runtime (e.g. through a MIB, etc).
  8341. EXAMPLES:
  8342. read_default_settings telnet -- gets the Telnet server to restore default
  8343. settings from nonvol.
  8344. read_default_settings ssh -- gets the SSH server to restore default
  8345. settings from nonvol.
  8347. ------------------------------------------------------------------------------
  8349. TABLE: msgLog/remoteAccess
  8351. COMMAND: restart_server
  8353. USAGE: restart_server telnet|ssh
  8355. DESCRIPTION:
  8356. Stops, then starts the specified Remote Access server. Any existing
  8357. connections will be closed. This is the only way to get a Remote Access
  8358. server to start using new settings from a Remote Access connection (e.g.
  8359. change the Telnet settings from a Telnet connection).
  8361. EXAMPLES:
  8362. restart_server telnet -- Restarts the Telnet server.
  8363. restart_server telnet -- Restarts the Telnet server.
  8365. ------------------------------------------------------------------------------
  8367. TABLE: msgLog/remoteAccess
  8369. COMMAND: start_server
  8371. USAGE: start_server telnet|ssh
  8373. DESCRIPTION:
  8374. Starts the specified Remote Access server if not already running.
  8376. EXAMPLES:
  8377. start_server telnet -- Starts the Telnet server.
  8378. start_server ssh -- Starts the SSH server.
  8380. ------------------------------------------------------------------------------
  8382. TABLE: msgLog/remoteAccess
  8384. COMMAND: stop_server
  8386. USAGE: stop_server telnet|ssh
  8388. DESCRIPTION:
  8389. Stops the specified Remote Access server if it is running. Any existing
  8390. connections will be closed.
  8392. EXAMPLES:
  8393. stop_server telnet -- Stops the Telnet server.
  8394. stop_server ssh -- Stops the SSH server.
  8396. ------------------------------------------------------------------------------
  8398. TABLE: non-vol
  8400. COMMAND: clear_device
  8402. USAGE: clear_device [both|perm|dyn]
  8404. DESCRIPTION:
  8405. Tells the nonvol device to wipe out the specified settings section. All data
  8406. will be lost; the device should be restored to its 'virgin' state. For flash
  8407. devices, the flash block is erased; for disk devices, the file is erased.
  8409. EXAMPLES:
  8410. clear_device -- Clears both Permanent and Dynamic sections.
  8411. clear_device perm -- Clears only the Permanent section.
  8413. ------------------------------------------------------------------------------
  8415. TABLE: non-vol
  8417. COMMAND: defaults
  8419. USAGE: defaults [both|perm|dyn]
  8421. DESCRIPTION:
  8422. Restores the settings to default values. NOTE: This does not write to
  8423. NonVol memory! You must do this manually. Also note that some settings do
  8424. not have good defaults, particularly the Permanent section! Use this command
  8425. with extreme care!
  8427. EXAMPLES:
  8428. defaults -- Sets both Permanent and Dynamic sections to defaults.
  8429. defaults perm -- Sets only the Permanent section to defaults.
  8431. ------------------------------------------------------------------------------
  8433. TABLE: non-vol
  8435. COMMAND: del_extra_data
  8437. USAGE: del_extra_data [both|perm|dyn]
  8439. DESCRIPTION:
  8440. Gets rid of any extra data that is assiociated with the settings. The extra
  8441. data is usually caused by a downgrade, where settings written by a newer
  8442. version are not understood by the older version, but are stored so that they
  8443. will still exist when the new code is run. However, in some cases, it is
  8444. desirable to get rid of them if they are not going to be used.
  8446. EXAMPLES:
  8447. del_extra_data perm -- Gets rid of extra permanent data.
  8449. ------------------------------------------------------------------------------
  8451. TABLE: non-vol
  8453. COMMAND: flush
  8455. USAGE: flush
  8457. DESCRIPTION:
  8458. For Composite NonVol Settings objects (which contain 1 or more groups of
  8459. NonVol Settings), this command flushes out any unrecognized groups that were
  8460. read from the device. This is useful in cases where the settings group isn't
  8461. needed by another application, and would just waste space.
  8463. EXAMPLES:
  8464. flush --
  8466. ------------------------------------------------------------------------------
  8468. TABLE: non-vol
  8470. COMMAND: manufactured
  8472. USAGE: manufactured [both|perm|dyn]
  8474. DESCRIPTION:
  8475. Checks to see if the specified section is manufactured.
  8477. EXAMPLES:
  8478. manufactured -- Checks both Permanent and Dynamic sections
  8479. manufacturing state.
  8480. manufactured perm -- Checks only the Permanent section manufacturing state.
  8482. ------------------------------------------------------------------------------
  8484. TABLE: non-vol
  8486. COMMAND: read
  8488. USAGE: read [both|perm|dyn]
  8490. DESCRIPTION:
  8491. Reads the specified section of non-volatile settings from non-volatile
  8492. memory. If 'both' is specified or there are no parameters, then both
  8493. Permanent and Dynamic settings will be read. Otherwise, only the section
  8494. specified will be read. This will destroy any changes you have made if you
  8495. haven't written them!
  8497. EXAMPLES:
  8498. read -- Reads both Permanent and Dynamic sections of settings.
  8499. read perm -- Reads only the Permanent section of non-vol settings.
  8501. ------------------------------------------------------------------------------
  8503. TABLE: non-vol
  8505. COMMAND: show
  8507. USAGE: show
  8509. DESCRIPTION:
  8510. Displays the current non-volatile settings values for both the Permanent and
  8511. Dynamic sections.
  8513. EXAMPLES:
  8514. show --
  8516. ------------------------------------------------------------------------------
  8518. TABLE: non-vol
  8520. COMMAND: stats
  8522. USAGE: stats
  8524. DESCRIPTION:
  8525. Prints stats about buffer usage for Dynamic and Permanent settings.
  8527. EXAMPLES:
  8528. stats --
  8530. ------------------------------------------------------------------------------
  8532. TABLE: non-vol
  8534. COMMAND: tftp_read
  8536. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  8538. DESCRIPTION:
  8539. Causes the Permanent or Dynamic settings data to be read from a server via
  8540. TFTP. The file must be generated correctly, with all of the headers, CRC,
  8541. and other information that would exist on the NonVol device. The file will
  8542. be read and evaluated for correctness before it is stored in the device. If
  8543. the file is rejected then the settings will be read from the device to undo
  8544. any changes. Normally, this will operate on all settings groups; if you
  8545. specify -g then it will operate only on the current group (e.g. if you are in
  8546. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  8547. read).
  8549. EXAMPLES:
  8550. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  8551. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  8553. ------------------------------------------------------------------------------
  8555. TABLE: non-vol
  8557. COMMAND: tftp_write
  8559. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  8561. DESCRIPTION:
  8562. Causes the Permanent or Dynamic settings data to be written to a server via
  8563. TFTP. Normally, this will operate on all settings groups; if you specify -g
  8564. then it will operate only on the current group (e.g. if you are in the SNMP
  8565. nonvol dir, then -g will cause only the SNMP settings group to be written).
  8567. EXAMPLES:
  8568. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  8569. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  8571. ------------------------------------------------------------------------------
  8573. TABLE: non-vol
  8575. COMMAND: write
  8577. USAGE: write [both|perm|dyn]
  8579. DESCRIPTION:
  8580. Writes the specified section of non-volatile settings to non-volatile memory.
  8581. If 'both' is specified or there are no parameters, then both Permanent and
  8582. Dynamic settings will be written. Otherwise, only the section specified will
  8583. be written.
  8585. EXAMPLES:
  8586. write -- Writes both Permanent and Dynamic sections of settings.
  8587. write perm -- Writes only the Permanent section of non-vol settings.
  8589. ------------------------------------------------------------------------------
  8591. TABLE: non-vol/802.11
  8593. COMMAND: a_channel_number
  8595. USAGE: a_channel_number [Number{36..64}]
  8597. DESCRIPTION:
  8598. Sets the default 80211a channel number. The channel number must be a
  8599. multiple of 4 (e.g., 36, 40, 44, 48, 52, 56, 60, or 64)
  8601. EXAMPLES:
  8602. a_channel_number -- Shows the 80211a channel number.
  8603. a_channel 36 -- Sets the 80211a channel number to 36
  8605. ------------------------------------------------------------------------------
  8607. TABLE: non-vol/802.11
  8609. COMMAND: a_mrate
  8611. USAGE: a_mrate [Float{0..54}]
  8613. DESCRIPTION:
  8614. Force a fixed multicast rate for the 5 Ghz Band. Valid values: 0, 6, 9, 12,
  8615. 18, 24, 36, 48, 54
  8617. EXAMPLES:
  8618. a_mrate -- Shows the 5 ghz band multicast rate.
  8619. a_mrate 0 -- Sets the 5 hgz multicast rate to Auto
  8621. ------------------------------------------------------------------------------
  8623. TABLE: non-vol/802.11
  8625. COMMAND: afterburner
  8627. USAGE: afterburner [disabled|enabled]
  8629. DESCRIPTION:
  8630. enables/disabled afterburner
  8632. EXAMPLES:
  8633. afterburner -- Shows the current setting.
  8634. afterburner enabled -- Enables afterburner
  8636. ------------------------------------------------------------------------------
  8638. TABLE: non-vol/802.11
  8640. COMMAND: authentication
  8642. USAGE: authentication [Number{1..3}]
  8644. DESCRIPTION:
  8645. Sets the authentication mode (DECPRECATED) (1 = open system, 2 = shared key,
  8646. 3 = both).
  8648. EXAMPLES:
  8649. authentication -- Shows the authentication mode.
  8650. authentication_mode 2 -- Selects shared-key authentication
  8652. ------------------------------------------------------------------------------
  8654. TABLE: non-vol/802.11
  8656. COMMAND: b_channel_number
  8658. USAGE: b_channel_number [Number{0..14}]
  8660. DESCRIPTION:
  8661. Sets the default 80211b/g channel number (0=Auto).
  8663. EXAMPLES:
  8664. b_channel_number -- Shows the 80211b/g channel number.
  8665. b_channel 1 -- Sets the 80211b/g channel number to 1
  8667. ------------------------------------------------------------------------------
  8669. TABLE: non-vol/802.11
  8671. COMMAND: basic_rates
  8673. USAGE: basic_rates [default|all]
  8675. DESCRIPTION:
  8676. sets the Basic rates available
  8678. EXAMPLES:
  8679. basic_rates default -- Sets basic rates the driver default
  8680. basic_rates all -- Sets all rates as basic rates
  8682. ------------------------------------------------------------------------------
  8684. TABLE: non-vol/802.11
  8686. COMMAND: beacon_interval
  8688. USAGE: beacon_interval [Number{0..65535}]
  8690. DESCRIPTION:
  8691. Sets the beacon interval (0-65535 ms).
  8693. EXAMPLES:
  8694. beacon_interval -- Shows the beacon interval.
  8695. beacon_interval 200 -- Sets the beacon interval to 200 ms
  8697. ------------------------------------------------------------------------------
  8699. TABLE: non-vol/802.11
  8701. COMMAND: bg_mrate
  8703. USAGE: bg_mrate [Float{0..54}]
  8705. DESCRIPTION:
  8706. Force a fixed multicast rate for the 2.4 Ghz Band. Valid values: 0, 1, 2,
  8707. 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54
  8709. EXAMPLES:
  8710. bg_mrate -- Shows the 2.4 ghz band multicast rate.
  8711. bg_mrate 0 -- Sets the 2.4 ghz multicast rate to Auto
  8713. ------------------------------------------------------------------------------
  8715. TABLE: non-vol/802.11
  8717. COMMAND: clear_device
  8719. USAGE: clear_device [both|perm|dyn]
  8721. DESCRIPTION:
  8722. Tells the nonvol device to wipe out the specified settings section. All data
  8723. will be lost; the device should be restored to its 'virgin' state. For flash
  8724. devices, the flash block is erased; for disk devices, the file is erased.
  8726. EXAMPLES:
  8727. clear_device -- Clears both Permanent and Dynamic sections.
  8728. clear_device perm -- Clears only the Permanent section.
  8730. ------------------------------------------------------------------------------
  8732. TABLE: non-vol/802.11
  8734. COMMAND: closed_network
  8736. USAGE: closed_network [Number{0..1}]
  8738. DESCRIPTION:
  8739. Determines whether SSID is broadcast in beacon packets (0) or not (1)
  8741. EXAMPLES:
  8742. closed_network -- Shows the current setting.
  8743. closed_network 1 -- Specified SSID should NOT be broadcast in beacon packets
  8745. ------------------------------------------------------------------------------
  8747. TABLE: non-vol/802.11
  8749. COMMAND: country
  8751. USAGE: country [Worldwide|Thailand|Israel|Jordan|China|Japan|USA|Europe|All] [perm|dyn]
  8753. DESCRIPTION:
  8754. Controls the country, which determines available channels. See
  8755. CM\802.11_hal\wl "country list" for abbreviations.
  8757. EXAMPLES:
  8758. country USA -- Set country to USA, default location.
  8759. country USA perm -- Set country to USA, permanent location.
  8760. country USA dyn -- Set country to USA, dynamic location.
  8763. ------------------------------------------------------------------------------
  8765. TABLE: non-vol/802.11
  8767. COMMAND: default_key
  8769. USAGE: default_key [Number{1..4}]
  8771. DESCRIPTION:
  8772. Sets the default key (1-4).
  8774. EXAMPLES:
  8775. default_key -- Shows the default key.
  8776. default_key 2 -- Sets the default key to key 2
  8778. ------------------------------------------------------------------------------
  8780. TABLE: non-vol/802.11
  8782. COMMAND: defaults
  8784. USAGE: defaults [both|perm|dyn]
  8786. DESCRIPTION:
  8787. Restores the settings to default values. NOTE: This does not write to
  8788. NonVol memory! You must do this manually. Also note that some settings do
  8789. not have good defaults, particularly the Permanent section! Use this command
  8790. with extreme care!
  8792. EXAMPLES:
  8793. defaults -- Sets both Permanent and Dynamic sections to defaults.
  8794. defaults perm -- Sets only the Permanent section to defaults.
  8796. ------------------------------------------------------------------------------
  8798. TABLE: non-vol/802.11
  8800. COMMAND: del_extra_data
  8802. USAGE: del_extra_data [both|perm|dyn]
  8804. DESCRIPTION:
  8805. Gets rid of any extra data that is assiociated with the settings. The extra
  8806. data is usually caused by a downgrade, where settings written by a newer
  8807. version are not understood by the older version, but are stored so that they
  8808. will still exist when the new code is run. However, in some cases, it is
  8809. desirable to get rid of them if they are not going to be used.
  8811. EXAMPLES:
  8812. del_extra_data perm -- Gets rid of extra permanent data.
  8814. ------------------------------------------------------------------------------
  8816. TABLE: non-vol/802.11
  8818. COMMAND: dtim_interval
  8820. USAGE: dtim_interval [Number{1..255}]
  8822. DESCRIPTION:
  8823. Sets the DTIM interval (1-255).
  8825. EXAMPLES:
  8826. dtim_interval -- Shows the dtim interval.
  8827. dtim_interval 3 -- Sets the DTIM interval to 3 beacon intervals
  8829. ------------------------------------------------------------------------------
  8831. TABLE: non-vol/802.11
  8833. COMMAND: enable
  8835. USAGE: enable [Number{0..1}]
  8837. DESCRIPTION:
  8838. Enables/disables the 802.11 interface
  8840. EXAMPLES:
  8841. enable -- Shows the current setting.
  8842. enable 1 -- Enables the 802.11 interface
  8844. ------------------------------------------------------------------------------
  8846. TABLE: non-vol/802.11
  8848. COMMAND: enc_mode
  8850. USAGE: enc_mode [Number{0..11}]
  8852. DESCRIPTION:
  8853. Sets the encryption mode:
  8854. 0 = off 5 = TKIP+AES 10 = AES+WEP128
  8855. 1 = WEP64 6 = TKIP+WEP64 11 = TKIP+AES+WEP128
  8856. 2 = WEP128 7 = AES+WEP64
  8857. 3 = TKIP 8 = TKIP+AES+WEP64
  8858. 4 = AES 9 = TKIP+WEP128
  8860. EXAMPLES:
  8861. enc_mode -- Shows the encryption_mode.
  8862. enc_mode 2 -- Selects WEP 128-bit encryption
  8864. ------------------------------------------------------------------------------
  8866. TABLE: non-vol/802.11
  8868. COMMAND: flush {disabled}
  8870. USAGE: flush
  8872. DESCRIPTION:
  8873. For Composite NonVol Settings objects (which contain 1 or more groups of
  8874. NonVol Settings), this command flushes out any unrecognized groups that were
  8875. read from the device. This is useful in cases where the settings group isn't
  8876. needed by another application, and would just waste space.
  8878. EXAMPLES:
  8879. flush --
  8881. ------------------------------------------------------------------------------
  8883. TABLE: non-vol/802.11
  8885. COMMAND: frag_threshold
  8887. USAGE: frag_threshold [Number{256..2346}]
  8889. DESCRIPTION:
  8890. Sets the fragmentation threshold (256-2346 bytes).
  8892. EXAMPLES:
  8893. frag_threshold -- Shows the fragmentation threshold.
  8894. frag_threshold 2348 -- Sets the fragmentation threshold to 2348 bytes
  8896. ------------------------------------------------------------------------------
  8898. TABLE: non-vol/802.11
  8900. COMMAND: frame_burst
  8902. USAGE: frame_burst [disabled|enabled]
  8904. DESCRIPTION:
  8905. enables/disabled frame bursting
  8907. EXAMPLES:
  8908. frame_burst -- Shows the current setting.
  8909. frame_burst enabled -- Enables frame bursting
  8911. ------------------------------------------------------------------------------
  8913. TABLE: non-vol/802.11
  8915. COMMAND: gmode
  8917. USAGE: gmode [Number{0..5}]
  8919. DESCRIPTION:
  8920. Sets the mode of the 54g interface:
  8921. 1 = auto
  8922. 2 = only
  8923. 4 = performance
  8924. 5 = LRS
  8925. 0 = 11b
  8927. EXAMPLES:
  8928. gmode -- Shows the current 54g mode.
  8929. gmode 1 -- Sets 54g mode to auto
  8931. ------------------------------------------------------------------------------
  8933. TABLE: non-vol/802.11
  8935. COMMAND: gprotection
  8937. USAGE: gprotection [off|auto]
  8939. DESCRIPTION:
  8940. Sets 54g Protection mode
  8942. EXAMPLES:
  8943. gprotection -- Shows the current setting.
  8944. gprotection auto -- Sets gprotection mode to auto
  8946. ------------------------------------------------------------------------------
  8948. TABLE: non-vol/802.11
  8950. COMMAND: key_128bit
  8952. USAGE: key_128bit [Number{1..4}] [Key Value{26}]
  8954. DESCRIPTION:
  8955. Sets/Queries the 128-Bit Key.
  8957. EXAMPLES:
  8958. key_128bit 1 -- Shows 128-Bit Key1.
  8959. key_128bit 1 0102030405060708090a0b0c0d -- Sets key 1 to
  8960. 0102030405060708090a0b0c0d
  8962. ------------------------------------------------------------------------------
  8964. TABLE: non-vol/802.11
  8966. COMMAND: key_40bit
  8968. USAGE: key_40bit [Number{1..4}] [Key Value{10}]
  8970. DESCRIPTION:
  8971. Sets/Queries the 40-Bit Keys.
  8973. EXAMPLES:
  8974. key_40bit 1 -- Shows key 1.
  8975. key_40bit 2 0a0b0c0d0e -- Sets key 2 to 0a0b0c0d0e
  8977. ------------------------------------------------------------------------------
  8979. TABLE: non-vol/802.11
  8981. COMMAND: long_retry_limit
  8983. USAGE: long_retry_limit [Number{1..255}]
  8985. DESCRIPTION:
  8986. Sets the long retry limit
  8988. EXAMPLES:
  8989. long_retry_limit -- Shows the current setting.
  8990. long_retry_limit 4 -- Sets the long retry limit to 4.
  8992. ------------------------------------------------------------------------------
  8994. TABLE: non-vol/802.11
  8996. COMMAND: mac_restrict
  8998. USAGE: mac_restrict [Disabled|Allow|Deny]
  9000. DESCRIPTION:
  9001. Sets behavior of MAC table
  9003. EXAMPLES:
  9004. mac_restrict Disabled -- All stations can associate
  9005. mac_restrict Allow -- Only stations in the MAC table may associate
  9006. mac_restrict Deny -- Stations in the MAC table are prohibited
  9009. ------------------------------------------------------------------------------
  9011. TABLE: non-vol/802.11
  9013. COMMAND: mac_table
  9015. USAGE: mac_table StationNum{1..32} [MacAddress]
  9017. DESCRIPTION:
  9018. Shows or sets the MAC address associated with the specified MAC table index.
  9019. You must reboot for this to take effect!
  9021. EXAMPLES:
  9022. mac_table 2 -- Shows the MAC addr for MAC table index 2.
  9023. mac_table 1 00:10:18:50:10:32 -- Sets the MAC addr for MAC table index 1.
  9025. ------------------------------------------------------------------------------
  9027. TABLE: non-vol/802.11
  9029. COMMAND: manufactured
  9031. USAGE: manufactured [both|perm|dyn]
  9033. DESCRIPTION:
  9034. Checks to see if the specified section is manufactured.
  9036. EXAMPLES:
  9037. manufactured -- Checks both Permanent and Dynamic sections
  9038. manufacturing state.
  9039. manufactured perm -- Checks only the Permanent section manufacturing state.
  9041. ------------------------------------------------------------------------------
  9043. TABLE: non-vol/802.11
  9045. COMMAND: n_band
  9047. USAGE: n_band [value{1..2}]
  9049. DESCRIPTION:
  9050. sets the band for 802.11N (2=2.5 GHz, 5=5 GHz)
  9052. EXAMPLES:
  9053. n_band -- Shows the current setting.
  9054. n_band 2 -- Sets the 802.11N band to 2.5 GHz.
  9056. ------------------------------------------------------------------------------
  9058. TABLE: non-vol/802.11
  9060. COMMAND: n_bandwidth
  9062. USAGE: n_bandwidth [value{10..40}]
  9064. DESCRIPTION:
  9065. sets the bandwidth for 802.11N (10, 20, or 40 MHz)
  9067. EXAMPLES:
  9068. n_bandwidth -- Shows the current setting.
  9069. n_bandwidth 40 -- Sets the 802.11N bandwidth to 40 MHz.
  9071. ------------------------------------------------------------------------------
  9073. TABLE: non-vol/802.11
  9075. COMMAND: n_control_channel
  9077. USAGE: n_control_channel [value{0..224}]
  9079. DESCRIPTION:
  9080. sets the control channel for 802.11N (0=auto, 1-224 channel no.)
  9082. EXAMPLES:
  9083. n_control_channel -- Shows the current setting.
  9084. n_control_channel 0 -- Sets the 802.11N control channel to auto.
  9086. ------------------------------------------------------------------------------
  9088. TABLE: non-vol/802.11
  9090. COMMAND: n_mode
  9092. USAGE: n_mode [off|auto]
  9094. DESCRIPTION:
  9095. sets n mode
  9097. EXAMPLES:
  9098. n_mode -- Shows the current setting.
  9099. n_mode auto -- Sets N mode to auto.
  9101. ------------------------------------------------------------------------------
  9103. TABLE: non-vol/802.11
  9105. COMMAND: n_phy_rate
  9107. USAGE: n_phy_rate [value{-2..32}]
  9109. DESCRIPTION:
  9110. sets the N phy rate (-2=legacy, -1=auto, 0-15, 32 = MCS index)
  9112. EXAMPLES:
  9113. n_phy_rate -- Shows the current setting.
  9114. n_phy_rate -1 -- Sets the N phy rate to auto.
  9116. ------------------------------------------------------------------------------
  9118. TABLE: non-vol/802.11
  9120. COMMAND: n_protection
  9122. USAGE: n_protection [off|auto]
  9124. DESCRIPTION:
  9125. sets n protection
  9127. EXAMPLES:
  9128. n_protection -- Shows the current setting.
  9129. n_protection auto -- Sets N protection to auto.
  9131. ------------------------------------------------------------------------------
  9133. TABLE: non-vol/802.11
  9135. COMMAND: n_sideband
  9137. USAGE: n_sideband [lower|none|upper{31}]
  9139. DESCRIPTION:
  9140. sets n sideband
  9142. EXAMPLES:
  9143. n_sideband -- Shows the current setting.
  9144. n_sideband upper -- Sets N sideband to upper.
  9146. ------------------------------------------------------------------------------
  9148. TABLE: non-vol/802.11
  9150. COMMAND: power_level
  9152. USAGE: power_level [Number{25..100}]
  9154. DESCRIPTION:
  9155. Sets the output power level
  9157. EXAMPLES:
  9158. power_level -- Shows the current setting.
  9159. power_level 25 -- Sets the output power leve to 25%.
  9161. ------------------------------------------------------------------------------
  9163. TABLE: non-vol/802.11
  9165. COMMAND: preamble_length
  9167. USAGE: preamble_length [short|long]
  9169. DESCRIPTION:
  9170. Controls the size of the preamble
  9172. EXAMPLES:
  9173. preamble_length short -- Use short preamble
  9174. preamble_length long -- Use long preamble
  9176. ------------------------------------------------------------------------------
  9178. TABLE: non-vol/802.11
  9180. COMMAND: primary_network
  9182. USAGE: primary_network [Disabled|Enabled]
  9184. DESCRIPTION:
  9185. enables/disables the Primary Wireless Network
  9187. EXAMPLES:
  9188. primary_network -- Shows the current setting.
  9189. primary_network enabled -- Enables the Primary Wireless network
  9191. ------------------------------------------------------------------------------
  9193. TABLE: non-vol/802.11
  9195. COMMAND: rad_key
  9197. USAGE: rad_key [key{255}]
  9199. DESCRIPTION:
  9200. Sets or displays the RADIUS Key.
  9201. It MUST be a 0 to 255 character ASCII string
  9203. EXAMPLES:
  9204. rad_key hello -- Sets the RADIUS Key to 'hello'.
  9205. rad_key -- Shows the current setting.
  9207. ------------------------------------------------------------------------------
  9209. TABLE: non-vol/802.11
  9211. COMMAND: rad_port
  9213. USAGE: rad_port [Number{0..65535}]
  9215. DESCRIPTION:
  9216. Sets RADIUS Server port
  9218. EXAMPLES:
  9219. rad_port -- Shows the current setting.
  9220. rad_port 1812 -- Sets the RADIUS server port to 1812
  9222. ------------------------------------------------------------------------------
  9224. TABLE: non-vol/802.11
  9226. COMMAND: rad_server
  9228. USAGE: rad_server [IpAddress]
  9230. DESCRIPTION:
  9231. Sets RADIUS server IP address
  9233. EXAMPLES:
  9234. rad_server -- Shows current setting.
  9235. rad_server 10.15.3.4 -- Sets RADIUS server IP address to 10.15.3.4.
  9237. ------------------------------------------------------------------------------
  9239. TABLE: non-vol/802.11
  9241. COMMAND: rate
  9243. USAGE: rate [Number{0..54000}]
  9245. DESCRIPTION:
  9246. Sets rate control
  9248. EXAMPLES:
  9249. rate -- Shows the current setting.
  9250. rate -- Sets the rate in Kbps (1,000 - 54,000, 0 = Auto)
  9252. ------------------------------------------------------------------------------
  9254. TABLE: non-vol/802.11
  9256. COMMAND: read
  9258. USAGE: read [both|perm|dyn]
  9260. DESCRIPTION:
  9261. Reads the specified section of non-volatile settings from non-volatile
  9262. memory. If 'both' is specified or there are no parameters, then both
  9263. Permanent and Dynamic settings will be read. Otherwise, only the section
  9264. specified will be read. This will destroy any changes you have made if you
  9265. haven't written them!
  9267. EXAMPLES:
  9268. read -- Reads both Permanent and Dynamic sections of settings.
  9269. read perm -- Reads only the Permanent section of non-vol settings.
  9271. ------------------------------------------------------------------------------
  9273. TABLE: non-vol/802.11
  9275. COMMAND: rts_threshold
  9277. USAGE: rts_threshold [Number{0..3000}]
  9279. DESCRIPTION:
  9280. Sets the RTS threshold (0-3000).
  9282. EXAMPLES:
  9283. rts_threshold -- Shows the RTS threshold.
  9284. rts_threshold 2348 -- Sets the RTS threshold to 2348 bytes
  9286. ------------------------------------------------------------------------------
  9288. TABLE: non-vol/802.11
  9290. COMMAND: shared_key_auth
  9292. USAGE: shared_key_auth [optional|required]
  9294. DESCRIPTION:
  9295. Controls the shared key authentication.
  9297. EXAMPLES:
  9298. shared_key_auth Optional -- Sets shared key authentication to optional
  9299. shared_key_auth -- Shows current setting
  9301. ------------------------------------------------------------------------------
  9303. TABLE: non-vol/802.11
  9305. COMMAND: short_retry_limit
  9307. USAGE: short_retry_limit [Number{1..255}]
  9309. DESCRIPTION:
  9310. Sets the short retry limit
  9312. EXAMPLES:
  9313. short_retry_limit -- Shows the current setting.
  9314. short_retry_limit 4 -- Sets the short retry limit to 4.
  9316. ------------------------------------------------------------------------------
  9318. TABLE: non-vol/802.11
  9320. COMMAND: show
  9322. USAGE: show
  9324. DESCRIPTION:
  9325. Displays the current non-volatile settings values for both the Permanent and
  9326. Dynamic sections.
  9328. EXAMPLES:
  9329. show --
  9331. ------------------------------------------------------------------------------
  9333. TABLE: non-vol/802.11
  9335. COMMAND: ssid
  9337. USAGE: ssid [SSID{32}]
  9339. DESCRIPTION:
  9340. Sets/Queries the Service Set Identifier.
  9342. EXAMPLES:
  9343. ssid -- Shows the SSID.
  9344. ssid Hello -- Sets the SSID to "Hello".
  9346. ------------------------------------------------------------------------------
  9348. TABLE: non-vol/802.11
  9350. COMMAND: stats
  9352. USAGE: stats
  9354. DESCRIPTION:
  9355. Prints stats about buffer usage for Dynamic and Permanent settings.
  9357. EXAMPLES:
  9358. stats --
  9360. ------------------------------------------------------------------------------
  9362. TABLE: non-vol/802.11
  9364. COMMAND: supported_rates
  9366. USAGE: supported_rates [min|default]
  9368. DESCRIPTION:
  9369. sets the supported rates (default or min)
  9371. EXAMPLES:
  9372. supported_rates min -- Sets supported rates to 1, 2 Mbps
  9373. supported_rates default -- Sets supported rates to 1, 2, 5.5, 11 Mbps
  9375. ------------------------------------------------------------------------------
  9377. TABLE: non-vol/802.11
  9379. COMMAND: tftp_read
  9381. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  9383. DESCRIPTION:
  9384. Causes the Permanent or Dynamic settings data to be read from a server via
  9385. TFTP. The file must be generated correctly, with all of the headers, CRC,
  9386. and other information that would exist on the NonVol device. The file will
  9387. be read and evaluated for correctness before it is stored in the device. If
  9388. the file is rejected then the settings will be read from the device to undo
  9389. any changes. Normally, this will operate on all settings groups; if you
  9390. specify -g then it will operate only on the current group (e.g. if you are in
  9391. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  9392. read).
  9394. EXAMPLES:
  9395. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  9396. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  9398. ------------------------------------------------------------------------------
  9400. TABLE: non-vol/802.11
  9402. COMMAND: tftp_write
  9404. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  9406. DESCRIPTION:
  9407. Causes the Permanent or Dynamic settings data to be written to a server via
  9408. TFTP. Normally, this will operate on all settings groups; if you specify -g
  9409. then it will operate only on the current group (e.g. if you are in the SNMP
  9410. nonvol dir, then -g will cause only the SNMP settings group to be written).
  9412. EXAMPLES:
  9413. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  9414. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  9416. ------------------------------------------------------------------------------
  9418. TABLE: non-vol/802.11
  9420. COMMAND: txpower_level
  9422. USAGE: txpower_level [Number{1..8}]
  9424. DESCRIPTION:
  9425. Sets the relative transmit power level (1-8)
  9427. EXAMPLES:
  9428. txpower_level -- Shows the current setting.
  9429. txpower_level 1 -- Sets ths relative power level to 1.
  9431. ------------------------------------------------------------------------------
  9433. TABLE: non-vol/802.11
  9435. COMMAND: vlan_mode
  9437. USAGE: vlan_mode [auto|off|on{31}]
  9439. DESCRIPTION:
  9440. Set WMM VLAN mode
  9442. EXAMPLES:
  9443. wmm -- Shows the current setting.
  9444. wmm on -- Enables VLAN mode
  9446. ------------------------------------------------------------------------------
  9448. TABLE: non-vol/802.11
  9450. COMMAND: wds
  9452. USAGE: wds [disabled|enabled]
  9454. DESCRIPTION:
  9455. enables/disabled WDS
  9457. EXAMPLES:
  9458. wds -- Shows the current setting.
  9459. wds enabled -- Enables WDS
  9461. ------------------------------------------------------------------------------
  9463. TABLE: non-vol/802.11
  9465. COMMAND: wds_list
  9467. USAGE: wds_list WdsNum{1..4} [MacAddress]
  9469. DESCRIPTION:
  9470. Shows or sets the MAC address associated with the specified WDS table index.
  9472. EXAMPLES:
  9473. wds_list 2 -- Shows the MAC addr for WDS table index 2.
  9474. wds_list 1 00:10:18:50:10:32 -- Sets the MAC addr for WDS table index 1.
  9476. ------------------------------------------------------------------------------
  9478. TABLE: non-vol/802.11
  9480. COMMAND: wmm_ac_ap
  9482. USAGE: wmm_ac_ap [be|bk|vi|vo{31}] [cwmin|cwmax|txop_g|txop_ag|adm_control|dof{31}] [value{0..6016}]
  9484. DESCRIPTION:
  9485. wmm_ac_ap [be|bk|vi|vo] [cwmin|cwmax|txop_g|txop_ag|adm_control|dof] value
  9487. EXAMPLES:
  9488. wmm_ac_ap -- Shows the current setting.
  9489. wmm_ac_ap be cwmin 15 -- Set CWmin value for the AP AC_BE
  9491. ------------------------------------------------------------------------------
  9493. TABLE: non-vol/802.11
  9495. COMMAND: wmm_ac_sta
  9497. USAGE: wmm_ac_sta [be|bk|vi|vo{31}] [cwmin|cwmax|txop_g|txop_ag{31}] [value{0..6016}]
  9499. DESCRIPTION:
  9500. wmm_ac_sta [be|bk|vi|vo] [cwmin|cwmax|txop_g|txop_ag] value
  9502. EXAMPLES:
  9503. wmm_ac_sta -- Shows the current setting.
  9504. wmm_ac_sta be cwmin 15 -- Set CWmin value for the STA AC_BE
  9506. ------------------------------------------------------------------------------
  9508. TABLE: non-vol/802.11
  9510. COMMAND: wmm_apsd
  9512. USAGE: wmm_apsd [off|on]
  9514. DESCRIPTION:
  9515. enables/disables WMM APSD support
  9517. EXAMPLES:
  9518. wmm_apsd -- Shows the current setting.
  9519. wmm_apsd on -- Enables WMM APSD support
  9521. ------------------------------------------------------------------------------
  9523. TABLE: non-vol/802.11
  9525. COMMAND: wmm_mode
  9527. USAGE: wmm_mode [off|on{31}]
  9529. DESCRIPTION:
  9530. Set WMM Mode
  9532. EXAMPLES:
  9533. wmm_mode -- Shows the current setting.
  9534. wmm_mode on -- Enables WMM support
  9536. ------------------------------------------------------------------------------
  9538. TABLE: non-vol/802.11
  9540. COMMAND: wmm_noack
  9542. USAGE: wmm_noack [off|on]
  9544. DESCRIPTION:
  9545. enables/disables WMM No-Acknowledgement
  9547. EXAMPLES:
  9548. wmm_noack -- Shows the current setting.
  9549. wmm_noack on -- Enables WMM No-Acknowledgement
  9551. ------------------------------------------------------------------------------
  9553. TABLE: non-vol/802.11
  9555. COMMAND: wpa2_preauth
  9557. USAGE: wpa2_preauth [disabled|enabled]
  9559. DESCRIPTION:
  9560. enables/disabled WPA2 Pre-authentication
  9562. EXAMPLES:
  9563. wpa2_preauth -- Shows the current setting.
  9564. wpa2_preauth enabled -- Enables WPA2 pre-authentication
  9566. ------------------------------------------------------------------------------
  9568. TABLE: non-vol/802.11
  9570. COMMAND: wpa_auth
  9572. USAGE: wpa_auth [Number{0..31}]
  9574. DESCRIPTION:
  9575. Sets WPA Authentication bitmask
  9576. 0x01 = 802.1x
  9577. 0x02 = WPA
  9578. 0x04 = WPA-PSK
  9579. 0x08 = WPA2
  9580. 0x10 = WPA2-PSK
  9582. EXAMPLES:
  9583. wpa_auth -- Shows the current setting.
  9584. wpa_auth 0x14 -- Enables WPA-PSK and WPA2-PSK.
  9586. ------------------------------------------------------------------------------
  9588. TABLE: non-vol/802.11
  9590. COMMAND: wpa_psk
  9592. USAGE: wpa_psk [key{64}]
  9594. DESCRIPTION:
  9595. Sets or displays the WPA Pre-Shared Key.
  9596. It MUST be either a 64-digit hexadecimal number,
  9597. OR a 8 to 63 character ASCII string
  9599. EXAMPLES:
  9600. wpa_psk thisismykey -- Sets the WPA Pre-Shared Key to
  9601. 'thisismykey'.
  9602. wpa_psk <64-digit hex number> -- Sets the WPA Pre-Shared Key to <number>.
  9604. ------------------------------------------------------------------------------
  9606. TABLE: non-vol/802.11
  9608. COMMAND: wpa_reauth
  9610. USAGE: wpa_reauth [Number{0..1048575}]
  9612. DESCRIPTION:
  9613. Sets WPA/WPA2 Reauth Interval
  9615. EXAMPLES:
  9616. wpa_reauth -- Shows the current setting.
  9617. wpa_reauth 1000 -- Sets the reauth interval to 1000
  9619. ------------------------------------------------------------------------------
  9621. TABLE: non-vol/802.11
  9623. COMMAND: wpa_rekey
  9625. USAGE: wpa_rekey [Number{0..1048575}]
  9627. DESCRIPTION:
  9628. Sets WPA Group Rekey Interval
  9630. EXAMPLES:
  9631. wpa_rekey -- Shows the current setting.
  9632. wpa_rekey 1000 -- Sets the rekey interval to 1000
  9634. ------------------------------------------------------------------------------
  9636. TABLE: non-vol/802.11
  9638. COMMAND: wps_addER
  9640. USAGE: wps_addER [disabled|enabled]
  9642. DESCRIPTION:
  9643. Disable/Enabled WPS Add External Registrar.
  9645. EXAMPLES:
  9646. wps_addER -- Shows the current setting.
  9647. wps_addER disabled -- Disabled WPS Add External Registrar.
  9649. ------------------------------------------------------------------------------
  9651. TABLE: non-vol/802.11
  9653. COMMAND: wps_board_num
  9655. USAGE: wps_board_num [WPS Board Num{32}]
  9657. DESCRIPTION:
  9658. Sets/Queries the WPS board num.
  9660. EXAMPLES:
  9661. wps_board_num -- Shows the WPS board num.
  9662. wps_board_num 0000001 -- Sets the WPS board num to "0000001".
  9664. ------------------------------------------------------------------------------
  9666. TABLE: non-vol/802.11
  9668. COMMAND: wps_button_mode
  9670. USAGE: wps_button_mode [ses|wps]
  9672. DESCRIPTION:
  9673. Select the button for SES or WPS mode.
  9675. EXAMPLES:
  9676. wps_button_mode -- Shows the current setting.
  9677. wps_button_mode wps -- Set the button to WPS mode.
  9679. ------------------------------------------------------------------------------
  9681. TABLE: non-vol/802.11
  9683. COMMAND: wps_config_state
  9685. USAGE: wps_config_state [unconfiged|configed]
  9687. DESCRIPTION:
  9688. Set WPS to unconfiged or configed.
  9690. EXAMPLES:
  9691. wps_config_state -- Shows the current setting.
  9692. wps_config_state configed -- Set the WPS config state to configed.
  9694. ------------------------------------------------------------------------------
  9696. TABLE: non-vol/802.11
  9698. COMMAND: wps_device_name
  9700. USAGE: wps_device_name [WPS Device Name{32}]
  9702. DESCRIPTION:
  9703. Sets/Queries the WPS device name.
  9705. EXAMPLES:
  9706. wps_device_name -- Shows the WPS device name.
  9707. wps_device_name BroadcomAP -- Sets the WPS device name to "BroadcomAP".
  9709. ------------------------------------------------------------------------------
  9711. TABLE: non-vol/802.11
  9713. COMMAND: wps_device_pin
  9715. USAGE: wps_device_pin [WPS Device Pin{8}]
  9717. DESCRIPTION:
  9718. Sets/Queries the WPS device pin.
  9720. EXAMPLES:
  9721. wps_device_pin -- Shows the WPS device pin.
  9722. wps_device_pin 12345670 -- Sets the WPS device pin to "12345670".
  9724. ------------------------------------------------------------------------------
  9726. TABLE: non-vol/802.11
  9728. COMMAND: wps_mfg_name
  9730. USAGE: wps_mfg_name [WPS Mfg Name{32}]
  9732. DESCRIPTION:
  9733. Sets/Queries the WPS mfg name.
  9735. EXAMPLES:
  9736. wps_mfg_name -- Shows the WPS mfg name.
  9737. wps_mfg_name Broadcom -- Sets the WPS mfg name to "Broadcom".
  9739. ------------------------------------------------------------------------------
  9741. TABLE: non-vol/802.11
  9743. COMMAND: wps_mode
  9745. USAGE: wps_mode [disabled|enabled]
  9747. DESCRIPTION:
  9748. enables/disabled WPS mode
  9750. EXAMPLES:
  9751. wps_mode -- Shows the current setting.
  9752. wps_mode enabled -- Enables WPS mode
  9754. ------------------------------------------------------------------------------
  9756. TABLE: non-vol/802.11
  9758. COMMAND: wps_model_name
  9760. USAGE: wps_model_name [WPS Model Name{32}]
  9762. DESCRIPTION:
  9763. Sets/Queries the WPS model name.
  9765. EXAMPLES:
  9766. wps_model_name -- Shows the WPS model name.
  9767. wps_model_name Broadcom -- Sets the WPS model name to "Broadcom".
  9769. ------------------------------------------------------------------------------
  9771. TABLE: non-vol/802.11
  9773. COMMAND: wps_model_num
  9775. USAGE: wps_model_num [WPS Model Num{32}]
  9777. DESCRIPTION:
  9778. Sets/Queries the WPS model num.
  9780. EXAMPLES:
  9781. wps_model_num -- Shows the WPS model num.
  9782. wps_model_num 123456 -- Sets the WPS model num to "123456".
  9784. ------------------------------------------------------------------------------
  9786. TABLE: non-vol/802.11
  9788. COMMAND: wps_reg
  9790. USAGE: wps_reg [external|internal]
  9792. DESCRIPTION:
  9793. Set WPS registrar to external or internal.
  9795. EXAMPLES:
  9796. wps_reg -- Shows the current setting.
  9797. wps_reg internal -- Set WPS registrar to internal.
  9799. ------------------------------------------------------------------------------
  9801. TABLE: non-vol/802.11
  9803. COMMAND: wps_sta_pin
  9805. USAGE: wps_sta_pin [WPS Sta Pin{8}]
  9807. DESCRIPTION:
  9808. Sets/Queries the WPS Sta pin.
  9810. EXAMPLES:
  9811. wps_sta_pin -- Shows the WPS Sta pin.
  9812. wps_sta_pin 94380507 -- Sets the WPS Sta pin to "94380507".
  9814. ------------------------------------------------------------------------------
  9816. TABLE: non-vol/802.11
  9818. COMMAND: wps_timeout
  9820. USAGE: wps_timeout [disabled|enabled]
  9822. DESCRIPTION:
  9823. Disable/Enabled WPS timeout.
  9825. EXAMPLES:
  9826. wps_timeout -- Shows the current setting.
  9827. wps_timeout disabled -- Disabled WPS timeout
  9829. ------------------------------------------------------------------------------
  9831. TABLE: non-vol/802.11
  9833. COMMAND: wps_uuid
  9835. USAGE: wps_uuid [WPS UUID{64}]
  9837. DESCRIPTION:
  9838. Sets/Queries the WPS UUID.
  9840. EXAMPLES:
  9841. wps_uuid -- Shows the WPS UUID.
  9842. wps_uuid 0x000102030405060708090A0B0C0D0EBB -- Sets the WPS UUID to
  9843. "0x000102030405060708090A0B0C0D
  9844. 0EBB".
  9846. ------------------------------------------------------------------------------
  9848. TABLE: non-vol/802.11
  9850. COMMAND: write
  9852. USAGE: write [both|perm|dyn]
  9854. DESCRIPTION:
  9855. Writes the specified section of non-volatile settings to non-volatile memory.
  9856. If 'both' is specified or there are no parameters, then both Permanent and
  9857. Dynamic settings will be written. Otherwise, only the section specified will
  9858. be written.
  9860. EXAMPLES:
  9861. write -- Writes both Permanent and Dynamic sections of settings.
  9862. write perm -- Writes only the Permanent section of non-vol settings.
  9864. ------------------------------------------------------------------------------
  9866. TABLE: non-vol/802.11/guest_network
  9868. COMMAND: clear_device
  9870. USAGE: clear_device [both|perm|dyn]
  9872. DESCRIPTION:
  9873. Tells the nonvol device to wipe out the specified settings section. All data
  9874. will be lost; the device should be restored to its 'virgin' state. For flash
  9875. devices, the flash block is erased; for disk devices, the file is erased.
  9877. EXAMPLES:
  9878. clear_device -- Clears both Permanent and Dynamic sections.
  9879. clear_device perm -- Clears only the Permanent section.
  9881. ------------------------------------------------------------------------------
  9883. TABLE: non-vol/802.11/guest_network
  9885. COMMAND: closed_network
  9887. USAGE: closed_network MBSS{1..3} [disabled|enabled]
  9889. DESCRIPTION:
  9890. enables/disables closed network (SSID not sent in beacons)
  9892. EXAMPLES:
  9893. closed_network 1 -- Shows the current setting for Guest network 1.
  9894. closed_network 1 enabled -- Enables the Guest network 1
  9896. ------------------------------------------------------------------------------
  9898. TABLE: non-vol/802.11/guest_network
  9900. COMMAND: default_key
  9902. USAGE: default_key MBSS{1..3} [Number{1..4}]
  9904. DESCRIPTION:
  9905. Sets the default key (1-4).
  9907. EXAMPLES:
  9908. default_key 1 -- Shows the default key of Guest network 1.
  9909. default_key 1 2 -- Sets the default key of Guest network 1 to key 2
  9911. ------------------------------------------------------------------------------
  9913. TABLE: non-vol/802.11/guest_network
  9915. COMMAND: defaults
  9917. USAGE: defaults [both|perm|dyn]
  9919. DESCRIPTION:
  9920. Restores the settings to default values. NOTE: This does not write to
  9921. NonVol memory! You must do this manually. Also note that some settings do
  9922. not have good defaults, particularly the Permanent section! Use this command
  9923. with extreme care!
  9925. EXAMPLES:
  9926. defaults -- Sets both Permanent and Dynamic sections to defaults.
  9927. defaults perm -- Sets only the Permanent section to defaults.
  9929. ------------------------------------------------------------------------------
  9931. TABLE: non-vol/802.11/guest_network
  9933. COMMAND: del_extra_data
  9935. USAGE: del_extra_data [both|perm|dyn]
  9937. DESCRIPTION:
  9938. Gets rid of any extra data that is assiociated with the settings. The extra
  9939. data is usually caused by a downgrade, where settings written by a newer
  9940. version are not understood by the older version, but are stored so that they
  9941. will still exist when the new code is run. However, in some cases, it is
  9942. desirable to get rid of them if they are not going to be used.
  9944. EXAMPLES:
  9945. del_extra_data perm -- Gets rid of extra permanent data.
  9947. ------------------------------------------------------------------------------
  9949. TABLE: non-vol/802.11/guest_network
  9951. COMMAND: dhcp_ip
  9953. USAGE: dhcp_ip MBSS{1..3} [IpAddress]
  9955. DESCRIPTION:
  9956. Sets Guest network DHCP server IP address
  9958. EXAMPLES:
  9959. dhcp_ip 1 -- Shows the current Guest network 1 setting.
  9960. dhcp_ip 1 10.15.3.4 -- Sets Guest network 1 DHCP server IP address to
  9961. 10.15.3.4.
  9963. ------------------------------------------------------------------------------
  9965. TABLE: non-vol/802.11/guest_network
  9967. COMMAND: dhcp_lease_time
  9969. USAGE: dhcp_lease_time MBSS{1..3} [Number{0..1048575}]
  9971. DESCRIPTION:
  9972. Sets the Guest network 1 DHCP lease time
  9974. EXAMPLES:
  9975. dhcp_lease_time 1 -- Shows the Guest network 1 current setting.
  9976. dhcp_lease_time 1 1000 -- Sets the Guest network 1 DHCP lease time to 1000
  9978. ------------------------------------------------------------------------------
  9980. TABLE: non-vol/802.11/guest_network
  9982. COMMAND: dhcp_pool_end
  9984. USAGE: dhcp_pool_end MBSS{1..3} [IpAddress]
  9986. DESCRIPTION:
  9987. Sets Guest network DHCP server lease pool end
  9989. EXAMPLES:
  9990. dhcp_pool_end 1 -- Shows the current Guest network 1 setting.
  9991. dhcp_pool_end 1 192.168.1.100 -- Sets Guest network 1 DHCP lease pool end to
  9992. 192.168.1.100.
  9994. ------------------------------------------------------------------------------
  9996. TABLE: non-vol/802.11/guest_network
  9998. COMMAND: dhcp_pool_start
  10000. USAGE: dhcp_pool_start MBSS{1..3} [IpAddress]
  10002. DESCRIPTION:
  10003. Sets Guest network DHCP server lease pool start
  10005. EXAMPLES:
  10006. dhcp_pool_start 1 -- Shows the Guest network 1 current setting.
  10007. dhcp_pool_start 1 192.168.1.10 -- Sets Guest network 1 DHCP lease pool start
  10008. to 192.168.1.10.
  10010. ------------------------------------------------------------------------------
  10012. TABLE: non-vol/802.11/guest_network
  10014. COMMAND: dhcp_server
  10016. USAGE: dhcp_server MBSS{1..3} [disabled|enabled]
  10018. DESCRIPTION:
  10019. enables/disabled DHCP server on the Guest network
  10021. EXAMPLES:
  10022. dhcpserver 1 -- Shows the current setting.
  10023. dhcpserver 1 enabled -- Enables Guest network DHCP server
  10025. ------------------------------------------------------------------------------
  10027. TABLE: non-vol/802.11/guest_network
  10029. COMMAND: dhcp_subnet_mask
  10031. USAGE: dhcp_subnet_mask MBSS{1..3} [IpAddress]
  10033. DESCRIPTION:
  10034. Sets Guest network DHCP server IP subnet mask
  10036. EXAMPLES:
  10037. dhcp_subnet_mask 1 -- Shows the current Guest network 1
  10038. setting.
  10039. dhcp_subnet_mask 1 255.255.255.0 -- Sets Guest network 1 DHCP server subnet
  10040. mask to 255.255.255.0.
  10042. ------------------------------------------------------------------------------
  10044. TABLE: non-vol/802.11/guest_network
  10046. COMMAND: enc_mode
  10048. USAGE: enc_mode MBSS{1..3} [Number{0..11}]
  10050. DESCRIPTION:
  10051. Sets the encryption mode:
  10052. 0 = off 5 = TKIP+AES 10 = AES+WEP128
  10053. 1 = WEP64 6 = TKIP+WEP64 11 = TKIP+AES+WEP128
  10054. 2 = WEP128 7 = AES+WEP64
  10055. 3 = TKIP 8 = TKIP+AES+WEP64
  10056. 4 = AES 9 = TKIP+WEP128
  10058. EXAMPLES:
  10059. enc_mode 1 -- Shows the encryption_mode for Guest network 1.
  10060. enc_mode 1 2 -- Selects WEP 128-bit encryption for Guest network 1
  10062. ------------------------------------------------------------------------------
  10064. TABLE: non-vol/802.11/guest_network
  10066. COMMAND: flush {disabled}
  10068. USAGE: flush
  10070. DESCRIPTION:
  10071. For Composite NonVol Settings objects (which contain 1 or more groups of
  10072. NonVol Settings), this command flushes out any unrecognized groups that were
  10073. read from the device. This is useful in cases where the settings group isn't
  10074. needed by another application, and would just waste space.
  10076. EXAMPLES:
  10077. flush --
  10079. ------------------------------------------------------------------------------
  10081. TABLE: non-vol/802.11/guest_network
  10083. COMMAND: guest_network
  10085. USAGE: guest_network MBSS{1..3} [disabled|enabled]
  10087. DESCRIPTION:
  10088. enables/disabled Guest network
  10090. EXAMPLES:
  10091. guest_network 1 -- Shows the current setting for Guest network 1.
  10092. guest_network 1 enabled -- Enables the Guest network 1
  10094. ------------------------------------------------------------------------------
  10096. TABLE: non-vol/802.11/guest_network
  10098. COMMAND: key_128bit
  10100. USAGE: key_128bit MBSS{1..3} [Number{1..4}] [Key Value{26}]
  10102. DESCRIPTION:
  10103. Sets/Queries the 128-Bit Key.
  10105. EXAMPLES:
  10106. key_128bit 1 1 -- Shows 128-Bit Key 1 of Guest
  10107. network 1.
  10108. key_128bit 1 2 0102030405060708090a0b0c0d -- Sets key 2 of Guest nework 1 to
  10109. 0102030405060708090a0b0c0d
  10111. ------------------------------------------------------------------------------
  10113. TABLE: non-vol/802.11/guest_network
  10115. COMMAND: key_40bit
  10117. USAGE: key_40bit MBSS{1..3} [Number{1..4}] [Key Value{10}]
  10119. DESCRIPTION:
  10120. Sets/Queries the 40-Bit Keys.
  10122. EXAMPLES:
  10123. key_40bit 1 1 -- Shows key 1 of Guest network 1.
  10124. key_40bit 1 2 0a0b0c0d0e -- Sets key 2 of Guest network 1 to 0a0b0c0d0e
  10126. ------------------------------------------------------------------------------
  10128. TABLE: non-vol/802.11/guest_network
  10130. COMMAND: manufactured
  10132. USAGE: manufactured [both|perm|dyn]
  10134. DESCRIPTION:
  10135. Checks to see if the specified section is manufactured.
  10137. EXAMPLES:
  10138. manufactured -- Checks both Permanent and Dynamic sections
  10139. manufacturing state.
  10140. manufactured perm -- Checks only the Permanent section manufacturing state.
  10142. ------------------------------------------------------------------------------
  10144. TABLE: non-vol/802.11/guest_network
  10146. COMMAND: network_bridge
  10148. USAGE: network_bridge MBSS{1..3} [Number{1..3}]
  10150. DESCRIPTION:
  10151. Assign the network bridge to which Guest LAN network
  10153. EXAMPLES:
  10154. network_bridge 1 -- Shows the Guest network 1 current setting.
  10155. network 1 2 -- Sets the Guest network 1 bridge to Guest LAN #2
  10157. ------------------------------------------------------------------------------
  10159. TABLE: non-vol/802.11/guest_network
  10161. COMMAND: rad_key
  10163. USAGE: rad_key MBSS{1..3} [key{255}]
  10165. DESCRIPTION:
  10166. Sets or displays the RADIUS Key.
  10167. It MUST be a 0 to 255 character ASCII string
  10169. EXAMPLES:
  10170. rad_key 1 hello -- Sets the RADIUS Key of Guest network 1 to 'hello'.
  10171. rad_key 1 -- Shows the current Guest network 1 RADIUS Key.
  10173. ------------------------------------------------------------------------------
  10175. TABLE: non-vol/802.11/guest_network
  10177. COMMAND: rad_port
  10179. USAGE: rad_port MBSS{1..3} [Number{0..65535}]
  10181. DESCRIPTION:
  10182. Sets RADIUS Server port
  10184. EXAMPLES:
  10185. rad_port 1 -- Shows the current RADIUS server port of Guest network 1.
  10186. rad_port 1 1812 -- Sets the RADIUS server port of Guest network to 1812
  10188. ------------------------------------------------------------------------------
  10190. TABLE: non-vol/802.11/guest_network
  10192. COMMAND: rad_server
  10194. USAGE: rad_server MBSS{1..3} [IpAddress]
  10196. DESCRIPTION:
  10197. Sets RADIUS server IP address
  10199. EXAMPLES:
  10200. rad_server 1 -- Shows current RADIUS server IP address of Guest
  10201. network 1.
  10202. rad_server 1 10.15.3.4 -- Sets RADIUS server IP address of Guest network 1
  10203. to 10.15.3.4.
  10205. ------------------------------------------------------------------------------
  10207. TABLE: non-vol/802.11/guest_network
  10209. COMMAND: read
  10211. USAGE: read [both|perm|dyn]
  10213. DESCRIPTION:
  10214. Reads the specified section of non-volatile settings from non-volatile
  10215. memory. If 'both' is specified or there are no parameters, then both
  10216. Permanent and Dynamic settings will be read. Otherwise, only the section
  10217. specified will be read. This will destroy any changes you have made if you
  10218. haven't written them!
  10220. EXAMPLES:
  10221. read -- Reads both Permanent and Dynamic sections of settings.
  10222. read perm -- Reads only the Permanent section of non-vol settings.
  10224. ------------------------------------------------------------------------------
  10226. TABLE: non-vol/802.11/guest_network
  10228. COMMAND: shared_key_auth
  10230. USAGE: shared_key_auth MBSS{1..3} [optional|required]
  10232. DESCRIPTION:
  10233. Controls the shared key authentication.
  10235. EXAMPLES:
  10236. shared_key_auth 1 Optional -- Sets shared key authentication of Guest
  10237. network 1 to optional
  10238. shared_key_auth 1 -- Shows current Guest network 1 setting
  10240. ------------------------------------------------------------------------------
  10242. TABLE: non-vol/802.11/guest_network
  10244. COMMAND: show
  10246. USAGE: show
  10248. DESCRIPTION:
  10249. Displays the current non-volatile settings values for both the Permanent and
  10250. Dynamic sections.
  10252. EXAMPLES:
  10253. show --
  10255. ------------------------------------------------------------------------------
  10257. TABLE: non-vol/802.11/guest_network
  10259. COMMAND: ssid
  10261. USAGE: ssid MBSS{1..3} [SSID{32}]
  10263. DESCRIPTION:
  10264. Sets/Queries the Service Set Identifier.
  10266. EXAMPLES:
  10267. ssid 1 -- Shows the SSID for Guest network 1.
  10268. ssid 1 Hello -- Sets the SSID of Guest network 1 to "Hello".
  10270. ------------------------------------------------------------------------------
  10272. TABLE: non-vol/802.11/guest_network
  10274. COMMAND: stats
  10276. USAGE: stats
  10278. DESCRIPTION:
  10279. Prints stats about buffer usage for Dynamic and Permanent settings.
  10281. EXAMPLES:
  10282. stats --
  10284. ------------------------------------------------------------------------------
  10286. TABLE: non-vol/802.11/guest_network
  10288. COMMAND: tftp_read
  10290. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  10292. DESCRIPTION:
  10293. Causes the Permanent or Dynamic settings data to be read from a server via
  10294. TFTP. The file must be generated correctly, with all of the headers, CRC,
  10295. and other information that would exist on the NonVol device. The file will
  10296. be read and evaluated for correctness before it is stored in the device. If
  10297. the file is rejected then the settings will be read from the device to undo
  10298. any changes. Normally, this will operate on all settings groups; if you
  10299. specify -g then it will operate only on the current group (e.g. if you are in
  10300. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  10301. read).
  10303. EXAMPLES:
  10304. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  10305. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  10307. ------------------------------------------------------------------------------
  10309. TABLE: non-vol/802.11/guest_network
  10311. COMMAND: tftp_write
  10313. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  10315. DESCRIPTION:
  10316. Causes the Permanent or Dynamic settings data to be written to a server via
  10317. TFTP. Normally, this will operate on all settings groups; if you specify -g
  10318. then it will operate only on the current group (e.g. if you are in the SNMP
  10319. nonvol dir, then -g will cause only the SNMP settings group to be written).
  10321. EXAMPLES:
  10322. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  10323. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  10325. ------------------------------------------------------------------------------
  10327. TABLE: non-vol/802.11/guest_network
  10329. COMMAND: wpa2_preauth
  10331. USAGE: wpa2_preauth MBSS{1..3} [disabled|enabled]
  10333. DESCRIPTION:
  10334. enables/disabled WPA2 Pre-authentication
  10336. EXAMPLES:
  10337. wpa2_preauth 1 -- Shows the current Guest network 1 setting.
  10338. wpa2_preauth 1 enabled -- Enables Guest network 1 WPA2 pre-authentication
  10340. ------------------------------------------------------------------------------
  10342. TABLE: non-vol/802.11/guest_network
  10344. COMMAND: wpa_auth
  10346. USAGE: wpa_auth MBSS{1..3} [Number{0..31}]
  10348. DESCRIPTION:
  10349. Sets WPA Authentication bitmask
  10350. 0x01 = 802.1x
  10351. 0x02 = WPA
  10352. 0x04 = WPA-PSK
  10353. 0x08 = WPA2
  10354. 0x10 = WPA2-PSK
  10356. EXAMPLES:
  10357. wpa_auth 1 -- Shows the current Guest network 1 setting.
  10358. wpa_auth 1 0x14 -- Enables Guest network 1 WPA Authentication to WPA-PSK and
  10359. WPA2-PSK.
  10361. ------------------------------------------------------------------------------
  10363. TABLE: non-vol/802.11/guest_network
  10365. COMMAND: wpa_psk
  10367. USAGE: wpa_psk MBSS{1..3} [key{64}]
  10369. DESCRIPTION:
  10370. Sets or displays the WPA Pre-Shared Key.
  10371. It MUST be either a 64-digit hexadecimal number,
  10372. OR a 8 to 63 character ASCII string
  10374. EXAMPLES:
  10375. wpa_psk 1 thisismykey -- Sets the Guest network 1 WPA Pre-Shared
  10376. Key to 'thisismykey'.
  10377. wpa_psk 1 <64-digit hex number> -- Sets the Guest network 1 WPA Pre-Shared
  10378. Key to <number>.
  10380. ------------------------------------------------------------------------------
  10382. TABLE: non-vol/802.11/guest_network
  10384. COMMAND: wpa_reauth
  10386. USAGE: wpa_reauth MBSS{1..3} [Number{0..1048575}]
  10388. DESCRIPTION:
  10389. Sets WPA/WPA2 Reauth Interval
  10391. EXAMPLES:
  10392. wpa_reauth 1 -- Shows the current Guest network 1 setting.
  10393. wpa_reauth 1 1000 -- Sets the Guest network 1 Reauth Interval to 1000
  10395. ------------------------------------------------------------------------------
  10397. TABLE: non-vol/802.11/guest_network
  10399. COMMAND: wpa_rekey
  10401. USAGE: wpa_rekey MBSS{1..3} [Number{0..1048575}]
  10403. DESCRIPTION:
  10404. Sets WPA Group Rekey Interval
  10406. EXAMPLES:
  10407. wpa_rekey 1 -- Shows the current rekey interval value for Guest network
  10408. 1.
  10409. wpa_rekey 1 1000 -- Sets the Guest network 1 rekey interval to 1000
  10411. ------------------------------------------------------------------------------
  10413. TABLE: non-vol/802.11/guest_network
  10415. COMMAND: write
  10417. USAGE: write [both|perm|dyn]
  10419. DESCRIPTION:
  10420. Writes the specified section of non-volatile settings to non-volatile memory.
  10421. If 'both' is specified or there are no parameters, then both Permanent and
  10422. Dynamic settings will be written. Otherwise, only the section specified will
  10423. be written.
  10425. EXAMPLES:
  10426. write -- Writes both Permanent and Dynamic sections of settings.
  10427. write perm -- Writes only the Permanent section of non-vol settings.
  10429. ------------------------------------------------------------------------------
  10431. TABLE: non-vol/802.11Srom
  10433. COMMAND: clear_device
  10435. USAGE: clear_device [both|perm|dyn]
  10437. DESCRIPTION:
  10438. Tells the nonvol device to wipe out the specified settings section. All data
  10439. will be lost; the device should be restored to its 'virgin' state. For flash
  10440. devices, the flash block is erased; for disk devices, the file is erased.
  10442. EXAMPLES:
  10443. clear_device -- Clears both Permanent and Dynamic sections.
  10444. clear_device perm -- Clears only the Permanent section.
  10446. ------------------------------------------------------------------------------
  10448. TABLE: non-vol/802.11Srom
  10450. COMMAND: defaults
  10452. USAGE: defaults [both|perm|dyn]
  10454. DESCRIPTION:
  10455. Restores the settings to default values. NOTE: This does not write to
  10456. NonVol memory! You must do this manually. Also note that some settings do
  10457. not have good defaults, particularly the Permanent section! Use this command
  10458. with extreme care!
  10460. EXAMPLES:
  10461. defaults -- Sets both Permanent and Dynamic sections to defaults.
  10462. defaults perm -- Sets only the Permanent section to defaults.
  10464. ------------------------------------------------------------------------------
  10466. TABLE: non-vol/802.11Srom
  10468. COMMAND: del_extra_data
  10470. USAGE: del_extra_data [both|perm|dyn]
  10472. DESCRIPTION:
  10473. Gets rid of any extra data that is assiociated with the settings. The extra
  10474. data is usually caused by a downgrade, where settings written by a newer
  10475. version are not understood by the older version, but are stored so that they
  10476. will still exist when the new code is run. However, in some cases, it is
  10477. desirable to get rid of them if they are not going to be used.
  10479. EXAMPLES:
  10480. del_extra_data perm -- Gets rid of extra permanent data.
  10482. ------------------------------------------------------------------------------
  10484. TABLE: non-vol/802.11Srom
  10486. COMMAND: flush {disabled}
  10488. USAGE: flush
  10490. DESCRIPTION:
  10491. For Composite NonVol Settings objects (which contain 1 or more groups of
  10492. NonVol Settings), this command flushes out any unrecognized groups that were
  10493. read from the device. This is useful in cases where the settings group isn't
  10494. needed by another application, and would just waste space.
  10496. EXAMPLES:
  10497. flush --
  10499. ------------------------------------------------------------------------------
  10501. TABLE: non-vol/802.11Srom
  10503. COMMAND: manufactured
  10505. USAGE: manufactured [both|perm|dyn]
  10507. DESCRIPTION:
  10508. Checks to see if the specified section is manufactured.
  10510. EXAMPLES:
  10511. manufactured -- Checks both Permanent and Dynamic sections
  10512. manufacturing state.
  10513. manufactured perm -- Checks only the Permanent section manufacturing state.
  10515. ------------------------------------------------------------------------------
  10517. TABLE: non-vol/802.11Srom
  10519. COMMAND: read
  10521. USAGE: read [both|perm|dyn]
  10523. DESCRIPTION:
  10524. Reads the specified section of non-volatile settings from non-volatile
  10525. memory. If 'both' is specified or there are no parameters, then both
  10526. Permanent and Dynamic settings will be read. Otherwise, only the section
  10527. specified will be read. This will destroy any changes you have made if you
  10528. haven't written them!
  10530. EXAMPLES:
  10531. read -- Reads both Permanent and Dynamic sections of settings.
  10532. read perm -- Reads only the Permanent section of non-vol settings.
  10534. ------------------------------------------------------------------------------
  10536. TABLE: non-vol/802.11Srom
  10538. COMMAND: show
  10540. USAGE: show
  10542. DESCRIPTION:
  10543. Displays the current non-volatile settings values for both the Permanent and
  10544. Dynamic sections.
  10546. EXAMPLES:
  10547. show --
  10549. ------------------------------------------------------------------------------
  10551. TABLE: non-vol/802.11Srom
  10553. COMMAND: sromWord
  10555. USAGE: sromWord [Number{0..65535}] [Number{0..65535}]
  10557. DESCRIPTION:
  10558. Sets the specific word specified by offset in the SROM.
  10560. EXAMPLES:
  10561. sromByte -- does nothing
  10562. sromByte 0 0x00ff -- Sets the 0 word on SROM to 255
  10564. ------------------------------------------------------------------------------
  10566. TABLE: non-vol/802.11Srom
  10568. COMMAND: stats
  10570. USAGE: stats
  10572. DESCRIPTION:
  10573. Prints stats about buffer usage for Dynamic and Permanent settings.
  10575. EXAMPLES:
  10576. stats --
  10578. ------------------------------------------------------------------------------
  10580. TABLE: non-vol/802.11Srom
  10582. COMMAND: tftp_read
  10584. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  10586. DESCRIPTION:
  10587. Causes the Permanent or Dynamic settings data to be read from a server via
  10588. TFTP. The file must be generated correctly, with all of the headers, CRC,
  10589. and other information that would exist on the NonVol device. The file will
  10590. be read and evaluated for correctness before it is stored in the device. If
  10591. the file is rejected then the settings will be read from the device to undo
  10592. any changes. Normally, this will operate on all settings groups; if you
  10593. specify -g then it will operate only on the current group (e.g. if you are in
  10594. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  10595. read).
  10597. EXAMPLES:
  10598. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  10599. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  10601. ------------------------------------------------------------------------------
  10603. TABLE: non-vol/802.11Srom
  10605. COMMAND: tftp_write
  10607. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  10609. DESCRIPTION:
  10610. Causes the Permanent or Dynamic settings data to be written to a server via
  10611. TFTP. Normally, this will operate on all settings groups; if you specify -g
  10612. then it will operate only on the current group (e.g. if you are in the SNMP
  10613. nonvol dir, then -g will cause only the SNMP settings group to be written).
  10615. EXAMPLES:
  10616. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  10617. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  10619. ------------------------------------------------------------------------------
  10621. TABLE: non-vol/802.11Srom
  10623. COMMAND: write
  10625. USAGE: write [both|perm|dyn]
  10627. DESCRIPTION:
  10628. Writes the specified section of non-volatile settings to non-volatile memory.
  10629. If 'both' is specified or there are no parameters, then both Permanent and
  10630. Dynamic settings will be written. Otherwise, only the section specified will
  10631. be written.
  10633. EXAMPLES:
  10634. write -- Writes both Permanent and Dynamic sections of settings.
  10635. write perm -- Writes only the Permanent section of non-vol settings.
  10637. ------------------------------------------------------------------------------
  10639. TABLE: non-vol/SA
  10641. COMMAND: 80211Antenna
  10643. USAGE: 80211Antenna [Number{0..1}]
  10645. DESCRIPTION:
  10646. To set the oid saRgDot11Antenna.
  10648. EXAMPLES:
  10649. SARg80211Antenna -- Show the value of saRgDot11Antenna.
  10650. SARg80211Antenna 0 -- Set oid saRgDot11Antenna as disable.
  10651. SARg80211Antenna 1 -- Set oid saRgDot11Antenna as enable.
  10654. ------------------------------------------------------------------------------
  10656. TABLE: non-vol/SA
  10658. COMMAND: 80211OperMode
  10660. USAGE: 80211OperMode [Number{0..3}]
  10662. DESCRIPTION:
  10663. Show & Set saRgDot11OperMode in nonvol location 20............notAvailable
  10664. 1............off
  10665. 2............remote
  10666. 3............local
  10669. EXAMPLES:
  10670. 80211OperMode 1 -- Set MIB saRgDot11OperMode to off(1).
  10671. 80211OperMode 3 -- Set MIB saRgDot11OperMode to local(3).
  10674. ------------------------------------------------------------------------------
  10676. TABLE: non-vol/SA
  10678. COMMAND: 80211PrimaryPrefix
  10680. USAGE: 80211PrimaryPrefix [String{19}]
  10682. DESCRIPTION:
  10683. To set the oid saRgDot11BssPrimarySsidPrefix.
  10685. EXAMPLES:
  10686. Rg80211PrimaryPrefix -- Show the value of oid
  10687. saRgDot11BssPrimarySsidPrefix.
  10688. Rg80211PrimaryPrefix "" -- Set oid saRgDot11BssPrimarySsidPrefix as empty.
  10689. Rg80211PrimaryPrefix abcd -- Set oid saRgDot11BssPrimarySsidPrefix as
  10690. 'abcd'.
  10693. ------------------------------------------------------------------------------
  10695. TABLE: non-vol/SA
  10697. COMMAND: 80211PrimaryPrefixType
  10699. USAGE: 80211PrimaryPrefixType [Number{1..2}]
  10701. DESCRIPTION:
  10702. To set the oid saRgDot11BssPrimarySsidType.
  10704. EXAMPLES:
  10705. SARg80211PrimaryPrefixType -- Show the value of oid
  10706. saRgDot11BssPrimarySsidType.
  10707. SARg80211PrimaryPrefixType 1 -- Set oid saRgDot11BssPrimarySsidType as
  10708. mac6char.
  10709. SARg80211PrimaryPrefixType 2 -- Set oid saRgDot11BssPrimarySsidType as
  10710. mac6char-prefix.
  10713. ------------------------------------------------------------------------------
  10715. TABLE: non-vol/SA
  10717. COMMAND: DsBonding
  10719. USAGE: DsBonding [Number{0..1}]
  10721. DESCRIPTION:
  10722. Set Cm Bonding Channel
  10723. DsBonding 0: Disable Bonding Channel
  10724. DsBonding 1: Enable Bonding Channel
  10727. EXAMPLES:
  10728. DsBonding 1
  10731. ------------------------------------------------------------------------------
  10733. TABLE: non-vol/SA
  10735. COMMAND: ForceDualScan
  10737. USAGE: ForceDualScan [Number{0..1}]
  10739. DESCRIPTION:
  10740. Set Cm Force Dual Scan
  10741. ForceDualScan 0: Disable Dual Scan
  10742. ForceDualScan 1: Enable Dual Scan
  10745. EXAMPLES:
  10746. ForceDualScan 1
  10749. ------------------------------------------------------------------------------
  10751. TABLE: non-vol/SA
  10753. COMMAND: HwBoardVersion
  10755. USAGE: HwBoardVersion [String{255}]
  10757. DESCRIPTION:
  10758. Show & Set HW board version.
  10760. EXAMPLES:
  10761. HwBoardVersion -- Show what Hardware board Version is.
  10762. HwBoardVersion 1 -- Set the Hardware board Version to 1.
  10764. ------------------------------------------------------------------------------
  10766. TABLE: non-vol/SA
  10768. COMMAND: HwCmMacAddress
  10770. USAGE: HwCmMacAddress [String{255}]
  10772. DESCRIPTION:
  10773. Show & Set Hw CmMacAddress
  10775. EXAMPLES:
  10776. kSAHwCmMacAddress -- Show what Hardware CmMacAddress is.
  10777. kSAHwCmMacAddress aabbccddeeff -- Set the Hardware CmMacAddress to
  10778. aabbccddeeff.
  10780. ------------------------------------------------------------------------------
  10782. TABLE: non-vol/SA
  10784. COMMAND: HwCountDect
  10786. USAGE: HwCountDect [Number{0..256}]
  10788. DESCRIPTION:
  10789. Show & Set HW Dect number
  10791. EXAMPLES:
  10792. HwCountDect -- Show how many Dect.
  10793. HwCountDect 0 -- Set Dect number to 0.
  10796. ------------------------------------------------------------------------------
  10798. TABLE: non-vol/SA
  10800. COMMAND: HwCountEthernet
  10802. USAGE: HwCountEthernet [Number{0..256}]
  10804. DESCRIPTION:
  10805. Show & Set HW Ethernet number
  10807. EXAMPLES:
  10808. HwCountEthernet -- Show how many Ethernet port.
  10809. HwCountEthernet 1 -- Set Ethernet number to 1.
  10811. ------------------------------------------------------------------------------
  10813. TABLE: non-vol/SA
  10815. COMMAND: HwCountMaxBattery
  10817. USAGE: HwCountMaxBattery [Number{0..256}]
  10819. DESCRIPTION:
  10820. Show & Set HW MAX Battery number
  10822. EXAMPLES:
  10823. HwCountMaxBattery -- Show what Max Battery number is.
  10824. HwCountMaxBattery 0 -- Set Max Battery number to 0.
  10826. ------------------------------------------------------------------------------
  10828. TABLE: non-vol/SA
  10830. COMMAND: HwCountPhoneLine
  10832. USAGE: HwCountPhoneLine [Number{0..256}]
  10834. DESCRIPTION:
  10835. Show & Set HW PhoneLine number
  10837. EXAMPLES:
  10838. HwCountPhoneLine -- Show how many Phone Line.
  10839. HwCountPhoneLine 2 -- Set Phone Line number to 2.
  10841. ------------------------------------------------------------------------------
  10843. TABLE: non-vol/SA
  10845. COMMAND: HwCountUsb
  10847. USAGE: HwCountUsb [Number{0..256}]
  10849. DESCRIPTION:
  10850. Show & Set HW Usb number
  10852. EXAMPLES:
  10853. HwCountUsb -- Show how many Usb port.
  10854. HwCountUsb 1 -- Set Usb number to 1.
  10856. ------------------------------------------------------------------------------
  10858. TABLE: non-vol/SA
  10860. COMMAND: HwCountWireless
  10862. USAGE: HwCountWireless [Number{0..256}]
  10864. DESCRIPTION:
  10865. Show & Set HW Wireless number
  10867. EXAMPLES:
  10868. HwCountWireless -- Show how many Wireless.
  10869. HwCountWireless 0 -- Set Wireless number to 0.
  10871. ------------------------------------------------------------------------------
  10873. TABLE: non-vol/SA
  10875. COMMAND: HwDectType
  10877. USAGE: HwDectType [Number{0..2}]
  10879. DESCRIPTION:
  10880. Show & Set HW Dect Type
  10881. 0............none
  10882. 1............north-america
  10883. 2............europe
  10885. EXAMPLES:
  10886. HwDectType -- Show what Dect Type is.
  10887. HwDectType 1 -- Set the Dect Type to north-america.
  10889. ------------------------------------------------------------------------------
  10891. TABLE: non-vol/SA
  10893. COMMAND: HwDiplexer
  10895. USAGE: HwDiplexer [Number{0..4}]
  10897. DESCRIPTION:
  10898. Show & Set HW Diplexer
  10899. 0............none
  10900. 1............north-america
  10901. 2............europe
  10902. 3............japan
  10903. 4............korea
  10906. EXAMPLES:
  10907. HwDiplexer -- Shows what Hardware Diplexer is.
  10908. HwDiplexer 0 -- Set the Hardware Diplexer to none.
  10909. HwDiplexer 2 -- Set the Hardware Diplexer to europe.
  10911. ------------------------------------------------------------------------------
  10913. TABLE: non-vol/SA
  10915. COMMAND: HwDmsType
  10917. USAGE: HwDmsType [Number{0..1}]
  10919. DESCRIPTION:
  10920. Show & Set HW DMS Type.
  10922. EXAMPLES:
  10923. HwDmsType -- Show HW DMS Type.
  10924. HwDmsType 0 -- Set DMS Type to none.
  10925. HwDmsType 1 -- Set DMS Type to dms1.
  10928. ------------------------------------------------------------------------------
  10930. TABLE: non-vol/SA
  10932. COMMAND: HwEthSwitch
  10934. USAGE: HwEthSwitch [Number{1..5}]
  10936. DESCRIPTION:
  10937. Show & Set HW Ethernet Switch Type.
  10938. 0............none
  10939. 1............bcm5325m
  10940. 2............marv6095f
  10941. 3............bcm5325e
  10942. 4............bcm53115s
  10943. 5............ar3816
  10946. EXAMPLES:
  10947. HwEthSwitch -- Show HW Ethernet Switch Type.
  10948. HwEthSwitch 1 -- Set Ethernet Switch Type to bcm5325m.
  10949. HwEthSwitch 2 -- Set Ethernet Switch Type to marv6095f.
  10950. HwEthSwitch 3 -- Set Ethernet Switch Type to bcm5325e.
  10953. ------------------------------------------------------------------------------
  10955. TABLE: non-vol/SA
  10957. COMMAND: HwFactoryID
  10959. USAGE: HwFactoryID [Number{0..256}]
  10961. DESCRIPTION:
  10962. Show & Set HW Factory ID
  10964. EXAMPLES:
  10965. HwFactoryID -- Show Factory ID.
  10966. HwFactoryID 0 -- Set Factory ID to 0.
  10969. ------------------------------------------------------------------------------
  10971. TABLE: non-vol/SA
  10973. COMMAND: HwMainProcessor
  10975. USAGE: HwMainProcessor [Number{1..10}]
  10977. DESCRIPTION:
  10978. Show & Set HW Main Processor
  10979. 1............bcm3349
  10980. 2............bcm3349kfb
  10981. 3............bcm3368
  10982. 4............bcm3381A1
  10983. 5............bcm3381A2
  10984. 6............bcm3349ipbg
  10985. 7............tipuma5
  10986. 8............bcm3361
  10987. 9............bcm3378
  10988. 10...........bcm3380
  10991. EXAMPLES:
  10992. HwMainProcessor -- Show what Hardware MainProcessor is.
  10993. HwMainProcessor 1 -- Set the Hardware MainProcessor to bcm3349.
  10995. ------------------------------------------------------------------------------
  10997. TABLE: non-vol/SA
  10999. COMMAND: HwManufactureDate
  11001. USAGE: HwManufactureDate [String{255}]
  11003. DESCRIPTION:
  11004. Show & Set Hw Manufacture Date
  11006. EXAMPLES:
  11007. Format is yyyymm .
  11008. HwManufactureDate -- Show what Hardware ManufactureDate is.
  11009. HwManufactureDate 200512 -- Set the Hardware ManufactureDate to 200512.
  11011. ------------------------------------------------------------------------------
  11013. TABLE: non-vol/SA
  11015. COMMAND: HwMemoryFlash
  11017. USAGE: HwMemoryFlash [Number{0..256}]
  11019. DESCRIPTION:
  11020. Show & Set HW Memory Flash size
  11022. EXAMPLES:
  11023. HwMemoryFlash -- Show what size of Hardware Flash Memory is.
  11024. HwMemoryFlash 4 -- Set the size of Hardware Flash Memory to 4MB.
  11026. ------------------------------------------------------------------------------
  11028. TABLE: non-vol/SA
  11030. COMMAND: HwMemoryMain
  11032. USAGE: HwMemoryMain [Number{0..256}]
  11034. DESCRIPTION:
  11035. Show & Set HW Memory Main size
  11037. EXAMPLES:
  11038. HwMemoryMain -- Show what size of Hardware Main Memory is.
  11039. HwMemoryMain 16 -- Set the size of Hardware Main Memory to 16MB.
  11041. ------------------------------------------------------------------------------
  11043. TABLE: non-vol/SA
  11045. COMMAND: HwMocaType
  11047. USAGE: HwMocaType [Number{0..1}]
  11049. DESCRIPTION:
  11050. Show & Set HW MoCA Type.
  11052. EXAMPLES:
  11053. HwMocaType -- Show HW MoCA Type.
  11054. HwMocaType 0 -- Set MoCA Type to none.
  11055. HwMocaType 1 -- Set MoCA Type to en2210.
  11058. ------------------------------------------------------------------------------
  11060. TABLE: non-vol/SA
  11062. COMMAND: HwModel
  11064. USAGE: HwModel [String{255}]
  11066. DESCRIPTION:
  11067. Show & Set HW Model.
  11069. EXAMPLES:
  11070. HwModel -- Show what Hardware Model is.
  11071. HwModel EPC2203 -- Set the Hardware Model to EPC2203.
  11073. ------------------------------------------------------------------------------
  11075. TABLE: non-vol/SA
  11077. COMMAND: HwPowerSupply
  11079. USAGE: HwPowerSupply [Number{1..2}]
  11081. DESCRIPTION:
  11082. Show & Set HW PowerSupply
  11083. 1............internal-switching
  11084. 2............external
  11086. EXAMPLES:
  11087. HwPowerSupply -- Show what Hardware PowerSupply is.
  11088. HwPowerSupply 1 -- Set the Hardware PowerSupply to internal-switching.
  11089. HwPowerSupply 2 -- Set the Hardware PowerSupply to external.
  11091. ------------------------------------------------------------------------------
  11093. TABLE: non-vol/SA
  11095. COMMAND: HwSerialNumber
  11097. USAGE: HwSerialNumber [String{255}]
  11099. DESCRIPTION:
  11100. Show & Set Hw SerialNumber
  11102. EXAMPLES:
  11103. HwSerialNumber -- Show what Hardware SerialNumber is.
  11104. HwSerialNumber 123456 -- Set the Hardware SerialNumber to 123456.
  11106. ------------------------------------------------------------------------------
  11108. TABLE: non-vol/SA
  11110. COMMAND: HwSlic
  11112. USAGE: HwSlic [Number{0..6}]
  11114. DESCRIPTION:
  11115. Show & Set HW Slic
  11116. 0............none
  11117. 1............le9500b
  11118. 2............le9500c
  11119. 3............le9500d
  11120. 4............le9520ddtc
  11121. 5............le88276
  11122. 6............le9530d
  11125. EXAMPLES:
  11126. HwSlic -- Show what Hardware Slic is.
  11127. HwSlic 2 -- Set the Hardware Slic to le9500c.
  11129. ------------------------------------------------------------------------------
  11131. TABLE: non-vol/SA
  11133. COMMAND: HwTuner
  11135. USAGE: HwTuner [Number{0..7}]
  11137. DESCRIPTION:
  11138. Show & Set HW Tuner
  11139. 0............none
  11140. 1............bcm3419
  11141. 2............bcm3420
  11142. 3............bcm3420x3
  11143. 4............bcm3420iml
  11144. 5............mt2170
  11145. 6............bcm3421
  11146. 7............bcmInternal
  11149. EXAMPLES:
  11150. HwTuner -- Show what Hardware Tuner is.
  11151. HwTuner 1 -- Set the Hardware Tuner to bcm3419.
  11153. ------------------------------------------------------------------------------
  11155. TABLE: non-vol/SA
  11157. COMMAND: HwUsbType
  11159. USAGE: HwUsbType [Number{0..3}]
  11161. DESCRIPTION:
  11162. Show & Set HW Usb Type
  11163. 0............none
  11164. 1............usb11
  11165. 2............usb20wPLX
  11166. 3............usb20w3381
  11168. EXAMPLES:
  11169. HwUsbType -- Show what Usb Type is.
  11170. HwUsbType 1 -- Set the Usb Type to usb11.
  11172. ------------------------------------------------------------------------------
  11174. TABLE: non-vol/SA
  11176. COMMAND: HwVersion
  11178. USAGE: HwVersion [String{255}]
  11180. DESCRIPTION:
  11181. Show & Set HW version.
  11183. EXAMPLES:
  11184. HwVersion -- Show what Hardware Version is.
  11185. HwVersion 1 -- Set the Hardware Version to 1.
  11187. ------------------------------------------------------------------------------
  11189. TABLE: non-vol/SA
  11191. COMMAND: HwWirelessButtonTime
  11193. USAGE: HwWirelessButtonTime [Number{0..10}]
  11195. DESCRIPTION:
  11196. Show & Set HW Wireless Push Button Duration (0~10 sec).
  11199. EXAMPLES:
  11200. HwWirelessButtonTime -- Show what Wireless Button Time.
  11201. HwWirelessButtonTime 0 -- Set the Wireless Button Time to 0.
  11204. ------------------------------------------------------------------------------
  11206. TABLE: non-vol/SA
  11208. COMMAND: HwWirelessButtonTime_dynamic
  11210. USAGE: HwWirelessButtonTime_dynamic [Number{0..10}]
  11212. DESCRIPTION:
  11213. Show & Set HW Wireless Push Button Duration (0~10 sec).
  11216. EXAMPLES:
  11217. HwWirelessButtonTime_dynamic -- Show what Wireless Button Time.
  11218. HwWirelessButtonTime_dynamic 0 -- Set the Wireless Button Time to 0.
  11221. ------------------------------------------------------------------------------
  11223. TABLE: non-vol/SA
  11225. COMMAND: HwWirelessChip
  11227. USAGE: HwWirelessChip [Number{0..6}]
  11229. DESCRIPTION:
  11230. Show & Set HW Wireless Chip
  11231. 0............none
  11232. 1............bcm4306
  11233. 2............bcm4318
  11234. 3............bcm4318E
  11235. 4............bcm4322
  11236. 5............bcm43224
  11237. 6............bcm43225
  11240. EXAMPLES:
  11241. HwWirelessChip -- Show what Wireless Chip is.
  11242. HwWirelessChip 1 -- Set the Wireless Chip to bcm4306.
  11243. HwWirelessChip 2 -- Set the Wireless Chip to bcm4318.
  11244. HwWirelessChip 3 -- Set the Wireless Chip to bcm4318E.
  11246. ------------------------------------------------------------------------------
  11248. TABLE: non-vol/SA
  11250. COMMAND: HwWirelessType
  11252. USAGE: HwWirelessType [Number{0..3}]
  11254. DESCRIPTION:
  11255. Show & Set HW Wireless Type
  11256. 0............none
  11257. 1............ieee80211b
  11258. 2............ieee80211g
  11259. 3............ieee80211n
  11261. EXAMPLES:
  11262. HwWirelessType -- Show what Hardware Wireless Type is.
  11263. HwWirelessType 2 -- Set the Wireless Type to ieee80211g.
  11265. ------------------------------------------------------------------------------
  11267. TABLE: non-vol/SA
  11269. COMMAND: IpProvsion
  11271. USAGE: IpProvsion [Number{0..4}]
  11273. DESCRIPTION:
  11274. Set Ip Provsion Mode
  11275. IpProvision 0: Honor the IP mode in the MDD message
  11276. IpProvision 1: Override IP mode to IPv4 if necessary
  11277. IpProvision 2: Override IP mode to IPv6 if necessary
  11278. IpProvision 3: Override IP mode to APM if necessary
  11279. IpProvision 4: Override IP mode to DPM if necessary
  11282. EXAMPLES:
  11283. IpProvision 0
  11286. ------------------------------------------------------------------------------
  11288. TABLE: non-vol/SA
  11290. COMMAND: UserAccessRead
  11292. USAGE: UserAccessRead [Number]
  11294. DESCRIPTION:
  11295. Set saRgDeviceUserAccessReadPages in nonvol location 2
  11297. EXAMPLES:
  11298. UserAccessRead 0xffffffff.
  11301. ------------------------------------------------------------------------------
  11303. TABLE: non-vol/SA
  11305. COMMAND: UserAccessWrite
  11307. USAGE: UserAccessWrite [Number]
  11309. DESCRIPTION:
  11310. Set saRgDeviceUserAccessWritePages in nonvol location 2
  11312. EXAMPLES:
  11313. UserAccessWrite 0xffffffff.
  11316. ------------------------------------------------------------------------------
  11318. TABLE: non-vol/SA
  11320. COMMAND: clear_device
  11322. USAGE: clear_device [both|perm|dyn]
  11324. DESCRIPTION:
  11325. Tells the nonvol device to wipe out the specified settings section. All data
  11326. will be lost; the device should be restored to its 'virgin' state. For flash
  11327. devices, the flash block is erased; for disk devices, the file is erased.
  11329. EXAMPLES:
  11330. clear_device -- Clears both Permanent and Dynamic sections.
  11331. clear_device perm -- Clears only the Permanent section.
  11333. ------------------------------------------------------------------------------
  11335. TABLE: non-vol/SA
  11337. COMMAND: comcast_led_enable
  11339. USAGE: comcast_led_enable [true|false]
  11341. DESCRIPTION:
  11342. Enable Comcast LED mode
  11344. EXAMPLES:
  11345. comcast_led_enable -- Shows whether Comcast LED mode is enabled.
  11346. comcast_led_enable false -- Disable Comcast LED mode.
  11347. comcast_led_enable true -- Enable Comcast LED mode.
  11349. ------------------------------------------------------------------------------
  11351. TABLE: non-vol/SA
  11353. COMMAND: console_enable
  11355. USAGE: console_enable [true|false]
  11357. DESCRIPTION:
  11358. Enable console
  11360. EXAMPLES:
  11361. console_enable -- Shows the current console_enable setting.
  11362. console_enable false -- Disable console port.
  11363. console_enable true -- Enable console port.
  11365. ------------------------------------------------------------------------------
  11367. TABLE: non-vol/SA
  11369. COMMAND: defaults
  11371. USAGE: defaults [both|perm|dyn]
  11373. DESCRIPTION:
  11374. Restores the settings to default values. NOTE: This does not write to
  11375. NonVol memory! You must do this manually. Also note that some settings do
  11376. not have good defaults, particularly the Permanent section! Use this command
  11377. with extreme care!
  11379. EXAMPLES:
  11380. defaults -- Sets both Permanent and Dynamic sections to defaults.
  11381. defaults perm -- Sets only the Permanent section to defaults.
  11383. ------------------------------------------------------------------------------
  11385. TABLE: non-vol/SA
  11387. COMMAND: del_extra_data
  11389. USAGE: del_extra_data [both|perm|dyn]
  11391. DESCRIPTION:
  11392. Gets rid of any extra data that is assiociated with the settings. The extra
  11393. data is usually caused by a downgrade, where settings written by a newer
  11394. version are not understood by the older version, but are stored so that they
  11395. will still exist when the new code is run. However, in some cases, it is
  11396. desirable to get rid of them if they are not going to be used.
  11398. EXAMPLES:
  11399. del_extra_data perm -- Gets rid of extra permanent data.
  11401. ------------------------------------------------------------------------------
  11403. TABLE: non-vol/SA
  11405. COMMAND: dhcp_option
  11407. USAGE: dhcp_option [option{0..255}]
  11409. DESCRIPTION:
  11410. Dhcp option
  11412. EXAMPLES:
  11413. dhcp_option -- Shows the current dhcp_option setting.
  11414. dhcp_option 0 -- Use the DHCP OPTION 122.
  11415. dhcp_option 1 -- Use the DHCP OPTION 122 OR 177.
  11416. dhcp_option 0 -- Use the DHCP OPTION 177.
  11418. ------------------------------------------------------------------------------
  11420. TABLE: non-vol/SA
  11422. COMMAND: dload_tel_root_cert
  11424. USAGE: dload_tel_root_cert IpAddress Filename{63}
  11426. DESCRIPTION:
  11427. To download a new Telephony Service Provider Root CA use this CLI command and
  11428. specify the server IP address and file name of Telephony Service Provider
  11429. Root CA certificate to install.
  11431. EXAMPLES:
  11432. dload_tel_root_cert 11.24.4.3 bpi.bin
  11434. ------------------------------------------------------------------------------
  11436. TABLE: non-vol/SA
  11438. COMMAND: ds_plan
  11440. USAGE: ds_plan [String{1}]
  11442. DESCRIPTION:
  11443. Change DS search plan
  11445. EXAMPLES:
  11446. ds_plan -- Shows the current DS search plan.
  11447. ds_plan a -- Use North America (NTSC).
  11448. ds_plan b -- Use International DOCSIS (PAL-I, PAL-G, NTSC and 1 MHz step
  11449. routine).
  11450. ds_plan c -- Use International Euro-DOCSIS/DOCSIS (PAL-G, PAL-I, NTSC and 1
  11451. MHz step routine).
  11452. ds_plan d -- Use Japanese (NTSC Japan).
  11453. ds_plan e -- Korea (Hybrid) with Dual Mode.
  11454. ds_plan f -- Reserved.
  11455. ds_plan g -- Reserved.
  11456. ds_plan h -- Korea (Hybrid) with Dual Mode 1.
  11457. ds_plan i -- Reserved.
  11458. ds_plan j -- Reserved.
  11459. ds_plan k -- Korea (Hybrid) with Dual Mode 2.
  11462. ------------------------------------------------------------------------------
  11464. TABLE: non-vol/SA
  11466. COMMAND: fast_busy_signal
  11468. USAGE: fast_busy_signal [Number{0..1}]
  11470. DESCRIPTION:
  11471. Enable Fast Busy Signal
  11473. EXAMPLES:
  11474. fast_busy_signal <0|1> -- Enable Fast Busy Signal Or Not
  11477. ------------------------------------------------------------------------------
  11479. TABLE: non-vol/SA
  11481. COMMAND: flush {disabled}
  11483. USAGE: flush
  11485. DESCRIPTION:
  11486. For Composite NonVol Settings objects (which contain 1 or more groups of
  11487. NonVol Settings), this command flushes out any unrecognized groups that were
  11488. read from the device. This is useful in cases where the settings group isn't
  11489. needed by another application, and would just waste space.
  11491. EXAMPLES:
  11492. flush --
  11494. ------------------------------------------------------------------------------
  11496. TABLE: non-vol/SA
  11498. COMMAND: ftp_switch
  11500. USAGE: ftp_switch [true|false]
  11502. DESCRIPTION:
  11503. Enable ftp improvement function
  11505. EXAMPLES:
  11506. ftp_switch -- Shows the current ftp_switch setting.
  11507. ftp_switch false -- Disable ftp improvement function.
  11508. ftp_switch true -- Enable ftp improvement function.
  11510. ------------------------------------------------------------------------------
  11512. TABLE: non-vol/SA
  11514. COMMAND: igmp
  11516. USAGE: igmp [true|false]
  11518. DESCRIPTION:
  11519. Enable IGMP proxy function
  11521. EXAMPLES:
  11522. igmp -- Shows the current igmp proxy setting.
  11523. igmp false -- Disable IGMP proxy.
  11524. igmp true -- Enable IGMP proxy.
  11526. ------------------------------------------------------------------------------
  11528. TABLE: non-vol/SA
  11530. COMMAND: level_password
  11532. USAGE: level_password [String{39}]
  11534. DESCRIPTION:
  11535. Changs the password controlling the level of access to the WebWizard.
  11537. EXAMPLES:
  11538. level_password 1234XyZ --
  11540. ------------------------------------------------------------------------------
  11542. TABLE: non-vol/SA
  11544. COMMAND: loop_curr
  11546. USAGE: loop_curr [Number{0..1}] [Number{25..40}]
  11548. DESCRIPTION:
  11549. Off Hook Loop Current
  11551. EXAMPLES:
  11552. loop_curr <0|1> <25|40> -- Set OffHookLoopCurrent endpt mA
  11555. ------------------------------------------------------------------------------
  11557. TABLE: non-vol/SA
  11559. COMMAND: manufactured
  11561. USAGE: manufactured [both|perm|dyn]
  11563. DESCRIPTION:
  11564. Checks to see if the specified section is manufactured.
  11566. EXAMPLES:
  11567. manufactured -- Checks both Permanent and Dynamic sections
  11568. manufacturing state.
  11569. manufactured perm -- Checks only the Permanent section manufacturing state.
  11571. ------------------------------------------------------------------------------
  11573. TABLE: non-vol/SA
  11575. COMMAND: read
  11577. USAGE: read [both|perm|dyn]
  11579. DESCRIPTION:
  11580. Reads the specified section of non-volatile settings from non-volatile
  11581. memory. If 'both' is specified or there are no parameters, then both
  11582. Permanent and Dynamic settings will be read. Otherwise, only the section
  11583. specified will be read. This will destroy any changes you have made if you
  11584. haven't written them!
  11586. EXAMPLES:
  11587. read -- Reads both Permanent and Dynamic sections of settings.
  11588. read perm -- Reads only the Permanent section of non-vol settings.
  11590. ------------------------------------------------------------------------------
  11592. TABLE: non-vol/SA
  11594. COMMAND: rtp_mute
  11596. USAGE: rtp_mute [Number{0..1}]
  11598. DESCRIPTION:
  11599. MTA device RTP mute <0|1> (0:noMute; 1:OnLocalRingBack)
  11601. EXAMPLES:
  11602. rtp_mute <0|1> -- Mute RTP stream Setting.
  11605. ------------------------------------------------------------------------------
  11607. TABLE: non-vol/SA
  11609. COMMAND: show
  11611. USAGE: show
  11613. DESCRIPTION:
  11614. Displays the current non-volatile settings values for both the Permanent and
  11615. Dynamic sections.
  11617. EXAMPLES:
  11618. show --
  11620. ------------------------------------------------------------------------------
  11622. TABLE: non-vol/SA
  11624. COMMAND: stats
  11626. USAGE: stats
  11628. DESCRIPTION:
  11629. Prints stats about buffer usage for Dynamic and Permanent settings.
  11631. EXAMPLES:
  11632. stats --
  11634. ------------------------------------------------------------------------------
  11636. TABLE: non-vol/SA
  11638. COMMAND: telnet_enable
  11640. USAGE: telnet_enable [Number{0..2}]
  11642. DESCRIPTION:
  11643. Change SA Telnet function enable mode
  11645. EXAMPLES:
  11646. telnet_enable -- Shows whether Telnet function enable mode.
  11647. telnet_enable 0 -- Disable Telnet function.
  11648. telnet_enable 1 -- Enable Telnet function after startup.
  11649. telnet_enable 2 -- Enable Telnet function but server will be started only by
  11650. MIB.
  11653. ------------------------------------------------------------------------------
  11655. TABLE: non-vol/SA
  11657. COMMAND: tftp_read
  11659. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  11661. DESCRIPTION:
  11662. Causes the Permanent or Dynamic settings data to be read from a server via
  11663. TFTP. The file must be generated correctly, with all of the headers, CRC,
  11664. and other information that would exist on the NonVol device. The file will
  11665. be read and evaluated for correctness before it is stored in the device. If
  11666. the file is rejected then the settings will be read from the device to undo
  11667. any changes. Normally, this will operate on all settings groups; if you
  11668. specify -g then it will operate only on the current group (e.g. if you are in
  11669. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  11670. read).
  11672. EXAMPLES:
  11673. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  11674. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  11676. ------------------------------------------------------------------------------
  11678. TABLE: non-vol/SA
  11680. COMMAND: tftp_write
  11682. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  11684. DESCRIPTION:
  11685. Causes the Permanent or Dynamic settings data to be written to a server via
  11686. TFTP. Normally, this will operate on all settings groups; if you specify -g
  11687. then it will operate only on the current group (e.g. if you are in the SNMP
  11688. nonvol dir, then -g will cause only the SNMP settings group to be written).
  11690. EXAMPLES:
  11691. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  11692. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  11694. ------------------------------------------------------------------------------
  11696. TABLE: non-vol/SA
  11698. COMMAND: wake_up_everybody
  11700. USAGE: wake_up_everybody [Number{0..1440}]
  11702. DESCRIPTION:
  11703. Wake Up EveryBody
  11705. EXAMPLES:
  11706. wake_up_everybody <0|1|2-1440 minute(s)> -- On Hook Voltage Interrupted Or
  11707. Not
  11708. wake_up_everybody 1 -- On Hook Voltage Interrupted
  11711. ------------------------------------------------------------------------------
  11713. TABLE: non-vol/SA
  11715. COMMAND: web_switch
  11717. USAGE: web_switch [true|false]
  11719. DESCRIPTION:
  11720. Turn on/off web pages after cm reboots.
  11722. EXAMPLES:
  11723. web_switch -- Shows the current web_switch setting.
  11724. web_switch false -- Turn off web pages after cm reboots.
  11725. web_switch true -- Turn on web pages after cm reboots.
  11727. ------------------------------------------------------------------------------
  11729. TABLE: non-vol/SA
  11731. COMMAND: write
  11733. USAGE: write [both|perm|dyn]
  11735. DESCRIPTION:
  11736. Writes the specified section of non-volatile settings to non-volatile memory.
  11737. If 'both' is specified or there are no parameters, then both Permanent and
  11738. Dynamic settings will be written. Otherwise, only the section specified will
  11739. be written.
  11741. EXAMPLES:
  11742. write -- Writes both Permanent and Dynamic sections of settings.
  11743. write perm -- Writes only the Permanent section of non-vol settings.
  11745. ------------------------------------------------------------------------------
  11747. TABLE: non-vol/battery
  11749. COMMAND: allowedFaults
  11751. USAGE: allowedFaults [faults{0..65535}]
  11753. DESCRIPTION:
  11754. Sets the hardware fault mask to the specified value.
  11756. EXAMPLES:
  11757. allowed_faults 0xffff -- Allows all faults - when detected - to affect Pico
  11758. operation.
  11761. ------------------------------------------------------------------------------
  11763. TABLE: non-vol/battery
  11765. COMMAND: attached_devices
  11767. USAGE: attached_devices [Devices{127}]
  11769. DESCRIPTION:
  11770. Sets the value of upsIdentAttachedDevices. See RFC-1628 for details.
  11772. EXAMPLES:
  11773. attached_devices foo -- Set upsIdentAttachedDevices to 'foo'.
  11775. ------------------------------------------------------------------------------
  11777. TABLE: non-vol/battery
  11779. COMMAND: clear_device
  11781. USAGE: clear_device [both|perm|dyn]
  11783. DESCRIPTION:
  11784. Tells the nonvol device to wipe out the specified settings section. All data
  11785. will be lost; the device should be restored to its 'virgin' state. For flash
  11786. devices, the flash block is erased; for disk devices, the file is erased.
  11788. EXAMPLES:
  11789. clear_device -- Clears both Permanent and Dynamic sections.
  11790. clear_device perm -- Clears only the Permanent section.
  11792. ------------------------------------------------------------------------------
  11794. TABLE: non-vol/battery
  11796. COMMAND: defaults
  11798. USAGE: defaults [both|perm|dyn]
  11800. DESCRIPTION:
  11801. Restores the settings to default values. NOTE: This does not write to
  11802. NonVol memory! You must do this manually. Also note that some settings do
  11803. not have good defaults, particularly the Permanent section! Use this command
  11804. with extreme care!
  11806. EXAMPLES:
  11807. defaults -- Sets both Permanent and Dynamic sections to defaults.
  11808. defaults perm -- Sets only the Permanent section to defaults.
  11810. ------------------------------------------------------------------------------
  11812. TABLE: non-vol/battery
  11814. COMMAND: del_extra_data
  11816. USAGE: del_extra_data [both|perm|dyn]
  11818. DESCRIPTION:
  11819. Gets rid of any extra data that is assiociated with the settings. The extra
  11820. data is usually caused by a downgrade, where settings written by a newer
  11821. version are not understood by the older version, but are stored so that they
  11822. will still exist when the new code is run. However, in some cases, it is
  11823. desirable to get rid of them if they are not going to be used.
  11825. EXAMPLES:
  11826. del_extra_data perm -- Gets rid of extra permanent data.
  11828. ------------------------------------------------------------------------------
  11830. TABLE: non-vol/battery
  11832. COMMAND: enable_life_testing
  11834. USAGE: enable_life_testing [enable]
  11836. DESCRIPTION:
  11837. Enable/disable periodic battery life cycle testing
  11839. EXAMPLES:
  11840. enable_life_testing true -- Enable periodic battery life cycle testing.
  11841. enable_life_testing false -- Disable periodic battery life cycle testing.
  11844. ------------------------------------------------------------------------------
  11846. TABLE: non-vol/battery
  11848. COMMAND: flush {disabled}
  11850. USAGE: flush
  11852. DESCRIPTION:
  11853. For Composite NonVol Settings objects (which contain 1 or more groups of
  11854. NonVol Settings), this command flushes out any unrecognized groups that were
  11855. read from the device. This is useful in cases where the settings group isn't
  11856. needed by another application, and would just waste space.
  11858. EXAMPLES:
  11859. flush --
  11861. ------------------------------------------------------------------------------
  11863. TABLE: non-vol/battery
  11865. COMMAND: if_timeout
  11867. USAGE: if_timeout [cm|ethernet|hpna|usb|bluetooth|wifi] [seconds{-1..1000000}]
  11869. DESCRIPTION:
  11870. Set the power mgmt timeout for the specified interface to the specified
  11871. value.If set to -1 the interface will never enter power mgmt mode.
  11873. EXAMPLES:
  11874. if_timeout ethernet 300 -- Set the ethernet interface to enter power mgmt
  11875. mode after 5 minutes on battery power.
  11877. ------------------------------------------------------------------------------
  11879. TABLE: non-vol/battery
  11881. COMMAND: life_test_period
  11883. USAGE: life_test_period [seconds{0..365}]
  11885. DESCRIPTION:
  11886. Sets the periodic battery life cycle test period (in days between tests on
  11887. any specific pack)
  11889. EXAMPLES:
  11890. life_test_period 90 -- Set life cycle test period to 90 days.
  11891. life_test_period 0 -- Set life cycle test period to zero (i.e. as soon as
  11892. possible).
  11895. ------------------------------------------------------------------------------
  11897. TABLE: non-vol/battery
  11899. COMMAND: life_test_tod
  11901. USAGE: life_test_tod [hh:mm{127}]
  11903. DESCRIPTION:
  11904. Sets GMT time-of-day at which life testing will occur.
  11906. EXAMPLES:
  11907. life_test_tod 22:00 -- Set life cycle test to occur at 10:00PM GMT.
  11910. ------------------------------------------------------------------------------
  11912. TABLE: non-vol/battery
  11914. COMMAND: low_batt_time
  11916. USAGE: low_batt_time [minutes{0..1000}]
  11918. DESCRIPTION:
  11919. Sets the value of upsConfigLowBattTime. See RFC-1628 for details.
  11921. EXAMPLES:
  11922. low_batt_time 30 -- Set upsConfigLowBattTime to 30 minutes.
  11925. ------------------------------------------------------------------------------
  11927. TABLE: non-vol/battery
  11929. COMMAND: low_charge
  11931. USAGE: low_charge [percent{0..100}]
  11933. DESCRIPTION:
  11934. Sets the percentage charge level below which the bcmAlarmLowBatteryCharge
  11935. alarm will be raised.
  11937. EXAMPLES:
  11938. low_charge 25 -- Set the battery low charge level to 80%.
  11941. ------------------------------------------------------------------------------
  11943. TABLE: non-vol/battery
  11945. COMMAND: manufactured
  11947. USAGE: manufactured [both|perm|dyn]
  11949. DESCRIPTION:
  11950. Checks to see if the specified section is manufactured.
  11952. EXAMPLES:
  11953. manufactured -- Checks both Permanent and Dynamic sections
  11954. manufacturing state.
  11955. manufactured perm -- Checks only the Permanent section manufacturing state.
  11957. ------------------------------------------------------------------------------
  11959. TABLE: non-vol/battery
  11961. COMMAND: max_charge
  11963. USAGE: max_charge [percent{0..100}]
  11965. DESCRIPTION:
  11966. Sets the maximum percentage charge level to which the battery will be
  11967. charged.
  11969. EXAMPLES:
  11970. max_charge 80 -- Set the maximum battery charge level to 80%.
  11973. ------------------------------------------------------------------------------
  11975. TABLE: non-vol/battery
  11977. COMMAND: name
  11979. USAGE: name [Name{127}]
  11981. DESCRIPTION:
  11982. Sets the value of upsIdentName. See RFC-1628 for details.
  11984. EXAMPLES:
  11985. name bar -- Set upsIdentName to 'bar'.
  11987. ------------------------------------------------------------------------------
  11989. TABLE: non-vol/battery
  11991. COMMAND: poll_interval
  11993. USAGE: poll_interval [seconds{0..120}]
  11995. DESCRIPTION:
  11996. Sets the interval at which the battery control thread will poll the battery
  11997. for the latest state and charge information.
  11999. EXAMPLES:
  12000. poll_interval 5 -- Set the battery poll interval to 5 seconds.
  12003. ------------------------------------------------------------------------------
  12005. TABLE: non-vol/battery
  12007. COMMAND: read
  12009. USAGE: read [both|perm|dyn]
  12011. DESCRIPTION:
  12012. Reads the specified section of non-volatile settings from non-volatile
  12013. memory. If 'both' is specified or there are no parameters, then both
  12014. Permanent and Dynamic settings will be read. Otherwise, only the section
  12015. specified will be read. This will destroy any changes you have made if you
  12016. haven't written them!
  12018. EXAMPLES:
  12019. read -- Reads both Permanent and Dynamic sections of settings.
  12020. read perm -- Reads only the Permanent section of non-vol settings.
  12022. ------------------------------------------------------------------------------
  12024. TABLE: non-vol/battery
  12026. COMMAND: replacement_threshold
  12028. USAGE: replacement_threshold [percent{0..100}]
  12030. DESCRIPTION:
  12031. Sets the percentage charge level to which the battery must be able to be
  12032. charged in order to be considered valid. If the battery can't be charged to
  12033. at least this level then it will be considered in need of replacement.
  12035. EXAMPLES:
  12036. replacement_threshold 50 -- Set the replacement threshold to 50%.
  12039. ------------------------------------------------------------------------------
  12041. TABLE: non-vol/battery
  12043. COMMAND: show
  12045. USAGE: show
  12047. DESCRIPTION:
  12048. Displays the current non-volatile settings values for both the Permanent and
  12049. Dynamic sections.
  12051. EXAMPLES:
  12052. show --
  12054. ------------------------------------------------------------------------------
  12056. TABLE: non-vol/battery
  12058. COMMAND: stats
  12060. USAGE: stats
  12062. DESCRIPTION:
  12063. Prints stats about buffer usage for Dynamic and Permanent settings.
  12065. EXAMPLES:
  12066. stats --
  12068. ------------------------------------------------------------------------------
  12070. TABLE: non-vol/battery
  12072. COMMAND: tftp_read
  12074. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  12076. DESCRIPTION:
  12077. Causes the Permanent or Dynamic settings data to be read from a server via
  12078. TFTP. The file must be generated correctly, with all of the headers, CRC,
  12079. and other information that would exist on the NonVol device. The file will
  12080. be read and evaluated for correctness before it is stored in the device. If
  12081. the file is rejected then the settings will be read from the device to undo
  12082. any changes. Normally, this will operate on all settings groups; if you
  12083. specify -g then it will operate only on the current group (e.g. if you are in
  12084. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  12085. read).
  12087. EXAMPLES:
  12088. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  12089. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  12091. ------------------------------------------------------------------------------
  12093. TABLE: non-vol/battery
  12095. COMMAND: tftp_write
  12097. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  12099. DESCRIPTION:
  12100. Causes the Permanent or Dynamic settings data to be written to a server via
  12101. TFTP. Normally, this will operate on all settings groups; if you specify -g
  12102. then it will operate only on the current group (e.g. if you are in the SNMP
  12103. nonvol dir, then -g will cause only the SNMP settings group to be written).
  12105. EXAMPLES:
  12106. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  12107. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  12109. ------------------------------------------------------------------------------
  12111. TABLE: non-vol/battery
  12113. COMMAND: write
  12115. USAGE: write [both|perm|dyn]
  12117. DESCRIPTION:
  12118. Writes the specified section of non-volatile settings to non-volatile memory.
  12119. If 'both' is specified or there are no parameters, then both Permanent and
  12120. Dynamic settings will be written. Otherwise, only the section specified will
  12121. be written.
  12123. EXAMPLES:
  12124. write -- Writes both Permanent and Dynamic sections of settings.
  12125. write perm -- Writes only the Permanent section of non-vol settings.
  12127. ------------------------------------------------------------------------------
  12129. TABLE: non-vol/bfcApp
  12131. COMMAND: auto_console
  12133. USAGE: auto_console [true|false]
  12135. DESCRIPTION:
  12136. Sets whether or not the application should automatically stop at the console
  12137. instead of running the application after waiting for the user to hit a key.
  12139. EXAMPLES:
  12140. auto_console -- Shows the current auto_console setting.
  12141. auto_console false -- Waits for the user to hit a key, then runs the app.
  12142. auto_console true -- Automatically breaks out into the console.
  12144. ------------------------------------------------------------------------------
  12146. TABLE: non-vol/bfcApp
  12148. COMMAND: clear_device
  12150. USAGE: clear_device [both|perm|dyn]
  12152. DESCRIPTION:
  12153. Tells the nonvol device to wipe out the specified settings section. All data
  12154. will be lost; the device should be restored to its 'virgin' state. For flash
  12155. devices, the flash block is erased; for disk devices, the file is erased.
  12157. EXAMPLES:
  12158. clear_device -- Clears both Permanent and Dynamic sections.
  12159. clear_device perm -- Clears only the Permanent section.
  12161. ------------------------------------------------------------------------------
  12163. TABLE: non-vol/bfcApp
  12165. COMMAND: console_stop_prompt
  12167. USAGE: console_stop_prompt [true|false]
  12169. DESCRIPTION:
  12170. Sets whether or not the application should wait for a keypress in order to
  12171. stop at the console. Disabling this will speed up boot time.
  12173. EXAMPLES:
  12174. console_stop_prompt 0 -- Disables the console init prompt.
  12176. ------------------------------------------------------------------------------
  12178. TABLE: non-vol/bfcApp
  12180. COMMAND: defaults
  12182. USAGE: defaults [both|perm|dyn]
  12184. DESCRIPTION:
  12185. Restores the settings to default values. NOTE: This does not write to
  12186. NonVol memory! You must do this manually. Also note that some settings do
  12187. not have good defaults, particularly the Permanent section! Use this command
  12188. with extreme care!
  12190. EXAMPLES:
  12191. defaults -- Sets both Permanent and Dynamic sections to defaults.
  12192. defaults perm -- Sets only the Permanent section to defaults.
  12194. ------------------------------------------------------------------------------
  12196. TABLE: non-vol/bfcApp
  12198. COMMAND: del_extra_data
  12200. USAGE: del_extra_data [both|perm|dyn]
  12202. DESCRIPTION:
  12203. Gets rid of any extra data that is assiociated with the settings. The extra
  12204. data is usually caused by a downgrade, where settings written by a newer
  12205. version are not understood by the older version, but are stored so that they
  12206. will still exist when the new code is run. However, in some cases, it is
  12207. desirable to get rid of them if they are not going to be used.
  12209. EXAMPLES:
  12210. del_extra_data perm -- Gets rid of extra permanent data.
  12212. ------------------------------------------------------------------------------
  12214. TABLE: non-vol/bfcApp
  12216. COMMAND: driver_init_prompt
  12218. USAGE: driver_init_prompt [true|false]
  12220. DESCRIPTION:
  12221. Sets whether or not the application should wait for a keypress in order to
  12222. bypass driver initialization. Disabling this will speed up boot time.
  12224. EXAMPLES:
  12225. driver_init_prompt 0 -- Disables the driver init prompt.
  12227. ------------------------------------------------------------------------------
  12229. TABLE: non-vol/bfcApp
  12231. COMMAND: flush {disabled}
  12233. USAGE: flush
  12235. DESCRIPTION:
  12236. For Composite NonVol Settings objects (which contain 1 or more groups of
  12237. NonVol Settings), this command flushes out any unrecognized groups that were
  12238. read from the device. This is useful in cases where the settings group isn't
  12239. needed by another application, and would just waste space.
  12241. EXAMPLES:
  12242. flush --
  12244. ------------------------------------------------------------------------------
  12246. TABLE: non-vol/bfcApp
  12248. COMMAND: manufactured
  12250. USAGE: manufactured [both|perm|dyn]
  12252. DESCRIPTION:
  12253. Checks to see if the specified section is manufactured.
  12255. EXAMPLES:
  12256. manufactured -- Checks both Permanent and Dynamic sections
  12257. manufacturing state.
  12258. manufactured perm -- Checks only the Permanent section manufacturing state.
  12260. ------------------------------------------------------------------------------
  12262. TABLE: non-vol/bfcApp
  12264. COMMAND: read
  12266. USAGE: read [both|perm|dyn]
  12268. DESCRIPTION:
  12269. Reads the specified section of non-volatile settings from non-volatile
  12270. memory. If 'both' is specified or there are no parameters, then both
  12271. Permanent and Dynamic settings will be read. Otherwise, only the section
  12272. specified will be read. This will destroy any changes you have made if you
  12273. haven't written them!
  12275. EXAMPLES:
  12276. read -- Reads both Permanent and Dynamic sections of settings.
  12277. read perm -- Reads only the Permanent section of non-vol settings.
  12279. ------------------------------------------------------------------------------
  12281. TABLE: non-vol/bfcApp
  12283. COMMAND: serial_console
  12285. USAGE: serial_console [disable|ro|rw]
  12287. DESCRIPTION:
  12288. Sets level of serial console availability.
  12289. disable - console input and output are disabled.
  12290. ro (read-only) - console input is disabled but output is enabled.
  12291. rw (read-write) - console input and output are enabled.
  12292. NOTE: chaing this setting via the console will not take effect until the next
  12293. reboot. If it took effect immediately then it would not be possible to issue
  12294. the 'write' command...
  12296. EXAMPLES:
  12297. serial_console disable -- Completely disable the console - no input or
  12298. output.
  12299. serial_console rw -- Completely enable the console - input and output.
  12302. ------------------------------------------------------------------------------
  12304. TABLE: non-vol/bfcApp
  12306. COMMAND: show
  12308. USAGE: show
  12310. DESCRIPTION:
  12311. Displays the current non-volatile settings values for both the Permanent and
  12312. Dynamic sections.
  12314. EXAMPLES:
  12315. show --
  12317. ------------------------------------------------------------------------------
  12319. TABLE: non-vol/bfcApp
  12321. COMMAND: stats
  12323. USAGE: stats
  12325. DESCRIPTION:
  12326. Prints stats about buffer usage for Dynamic and Permanent settings.
  12328. EXAMPLES:
  12329. stats --
  12331. ------------------------------------------------------------------------------
  12333. TABLE: non-vol/bfcApp
  12335. COMMAND: tftp_read
  12337. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  12339. DESCRIPTION:
  12340. Causes the Permanent or Dynamic settings data to be read from a server via
  12341. TFTP. The file must be generated correctly, with all of the headers, CRC,
  12342. and other information that would exist on the NonVol device. The file will
  12343. be read and evaluated for correctness before it is stored in the device. If
  12344. the file is rejected then the settings will be read from the device to undo
  12345. any changes. Normally, this will operate on all settings groups; if you
  12346. specify -g then it will operate only on the current group (e.g. if you are in
  12347. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  12348. read).
  12350. EXAMPLES:
  12351. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  12352. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  12354. ------------------------------------------------------------------------------
  12356. TABLE: non-vol/bfcApp
  12358. COMMAND: tftp_write
  12360. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  12362. DESCRIPTION:
  12363. Causes the Permanent or Dynamic settings data to be written to a server via
  12364. TFTP. Normally, this will operate on all settings groups; if you specify -g
  12365. then it will operate only on the current group (e.g. if you are in the SNMP
  12366. nonvol dir, then -g will cause only the SNMP settings group to be written).
  12368. EXAMPLES:
  12369. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  12370. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  12372. ------------------------------------------------------------------------------
  12374. TABLE: non-vol/bfcApp
  12376. COMMAND: write
  12378. USAGE: write [both|perm|dyn]
  12380. DESCRIPTION:
  12381. Writes the specified section of non-volatile settings to non-volatile memory.
  12382. If 'both' is specified or there are no parameters, then both Permanent and
  12383. Dynamic settings will be written. Otherwise, only the section specified will
  12384. be written.
  12386. EXAMPLES:
  12387. write -- Writes both Permanent and Dynamic sections of settings.
  12388. write perm -- Writes only the Permanent section of non-vol settings.
  12390. ------------------------------------------------------------------------------
  12392. TABLE: non-vol/bpi
  12394. COMMAND: change_key
  12396. USAGE: change_key public|private|root|cm_cert|ca_cert|cvc_root|cvc_ca
  12398. DESCRIPTION:
  12399. Prompts you for the new key value to be used. You will enter the number of
  12400. values to be used first, then you will be prompted for each value, one at a
  12401. time. If you hit Esc or Enter without specifying a new value, then this will
  12402. be aborted. The keyName parameter is one of the following:
  12404. public -- BPI Public Key
  12405. private -- BPI Private Key
  12406. root -- BPI+ Root Public Key
  12407. cm_cert -- BPI+ CM Certificate
  12408. ca_cert -- BPI+ CA Certificate
  12410. EXAMPLES:
  12411. change_key public -- Begins prompting you for the new BPI Public Key.
  12413. ------------------------------------------------------------------------------
  12415. TABLE: non-vol/bpi
  12417. COMMAND: clear_device
  12419. USAGE: clear_device [both|perm|dyn]
  12421. DESCRIPTION:
  12422. Tells the nonvol device to wipe out the specified settings section. All data
  12423. will be lost; the device should be restored to its 'virgin' state. For flash
  12424. devices, the flash block is erased; for disk devices, the file is erased.
  12426. EXAMPLES:
  12427. clear_device -- Clears both Permanent and Dynamic sections.
  12428. clear_device perm -- Clears only the Permanent section.
  12430. ------------------------------------------------------------------------------
  12432. TABLE: non-vol/bpi
  12434. COMMAND: code_access
  12436. USAGE: code_access
  12438. DESCRIPTION:
  12439. Prompts you for the new Secure s/w dload Code Access Start value to be used.
  12440. This is a fixed 12 byte field. You will be prompted for each value, one at a
  12441. time. If you hit Esc or Enter without specifying a new value, then this will
  12442. be aborted.
  12444. EXAMPLES:
  12445. code_access -- Begins prompting you for the new Code Access Start value.
  12447. ------------------------------------------------------------------------------
  12449. TABLE: non-vol/bpi
  12451. COMMAND: cvc_access
  12453. USAGE: cvc_access
  12455. DESCRIPTION:
  12456. Prompts you for the new Secure s/w dload CVC Access Start value to be used.
  12457. This is a fixed 12 byte field. You will be prompted for each value, one at a
  12458. time. If you hit Esc or Enter without specifying a new value, then this will
  12459. be aborted.
  12461. EXAMPLES:
  12462. cvc_access -- Begins prompting you for the new CVC Access Start value.
  12464. ------------------------------------------------------------------------------
  12466. TABLE: non-vol/bpi
  12468. COMMAND: defaults
  12470. USAGE: defaults [both|perm|dyn]
  12472. DESCRIPTION:
  12473. Restores the settings to default values. NOTE: This does not write to
  12474. NonVol memory! You must do this manually. Also note that some settings do
  12475. not have good defaults, particularly the Permanent section! Use this command
  12476. with extreme care!
  12478. EXAMPLES:
  12479. defaults -- Sets both Permanent and Dynamic sections to defaults.
  12480. defaults perm -- Sets only the Permanent section to defaults.
  12482. ------------------------------------------------------------------------------
  12484. TABLE: non-vol/bpi
  12486. COMMAND: del_extra_data
  12488. USAGE: del_extra_data [both|perm|dyn]
  12490. DESCRIPTION:
  12491. Gets rid of any extra data that is assiociated with the settings. The extra
  12492. data is usually caused by a downgrade, where settings written by a newer
  12493. version are not understood by the older version, but are stored so that they
  12494. will still exist when the new code is run. However, in some cases, it is
  12495. desirable to get rid of them if they are not going to be used.
  12497. EXAMPLES:
  12498. del_extra_data perm -- Gets rid of extra permanent data.
  12500. ------------------------------------------------------------------------------
  12502. TABLE: non-vol/bpi
  12504. COMMAND: flush {disabled}
  12506. USAGE: flush
  12508. DESCRIPTION:
  12509. For Composite NonVol Settings objects (which contain 1 or more groups of
  12510. NonVol Settings), this command flushes out any unrecognized groups that were
  12511. read from the device. This is useful in cases where the settings group isn't
  12512. needed by another application, and would just waste space.
  12514. EXAMPLES:
  12515. flush --
  12517. ------------------------------------------------------------------------------
  12519. TABLE: non-vol/bpi
  12521. COMMAND: key_location
  12523. USAGE: key_location root|ca_cert [boolIsDynamic]
  12525. DESCRIPTION:
  12526. Sets the location (dynamic or permanent) of the key value to be used. These
  12527. keys are placed in permanent settings at manufacturing time, but can be
  12528. upgraded later, in which case they will be stored in dynamic. This command
  12529. allows you to override the automatic decision of which value to use. The key
  12530. name parameter is one of the following:
  12532. root -- BPI+ Root Public Key
  12533. ca_cert -- BPI+ CA Certificate
  12535. EXAMPLES:
  12536. key_location root false -- Sets the BPI+ Root Public Key to use Permanent
  12538. ------------------------------------------------------------------------------
  12540. TABLE: non-vol/bpi
  12542. COMMAND: manufactured
  12544. USAGE: manufactured [both|perm|dyn]
  12546. DESCRIPTION:
  12547. Checks to see if the specified section is manufactured.
  12549. EXAMPLES:
  12550. manufactured -- Checks both Permanent and Dynamic sections
  12551. manufacturing state.
  12552. manufactured perm -- Checks only the Permanent section manufacturing state.
  12554. ------------------------------------------------------------------------------
  12556. TABLE: non-vol/bpi
  12558. COMMAND: print
  12560. USAGE: print public|private|root|cm_cert|ca_cert|cvc_root|cvc_ca
  12562. DESCRIPTION:
  12563. Displays the value for the key name that is specified. The key values are
  12564. not displayed with the 'show' command in order to keep them from overflowing
  12565. the screen. The keyName parameter is one of the following:
  12567. public -- BPI Public Key
  12568. private -- BPI Private Key
  12569. root -- BPI+ Root Public Key
  12570. cm_cert -- BPI+ CM Certificate
  12571. ca_cert -- BPI+ CA Certificate
  12572. cvc_root -- BPI+ CVC Rott CA Certificate
  12573. cvc_ca -- BPI+ CVC CA Certificate
  12575. EXAMPLES:
  12576. print public -- Prints the BPI Public Key.
  12578. ------------------------------------------------------------------------------
  12580. TABLE: non-vol/bpi
  12582. COMMAND: read
  12584. USAGE: read [both|perm|dyn]
  12586. DESCRIPTION:
  12587. Reads the specified section of non-volatile settings from non-volatile
  12588. memory. If 'both' is specified or there are no parameters, then both
  12589. Permanent and Dynamic settings will be read. Otherwise, only the section
  12590. specified will be read. This will destroy any changes you have made if you
  12591. haven't written them!
  12593. EXAMPLES:
  12594. read -- Reads both Permanent and Dynamic sections of settings.
  12595. read perm -- Reads only the Permanent section of non-vol settings.
  12597. ------------------------------------------------------------------------------
  12599. TABLE: non-vol/bpi
  12601. COMMAND: show
  12603. USAGE: show
  12605. DESCRIPTION:
  12606. Displays the current non-volatile settings values for both the Permanent and
  12607. Dynamic sections.
  12609. EXAMPLES:
  12610. show --
  12612. ------------------------------------------------------------------------------
  12614. TABLE: non-vol/bpi
  12616. COMMAND: stats
  12618. USAGE: stats
  12620. DESCRIPTION:
  12621. Prints stats about buffer usage for Dynamic and Permanent settings.
  12623. EXAMPLES:
  12624. stats --
  12626. ------------------------------------------------------------------------------
  12628. TABLE: non-vol/bpi
  12630. COMMAND: tftp_read
  12632. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  12634. DESCRIPTION:
  12635. Causes the Permanent or Dynamic settings data to be read from a server via
  12636. TFTP. The file must be generated correctly, with all of the headers, CRC,
  12637. and other information that would exist on the NonVol device. The file will
  12638. be read and evaluated for correctness before it is stored in the device. If
  12639. the file is rejected then the settings will be read from the device to undo
  12640. any changes. Normally, this will operate on all settings groups; if you
  12641. specify -g then it will operate only on the current group (e.g. if you are in
  12642. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  12643. read).
  12645. EXAMPLES:
  12646. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  12647. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  12649. ------------------------------------------------------------------------------
  12651. TABLE: non-vol/bpi
  12653. COMMAND: tftp_write
  12655. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  12657. DESCRIPTION:
  12658. Causes the Permanent or Dynamic settings data to be written to a server via
  12659. TFTP. Normally, this will operate on all settings groups; if you specify -g
  12660. then it will operate only on the current group (e.g. if you are in the SNMP
  12661. nonvol dir, then -g will cause only the SNMP settings group to be written).
  12663. EXAMPLES:
  12664. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  12665. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  12667. ------------------------------------------------------------------------------
  12669. TABLE: non-vol/bpi
  12671. COMMAND: write
  12673. USAGE: write [both|perm|dyn]
  12675. DESCRIPTION:
  12676. Writes the specified section of non-volatile settings to non-volatile memory.
  12677. If 'both' is specified or there are no parameters, then both Permanent and
  12678. Dynamic settings will be written. Otherwise, only the section specified will
  12679. be written.
  12681. EXAMPLES:
  12682. write -- Writes both Permanent and Dynamic sections of settings.
  12683. write perm -- Writes only the Permanent section of non-vol settings.
  12685. ------------------------------------------------------------------------------
  12687. TABLE: non-vol/cap
  12689. COMMAND: add_cap_mapping
  12691. USAGE: add_cap_mapping
  12693. DESCRIPTION:
  12694. Presents you with a series of prompts that allows one to add a CAP mapping.
  12696. EXAMPLES:
  12697. add_cap_mapping -- Prompts you for the new CAP mapping.
  12699. ------------------------------------------------------------------------------
  12701. TABLE: non-vol/cap
  12703. COMMAND: add_passthrough
  12705. USAGE: add_passthrough Passthrough Index{1..65535} [MacAddress]
  12707. DESCRIPTION:
  12708. Adds a passthrough mac address to the passthrough table
  12710. EXAMPLES:
  12711. add_passthrough 1 00:10:18:50:10:32 -- Sets the passthrough address with
  12712. index 1.
  12714. ------------------------------------------------------------------------------
  12716. TABLE: non-vol/cap
  12718. COMMAND: clear_device
  12720. USAGE: clear_device [both|perm|dyn]
  12722. DESCRIPTION:
  12723. Tells the nonvol device to wipe out the specified settings section. All data
  12724. will be lost; the device should be restored to its 'virgin' state. For flash
  12725. devices, the flash block is erased; for disk devices, the file is erased.
  12727. EXAMPLES:
  12728. clear_device -- Clears both Permanent and Dynamic sections.
  12729. clear_device perm -- Clears only the Permanent section.
  12731. ------------------------------------------------------------------------------
  12733. TABLE: non-vol/cap
  12735. COMMAND: defaults
  12737. USAGE: defaults [both|perm|dyn]
  12739. DESCRIPTION:
  12740. Restores the settings to default values. NOTE: This does not write to
  12741. NonVol memory! You must do this manually. Also note that some settings do
  12742. not have good defaults, particularly the Permanent section! Use this command
  12743. with extreme care!
  12745. EXAMPLES:
  12746. defaults -- Sets both Permanent and Dynamic sections to defaults.
  12747. defaults perm -- Sets only the Permanent section to defaults.
  12749. ------------------------------------------------------------------------------
  12751. TABLE: non-vol/cap
  12753. COMMAND: del_cap_mapping
  12755. USAGE: del_cap_mapping
  12757. DESCRIPTION:
  12758. Presents you the cap mapping index to delete a CAP mapping.
  12760. EXAMPLES:
  12761. delete_cap_mapping -- Prompts you to delete a CAP mapping index.
  12763. ------------------------------------------------------------------------------
  12765. TABLE: non-vol/cap
  12767. COMMAND: del_extra_data
  12769. USAGE: del_extra_data [both|perm|dyn]
  12771. DESCRIPTION:
  12772. Gets rid of any extra data that is assiociated with the settings. The extra
  12773. data is usually caused by a downgrade, where settings written by a newer
  12774. version are not understood by the older version, but are stored so that they
  12775. will still exist when the new code is run. However, in some cases, it is
  12776. desirable to get rid of them if they are not going to be used.
  12778. EXAMPLES:
  12779. del_extra_data perm -- Gets rid of extra permanent data.
  12781. ------------------------------------------------------------------------------
  12783. TABLE: non-vol/cap
  12785. COMMAND: del_passthrough
  12787. USAGE: del_passthrough Passthrough Index{1..65535}
  12789. DESCRIPTION:
  12790. Deletes the passthrough mac address from the passthrough table
  12792. EXAMPLES:
  12793. delete_passthrough 1 -- Removes the passthrough address associated with
  12794. index 1
  12796. ------------------------------------------------------------------------------
  12798. TABLE: non-vol/cap
  12800. COMMAND: flush {disabled}
  12802. USAGE: flush
  12804. DESCRIPTION:
  12805. For Composite NonVol Settings objects (which contain 1 or more groups of
  12806. NonVol Settings), this command flushes out any unrecognized groups that were
  12807. read from the device. This is useful in cases where the settings group isn't
  12808. needed by another application, and would just waste space.
  12810. EXAMPLES:
  12811. flush --
  12813. ------------------------------------------------------------------------------
  12815. TABLE: non-vol/cap
  12817. COMMAND: manufactured
  12819. USAGE: manufactured [both|perm|dyn]
  12821. DESCRIPTION:
  12822. Checks to see if the specified section is manufactured.
  12824. EXAMPLES:
  12825. manufactured -- Checks both Permanent and Dynamic sections
  12826. manufacturing state.
  12827. manufactured perm -- Checks only the Permanent section manufacturing state.
  12829. ------------------------------------------------------------------------------
  12831. TABLE: non-vol/cap
  12833. COMMAND: primary_mode
  12835. USAGE: primary_mode mode{1..3}
  12837. DESCRIPTION:
  12838. Sets the Cap Primary mode to value:
  12839. (1) NAPT (2) NAT (3) CAPT
  12841. EXAMPLES:
  12842. primary_mode 2 - NAT -- .
  12844. ------------------------------------------------------------------------------
  12846. TABLE: non-vol/cap
  12848. COMMAND: provisioning_mode
  12850. USAGE: provisioning_mode mode{1..3}
  12852. DESCRIPTION:
  12853. Sets the Provisioining mode to value:
  12854. (1) DISABLED (2) DHCP (3) DORMANT
  12856. EXAMPLES:
  12857. provisioning_mode 2 - DHCP -- .
  12859. ------------------------------------------------------------------------------
  12861. TABLE: non-vol/cap
  12863. COMMAND: read
  12865. USAGE: read [both|perm|dyn]
  12867. DESCRIPTION:
  12868. Reads the specified section of non-volatile settings from non-volatile
  12869. memory. If 'both' is specified or there are no parameters, then both
  12870. Permanent and Dynamic settings will be read. Otherwise, only the section
  12871. specified will be read. This will destroy any changes you have made if you
  12872. haven't written them!
  12874. EXAMPLES:
  12875. read -- Reads both Permanent and Dynamic sections of settings.
  12876. read perm -- Reads only the Permanent section of non-vol settings.
  12878. ------------------------------------------------------------------------------
  12880. TABLE: non-vol/cap
  12882. COMMAND: show
  12884. USAGE: show
  12886. DESCRIPTION:
  12887. Displays the current non-volatile settings values for both the Permanent and
  12888. Dynamic sections.
  12890. EXAMPLES:
  12891. show --
  12893. ------------------------------------------------------------------------------
  12895. TABLE: non-vol/cap
  12897. COMMAND: stats
  12899. USAGE: stats
  12901. DESCRIPTION:
  12902. Prints stats about buffer usage for Dynamic and Permanent settings.
  12904. EXAMPLES:
  12905. stats --
  12907. ------------------------------------------------------------------------------
  12909. TABLE: non-vol/cap
  12911. COMMAND: tftp_read
  12913. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  12915. DESCRIPTION:
  12916. Causes the Permanent or Dynamic settings data to be read from a server via
  12917. TFTP. The file must be generated correctly, with all of the headers, CRC,
  12918. and other information that would exist on the NonVol device. The file will
  12919. be read and evaluated for correctness before it is stored in the device. If
  12920. the file is rejected then the settings will be read from the device to undo
  12921. any changes. Normally, this will operate on all settings groups; if you
  12922. specify -g then it will operate only on the current group (e.g. if you are in
  12923. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  12924. read).
  12926. EXAMPLES:
  12927. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  12928. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  12930. ------------------------------------------------------------------------------
  12932. TABLE: non-vol/cap
  12934. COMMAND: tftp_write
  12936. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  12938. DESCRIPTION:
  12939. Causes the Permanent or Dynamic settings data to be written to a server via
  12940. TFTP. Normally, this will operate on all settings groups; if you specify -g
  12941. then it will operate only on the current group (e.g. if you are in the SNMP
  12942. nonvol dir, then -g will cause only the SNMP settings group to be written).
  12944. EXAMPLES:
  12945. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  12946. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  12948. ------------------------------------------------------------------------------
  12950. TABLE: non-vol/cap
  12952. COMMAND: wanipconnection_enable
  12954. USAGE: wanipconnection_enable [true|false]
  12956. DESCRIPTION:
  12957. Enable or disable the UPnP WanIpConnection service.
  12959. EXAMPLES:
  12960. wanipconnection_enable true - enables the UPnP WanIpConnection service. -- .
  12962. ------------------------------------------------------------------------------
  12964. TABLE: non-vol/cap
  12966. COMMAND: write
  12968. USAGE: write [both|perm|dyn]
  12970. DESCRIPTION:
  12971. Writes the specified section of non-volatile settings to non-volatile memory.
  12972. If 'both' is specified or there are no parameters, then both Permanent and
  12973. Dynamic settings will be written. Otherwise, only the section specified will
  12974. be written.
  12976. EXAMPLES:
  12977. write -- Writes both Permanent and Dynamic sections of settings.
  12978. write perm -- Writes only the Permanent section of non-vol settings.
  12980. ------------------------------------------------------------------------------
  12982. TABLE: non-vol/cdp
  12984. COMMAND: add_lan_addr
  12986. USAGE: add_lan_addr
  12988. DESCRIPTION:
  12989. Presents you with a series of prompts that allows one to add a lan entry.
  12991. EXAMPLES:
  12992. add_lan_addr -- Prompts you for the new lan entry.
  12994. ------------------------------------------------------------------------------
  12996. TABLE: non-vol/cdp
  12998. COMMAND: add_wan_data
  13000. USAGE: add_wan_data
  13002. DESCRIPTION:
  13003. Presents you with a series of prompts that allows one to add a wan data
  13004. entry.
  13006. EXAMPLES:
  13007. add_wan_data -- Prompts you for the new wan data entry.
  13009. ------------------------------------------------------------------------------
  13011. TABLE: non-vol/cdp
  13013. COMMAND: add_wan_server
  13015. USAGE: add_wan_server
  13017. DESCRIPTION:
  13018. Presents you with a series of prompts that allows one to add a wan data
  13019. server entry.
  13021. EXAMPLES:
  13022. add_wan_server -- Prompts you for the new wan data entry.
  13024. ------------------------------------------------------------------------------
  13026. TABLE: non-vol/cdp
  13028. COMMAND: cds_settings
  13030. USAGE: cds_settings
  13032. DESCRIPTION:
  13033. Presents you with a series of prompts that allows one set the CDS ( DHCP
  13034. Server ) settings.
  13036. EXAMPLES:
  13037. cds_settings -- Prompts you to CDS settings.
  13039. ------------------------------------------------------------------------------
  13041. TABLE: non-vol/cdp
  13043. COMMAND: clear_device
  13045. USAGE: clear_device [both|perm|dyn]
  13047. DESCRIPTION:
  13048. Tells the nonvol device to wipe out the specified settings section. All data
  13049. will be lost; the device should be restored to its 'virgin' state. For flash
  13050. devices, the flash block is erased; for disk devices, the file is erased.
  13052. EXAMPLES:
  13053. clear_device -- Clears both Permanent and Dynamic sections.
  13054. clear_device perm -- Clears only the Permanent section.
  13056. ------------------------------------------------------------------------------
  13058. TABLE: non-vol/cdp
  13060. COMMAND: defaults
  13062. USAGE: defaults [both|perm|dyn]
  13064. DESCRIPTION:
  13065. Restores the settings to default values. NOTE: This does not write to
  13066. NonVol memory! You must do this manually. Also note that some settings do
  13067. not have good defaults, particularly the Permanent section! Use this command
  13068. with extreme care!
  13070. EXAMPLES:
  13071. defaults -- Sets both Permanent and Dynamic sections to defaults.
  13072. defaults perm -- Sets only the Permanent section to defaults.
  13074. ------------------------------------------------------------------------------
  13076. TABLE: non-vol/cdp
  13078. COMMAND: del_extra_data
  13080. USAGE: del_extra_data [both|perm|dyn]
  13082. DESCRIPTION:
  13083. Gets rid of any extra data that is assiociated with the settings. The extra
  13084. data is usually caused by a downgrade, where settings written by a newer
  13085. version are not understood by the older version, but are stored so that they
  13086. will still exist when the new code is run. However, in some cases, it is
  13087. desirable to get rid of them if they are not going to be used.
  13089. EXAMPLES:
  13090. del_extra_data perm -- Gets rid of extra permanent data.
  13092. ------------------------------------------------------------------------------
  13094. TABLE: non-vol/cdp
  13096. COMMAND: del_lan_addr
  13098. USAGE: del_lan_addr
  13100. DESCRIPTION:
  13101. Presents you with a series of prompts that allows one to delete a lan entry.
  13103. EXAMPLES:
  13104. del_lan_addr -- Prompts you to delete a lan entry.
  13106. ------------------------------------------------------------------------------
  13108. TABLE: non-vol/cdp
  13110. COMMAND: del_wan_data
  13112. USAGE: del_wan_data
  13114. DESCRIPTION:
  13115. Presents you with a series of prompts that allows one to delete a wan data
  13116. entry.
  13118. EXAMPLES:
  13119. del_wan_data -- Prompts you to delete a wan data entry.
  13121. ------------------------------------------------------------------------------
  13123. TABLE: non-vol/cdp
  13125. COMMAND: del_wan_server
  13127. USAGE: del_wan_server
  13129. DESCRIPTION:
  13130. Presents you with a series of prompts that allows one to delete a wan data
  13131. server entry.
  13133. EXAMPLES:
  13134. del_wan_server -- Prompts you to delete a wan data entry.
  13136. ------------------------------------------------------------------------------
  13138. TABLE: non-vol/cdp
  13140. COMMAND: flush {disabled}
  13142. USAGE: flush
  13144. DESCRIPTION:
  13145. For Composite NonVol Settings objects (which contain 1 or more groups of
  13146. NonVol Settings), this command flushes out any unrecognized groups that were
  13147. read from the device. This is useful in cases where the settings group isn't
  13148. needed by another application, and would just waste space.
  13150. EXAMPLES:
  13151. flush --
  13153. ------------------------------------------------------------------------------
  13155. TABLE: non-vol/cdp
  13157. COMMAND: lan_trans_action
  13159. USAGE: lan_trans_action [action{1..2}]
  13161. DESCRIPTION:
  13162. (1) normal (2) no assignment
  13164. EXAMPLES:
  13165. lan_trans_action 1 -- Sets the action to normal
  13168. ------------------------------------------------------------------------------
  13170. TABLE: non-vol/cdp
  13172. COMMAND: lan_trans_threshold
  13174. USAGE: lan_trans_threshold [threshold{1..65533}]
  13176. DESCRIPTION:
  13177. Tbd
  13179. EXAMPLES:
  13180. lan_trans_threshold 10 -- Sets the threshold to 2
  13183. ------------------------------------------------------------------------------
  13185. TABLE: non-vol/cdp
  13187. COMMAND: manufactured
  13189. USAGE: manufactured [both|perm|dyn]
  13191. DESCRIPTION:
  13192. Checks to see if the specified section is manufactured.
  13194. EXAMPLES:
  13195. manufactured -- Checks both Permanent and Dynamic sections
  13196. manufacturing state.
  13197. manufactured perm -- Checks only the Permanent section manufacturing state.
  13199. ------------------------------------------------------------------------------
  13201. TABLE: non-vol/cdp
  13203. COMMAND: read
  13205. USAGE: read [both|perm|dyn]
  13207. DESCRIPTION:
  13208. Reads the specified section of non-volatile settings from non-volatile
  13209. memory. If 'both' is specified or there are no parameters, then both
  13210. Permanent and Dynamic settings will be read. Otherwise, only the section
  13211. specified will be read. This will destroy any changes you have made if you
  13212. haven't written them!
  13214. EXAMPLES:
  13215. read -- Reads both Permanent and Dynamic sections of settings.
  13216. read perm -- Reads only the Permanent section of non-vol settings.
  13218. ------------------------------------------------------------------------------
  13220. TABLE: non-vol/cdp
  13222. COMMAND: show
  13224. USAGE: show
  13226. DESCRIPTION:
  13227. Displays the current non-volatile settings values for both the Permanent and
  13228. Dynamic sections.
  13230. EXAMPLES:
  13231. show --
  13233. ------------------------------------------------------------------------------
  13235. TABLE: non-vol/cdp
  13237. COMMAND: stats
  13239. USAGE: stats
  13241. DESCRIPTION:
  13242. Prints stats about buffer usage for Dynamic and Permanent settings.
  13244. EXAMPLES:
  13245. stats --
  13247. ------------------------------------------------------------------------------
  13249. TABLE: non-vol/cdp
  13251. COMMAND: tftp_read
  13253. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  13255. DESCRIPTION:
  13256. Causes the Permanent or Dynamic settings data to be read from a server via
  13257. TFTP. The file must be generated correctly, with all of the headers, CRC,
  13258. and other information that would exist on the NonVol device. The file will
  13259. be read and evaluated for correctness before it is stored in the device. If
  13260. the file is rejected then the settings will be read from the device to undo
  13261. any changes. Normally, this will operate on all settings groups; if you
  13262. specify -g then it will operate only on the current group (e.g. if you are in
  13263. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  13264. read).
  13266. EXAMPLES:
  13267. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  13268. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  13270. ------------------------------------------------------------------------------
  13272. TABLE: non-vol/cdp
  13274. COMMAND: tftp_write
  13276. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  13278. DESCRIPTION:
  13279. Causes the Permanent or Dynamic settings data to be written to a server via
  13280. TFTP. Normally, this will operate on all settings groups; if you specify -g
  13281. then it will operate only on the current group (e.g. if you are in the SNMP
  13282. nonvol dir, then -g will cause only the SNMP settings group to be written).
  13284. EXAMPLES:
  13285. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  13286. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  13288. ------------------------------------------------------------------------------
  13290. TABLE: non-vol/cdp
  13292. COMMAND: wan_ip_addr_cnt
  13294. USAGE: wan_ip_addr_cnt [count{0..63}]
  13296. DESCRIPTION:
  13297. Tbd
  13299. EXAMPLES:
  13300. wan_ip_addr_cnt 5 -- Set the count to 5
  13303. ------------------------------------------------------------------------------
  13305. TABLE: non-vol/cdp
  13307. COMMAND: wins_servers
  13309. USAGE: wins_servers
  13311. DESCRIPTION:
  13312. Prompts user to enter WINS server IP addresses to pass to CPEs via DHCP
  13313. server.
  13315. EXAMPLES:
  13316. wins_servers -- Prompts you to WINS servers settings.
  13318. ------------------------------------------------------------------------------
  13320. TABLE: non-vol/cdp
  13322. COMMAND: write
  13324. USAGE: write [both|perm|dyn]
  13326. DESCRIPTION:
  13327. Writes the specified section of non-volatile settings to non-volatile memory.
  13328. If 'both' is specified or there are no parameters, then both Permanent and
  13329. Dynamic settings will be written. Otherwise, only the section specified will
  13330. be written.
  13332. EXAMPLES:
  13333. write -- Writes both Permanent and Dynamic sections of settings.
  13334. write perm -- Writes only the Permanent section of non-vol settings.
  13336. ------------------------------------------------------------------------------
  13338. TABLE: non-vol/cmp
  13340. COMMAND: clear_device
  13342. USAGE: clear_device [both|perm|dyn]
  13344. DESCRIPTION:
  13345. Tells the nonvol device to wipe out the specified settings section. All data
  13346. will be lost; the device should be restored to its 'virgin' state. For flash
  13347. devices, the flash block is erased; for disk devices, the file is erased.
  13349. EXAMPLES:
  13350. clear_device -- Clears both Permanent and Dynamic sections.
  13351. clear_device perm -- Clears only the Permanent section.
  13353. ------------------------------------------------------------------------------
  13355. TABLE: non-vol/cmp
  13357. COMMAND: defaults
  13359. USAGE: defaults [both|perm|dyn]
  13361. DESCRIPTION:
  13362. Restores the settings to default values. NOTE: This does not write to
  13363. NonVol memory! You must do this manually. Also note that some settings do
  13364. not have good defaults, particularly the Permanent section! Use this command
  13365. with extreme care!
  13367. EXAMPLES:
  13368. defaults -- Sets both Permanent and Dynamic sections to defaults.
  13369. defaults perm -- Sets only the Permanent section to defaults.
  13371. ------------------------------------------------------------------------------
  13373. TABLE: non-vol/cmp
  13375. COMMAND: del_extra_data
  13377. USAGE: del_extra_data [both|perm|dyn]
  13379. DESCRIPTION:
  13380. Gets rid of any extra data that is assiociated with the settings. The extra
  13381. data is usually caused by a downgrade, where settings written by a newer
  13382. version are not understood by the older version, but are stored so that they
  13383. will still exist when the new code is run. However, in some cases, it is
  13384. desirable to get rid of them if they are not going to be used.
  13386. EXAMPLES:
  13387. del_extra_data perm -- Gets rid of extra permanent data.
  13389. ------------------------------------------------------------------------------
  13391. TABLE: non-vol/cmp
  13393. COMMAND: flush {disabled}
  13395. USAGE: flush
  13397. DESCRIPTION:
  13398. For Composite NonVol Settings objects (which contain 1 or more groups of
  13399. NonVol Settings), this command flushes out any unrecognized groups that were
  13400. read from the device. This is useful in cases where the settings group isn't
  13401. needed by another application, and would just waste space.
  13403. EXAMPLES:
  13404. flush --
  13406. ------------------------------------------------------------------------------
  13408. TABLE: non-vol/cmp
  13410. COMMAND: manufactured
  13412. USAGE: manufactured [both|perm|dyn]
  13414. DESCRIPTION:
  13415. Checks to see if the specified section is manufactured.
  13417. EXAMPLES:
  13418. manufactured -- Checks both Permanent and Dynamic sections
  13419. manufacturing state.
  13420. manufactured perm -- Checks only the Permanent section manufacturing state.
  13422. ------------------------------------------------------------------------------
  13424. TABLE: non-vol/cmp
  13426. COMMAND: read
  13428. USAGE: read [both|perm|dyn]
  13430. DESCRIPTION:
  13431. Reads the specified section of non-volatile settings from non-volatile
  13432. memory. If 'both' is specified or there are no parameters, then both
  13433. Permanent and Dynamic settings will be read. Otherwise, only the section
  13434. specified will be read. This will destroy any changes you have made if you
  13435. haven't written them!
  13437. EXAMPLES:
  13438. read -- Reads both Permanent and Dynamic sections of settings.
  13439. read perm -- Reads only the Permanent section of non-vol settings.
  13441. ------------------------------------------------------------------------------
  13443. TABLE: non-vol/cmp
  13445. COMMAND: show
  13447. USAGE: show
  13449. DESCRIPTION:
  13450. Displays the current non-volatile settings values for both the Permanent and
  13451. Dynamic sections.
  13453. EXAMPLES:
  13454. show --
  13456. ------------------------------------------------------------------------------
  13458. TABLE: non-vol/cmp
  13460. COMMAND: stats
  13462. USAGE: stats
  13464. DESCRIPTION:
  13465. Prints stats about buffer usage for Dynamic and Permanent settings.
  13467. EXAMPLES:
  13468. stats --
  13470. ------------------------------------------------------------------------------
  13472. TABLE: non-vol/cmp
  13474. COMMAND: sysContact
  13476. USAGE: sysContact [String{127}]
  13478. DESCRIPTION:
  13479. Sets the sysContact string that will be reported via SNMP.
  13481. EXAMPLES:
  13482. sysContact me myself and I --
  13484. ------------------------------------------------------------------------------
  13486. TABLE: non-vol/cmp
  13488. COMMAND: sysDescr
  13490. USAGE: sysDescr [String{254}]
  13492. DESCRIPTION:
  13493. Sets the sysDescr string that will be reported via SNMP.
  13495. EXAMPLES:
  13496. sysDescr Best thing since sliced bread --
  13498. ------------------------------------------------------------------------------
  13500. TABLE: non-vol/cmp
  13502. COMMAND: sysLocation
  13504. USAGE: sysLocation [String{127}]
  13506. DESCRIPTION:
  13507. Sets the sysLocation string that will be reported via SNMP.
  13509. EXAMPLES:
  13510. sysLocation wherever you are --
  13512. ------------------------------------------------------------------------------
  13514. TABLE: non-vol/cmp
  13516. COMMAND: sysName
  13518. USAGE: sysName [String{127}]
  13520. DESCRIPTION:
  13521. Sets the sysName string that will be reported via SNMP.
  13523. EXAMPLES:
  13524. sysName whoever you are --
  13526. ------------------------------------------------------------------------------
  13528. TABLE: non-vol/cmp
  13530. COMMAND: sysORDescr
  13532. USAGE: sysORDescr [String{127}]
  13534. DESCRIPTION:
  13535. Sets the sysORDescr string that will be reported via SNMP.
  13537. EXAMPLES:
  13538. sysORDescr who I am --
  13540. ------------------------------------------------------------------------------
  13542. TABLE: non-vol/cmp
  13544. COMMAND: sysORID
  13546. USAGE: sysORID [String{127}]
  13548. DESCRIPTION:
  13549. Sets the sysORID string that will be reported via SNMP.
  13551. EXAMPLES:
  13552. sysORID 1.2.3.4.5.6.1 --
  13554. ------------------------------------------------------------------------------
  13556. TABLE: non-vol/cmp
  13558. COMMAND: sysObjectId
  13560. USAGE: sysObjectId [String{127}]
  13562. DESCRIPTION:
  13563. Sets the sysObjectId string that will be reported via SNMP.
  13565. EXAMPLES:
  13566. sysObjectId 1.2.3.4.5.6 --
  13568. ------------------------------------------------------------------------------
  13570. TABLE: non-vol/cmp
  13572. COMMAND: sysServices
  13574. USAGE: sysServices [Number{0..255}]
  13576. DESCRIPTION:
  13577. Sets the sysServices value that will be reported via SNMP.
  13579. EXAMPLES:
  13580. sysServices 0x4f --
  13582. ------------------------------------------------------------------------------
  13584. TABLE: non-vol/cmp
  13586. COMMAND: tftp_read
  13588. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  13590. DESCRIPTION:
  13591. Causes the Permanent or Dynamic settings data to be read from a server via
  13592. TFTP. The file must be generated correctly, with all of the headers, CRC,
  13593. and other information that would exist on the NonVol device. The file will
  13594. be read and evaluated for correctness before it is stored in the device. If
  13595. the file is rejected then the settings will be read from the device to undo
  13596. any changes. Normally, this will operate on all settings groups; if you
  13597. specify -g then it will operate only on the current group (e.g. if you are in
  13598. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  13599. read).
  13601. EXAMPLES:
  13602. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  13603. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  13605. ------------------------------------------------------------------------------
  13607. TABLE: non-vol/cmp
  13609. COMMAND: tftp_write
  13611. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  13613. DESCRIPTION:
  13614. Causes the Permanent or Dynamic settings data to be written to a server via
  13615. TFTP. Normally, this will operate on all settings groups; if you specify -g
  13616. then it will operate only on the current group (e.g. if you are in the SNMP
  13617. nonvol dir, then -g will cause only the SNMP settings group to be written).
  13619. EXAMPLES:
  13620. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  13621. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  13623. ------------------------------------------------------------------------------
  13625. TABLE: non-vol/cmp
  13627. COMMAND: write
  13629. USAGE: write [both|perm|dyn]
  13631. DESCRIPTION:
  13632. Writes the specified section of non-volatile settings to non-volatile memory.
  13633. If 'both' is specified or there are no parameters, then both Permanent and
  13634. Dynamic settings will be written. Otherwise, only the section specified will
  13635. be written.
  13637. EXAMPLES:
  13638. write -- Writes both Permanent and Dynamic sections of settings.
  13639. write perm -- Writes only the Permanent section of non-vol settings.
  13641. ------------------------------------------------------------------------------
  13643. TABLE: non-vol/cqp2
  13645. COMMAND: add_policy
  13647. USAGE: add_policy
  13649. DESCRIPTION:
  13650. Presents you with a series of prompts that allows one to add a QoS policy
  13651. table entry.
  13653. EXAMPLES:
  13654. add_policy -- Prompts you for the new QoS policy table entry.
  13656. ------------------------------------------------------------------------------
  13658. TABLE: non-vol/cqp2
  13660. COMMAND: add_traffic
  13662. USAGE: add_traffic
  13664. DESCRIPTION:
  13665. Presents you with a series of prompts that allows one to add a QoS Traffic
  13666. Class table entry.
  13668. EXAMPLES:
  13669. add_traffic -- Prompts you for the new QoS Traffic Class table entry.
  13671. ------------------------------------------------------------------------------
  13673. TABLE: non-vol/cqp2
  13675. COMMAND: clear_device
  13677. USAGE: clear_device [both|perm|dyn]
  13679. DESCRIPTION:
  13680. Tells the nonvol device to wipe out the specified settings section. All data
  13681. will be lost; the device should be restored to its 'virgin' state. For flash
  13682. devices, the flash block is erased; for disk devices, the file is erased.
  13684. EXAMPLES:
  13685. clear_device -- Clears both Permanent and Dynamic sections.
  13686. clear_device perm -- Clears only the Permanent section.
  13688. ------------------------------------------------------------------------------
  13690. TABLE: non-vol/cqp2
  13692. COMMAND: defaults
  13694. USAGE: defaults [both|perm|dyn]
  13696. DESCRIPTION:
  13697. Restores the settings to default values. NOTE: This does not write to
  13698. NonVol memory! You must do this manually. Also note that some settings do
  13699. not have good defaults, particularly the Permanent section! Use this command
  13700. with extreme care!
  13702. EXAMPLES:
  13703. defaults -- Sets both Permanent and Dynamic sections to defaults.
  13704. defaults perm -- Sets only the Permanent section to defaults.
  13706. ------------------------------------------------------------------------------
  13708. TABLE: non-vol/cqp2
  13710. COMMAND: del_extra_data
  13712. USAGE: del_extra_data [both|perm|dyn]
  13714. DESCRIPTION:
  13715. Gets rid of any extra data that is assiociated with the settings. The extra
  13716. data is usually caused by a downgrade, where settings written by a newer
  13717. version are not understood by the older version, but are stored so that they
  13718. will still exist when the new code is run. However, in some cases, it is
  13719. desirable to get rid of them if they are not going to be used.
  13721. EXAMPLES:
  13722. del_extra_data perm -- Gets rid of extra permanent data.
  13724. ------------------------------------------------------------------------------
  13726. TABLE: non-vol/cqp2
  13728. COMMAND: del_policy
  13730. USAGE: del_policy
  13732. DESCRIPTION:
  13733. Presents you with a series of prompts that allows one to delete a QoS policy
  13734. table entry.
  13736. EXAMPLES:
  13737. del_policy -- Prompts you to delete a QoS policy table entry.
  13739. ------------------------------------------------------------------------------
  13741. TABLE: non-vol/cqp2
  13743. COMMAND: del_traffic
  13745. USAGE: del_traffic
  13747. DESCRIPTION:
  13748. Presents you with a series of prompts that allows one to delete a QoS Traffic
  13749. Class table entry.
  13751. EXAMPLES:
  13752. del_traffic -- Prompts you to delete a QoS Traffic Class table entry.
  13754. ------------------------------------------------------------------------------
  13756. TABLE: non-vol/cqp2
  13758. COMMAND: flush {disabled}
  13760. USAGE: flush
  13762. DESCRIPTION:
  13763. For Composite NonVol Settings objects (which contain 1 or more groups of
  13764. NonVol Settings), this command flushes out any unrecognized groups that were
  13765. read from the device. This is useful in cases where the settings group isn't
  13766. needed by another application, and would just waste space.
  13768. EXAMPLES:
  13769. flush --
  13771. ------------------------------------------------------------------------------
  13773. TABLE: non-vol/cqp2
  13775. COMMAND: manufactured
  13777. USAGE: manufactured [both|perm|dyn]
  13779. DESCRIPTION:
  13780. Checks to see if the specified section is manufactured.
  13782. EXAMPLES:
  13783. manufactured -- Checks both Permanent and Dynamic sections
  13784. manufacturing state.
  13785. manufactured perm -- Checks only the Permanent section manufacturing state.
  13787. ------------------------------------------------------------------------------
  13789. TABLE: non-vol/cqp2
  13791. COMMAND: read
  13793. USAGE: read [both|perm|dyn]
  13795. DESCRIPTION:
  13796. Reads the specified section of non-volatile settings from non-volatile
  13797. memory. If 'both' is specified or there are no parameters, then both
  13798. Permanent and Dynamic settings will be read. Otherwise, only the section
  13799. specified will be read. This will destroy any changes you have made if you
  13800. haven't written them!
  13802. EXAMPLES:
  13803. read -- Reads both Permanent and Dynamic sections of settings.
  13804. read perm -- Reads only the Permanent section of non-vol settings.
  13806. ------------------------------------------------------------------------------
  13808. TABLE: non-vol/cqp2
  13810. COMMAND: show
  13812. USAGE: show
  13814. DESCRIPTION:
  13815. Displays the current non-volatile settings values for both the Permanent and
  13816. Dynamic sections.
  13818. EXAMPLES:
  13819. show --
  13821. ------------------------------------------------------------------------------
  13823. TABLE: non-vol/cqp2
  13825. COMMAND: stats
  13827. USAGE: stats
  13829. DESCRIPTION:
  13830. Prints stats about buffer usage for Dynamic and Permanent settings.
  13832. EXAMPLES:
  13833. stats --
  13835. ------------------------------------------------------------------------------
  13837. TABLE: non-vol/cqp2
  13839. COMMAND: tftp_read
  13841. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  13843. DESCRIPTION:
  13844. Causes the Permanent or Dynamic settings data to be read from a server via
  13845. TFTP. The file must be generated correctly, with all of the headers, CRC,
  13846. and other information that would exist on the NonVol device. The file will
  13847. be read and evaluated for correctness before it is stored in the device. If
  13848. the file is rejected then the settings will be read from the device to undo
  13849. any changes. Normally, this will operate on all settings groups; if you
  13850. specify -g then it will operate only on the current group (e.g. if you are in
  13851. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  13852. read).
  13854. EXAMPLES:
  13855. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  13856. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  13858. ------------------------------------------------------------------------------
  13860. TABLE: non-vol/cqp2
  13862. COMMAND: tftp_write
  13864. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  13866. DESCRIPTION:
  13867. Causes the Permanent or Dynamic settings data to be written to a server via
  13868. TFTP. Normally, this will operate on all settings groups; if you specify -g
  13869. then it will operate only on the current group (e.g. if you are in the SNMP
  13870. nonvol dir, then -g will cause only the SNMP settings group to be written).
  13872. EXAMPLES:
  13873. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  13874. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  13876. ------------------------------------------------------------------------------
  13878. TABLE: non-vol/cqp2
  13880. COMMAND: write
  13882. USAGE: write [both|perm|dyn]
  13884. DESCRIPTION:
  13885. Writes the specified section of non-volatile settings to non-volatile memory.
  13886. If 'both' is specified or there are no parameters, then both Permanent and
  13887. Dynamic settings will be written. Otherwise, only the section specified will
  13888. be written.
  13890. EXAMPLES:
  13891. write -- Writes both Permanent and Dynamic sections of settings.
  13892. write perm -- Writes only the Permanent section of non-vol settings.
  13894. ------------------------------------------------------------------------------
  13896. TABLE: non-vol/csp
  13898. COMMAND: alert_period
  13900. USAGE: alert_period period{0..65535}
  13902. DESCRIPTION:
  13903. Tbd
  13905. EXAMPLES:
  13906. alert_period --
  13908. ------------------------------------------------------------------------------
  13910. TABLE: non-vol/csp
  13912. COMMAND: alert_threshold
  13914. USAGE: alert_threshold threshold{0..65535}
  13916. DESCRIPTION:
  13917. Tbd
  13919. EXAMPLES:
  13920. alert_threshold --
  13922. ------------------------------------------------------------------------------
  13924. TABLE: non-vol/csp
  13926. COMMAND: change_key
  13928. USAGE: change_key ps_cert|ps_private_key|mfg_ca_cert|srv_ca_cert
  13930. DESCRIPTION:
  13931. Prompts you for the new key value to be used. You will enter the number of
  13932. values to be used first, then you will be prompted for each value, one at a
  13933. time. If you hit Esc or Enter without specifying a new value, then this will
  13934. be aborted. The keyName parameter is one of the following:
  13936. ps_cert -- PS Certificate
  13937. ps_private_key -- PS Certificate Private Key
  13938. mfg_ca_cert -- Manufacturer CA Certificate
  13939. srv_ca_cert -- Service Provider CA Certificate
  13942. EXAMPLES:
  13943. change_key ps_cert -- Begins prompting you for the new PS Certificate.
  13945. ------------------------------------------------------------------------------
  13947. TABLE: non-vol/csp
  13949. COMMAND: clear_device
  13951. USAGE: clear_device [both|perm|dyn]
  13953. DESCRIPTION:
  13954. Tells the nonvol device to wipe out the specified settings section. All data
  13955. will be lost; the device should be restored to its 'virgin' state. For flash
  13956. devices, the flash block is erased; for disk devices, the file is erased.
  13958. EXAMPLES:
  13959. clear_device -- Clears both Permanent and Dynamic sections.
  13960. clear_device perm -- Clears only the Permanent section.
  13962. ------------------------------------------------------------------------------
  13964. TABLE: non-vol/csp
  13966. COMMAND: defaults
  13968. USAGE: defaults [both|perm|dyn]
  13970. DESCRIPTION:
  13971. Restores the settings to default values. NOTE: This does not write to
  13972. NonVol memory! You must do this manually. Also note that some settings do
  13973. not have good defaults, particularly the Permanent section! Use this command
  13974. with extreme care!
  13976. EXAMPLES:
  13977. defaults -- Sets both Permanent and Dynamic sections to defaults.
  13978. defaults perm -- Sets only the Permanent section to defaults.
  13980. ------------------------------------------------------------------------------
  13982. TABLE: non-vol/csp
  13984. COMMAND: del_extra_data
  13986. USAGE: del_extra_data [both|perm|dyn]
  13988. DESCRIPTION:
  13989. Gets rid of any extra data that is assiociated with the settings. The extra
  13990. data is usually caused by a downgrade, where settings written by a newer
  13991. version are not understood by the older version, but are stored so that they
  13992. will still exist when the new code is run. However, in some cases, it is
  13993. desirable to get rid of them if they are not going to be used.
  13995. EXAMPLES:
  13996. del_extra_data perm -- Gets rid of extra permanent data.
  13998. ------------------------------------------------------------------------------
  14000. TABLE: non-vol/csp
  14002. COMMAND: dload
  14004. USAGE: dload IpAddress [Filename{127}]
  14006. DESCRIPTION:
  14007. Causes the CableHome CSP Control thread to download and store the specified
  14008. firewall config file via TFTP from the specified TFTP Server IP address.
  14010. EXAMPLES:
  14011. dload 10.15.3.5 BRCM231_PSS03RS1.bin -- TFTPs BRCM231_PSS03RS1.bin from the
  14012. server.
  14015. ------------------------------------------------------------------------------
  14017. TABLE: non-vol/csp
  14019. COMMAND: event_type1_enable
  14021. USAGE: event_type1_enable [true|false]
  14023. DESCRIPTION:
  14024. Tbd
  14026. EXAMPLES:
  14027. event_type1_enable true:false -- .
  14029. ------------------------------------------------------------------------------
  14031. TABLE: non-vol/csp
  14033. COMMAND: event_type2_enable
  14035. USAGE: event_type2_enable [true|false]
  14037. DESCRIPTION:
  14038. Tbd
  14040. EXAMPLES:
  14041. event_type2_enable true:false -- .
  14043. ------------------------------------------------------------------------------
  14045. TABLE: non-vol/csp
  14047. COMMAND: event_type3_enable
  14049. USAGE: event_type3_enable [true|false]
  14051. DESCRIPTION:
  14052. Tbd
  14054. EXAMPLES:
  14055. event_type3_enable true:false -- .
  14057. ------------------------------------------------------------------------------
  14059. TABLE: non-vol/csp
  14061. COMMAND: flush {disabled}
  14063. USAGE: flush
  14065. DESCRIPTION:
  14066. For Composite NonVol Settings objects (which contain 1 or more groups of
  14067. NonVol Settings), this command flushes out any unrecognized groups that were
  14068. read from the device. This is useful in cases where the settings group isn't
  14069. needed by another application, and would just waste space.
  14071. EXAMPLES:
  14072. flush --
  14074. ------------------------------------------------------------------------------
  14076. TABLE: non-vol/csp
  14078. COMMAND: manufactured
  14080. USAGE: manufactured [both|perm|dyn]
  14082. DESCRIPTION:
  14083. Checks to see if the specified section is manufactured.
  14085. EXAMPLES:
  14086. manufactured -- Checks both Permanent and Dynamic sections
  14087. manufacturing state.
  14088. manufactured perm -- Checks only the Permanent section manufacturing state.
  14090. ------------------------------------------------------------------------------
  14092. TABLE: non-vol/csp
  14094. COMMAND: policy_enable
  14096. USAGE: policy_enable [true|false]
  14098. DESCRIPTION:
  14099. Tbd
  14101. EXAMPLES:
  14102. policy_enable true:false -- .
  14104. ------------------------------------------------------------------------------
  14106. TABLE: non-vol/csp
  14108. COMMAND: print
  14110. USAGE: print ps_cert|ps_private_key|mfg_ca_cert|srv_ca_cert
  14112. DESCRIPTION:
  14113. Displays the value for the key name that is specified. The key values are
  14114. not displayed with the 'show' command in order to keep them from overflowing
  14115. the screen. The keyName parameter is one of the following:
  14117. ps_cert -- PS Certificate
  14118. ps_private_key -- PS Certificate Private Key
  14119. mfg_ca_cert -- Manufacturer CA Certificate
  14120. srv_ca_cert -- Service Provider CA Certificate
  14123. EXAMPLES:
  14124. print ps_cert -- Prints the PS Certificate.
  14126. ------------------------------------------------------------------------------
  14128. TABLE: non-vol/csp
  14130. COMMAND: read
  14132. USAGE: read [both|perm|dyn]
  14134. DESCRIPTION:
  14135. Reads the specified section of non-volatile settings from non-volatile
  14136. memory. If 'both' is specified or there are no parameters, then both
  14137. Permanent and Dynamic settings will be read. Otherwise, only the section
  14138. specified will be read. This will destroy any changes you have made if you
  14139. haven't written them!
  14141. EXAMPLES:
  14142. read -- Reads both Permanent and Dynamic sections of settings.
  14143. read perm -- Reads only the Permanent section of non-vol settings.
  14145. ------------------------------------------------------------------------------
  14147. TABLE: non-vol/csp
  14149. COMMAND: show
  14151. USAGE: show
  14153. DESCRIPTION:
  14154. Displays the current non-volatile settings values for both the Permanent and
  14155. Dynamic sections.
  14157. EXAMPLES:
  14158. show --
  14160. ------------------------------------------------------------------------------
  14162. TABLE: non-vol/csp
  14164. COMMAND: stats
  14166. USAGE: stats
  14168. DESCRIPTION:
  14169. Prints stats about buffer usage for Dynamic and Permanent settings.
  14171. EXAMPLES:
  14172. stats --
  14174. ------------------------------------------------------------------------------
  14176. TABLE: non-vol/csp
  14178. COMMAND: tftp_read
  14180. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  14182. DESCRIPTION:
  14183. Causes the Permanent or Dynamic settings data to be read from a server via
  14184. TFTP. The file must be generated correctly, with all of the headers, CRC,
  14185. and other information that would exist on the NonVol device. The file will
  14186. be read and evaluated for correctness before it is stored in the device. If
  14187. the file is rejected then the settings will be read from the device to undo
  14188. any changes. Normally, this will operate on all settings groups; if you
  14189. specify -g then it will operate only on the current group (e.g. if you are in
  14190. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  14191. read).
  14193. EXAMPLES:
  14194. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  14195. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  14197. ------------------------------------------------------------------------------
  14199. TABLE: non-vol/csp
  14201. COMMAND: tftp_write
  14203. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  14205. DESCRIPTION:
  14206. Causes the Permanent or Dynamic settings data to be written to a server via
  14207. TFTP. Normally, this will operate on all settings groups; if you specify -g
  14208. then it will operate only on the current group (e.g. if you are in the SNMP
  14209. nonvol dir, then -g will cause only the SNMP settings group to be written).
  14211. EXAMPLES:
  14212. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  14213. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  14215. ------------------------------------------------------------------------------
  14217. TABLE: non-vol/csp
  14219. COMMAND: write
  14221. USAGE: write [both|perm|dyn]
  14223. DESCRIPTION:
  14224. Writes the specified section of non-volatile settings to non-volatile memory.
  14225. If 'both' is specified or there are no parameters, then both Permanent and
  14226. Dynamic settings will be written. Otherwise, only the section specified will
  14227. be written.
  14229. EXAMPLES:
  14230. write -- Writes both Permanent and Dynamic sections of settings.
  14231. write perm -- Writes only the Permanent section of non-vol settings.
  14233. ------------------------------------------------------------------------------
  14235. TABLE: non-vol/docsis
  14237. COMMAND: bpi_version
  14239. USAGE: bpi_version [version{0..1}]
  14241. DESCRIPTION:
  14242. Sets the BPI version that will be supported. The version parameter must be
  14243. one of the following:
  14245. 0 -- BPI
  14246. 1 -- BPI+
  14248. EXAMPLES:
  14249. bpi_version 1 -- Enables BPI+ support.
  14251. ------------------------------------------------------------------------------
  14253. TABLE: non-vol/docsis
  14255. COMMAND: clear_device
  14257. USAGE: clear_device [both|perm|dyn]
  14259. DESCRIPTION:
  14260. Tells the nonvol device to wipe out the specified settings section. All data
  14261. will be lost; the device should be restored to its 'virgin' state. For flash
  14262. devices, the flash block is erased; for disk devices, the file is erased.
  14264. EXAMPLES:
  14265. clear_device -- Clears both Permanent and Dynamic sections.
  14266. clear_device perm -- Clears only the Permanent section.
  14268. ------------------------------------------------------------------------------
  14270. TABLE: non-vol/docsis
  14272. COMMAND: concat_thresh
  14274. USAGE: concat_thresh [NumPackets{2..255}]
  14276. DESCRIPTION:
  14277. Sets the concatenation threshold to the value specified. This is only used
  14278. if concat is enabled via non-vol and the CMTS. It specifies the minimum
  14279. number of packets that must be present in order for concat to occur. This
  14280. must be >= 2.
  14282. EXAMPLES:
  14283. concat_thresh 4 -- Sets the concat threshold to 4 packets.
  14285. ------------------------------------------------------------------------------
  14287. TABLE: non-vol/docsis
  14289. COMMAND: cpe_interface
  14291. USAGE: cpe_interface [other|ethernet|usb]
  14293. DESCRIPTION:
  14294. Sets the CPE interface for designs (eg 3380) which have a selectable CPE
  14295. interface rather than being able to support multiple CPE interfaces
  14296. simultaneously. For designs which support multiple CPE interfaces, this
  14297. setting is unused and will always return 'other'
  14299. EXAMPLES:
  14300. cpe_interface ethernet -- Sets the selected CPE interface to ethernet.
  14303. ------------------------------------------------------------------------------
  14305. TABLE: non-vol/docsis
  14307. COMMAND: defaults
  14309. USAGE: defaults [both|perm|dyn]
  14311. DESCRIPTION:
  14312. Restores the settings to default values. NOTE: This does not write to
  14313. NonVol memory! You must do this manually. Also note that some settings do
  14314. not have good defaults, particularly the Permanent section! Use this command
  14315. with extreme care!
  14317. EXAMPLES:
  14318. defaults -- Sets both Permanent and Dynamic sections to defaults.
  14319. defaults perm -- Sets only the Permanent section to defaults.
  14321. ------------------------------------------------------------------------------
  14323. TABLE: non-vol/docsis
  14325. COMMAND: del_extra_data
  14327. USAGE: del_extra_data [both|perm|dyn]
  14329. DESCRIPTION:
  14330. Gets rid of any extra data that is assiociated with the settings. The extra
  14331. data is usually caused by a downgrade, where settings written by a newer
  14332. version are not understood by the older version, but are stored so that they
  14333. will still exist when the new code is run. However, in some cases, it is
  14334. desirable to get rid of them if they are not going to be used.
  14336. EXAMPLES:
  14337. del_extra_data perm -- Gets rid of extra permanent data.
  14339. ------------------------------------------------------------------------------
  14341. TABLE: non-vol/docsis
  14343. COMMAND: dhcp_settings
  14345. USAGE: dhcp_settings
  14347. DESCRIPTION:
  14348. Presents you with a series of prompts that allow you to modify the canned
  14349. DHCP settings that will be used when DHCP is disabled. You can just hit
  14350. enter to leave a setting alone, or can enter a new value to replace the
  14351. existing one.
  14353. EXAMPLES:
  14354. dhcp_settings -- Prompts you for the new DHCP settings.
  14356. ------------------------------------------------------------------------------
  14358. TABLE: non-vol/docsis
  14360. COMMAND: doc10_mcastpromisc
  14362. USAGE: doc10_mcastpromisc [true|false]
  14364. DESCRIPTION:
  14365. Enables or disables DOCSIS 1.0 multicast promisc. support. This flag only has
  14366. an effect if the code is built with DOCSIS 1.0 IGMP support!
  14368. EXAMPLES:
  14369. doc10_mcastpromisc true -- .
  14371. ------------------------------------------------------------------------------
  14373. TABLE: non-vol/docsis
  14375. COMMAND: ds_frequency
  14377. USAGE: ds_frequency [frequency{1..4294967295}]
  14379. DESCRIPTION:
  14380. Sets the downstream frequency that is considered the last 'happy home'. This
  14381. value can be in units of Hz or MHz (if the value is less than 10,000 then it
  14382. is assumed to be MHz).
  14384. EXAMPLES:
  14385. ds_frequency 327000000 -- Sets the 'happy home' to 327 MHz.
  14386. ds_frequency 405 -- Sets the 'happy home' to 405 MHz.
  14388. ------------------------------------------------------------------------------
  14390. TABLE: non-vol/docsis
  14392. COMMAND: enable
  14394. USAGE: enable canned|scan|bpi|concat|rate|frag|phs|igmp|docsis11|dhcp|tod|tftp|rng|advphy|bpi23|20hack|opt_init_rng|force_cfgfile|AckCel|nonstd_us|bonding true|false
  14396. DESCRIPTION:
  14397. Enables or disables the specified feature. Most of these only take effect
  14398. the next time the CM 'resets the MAC' and registers with the CMTS. The
  14399. feature parameter is one of the following:
  14401. scan -- Scan single DsChan only
  14402. bpi -- Baseline Privacy
  14403. concat -- Concatenation
  14404. frag -- Fragmentation
  14405. phs -- Payload Header Suppression
  14406. igmp -- IGMP Multicast
  14407. rate -- Rate Shaping
  14408. docsis11 -- DOCSIS 1.1 support
  14409. dhcp -- DHCP on CM's IP stack
  14410. tod -- Time Of Day
  14411. tftp -- TFTP of CM config file
  14412. canned -- REG-REQ with canned config file
  14413. rng -- One-line RNG-RSP messages
  14414. advphy -- Advanced PHY
  14415. bpi23 -- Secure s/w dload in DOCSIS 1.1 mode
  14416. 20hack -- Hack to allow 2.0 CM register on 1.x CMTS
  14417. opt_init_rng -- Turns optimized initial ranging (bisection) on or off.
  14418. force_cfgfile -- Force a specified config file if using DHCP.
  14419. AckCel -- Enables or disables Broadcom's Patent Pending AckCel
  14420. Technology for the DOCSIS upsteam.
  14421. nonstd_us -- Configures s/w support for non-standard upstream
  14422. configurations (if supported by h/w)
  14423. bonding -- Configures s/w support for DS channel bonding (if
  14424. supported by h/w)
  14426. EXAMPLES:
  14427. enable docsis11 true -- Enables DOCSIS 1.1 features.
  14428. enable rng 0 -- Disables one-line RNG-RSP messages.
  14431. ------------------------------------------------------------------------------
  14433. TABLE: non-vol/docsis
  14435. COMMAND: fake_reg
  14437. USAGE: fake_reg true|false
  14439. DESCRIPTION:
  14440. Configures the system to do real or fake registration, depending on whether
  14441. you specify true or false. If you specify true, DHCP/ToD/TFTP are disabled,
  14442. and canned reg is enabled. If you specify false, then things are reversed.
  14444. EXAMPLES:
  14445. fake_reg true -- Configures for fake registration.
  14447. ------------------------------------------------------------------------------
  14449. TABLE: non-vol/docsis
  14451. COMMAND: flush {disabled}
  14453. USAGE: flush
  14455. DESCRIPTION:
  14456. For Composite NonVol Settings objects (which contain 1 or more groups of
  14457. NonVol Settings), this command flushes out any unrecognized groups that were
  14458. read from the device. This is useful in cases where the settings group isn't
  14459. needed by another application, and would just waste space.
  14461. EXAMPLES:
  14462. flush --
  14464. ------------------------------------------------------------------------------
  14466. TABLE: non-vol/docsis
  14468. COMMAND: ip_stack_number
  14470. USAGE: ip_stack_number [stackNumber{1..8}]
  14472. DESCRIPTION:
  14473. Allows you to show/change the IP stack number that the CM will use. The
  14474. system may have more than 1 IP stack, so we need to be told which one to use.
  14475. NOTE: This IP stack must NOT be used by any other application, because it
  14476. will start DHCP or force the IP address to the values entered in the DHCP
  14477. settings!
  14479. EXAMPLES:
  14480. ip_stack_number -- Shows the IP stack number.
  14481. ip_stack_number 1 -- Configures the server to use IP stack 1.
  14483. ------------------------------------------------------------------------------
  14485. TABLE: non-vol/docsis
  14487. COMMAND: manufactured
  14489. USAGE: manufactured [both|perm|dyn]
  14491. DESCRIPTION:
  14492. Checks to see if the specified section is manufactured.
  14494. EXAMPLES:
  14495. manufactured -- Checks both Permanent and Dynamic sections
  14496. manufacturing state.
  14497. manufactured perm -- Checks only the Permanent section manufacturing state.
  14499. ------------------------------------------------------------------------------
  14501. TABLE: non-vol/docsis
  14503. COMMAND: max_concat
  14505. USAGE: max_concat [NumPackets{2..255}]
  14507. DESCRIPTION:
  14508. Sets the maximum number of packets that will be allowed to be concatenated on
  14509. an upstream Flow.
  14511. EXAMPLES:
  14512. max_concat 10 -- Allows up to 10 packets to be concatenated.
  14514. ------------------------------------------------------------------------------
  14516. TABLE: non-vol/docsis
  14518. COMMAND: queues
  14520. USAGE: queues [NumQueues{0..255}]
  14522. DESCRIPTION:
  14523. Sets the number of upstream queues that will be allowed for use by DOCSIS 1.1
  14524. Service Flows; this can only be used to limit it below what is really
  14525. available in hardware. If you specify 0, then there is no artificial limit.
  14527. EXAMPLES:
  14528. queues 4 -- Sets the number of enabled queues to 4.
  14530. ------------------------------------------------------------------------------
  14532. TABLE: non-vol/docsis
  14534. COMMAND: rate_shaping_time
  14536. USAGE: rate_shaping_time [seconds{1..255}]
  14538. DESCRIPTION:
  14539. Sets the number of seconds over which DOCSIS 1.1 QoS rate shaping will be
  14540. applied. In the equation Max(T) = T*(R/8)+B, this is the variable T. R and
  14541. B come from TLVs in the Service Flow settings. We recommend using 2 for T,
  14542. but it may be useful to set it higher.
  14544. EXAMPLES:
  14545. rate_shaping_time 2 -- Sets the rate shaping time to 2 seconds.
  14547. ------------------------------------------------------------------------------
  14549. TABLE: non-vol/docsis
  14551. COMMAND: read
  14553. USAGE: read [both|perm|dyn]
  14555. DESCRIPTION:
  14556. Reads the specified section of non-volatile settings from non-volatile
  14557. memory. If 'both' is specified or there are no parameters, then both
  14558. Permanent and Dynamic settings will be read. Otherwise, only the section
  14559. specified will be read. This will destroy any changes you have made if you
  14560. haven't written them!
  14562. EXAMPLES:
  14563. read -- Reads both Permanent and Dynamic sections of settings.
  14564. read perm -- Reads only the Permanent section of non-vol settings.
  14566. ------------------------------------------------------------------------------
  14568. TABLE: non-vol/docsis
  14570. COMMAND: rng_class_extension
  14572. USAGE: rng_class_extension [Bitmask]
  14574. DESCRIPTION:
  14575. Sets the ranging class extension.
  14576. CM Ranging Class ID Extension is a 16 bit field and is normally set
  14577. through the CM Configuration File. Values are not defined yet. Use this
  14578. command for testing purposes!
  14581. EXAMPLES:
  14582. rng_class_extension 0x04 -- .
  14584. ------------------------------------------------------------------------------
  14586. TABLE: non-vol/docsis
  14588. COMMAND: show
  14590. USAGE: show
  14592. DESCRIPTION:
  14593. Displays the current non-volatile settings values for both the Permanent and
  14594. Dynamic sections.
  14596. EXAMPLES:
  14597. show --
  14599. ------------------------------------------------------------------------------
  14601. TABLE: non-vol/docsis
  14603. COMMAND: startup_context
  14605. USAGE: startup_context [context{0..255}]
  14607. DESCRIPTION:
  14608. Sets the startup target context (see CmChanTargeting.h for legal values).
  14609. This tells the context in which the UsChan and DsFreq should be used.
  14611. EXAMPLES:
  14612. startup_context 7 -- Sets startup context to kDccInProg.
  14614. ------------------------------------------------------------------------------
  14616. TABLE: non-vol/docsis
  14618. COMMAND: startup_dsfreq
  14620. USAGE: startup_dsfreq [frequency]
  14622. DESCRIPTION:
  14623. Sets the startup target for scanning downstream frequencies. If non-0, then
  14624. we try this frequency first based on the assumption that we were supposed to
  14625. target it, but rebooted for some reason. This value can be in units of Hz or
  14626. MHz (if the value is less than 10,000 then it is assumed to be MHz).
  14628. EXAMPLES:
  14629. startup_dsfreq 327000000 -- Sets the startup Ds Freq to 327 MHz.
  14630. startup_dsfreq 405 -- Sets the startup Ds Freq to 405 MHz.
  14632. ------------------------------------------------------------------------------
  14634. TABLE: non-vol/docsis
  14636. COMMAND: startup_uschan
  14638. USAGE: startup_uschan [channel{0..255}]
  14640. DESCRIPTION:
  14641. Sets the startup target upstream channel id. If non-0, then we try this
  14642. channel first based on the assumption that we were supposed to target it, but
  14643. rebooted for some reason.
  14645. EXAMPLES:
  14646. startup_uschan 1 -- Sets startup Us Channel to 1.
  14648. ------------------------------------------------------------------------------
  14650. TABLE: non-vol/docsis
  14652. COMMAND: stats
  14654. USAGE: stats
  14656. DESCRIPTION:
  14657. Prints stats about buffer usage for Dynamic and Permanent settings.
  14659. EXAMPLES:
  14660. stats --
  14662. ------------------------------------------------------------------------------
  14664. TABLE: non-vol/docsis
  14666. COMMAND: tftp_read
  14668. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  14670. DESCRIPTION:
  14671. Causes the Permanent or Dynamic settings data to be read from a server via
  14672. TFTP. The file must be generated correctly, with all of the headers, CRC,
  14673. and other information that would exist on the NonVol device. The file will
  14674. be read and evaluated for correctness before it is stored in the device. If
  14675. the file is rejected then the settings will be read from the device to undo
  14676. any changes. Normally, this will operate on all settings groups; if you
  14677. specify -g then it will operate only on the current group (e.g. if you are in
  14678. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  14679. read).
  14681. EXAMPLES:
  14682. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  14683. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  14685. ------------------------------------------------------------------------------
  14687. TABLE: non-vol/docsis
  14689. COMMAND: tftp_timeout
  14691. USAGE: tftp_timeout [seconds{1..4294967295}]
  14693. DESCRIPTION:
  14694. This is the number of seconds that the CM will wait between failed attempts
  14695. to download a software image. The spec requires this to be a minimum of 10
  14696. minutes, but it can be useful to set this smaller for testing.
  14698. EXAMPLES:
  14699. tftp_timeout 60 -- Sets the TFTP timeout to 1 minute.
  14701. ------------------------------------------------------------------------------
  14703. TABLE: non-vol/docsis
  14705. COMMAND: tftp_write
  14707. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  14709. DESCRIPTION:
  14710. Causes the Permanent or Dynamic settings data to be written to a server via
  14711. TFTP. Normally, this will operate on all settings groups; if you specify -g
  14712. then it will operate only on the current group (e.g. if you are in the SNMP
  14713. nonvol dir, then -g will cause only the SNMP settings group to be written).
  14715. EXAMPLES:
  14716. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  14717. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  14719. ------------------------------------------------------------------------------
  14721. TABLE: non-vol/docsis
  14723. COMMAND: timer_disable
  14725. USAGE: timer_disable [Bitmask]
  14727. DESCRIPTION:
  14728. Sets the bitmask of DOCSIS timers that are to be disabled. The timers will
  14729. still run, but they will be ignored when they expire. This must only be used
  14730. for debugging purposes. These are the bit definitions:
  14732. 0x00000001 -- T1
  14733. 0x00000002 -- T2
  14734. : -- :
  14735. 0x80000000 -- T32
  14737. EXAMPLES:
  14738. timer_disable 0x6 -- Disables DOCSIS timers T2 and T3.
  14740. ------------------------------------------------------------------------------
  14742. TABLE: non-vol/docsis
  14744. COMMAND: ugs_depth
  14746. USAGE: ugs_depth [-i GrantInterval uSec{0..65535}] Index{0..7} [NumPackets{1..255}]
  14748. DESCRIPTION:
  14749. Sets the number of packets that will be allowed to be queued on an UGS
  14750. Service Flow corresponding to the specified table index before dropping
  14751. packets. A higher number means packets are less likely to be dropped, but
  14752. also means potentially higher latency. There is a separate entry for
  14753. different ranges of grant intervals. The grant interval for the entry can be
  14754. set using the -i flag.
  14756. EXAMPLES:
  14757. ugs_depth 4 3 -- Allows up to 3 packets to be queued on an UGS flow
  14758. for table index 4
  14759. ugs_depth 0 32 -i 100 -- Allows 32 packets for table index 0, setting the
  14760. max grant interval to 100 uSec
  14762. ------------------------------------------------------------------------------
  14764. TABLE: non-vol/docsis
  14766. COMMAND: ugs_table_entries
  14768. USAGE: ugs_table_entries [NumEntries{1..8}]
  14770. DESCRIPTION:
  14771. Sets the number of entries to be stored in the Max UGS Queue Depth table.
  14772. Each entry specifies a max UGS queue depth for a particular range of grant
  14773. intervals. Generally, the smaller the grant interval, the deeper the queue
  14774. needs to be.
  14776. EXAMPLES:
  14777. ugs_table_entries 5 -- .
  14779. ------------------------------------------------------------------------------
  14781. TABLE: non-vol/docsis
  14783. COMMAND: us_channel
  14785. USAGE: us_channel [channel{0..255}]
  14787. DESCRIPTION:
  14788. Sets the upstream channel that is considered the last 'happy home'.
  14790. EXAMPLES:
  14791. us_channel 1 -- Sets the 'happy home' to channel 1.
  14793. ------------------------------------------------------------------------------
  14795. TABLE: non-vol/docsis
  14797. COMMAND: us_power
  14799. USAGE: us_power [quarter dBmV{0..65535}]
  14801. DESCRIPTION:
  14802. Sets the initial upstream transmit power to be used. The value is in units
  14803. of quarter dBmV.
  14805. EXAMPLES:
  14806. us_power 32 -- Sets the initial Us power to 8.0 dBmV.
  14807. us_power 6 -- Sets the initial Us power to 1.5 dBmV.
  14809. ------------------------------------------------------------------------------
  14811. TABLE: non-vol/docsis
  14813. COMMAND: write
  14815. USAGE: write [both|perm|dyn]
  14817. DESCRIPTION:
  14818. Writes the specified section of non-volatile settings to non-volatile memory.
  14819. If 'both' is specified or there are no parameters, then both Permanent and
  14820. Dynamic settings will be written. Otherwise, only the section specified will
  14821. be written.
  14823. EXAMPLES:
  14824. write -- Writes both Permanent and Dynamic sections of settings.
  14825. write perm -- Writes only the Permanent section of non-vol settings.
  14827. ------------------------------------------------------------------------------
  14829. TABLE: non-vol/docsis30
  14831. COMMAND: clear_device
  14833. USAGE: clear_device [both|perm|dyn]
  14835. DESCRIPTION:
  14836. Tells the nonvol device to wipe out the specified settings section. All data
  14837. will be lost; the device should be restored to its 'virgin' state. For flash
  14838. devices, the flash block is erased; for disk devices, the file is erased.
  14840. EXAMPLES:
  14841. clear_device -- Clears both Permanent and Dynamic sections.
  14842. clear_device perm -- Clears only the Permanent section.
  14844. ------------------------------------------------------------------------------
  14846. TABLE: non-vol/docsis30
  14848. COMMAND: defaults
  14850. USAGE: defaults [both|perm|dyn]
  14852. DESCRIPTION:
  14853. Restores the settings to default values. NOTE: This does not write to
  14854. NonVol memory! You must do this manually. Also note that some settings do
  14855. not have good defaults, particularly the Permanent section! Use this command
  14856. with extreme care!
  14858. EXAMPLES:
  14859. defaults -- Sets both Permanent and Dynamic sections to defaults.
  14860. defaults perm -- Sets only the Permanent section to defaults.
  14862. ------------------------------------------------------------------------------
  14864. TABLE: non-vol/docsis30
  14866. COMMAND: del_extra_data
  14868. USAGE: del_extra_data [both|perm|dyn]
  14870. DESCRIPTION:
  14871. Gets rid of any extra data that is assiociated with the settings. The extra
  14872. data is usually caused by a downgrade, where settings written by a newer
  14873. version are not understood by the older version, but are stored so that they
  14874. will still exist when the new code is run. However, in some cases, it is
  14875. desirable to get rid of them if they are not going to be used.
  14877. EXAMPLES:
  14878. del_extra_data perm -- Gets rid of extra permanent data.
  14880. ------------------------------------------------------------------------------
  14882. TABLE: non-vol/docsis30
  14884. COMMAND: enable
  14886. USAGE: enable ipv6|overrideMdd|rptEaeCap|sgDiscFailMode|mpRegReqFormat|mcastDsidFwdDisable|eaeOffset|dbcHmacMismatchIgnore|forceD30ModemCaps|noMultiUsTx|noTccUcd|suppressTotalSidCluster|useCbcTekDecryption|noDrw true|false
  14888. DESCRIPTION:
  14889. Enables or disables the specified feature. Most of these only take effect
  14890. the next time the CM 'resets the MAC' and registers with the CMTS. The
  14891. feature parameter is one of the following:
  14893. ipv6 -- Enables IPv6 support
  14894. overrideMdd -- Override MDD IP init params TLV with non-vol
  14895. settings
  14896. rptEaeCap -- Report Eae capability bit in B-INIT-RNG-REQ
  14897. sgDiscFailMode -- Select strict DOCSIS 3.0 rules for MD-DS-SG
  14898. disc failure
  14899. mpRegReqFormat -- Use REG-REQ-MP if MDD settings detected
  14900. mcastDsidFwdDisabled -- Disable multicast DSID forwarding in modem
  14901. caps
  14902. eaeOffset -- Enable zero byte offset for EAE encryption
  14903. dbcHmacMismatchIgnore -- Ignore DBC-REQ HMAC mismatch failures
  14904. forceD30ModemCaps -- Force Docsis30 in modem capabilites for 3381
  14905. noMultiUsTx -- Indicate no multi Tx support via zero num us
  14906. Tx
  14907. noTccUcd -- Ignore UCDs embedded in TCC commands
  14908. suppressTotalSidCluster -- Do not send total sid cluster modem
  14909. capability in REG-REQ
  14910. useCbcTekDecryption -- Use CBC TEK key decryption instead of ECB.
  14911. noDrw -- Disable dynamic range window power level
  14912. enforcement.
  14915. EXAMPLES:
  14916. enable overrideMdd true -- Removes requirement for MDD message
  14919. ------------------------------------------------------------------------------
  14921. TABLE: non-vol/docsis30
  14923. COMMAND: flush {disabled}
  14925. USAGE: flush
  14927. DESCRIPTION:
  14928. For Composite NonVol Settings objects (which contain 1 or more groups of
  14929. NonVol Settings), this command flushes out any unrecognized groups that were
  14930. read from the device. This is useful in cases where the settings group isn't
  14931. needed by another application, and would just waste space.
  14933. EXAMPLES:
  14934. flush --
  14936. ------------------------------------------------------------------------------
  14938. TABLE: non-vol/docsis30
  14940. COMMAND: ip_prov_mode
  14942. USAGE: ip_prov_mode ipv4|ipv6|apm|dual
  14944. DESCRIPTION:
  14945. Only if 'Override MDD' non-vol setting is enabled, this value determines
  14946. which IP provisioning modethe CM will use. This is normally determined by
  14947. the MDD message.
  14949. ipv4 -- IPv4 only
  14950. ipv6 -- IPv6 only
  14951. apm -- IPv4 only if IPv6 fails to complete
  14952. dual -- Dual-stack mode
  14955. EXAMPLES:
  14956. ip_prov_mode dual
  14958. ------------------------------------------------------------------------------
  14960. TABLE: non-vol/docsis30
  14962. COMMAND: manufactured
  14964. USAGE: manufactured [both|perm|dyn]
  14966. DESCRIPTION:
  14967. Checks to see if the specified section is manufactured.
  14969. EXAMPLES:
  14970. manufactured -- Checks both Permanent and Dynamic sections
  14971. manufacturing state.
  14972. manufactured perm -- Checks only the Permanent section manufacturing state.
  14974. ------------------------------------------------------------------------------
  14976. TABLE: non-vol/docsis30
  14978. COMMAND: read
  14980. USAGE: read [both|perm|dyn]
  14982. DESCRIPTION:
  14983. Reads the specified section of non-volatile settings from non-volatile
  14984. memory. If 'both' is specified or there are no parameters, then both
  14985. Permanent and Dynamic settings will be read. Otherwise, only the section
  14986. specified will be read. This will destroy any changes you have made if you
  14987. haven't written them!
  14989. EXAMPLES:
  14990. read -- Reads both Permanent and Dynamic sections of settings.
  14991. read perm -- Reads only the Permanent section of non-vol settings.
  14993. ------------------------------------------------------------------------------
  14995. TABLE: non-vol/docsis30
  14997. COMMAND: show
  14999. USAGE: show
  15001. DESCRIPTION:
  15002. Displays the current non-volatile settings values for both the Permanent and
  15003. Dynamic sections.
  15005. EXAMPLES:
  15006. show --
  15008. ------------------------------------------------------------------------------
  15010. TABLE: non-vol/docsis30
  15012. COMMAND: stats
  15014. USAGE: stats
  15016. DESCRIPTION:
  15017. Prints stats about buffer usage for Dynamic and Permanent settings.
  15019. EXAMPLES:
  15020. stats --
  15022. ------------------------------------------------------------------------------
  15024. TABLE: non-vol/docsis30
  15026. COMMAND: tcs_params
  15028. USAGE: tcs_params
  15030. DESCRIPTION:
  15031. Sets the UCID/Tx Power for each entry in the TCS that is considered the last
  15032. 'happy home'.
  15034. EXAMPLES:
  15037. ------------------------------------------------------------------------------
  15039. TABLE: non-vol/docsis30
  15041. COMMAND: tftp_ip
  15043. USAGE: tftp_ip IpAddress
  15045. DESCRIPTION:
  15046. Sets the TFTP server IPv6 address if DHCP is disabled in Docsis non-vol
  15050. EXAMPLES:
  15051. tftp_ip fec0:a:18:5e:a00:20ff:feb3:cfc2
  15053. ------------------------------------------------------------------------------
  15055. TABLE: non-vol/docsis30
  15057. COMMAND: tftp_read
  15059. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  15061. DESCRIPTION:
  15062. Causes the Permanent or Dynamic settings data to be read from a server via
  15063. TFTP. The file must be generated correctly, with all of the headers, CRC,
  15064. and other information that would exist on the NonVol device. The file will
  15065. be read and evaluated for correctness before it is stored in the device. If
  15066. the file is rejected then the settings will be read from the device to undo
  15067. any changes. Normally, this will operate on all settings groups; if you
  15068. specify -g then it will operate only on the current group (e.g. if you are in
  15069. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  15070. read).
  15072. EXAMPLES:
  15073. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  15074. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  15076. ------------------------------------------------------------------------------
  15078. TABLE: non-vol/docsis30
  15080. COMMAND: tftp_write
  15082. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  15084. DESCRIPTION:
  15085. Causes the Permanent or Dynamic settings data to be written to a server via
  15086. TFTP. Normally, this will operate on all settings groups; if you specify -g
  15087. then it will operate only on the current group (e.g. if you are in the SNMP
  15088. nonvol dir, then -g will cause only the SNMP settings group to be written).
  15090. EXAMPLES:
  15091. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  15092. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  15094. ------------------------------------------------------------------------------
  15096. TABLE: non-vol/docsis30
  15098. COMMAND: tod_ip
  15100. USAGE: tod_ip IpAddress
  15102. DESCRIPTION:
  15103. Sets the TOD server IPv6 address if DHCP is disabled in Docsis non-vol
  15107. EXAMPLES:
  15108. tod_ip fec0:a:18:5e:a00:20ff:feb3:cfc2
  15110. ------------------------------------------------------------------------------
  15112. TABLE: non-vol/docsis30
  15114. COMMAND: write
  15116. USAGE: write [both|perm|dyn]
  15118. DESCRIPTION:
  15119. Writes the specified section of non-volatile settings to non-volatile memory.
  15120. If 'both' is specified or there are no parameters, then both Permanent and
  15121. Dynamic settings will be written. Otherwise, only the section specified will
  15122. be written.
  15124. EXAMPLES:
  15125. write -- Writes both Permanent and Dynamic sections of settings.
  15126. write perm -- Writes only the Permanent section of non-vol settings.
  15128. ------------------------------------------------------------------------------
  15130. TABLE: non-vol/ds-cal
  15132. COMMAND: clear_device
  15134. USAGE: clear_device [both|perm|dyn]
  15136. DESCRIPTION:
  15137. Tells the nonvol device to wipe out the specified settings section. All data
  15138. will be lost; the device should be restored to its 'virgin' state. For flash
  15139. devices, the flash block is erased; for disk devices, the file is erased.
  15141. EXAMPLES:
  15142. clear_device -- Clears both Permanent and Dynamic sections.
  15143. clear_device perm -- Clears only the Permanent section.
  15145. ------------------------------------------------------------------------------
  15147. TABLE: non-vol/ds-cal
  15149. COMMAND: clear_tables
  15151. USAGE: clear_tables
  15153. DESCRIPTION:
  15154. Causes the DsCal tables to be filled with zeros for all rows and columns.
  15156. EXAMPLES:
  15157. clear_tables --
  15159. ------------------------------------------------------------------------------
  15161. TABLE: non-vol/ds-cal
  15163. COMMAND: coef
  15165. USAGE: coef tuner|if|fine|eq rowIndex{0..255} coefIndex{0..255} [value]
  15167. DESCRIPTION:
  15168. Sets the coefficient value for the Tuner, IF, Fine/Lna, or Equalizer/Pga
  15169. table, using the row and coef index specified.
  15171. EXAMPLES:
  15172. coef tuner 2 1 -5.781 -- Sets coef for Tuner[2][1] to -5.781
  15174. ------------------------------------------------------------------------------
  15176. TABLE: non-vol/ds-cal
  15178. COMMAND: copy
  15180. USAGE: copy [fromInstance{0..2}]
  15182. DESCRIPTION:
  15183. Copies the settings from the fromSource instance to this instance.
  15185. EXAMPLES:
  15186. copy (1) 0 -- Copies the settings from instance 0 to instance 1.
  15188. ------------------------------------------------------------------------------
  15190. TABLE: non-vol/ds-cal
  15192. COMMAND: defaults
  15194. USAGE: defaults [both|perm|dyn]
  15196. DESCRIPTION:
  15197. Restores the settings to default values. NOTE: This does not write to
  15198. NonVol memory! You must do this manually. Also note that some settings do
  15199. not have good defaults, particularly the Permanent section! Use this command
  15200. with extreme care!
  15202. EXAMPLES:
  15203. defaults -- Sets both Permanent and Dynamic sections to defaults.
  15204. defaults perm -- Sets only the Permanent section to defaults.
  15206. ------------------------------------------------------------------------------
  15208. TABLE: non-vol/ds-cal
  15210. COMMAND: del_extra_data
  15212. USAGE: del_extra_data [both|perm|dyn]
  15214. DESCRIPTION:
  15215. Gets rid of any extra data that is assiociated with the settings. The extra
  15216. data is usually caused by a downgrade, where settings written by a newer
  15217. version are not understood by the older version, but are stored so that they
  15218. will still exist when the new code is run. However, in some cases, it is
  15219. desirable to get rid of them if they are not going to be used.
  15221. EXAMPLES:
  15222. del_extra_data perm -- Gets rid of extra permanent data.
  15224. ------------------------------------------------------------------------------
  15226. TABLE: non-vol/ds-cal
  15228. COMMAND: flush {disabled}
  15230. USAGE: flush
  15232. DESCRIPTION:
  15233. For Composite NonVol Settings objects (which contain 1 or more groups of
  15234. NonVol Settings), this command flushes out any unrecognized groups that were
  15235. read from the device. This is useful in cases where the settings group isn't
  15236. needed by another application, and would just waste space.
  15238. EXAMPLES:
  15239. flush --
  15241. ------------------------------------------------------------------------------
  15243. TABLE: non-vol/ds-cal
  15245. COMMAND: frequency
  15247. USAGE: frequency rowIndex{0..255} [freqHz]
  15249. DESCRIPTION:
  15250. Sets the frequency value for the specified row in the table.
  15252. EXAMPLES:
  15253. frequency 2 327000000 -- Sets frequency[2] to 327MHz.
  15255. ------------------------------------------------------------------------------
  15257. TABLE: non-vol/ds-cal
  15259. COMMAND: ldaix_time
  15261. USAGE: ldaix_time [milliseconds{0..255}]
  15263. DESCRIPTION:
  15264. Sets the time (in milliseconds) between each read of the LDAIx registers.
  15266. EXAMPLES:
  15267. ldaix_time 50 -- Sets the time between LDAIx reads to 50ms.
  15269. ------------------------------------------------------------------------------
  15271. TABLE: non-vol/ds-cal
  15273. COMMAND: manufactured
  15275. USAGE: manufactured [both|perm|dyn]
  15277. DESCRIPTION:
  15278. Checks to see if the specified section is manufactured.
  15280. EXAMPLES:
  15281. manufactured -- Checks both Permanent and Dynamic sections
  15282. manufacturing state.
  15283. manufactured perm -- Checks only the Permanent section manufacturing state.
  15285. ------------------------------------------------------------------------------
  15287. TABLE: non-vol/ds-cal
  15289. COMMAND: master
  15291. USAGE: master [dBmV{-327..327}]
  15293. DESCRIPTION:
  15294. Sets the master offset power value (in dBmV) for the modem. Each frequency
  15295. band in the table has an offset power adjustment that is applied to this
  15296. value when calculating the actual power level.
  15298. EXAMPLES:
  15299. master 58.25 --
  15301. ------------------------------------------------------------------------------
  15303. TABLE: non-vol/ds-cal
  15305. COMMAND: num_coef
  15307. USAGE: num_coef tuner|if|fine|eq [numCoef{1..255}]
  15309. DESCRIPTION:
  15310. Changes the number of coefficients that are stored for each frequency band in
  15311. the specified coeff table. NOTE: This causes that table to be cleared!
  15313. EXAMPLES:
  15314. num_coef tuner 31 -- Configures the Tuner table for 31 coefs per freq band.
  15316. ------------------------------------------------------------------------------
  15318. TABLE: non-vol/ds-cal
  15320. COMMAND: num_freq
  15322. USAGE: num_freq [numFreq{0..255}]
  15324. DESCRIPTION:
  15325. Changes the size of the DsCal table, setting the number of frequency bands
  15326. that will be stored. NOTE: This causes all tables to be cleared!
  15328. EXAMPLES:
  15329. num_freq 14 -- Configures the table for 14 frequency bands.
  15331. ------------------------------------------------------------------------------
  15333. TABLE: non-vol/ds-cal
  15335. COMMAND: num_ldaix
  15337. USAGE: num_ldaix [numLdaixReads{1..255}]
  15339. DESCRIPTION:
  15340. Sets the number of times the LDAIx registers will be read before doing the
  15341. power calculations. It will average the register values.
  15343. EXAMPLES:
  15344. num_ldaix 5 -- Uses the average of 5 samples of the LDAIx registers.
  15346. ------------------------------------------------------------------------------
  15348. TABLE: non-vol/ds-cal
  15350. COMMAND: offset
  15352. USAGE: offset [rowIndex{0..255}] [dBmV{-327..327}]
  15354. DESCRIPTION:
  15355. Sets the offset power adjustment value for the specified row in the table.
  15356. The units are in dBmV units; this value is added to the master power offset
  15357. value.
  15359. EXAMPLES:
  15360. offset 2 -2.25 -- Sets offset[2] to -2.25 dBmV
  15362. ------------------------------------------------------------------------------
  15364. TABLE: non-vol/ds-cal
  15366. COMMAND: read
  15368. USAGE: read [both|perm|dyn]
  15370. DESCRIPTION:
  15371. Reads the specified section of non-volatile settings from non-volatile
  15372. memory. If 'both' is specified or there are no parameters, then both
  15373. Permanent and Dynamic settings will be read. Otherwise, only the section
  15374. specified will be read. This will destroy any changes you have made if you
  15375. haven't written them!
  15377. EXAMPLES:
  15378. read -- Reads both Permanent and Dynamic sections of settings.
  15379. read perm -- Reads only the Permanent section of non-vol settings.
  15381. ------------------------------------------------------------------------------
  15383. TABLE: non-vol/ds-cal
  15385. COMMAND: show
  15387. USAGE: show
  15389. DESCRIPTION:
  15390. Displays the current non-volatile settings values for both the Permanent and
  15391. Dynamic sections.
  15393. EXAMPLES:
  15394. show --
  15396. ------------------------------------------------------------------------------
  15398. TABLE: non-vol/ds-cal
  15400. COMMAND: stats
  15402. USAGE: stats
  15404. DESCRIPTION:
  15405. Prints stats about buffer usage for Dynamic and Permanent settings.
  15407. EXAMPLES:
  15408. stats --
  15410. ------------------------------------------------------------------------------
  15412. TABLE: non-vol/ds-cal
  15414. COMMAND: tftp_read
  15416. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  15418. DESCRIPTION:
  15419. Causes the Permanent or Dynamic settings data to be read from a server via
  15420. TFTP. The file must be generated correctly, with all of the headers, CRC,
  15421. and other information that would exist on the NonVol device. The file will
  15422. be read and evaluated for correctness before it is stored in the device. If
  15423. the file is rejected then the settings will be read from the device to undo
  15424. any changes. Normally, this will operate on all settings groups; if you
  15425. specify -g then it will operate only on the current group (e.g. if you are in
  15426. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  15427. read).
  15429. EXAMPLES:
  15430. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  15431. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  15433. ------------------------------------------------------------------------------
  15435. TABLE: non-vol/ds-cal
  15437. COMMAND: tftp_write
  15439. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  15441. DESCRIPTION:
  15442. Causes the Permanent or Dynamic settings data to be written to a server via
  15443. TFTP. Normally, this will operate on all settings groups; if you specify -g
  15444. then it will operate only on the current group (e.g. if you are in the SNMP
  15445. nonvol dir, then -g will cause only the SNMP settings group to be written).
  15447. EXAMPLES:
  15448. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  15449. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  15451. ------------------------------------------------------------------------------
  15453. TABLE: non-vol/ds-cal
  15455. COMMAND: tuner_step
  15457. USAGE: tuner_step [dBmV{0..8}]
  15459. DESCRIPTION:
  15460. Sets the step size (in dBmV) that was used when sampling the tuner table.
  15461. This influences how the data is interpolated when calculating the tuner
  15462. gainpart of actual power level.
  15464. EXAMPLES:
  15465. tuner_step 1.0 --
  15467. ------------------------------------------------------------------------------
  15469. TABLE: non-vol/ds-cal
  15471. COMMAND: write
  15473. USAGE: write [both|perm|dyn]
  15475. DESCRIPTION:
  15476. Writes the specified section of non-volatile settings to non-volatile memory.
  15477. If 'both' is specified or there are no parameters, then both Permanent and
  15478. Dynamic settings will be written. Otherwise, only the section specified will
  15479. be written.
  15481. EXAMPLES:
  15482. write -- Writes both Permanent and Dynamic sections of settings.
  15483. write perm -- Writes only the Permanent section of non-vol settings.
  15485. ------------------------------------------------------------------------------
  15487. TABLE: non-vol/emtaConfig
  15489. COMMAND: call_signalling_config
  15491. USAGE: call_signalling_config [String{63}]
  15493. DESCRIPTION:
  15494. Gets/sets the call server IP address or FQDN.
  15496. EXAMPLES:
  15497. call_signalling_config myserver.com --
  15499. ------------------------------------------------------------------------------
  15501. TABLE: non-vol/emtaConfig
  15503. COMMAND: clear_device
  15505. USAGE: clear_device [both|perm|dyn]
  15507. DESCRIPTION:
  15508. Tells the nonvol device to wipe out the specified settings section. All data
  15509. will be lost; the device should be restored to its 'virgin' state. For flash
  15510. devices, the flash block is erased; for disk devices, the file is erased.
  15512. EXAMPLES:
  15513. clear_device -- Clears both Permanent and Dynamic sections.
  15514. clear_device perm -- Clears only the Permanent section.
  15516. ------------------------------------------------------------------------------
  15518. TABLE: non-vol/emtaConfig
  15520. COMMAND: dc_offset_ring_enable
  15522. USAGE: dc_offset_ring_enable [true|false]
  15524. DESCRIPTION:
  15525. Enables/disables ring with DC offset support.
  15527. EXAMPLES:
  15528. dc_offset_ring_enable true
  15531. ------------------------------------------------------------------------------
  15533. TABLE: non-vol/emtaConfig
  15535. COMMAND: defaults
  15537. USAGE: defaults [both|perm|dyn]
  15539. DESCRIPTION:
  15540. Restores the settings to default values. NOTE: This does not write to
  15541. NonVol memory! You must do this manually. Also note that some settings do
  15542. not have good defaults, particularly the Permanent section! Use this command
  15543. with extreme care!
  15545. EXAMPLES:
  15546. defaults -- Sets both Permanent and Dynamic sections to defaults.
  15547. defaults perm -- Sets only the Permanent section to defaults.
  15549. ------------------------------------------------------------------------------
  15551. TABLE: non-vol/emtaConfig
  15553. COMMAND: del_extra_data
  15555. USAGE: del_extra_data [both|perm|dyn]
  15557. DESCRIPTION:
  15558. Gets rid of any extra data that is assiociated with the settings. The extra
  15559. data is usually caused by a downgrade, where settings written by a newer
  15560. version are not understood by the older version, but are stored so that they
  15561. will still exist when the new code is run. However, in some cases, it is
  15562. desirable to get rid of them if they are not going to be used.
  15564. EXAMPLES:
  15565. del_extra_data perm -- Gets rid of extra permanent data.
  15567. ------------------------------------------------------------------------------
  15569. TABLE: non-vol/emtaConfig
  15571. COMMAND: dhcp_enable
  15573. USAGE: dhcp_enable [true|false]
  15575. DESCRIPTION:
  15576. Enables/disables DHCP on the EMTA.
  15578. EXAMPLES:
  15579. dhcp_enable true -- EMTA should do real DHCP
  15580. dhcp_enable false -- EMTA should use non-vol settings
  15582. ------------------------------------------------------------------------------
  15584. TABLE: non-vol/emtaConfig
  15586. COMMAND: dhcp_option
  15588. USAGE: dhcp_option [Number{0..255}]
  15590. DESCRIPTION:
  15591. Specifies the DHCP option number which will be used for CM and EMTA DHCP
  15592. requests. Note that PacketCable requires this value MUST be 122.
  15594. EXAMPLES:
  15595. dhcp_option 122
  15598. ------------------------------------------------------------------------------
  15600. TABLE: non-vol/emtaConfig
  15602. COMMAND: dhcp_settings
  15604. USAGE: dhcp_settings
  15606. DESCRIPTION:
  15607. Sets the EMTA DHCP settings. You will be prompted for the values.
  15609. EXAMPLES:
  15610. dhcp_settings --
  15612. ------------------------------------------------------------------------------
  15614. TABLE: non-vol/emtaConfig
  15616. COMMAND: dialtone_timeout
  15618. USAGE: dialtone_timeout [Number{1..2}] [Number{0..65535}]
  15620. DESCRIPTION:
  15621. Dialtone timeout in MS
  15623. EXAMPLES:
  15624. dialtone_timeout 1 10
  15627. ------------------------------------------------------------------------------
  15629. TABLE: non-vol/emtaConfig
  15631. COMMAND: dload_inhibit
  15633. USAGE: dload_inhibit [true|false]
  15635. DESCRIPTION:
  15636. Enables/disables inhibiting DOCSIS SW download while a line is off-hook.
  15638. EXAMPLES:
  15639. dload_inhibit true -- DOCSIS SW download will not be possible while a line
  15640. is off-hook
  15641. dload_inhibit false -- DOCSIS SW download behaves according to the DOCSIS
  15642. spec
  15644. ------------------------------------------------------------------------------
  15646. TABLE: non-vol/emtaConfig
  15648. COMMAND: firewall_disable
  15650. USAGE: firewall_disable [true|false]
  15652. DESCRIPTION:
  15653. Enables/disables the MTA IP stack lightweight firewall.
  15655. EXAMPLES:
  15656. firewall_disable true
  15659. ------------------------------------------------------------------------------
  15661. TABLE: non-vol/emtaConfig
  15663. COMMAND: flush {disabled}
  15665. USAGE: flush
  15667. DESCRIPTION:
  15668. For Composite NonVol Settings objects (which contain 1 or more groups of
  15669. NonVol Settings), this command flushes out any unrecognized groups that were
  15670. read from the device. This is useful in cases where the settings group isn't
  15671. needed by another application, and would just waste space.
  15673. EXAMPLES:
  15674. flush --
  15676. ------------------------------------------------------------------------------
  15678. TABLE: non-vol/emtaConfig
  15680. COMMAND: hv_ring_enable
  15682. USAGE: hv_ring_enable [true|false]
  15684. DESCRIPTION:
  15685. Enables/disables high voltage ring support.
  15687. EXAMPLES:
  15688. hv_ring_enable true -- Enable high voltage ring support.
  15689. hv_ring_enable false -- Disable high voltage ring support.
  15691. ------------------------------------------------------------------------------
  15693. TABLE: non-vol/emtaConfig
  15695. COMMAND: ifadminstatus
  15697. USAGE: ifadminstatus [Number{1..2}] [Number]
  15699. DESCRIPTION:
  15700. Specifies ifAdminStatus value for a given endpoint.
  15702. EXAMPLES:
  15703. ifadminstatus 1 1 -- Set ifAdminStatus for endpoint 1 to 'up'
  15705. ------------------------------------------------------------------------------
  15707. TABLE: non-vol/emtaConfig
  15709. COMMAND: ip_stack
  15711. USAGE: ip_stack [Number{1..8}]
  15713. DESCRIPTION:
  15714. Gets/sets the IP stack number that the EMTA should use.
  15716. EXAMPLES:
  15717. ip_stack 3 --
  15719. ------------------------------------------------------------------------------
  15721. TABLE: non-vol/emtaConfig
  15723. COMMAND: load_balancing_enable
  15725. USAGE: load_balancing_enable [true|false]
  15727. DESCRIPTION:
  15728. Enables/disables dynamic load balancing support.
  15730. EXAMPLES:
  15731. load_balancing_enable true -- Enable dynamic load balancing support.
  15732. load_balancing_enable false -- Disable dynamic load balancing support.
  15734. ------------------------------------------------------------------------------
  15736. TABLE: non-vol/emtaConfig
  15738. COMMAND: manufactured
  15740. USAGE: manufactured [both|perm|dyn]
  15742. DESCRIPTION:
  15743. Checks to see if the specified section is manufactured.
  15745. EXAMPLES:
  15746. manufactured -- Checks both Permanent and Dynamic sections
  15747. manufacturing state.
  15748. manufactured perm -- Checks only the Permanent section manufacturing state.
  15750. ------------------------------------------------------------------------------
  15752. TABLE: non-vol/emtaConfig
  15754. COMMAND: max_cpe_includes_emta
  15756. USAGE: max_cpe_includes_emta [true|false]
  15758. DESCRIPTION:
  15759. Specifies whether to include the EMTA in the CM's max CPE. Note that eDOCSIS
  15760. requires this setting MUST be true.
  15762. EXAMPLES:
  15763. max_cpe_includes_emta true
  15766. ------------------------------------------------------------------------------
  15768. TABLE: non-vol/emtaConfig
  15770. COMMAND: option122
  15772. USAGE: option122
  15774. DESCRIPTION:
  15775. Sets the DHCP option 122 sub-options 1-8. You will be prompted for the
  15776. values.
  15778. EXAMPLES:
  15779. option122 --
  15781. ------------------------------------------------------------------------------
  15783. TABLE: non-vol/emtaConfig
  15785. COMMAND: phs_enable
  15787. USAGE: phs_enable [true|false]
  15789. DESCRIPTION:
  15790. Enables/disables PHS for EMTA flows only.
  15792. EXAMPLES:
  15793. phs_enable true -- EMTA should request PHS on US/DS flows
  15794. phs_enable false -- EMTA should NOT request PHS on US/DS flows
  15796. ------------------------------------------------------------------------------
  15798. TABLE: non-vol/emtaConfig
  15800. COMMAND: read
  15802. USAGE: read [both|perm|dyn]
  15804. DESCRIPTION:
  15805. Reads the specified section of non-volatile settings from non-volatile
  15806. memory. If 'both' is specified or there are no parameters, then both
  15807. Permanent and Dynamic settings will be read. Otherwise, only the section
  15808. specified will be read. This will destroy any changes you have made if you
  15809. haven't written them!
  15811. EXAMPLES:
  15812. read -- Reads both Permanent and Dynamic sections of settings.
  15813. read perm -- Reads only the Permanent section of non-vol settings.
  15815. ------------------------------------------------------------------------------
  15817. TABLE: non-vol/emtaConfig
  15819. COMMAND: ringoffsetcal
  15821. USAGE: ringoffsetcal [Number{1..2}] [Number]
  15823. DESCRIPTION:
  15824. Specifies ring offset Calibration for a channel.
  15826. EXAMPLES:
  15827. ringoffsetcal 1 5
  15830. ------------------------------------------------------------------------------
  15832. TABLE: non-vol/emtaConfig
  15834. COMMAND: rtp_port
  15836. USAGE: rtp_port [Number{0..65535}]
  15838. DESCRIPTION:
  15839. Specifies the UDP port for RTP.
  15841. EXAMPLES:
  15842. rtp_port 53456
  15845. ------------------------------------------------------------------------------
  15847. TABLE: non-vol/emtaConfig
  15849. COMMAND: severities
  15851. USAGE: severities [dns|kerb|ncs|mta|prov] [Number]
  15853. DESCRIPTION:
  15854. Sets non-vol message log severities bitmask for EMTA
  15855. Message logging bit definitions:
  15857. 0x00000001 -- Fatal Errors
  15858. 0x00000002 -- Errors
  15859. 0x00000004 -- Warnings
  15860. 0x00000008 -- Initialization
  15861. 0x00000010 -- Function entry/exit
  15862. 0x00000020 -- Informational
  15863. 0xffffffc0 -- Application-specific
  15864. 0xffffffff -- All messages
  15866. EXAMPLES:
  15867. severities ncs 0x2f
  15869. ------------------------------------------------------------------------------
  15871. TABLE: non-vol/emtaConfig
  15873. COMMAND: show
  15875. USAGE: show
  15877. DESCRIPTION:
  15878. Displays the current non-volatile settings values for both the Permanent and
  15879. Dynamic sections.
  15881. EXAMPLES:
  15882. show --
  15884. ------------------------------------------------------------------------------
  15886. TABLE: non-vol/emtaConfig
  15888. COMMAND: standalone
  15890. USAGE: standalone [true|false]
  15892. DESCRIPTION:
  15893. Tells whether the EMTA should run only after DOCSIS reaches Operational
  15894. state, or if the DOCSIS control thread is disabled and the EMTA should be
  15895. activated immediately.
  15897. EXAMPLES:
  15898. standalone true -- Activates the EMTA without DOCSIS.
  15899. standalone false -- EMTA run after DOCSIS is operational.
  15901. ------------------------------------------------------------------------------
  15903. TABLE: non-vol/emtaConfig
  15905. COMMAND: stats
  15907. USAGE: stats
  15909. DESCRIPTION:
  15910. Prints stats about buffer usage for Dynamic and Permanent settings.
  15912. EXAMPLES:
  15913. stats --
  15915. ------------------------------------------------------------------------------
  15917. TABLE: non-vol/emtaConfig
  15919. COMMAND: tftp_read
  15921. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  15923. DESCRIPTION:
  15924. Causes the Permanent or Dynamic settings data to be read from a server via
  15925. TFTP. The file must be generated correctly, with all of the headers, CRC,
  15926. and other information that would exist on the NonVol device. The file will
  15927. be read and evaluated for correctness before it is stored in the device. If
  15928. the file is rejected then the settings will be read from the device to undo
  15929. any changes. Normally, this will operate on all settings groups; if you
  15930. specify -g then it will operate only on the current group (e.g. if you are in
  15931. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  15932. read).
  15934. EXAMPLES:
  15935. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  15936. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  15938. ------------------------------------------------------------------------------
  15940. TABLE: non-vol/emtaConfig
  15942. COMMAND: tftp_write
  15944. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  15946. DESCRIPTION:
  15947. Causes the Permanent or Dynamic settings data to be written to a server via
  15948. TFTP. Normally, this will operate on all settings groups; if you specify -g
  15949. then it will operate only on the current group (e.g. if you are in the SNMP
  15950. nonvol dir, then -g will cause only the SNMP settings group to be written).
  15952. EXAMPLES:
  15953. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  15954. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  15956. ------------------------------------------------------------------------------
  15958. TABLE: non-vol/emtaConfig
  15960. COMMAND: write
  15962. USAGE: write [both|perm|dyn]
  15964. DESCRIPTION:
  15965. Writes the specified section of non-volatile settings to non-volatile memory.
  15966. If 'both' is specified or there are no parameters, then both Permanent and
  15967. Dynamic settings will be written. Otherwise, only the section specified will
  15968. be written.
  15970. EXAMPLES:
  15971. write -- Writes both Permanent and Dynamic sections of settings.
  15972. write perm -- Writes only the Permanent section of non-vol settings.
  15974. ------------------------------------------------------------------------------
  15976. TABLE: non-vol/emtaConfigVoice
  15978. COMMAND: authblockTLV
  15980. USAGE: authblockTLV [Enable{254}]
  15982. DESCRIPTION:
  15983. Toggle authblock TLV format.
  15985. EXAMPLES:
  15986. authblockTLV -- Display current authblock TLV format.
  15987. authblockTLV 1 -- Enable authblock TLV format.
  15988. authblockTLV 0 -- Disable authblock TLV format.
  15990. ------------------------------------------------------------------------------
  15992. TABLE: non-vol/emtaConfigVoice
  15994. COMMAND: certEnv
  15996. USAGE: certEnv [Mode{254}]
  15998. DESCRIPTION:
  15999. Toggle the current certificate environment.
  16001. EXAMPLES:
  16002. certEnv -- Display current certificate environment.
  16003. certEnv 0 -- Use certCfg.h file.
  16004. certEnv 1 -- Use PacketCable Certs.
  16006. ------------------------------------------------------------------------------
  16008. TABLE: non-vol/emtaConfigVoice
  16010. COMMAND: clear_device
  16012. USAGE: clear_device [both|perm|dyn]
  16014. DESCRIPTION:
  16015. Tells the nonvol device to wipe out the specified settings section. All data
  16016. will be lost; the device should be restored to its 'virgin' state. For flash
  16017. devices, the flash block is erased; for disk devices, the file is erased.
  16019. EXAMPLES:
  16020. clear_device -- Clears both Permanent and Dynamic sections.
  16021. clear_device perm -- Clears only the Permanent section.
  16023. ------------------------------------------------------------------------------
  16025. TABLE: non-vol/emtaConfigVoice
  16027. COMMAND: defaults
  16029. USAGE: defaults [both|perm|dyn]
  16031. DESCRIPTION:
  16032. Restores the settings to default values. NOTE: This does not write to
  16033. NonVol memory! You must do this manually. Also note that some settings do
  16034. not have good defaults, particularly the Permanent section! Use this command
  16035. with extreme care!
  16037. EXAMPLES:
  16038. defaults -- Sets both Permanent and Dynamic sections to defaults.
  16039. defaults perm -- Sets only the Permanent section to defaults.
  16041. ------------------------------------------------------------------------------
  16043. TABLE: non-vol/emtaConfigVoice
  16045. COMMAND: del_extra_data
  16047. USAGE: del_extra_data [both|perm|dyn]
  16049. DESCRIPTION:
  16050. Gets rid of any extra data that is assiociated with the settings. The extra
  16051. data is usually caused by a downgrade, where settings written by a newer
  16052. version are not understood by the older version, but are stored so that they
  16053. will still exist when the new code is run. However, in some cases, it is
  16054. desirable to get rid of them if they are not going to be used.
  16056. EXAMPLES:
  16057. del_extra_data perm -- Gets rid of extra permanent data.
  16059. ------------------------------------------------------------------------------
  16061. TABLE: non-vol/emtaConfigVoice
  16063. COMMAND: devSerialNumber
  16065. USAGE: devSerialNumber [SerialNumber{254}]
  16067. DESCRIPTION:
  16068. Get or Set the Device Serial Number, a string with size up to 130
  16069. characeters.
  16071. EXAMPLES:
  16072. devSerialNumber -- Display current Device Serial Number.
  16073. devSerialNumber NULL -- Clear the Device Serial Number
  16074. devSerialNumber ### -- Set the Device Serial Number to ###
  16076. ------------------------------------------------------------------------------
  16078. TABLE: non-vol/emtaConfigVoice
  16080. COMMAND: dload
  16082. USAGE: dload TFTP_IP{254} File{254}
  16084. DESCRIPTION:
  16085. Download MTA non-vol/certificates from a server. File is expected to be in
  16086. non-vol builder format.
  16088. EXAMPLES:
  16089. dload 10.1.0.6 cert.bin -- Download cert.bin from 10.1.06.
  16091. ------------------------------------------------------------------------------
  16093. TABLE: non-vol/emtaConfigVoice
  16095. COMMAND: enforceGateId
  16097. USAGE: enforceGateId [Enable{254}]
  16099. DESCRIPTION:
  16100. Toggle DQoS GateID enforcement.
  16102. EXAMPLES:
  16103. enforceGateId -- Display current GateID setting.
  16104. enforceGateId 1 -- Enable GateID enforcement.
  16105. enforceGateId 0 -- Disable GateID enforcement.
  16107. ------------------------------------------------------------------------------
  16109. TABLE: non-vol/emtaConfigVoice
  16111. COMMAND: eventLog
  16113. USAGE: eventLog [Enable{254}]
  16115. DESCRIPTION:
  16116. Toggle additional event logging.
  16118. EXAMPLES:
  16119. eventLog -- Display current additional event log setting.
  16120. eventLog 1 -- Enable additional event logging.
  16121. eventLog 0 -- Disable additional event logging.
  16123. ------------------------------------------------------------------------------
  16125. TABLE: non-vol/emtaConfigVoice
  16127. COMMAND: flush {disabled}
  16129. USAGE: flush
  16131. DESCRIPTION:
  16132. For Composite NonVol Settings objects (which contain 1 or more groups of
  16133. NonVol Settings), this command flushes out any unrecognized groups that were
  16134. read from the device. This is useful in cases where the settings group isn't
  16135. needed by another application, and would just waste space.
  16137. EXAMPLES:
  16138. flush --
  16140. ------------------------------------------------------------------------------
  16142. TABLE: non-vol/emtaConfigVoice
  16144. COMMAND: fqdnCheck
  16146. USAGE: fqdnCheck [Enable{254}]
  16148. DESCRIPTION:
  16149. Toggle FQDN Syntax Checking.
  16151. EXAMPLES:
  16152. fqdnCheck -- Display current FQDN Syntax Checking.
  16153. fqdnCheck 1 -- Enable FQDN Syntax Checking.
  16154. fqdnCheck 0 -- Disable FQDN Syntax Checking.
  16156. ------------------------------------------------------------------------------
  16158. TABLE: non-vol/emtaConfigVoice
  16160. COMMAND: ipsecDisabled
  16162. USAGE: ipsecDisabled [Disable{254}]
  16164. DESCRIPTION:
  16165. Toggle ISPEC establishment.
  16167. EXAMPLES:
  16168. ipsecDisabled 1 -- Disable ISPEC establishment.
  16169. ipsecDisabled 0 -- Enable ISPEC establishment.
  16171. ------------------------------------------------------------------------------
  16173. TABLE: non-vol/emtaConfigVoice
  16175. COMMAND: krbContProvFlag
  16177. USAGE: krbContProvFlag [Flag{254}]
  16179. DESCRIPTION:
  16180. Continue provisioning if kerberos fails.
  16182. EXAMPLES:
  16183. krbContProvFlag -- Display current setting for continue if kerberos fails.
  16184. krbContProvFlag 1 -- Continue provisioning if kerberos fails.
  16185. krbContProvFlag 0 -- Do not continue provisioning if kerberos fails.
  16187. ------------------------------------------------------------------------------
  16189. TABLE: non-vol/emtaConfigVoice
  16191. COMMAND: krbFlag
  16193. USAGE: krbFlag [Flag{254}]
  16195. DESCRIPTION:
  16196. Get or Set Kerberos flag for SNMPv3 and IPSEC.
  16198. EXAMPLES:
  16199. krbFlag -- Display current Kerberos flag setting.
  16200. krbFlag 0 -- No Kerberos for SNMPv3 or IPSEC
  16201. krbFlag 1 -- Kerberos for IPSEC
  16202. krbFlag 2 -- Kerberos for SNMPv3
  16203. krbFlag 3 -- Kerberos for both SNMPv3 and IPSEC
  16205. ------------------------------------------------------------------------------
  16207. TABLE: non-vol/emtaConfigVoice
  16209. COMMAND: manufactured
  16211. USAGE: manufactured [both|perm|dyn]
  16213. DESCRIPTION:
  16214. Checks to see if the specified section is manufactured.
  16216. EXAMPLES:
  16217. manufactured -- Checks both Permanent and Dynamic sections
  16218. manufacturing state.
  16219. manufactured perm -- Checks only the Permanent section manufacturing state.
  16221. ------------------------------------------------------------------------------
  16223. TABLE: non-vol/emtaConfigVoice
  16225. COMMAND: mediaSecDisable
  16227. USAGE: mediaSecDisable [Disable{254}]
  16229. DESCRIPTION:
  16230. Toggle Media Security.
  16232. EXAMPLES:
  16233. mediaSecDisable 1 -- Disable Media Security.
  16234. mediaSecDisable 0 -- Enable Media Security.
  16236. ------------------------------------------------------------------------------
  16238. TABLE: non-vol/emtaConfigVoice
  16240. COMMAND: orgName
  16242. USAGE: orgName [Name{254}]
  16244. DESCRIPTION:
  16245. Get or Set the Organization Name for Prov Server Certificate.
  16247. EXAMPLES:
  16248. orgName -- Display current Organization Name.
  16249. orgName OrgName -- Set Organization Name to OrgName.
  16251. ------------------------------------------------------------------------------
  16253. TABLE: non-vol/emtaConfigVoice
  16255. COMMAND: pktcCompDisable
  16257. USAGE: pktcCompDisable [Disable{254}]
  16259. DESCRIPTION:
  16260. Toggle PKTC Compliancy.
  16262. EXAMPLES:
  16263. pktcCompDisable -- Display current PKTC compliancy setting.
  16264. pktcCompDisable 1 -- Disable PKTC Compliancy.
  16265. pktcCompDisable 0 -- Enable PKTC Compliancy.
  16267. ------------------------------------------------------------------------------
  16269. TABLE: non-vol/emtaConfigVoice
  16271. COMMAND: printCert
  16273. USAGE: printCert CertType{254}
  16275. DESCRIPTION:
  16276. Show the certificates in NVRAM in readable text.
  16277. Depending on the other non-vol setting, the certificate printed may not be
  16278. the certificated being used.
  16280. EXAMPLES:
  16281. printCert 1 -- Display Telephony Root Cert.
  16282. printCert 2 -- Display MTA Manufacture Cert.
  16283. printCert 3 -- Display MTA Device Cert.
  16286. ------------------------------------------------------------------------------
  16288. TABLE: non-vol/emtaConfigVoice
  16290. COMMAND: provRspDisable
  16292. USAGE: provRspDisable [Disable{254}]
  16294. DESCRIPTION:
  16295. Toggle provisional response support.
  16297. EXAMPLES:
  16298. provRspDisable -- Display current provisional response.
  16299. provRspDisable 1 -- Disable provisional responses.
  16300. provRspDisable 0 -- Enable provisional responses.
  16302. ------------------------------------------------------------------------------
  16304. TABLE: non-vol/emtaConfigVoice
  16306. COMMAND: read
  16308. USAGE: read [both|perm|dyn]
  16310. DESCRIPTION:
  16311. Reads the specified section of non-volatile settings from non-volatile
  16312. memory. If 'both' is specified or there are no parameters, then both
  16313. Permanent and Dynamic settings will be read. Otherwise, only the section
  16314. specified will be read. This will destroy any changes you have made if you
  16315. haven't written them!
  16317. EXAMPLES:
  16318. read -- Reads both Permanent and Dynamic sections of settings.
  16319. read perm -- Reads only the Permanent section of non-vol settings.
  16321. ------------------------------------------------------------------------------
  16323. TABLE: non-vol/emtaConfigVoice
  16325. COMMAND: resetTickets
  16327. USAGE: resetTickets [Flag{254}]
  16329. DESCRIPTION:
  16330. Value corresponding to pktcMtaDevResetKrbTickets.
  16332. EXAMPLES:
  16333. resetTickets -- Display current setting for pktcMtaDevResetKrbTickets.
  16334. resetTickets 0 -- No tickets is reset.
  16335. resetTickets 1 -- Reset CMS tickets.
  16336. resetTickets 2 -- Reset Prov ticket
  16337. resetTickets 3 -- Reset both CMS and Prov tickets
  16339. ------------------------------------------------------------------------------
  16341. TABLE: non-vol/emtaConfigVoice
  16343. COMMAND: setCountry
  16345. USAGE: setCountry [Code{254}]
  16347. DESCRIPTION:
  16348. Sets current country code.
  16350. EXAMPLES:
  16351. setCountry -- Display current country code.
  16352. setCountry 0 -- Set country code to NORTH_AMERICA.
  16354. ------------------------------------------------------------------------------
  16356. TABLE: non-vol/emtaConfigVoice
  16358. COMMAND: show
  16360. USAGE: show
  16362. DESCRIPTION:
  16363. Displays the current non-volatile settings values for both the Permanent and
  16364. Dynamic sections.
  16366. EXAMPLES:
  16367. show --
  16369. ------------------------------------------------------------------------------
  16371. TABLE: non-vol/emtaConfigVoice
  16373. COMMAND: showTickets
  16375. USAGE: showTickets
  16377. DESCRIPTION:
  16378. Show all tickets in NVM.
  16380. EXAMPLES:
  16381. showTickets -- Display all Kerberos tickets in NVM.
  16383. ------------------------------------------------------------------------------
  16385. TABLE: non-vol/emtaConfigVoice
  16387. COMMAND: snmpInformDisable
  16389. USAGE: snmpInformDisable [SNMPType{254}]
  16391. DESCRIPTION:
  16392. Toggle SNMP INFORM operation.
  16394. EXAMPLES:
  16395. snmpInformDisable -- Display current SNMP INFORM operation setting.
  16396. snmpInformDisable 0 -- Use SNMP INFROM with Passphase disabled
  16397. snmpInformDisable 1 -- Use SNMP TRAP with Passphase disabled
  16398. snmpInformDisable 2 -- Use SNMP INFROM with Passphase enabled.
  16399. snmpInformDisable 3 -- Use SNMP TRAP with Passphase enabled.
  16401. ------------------------------------------------------------------------------
  16403. TABLE: non-vol/emtaConfigVoice
  16405. COMMAND: snmpOperMode
  16407. USAGE: snmpOperMode [Mode{254}]
  16409. DESCRIPTION:
  16410. SNMP Operation Mode (PacketCable Prov. Flow).
  16412. EXAMPLES:
  16413. snmpOperMode 0 -- Secure - SNMPv3.
  16414. snmpOperMode 1 -- BASIC.1 - SNMPv2.
  16415. snmpOperMode 2 -- BASIC.2 - SNMPv2.
  16416. snmpOperMode 3 -- HYBRID.1 - SNMPv2.
  16417. snmpOperMode 4 -- HYBRID.2 - SNMPv2.
  16419. ------------------------------------------------------------------------------
  16421. TABLE: non-vol/emtaConfigVoice
  16423. COMMAND: snmpV2ComNamRO
  16425. USAGE: snmpV2ComNamRO [Name{254}]
  16427. DESCRIPTION:
  16428. Get or Set the Read-Only SNMPv2 Community Name.
  16430. EXAMPLES:
  16431. snmpV2ComNamRO -- Show the RO community name.
  16432. snmpV2ComNamRO NULL -- Clear the RO community name.
  16433. snmpV2ComNamRO CommunityName -- Set the RO community name to CommunityName.
  16435. ------------------------------------------------------------------------------
  16437. TABLE: non-vol/emtaConfigVoice
  16439. COMMAND: snmpV2ComNamRW
  16441. USAGE: snmpV2ComNamRW [Name{254}]
  16443. DESCRIPTION:
  16444. Get or Set the Read-Write SNMPv2 Community Name.
  16446. EXAMPLES:
  16447. snmpV2ComNamRW -- Show the RW community name.
  16448. snmpV2ComNamRW NULL -- Clear the RW community name.
  16449. snmpV2ComNamRW CommunityName -- Set the RW community name to CommunityName.
  16451. ------------------------------------------------------------------------------
  16453. TABLE: non-vol/emtaConfigVoice
  16455. COMMAND: stats
  16457. USAGE: stats
  16459. DESCRIPTION:
  16460. Prints stats about buffer usage for Dynamic and Permanent settings.
  16462. EXAMPLES:
  16463. stats --
  16465. ------------------------------------------------------------------------------
  16467. TABLE: non-vol/emtaConfigVoice
  16469. COMMAND: tftp_read
  16471. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  16473. DESCRIPTION:
  16474. Causes the Permanent or Dynamic settings data to be read from a server via
  16475. TFTP. The file must be generated correctly, with all of the headers, CRC,
  16476. and other information that would exist on the NonVol device. The file will
  16477. be read and evaluated for correctness before it is stored in the device. If
  16478. the file is rejected then the settings will be read from the device to undo
  16479. any changes. Normally, this will operate on all settings groups; if you
  16480. specify -g then it will operate only on the current group (e.g. if you are in
  16481. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  16482. read).
  16484. EXAMPLES:
  16485. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  16486. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  16488. ------------------------------------------------------------------------------
  16490. TABLE: non-vol/emtaConfigVoice
  16492. COMMAND: tftp_write
  16494. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  16496. DESCRIPTION:
  16497. Causes the Permanent or Dynamic settings data to be written to a server via
  16498. TFTP. Normally, this will operate on all settings groups; if you specify -g
  16499. then it will operate only on the current group (e.g. if you are in the SNMP
  16500. nonvol dir, then -g will cause only the SNMP settings group to be written).
  16502. EXAMPLES:
  16503. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  16504. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  16506. ------------------------------------------------------------------------------
  16508. TABLE: non-vol/emtaConfigVoice
  16510. COMMAND: ugsAd
  16512. USAGE: ugsAd [Enable{254}]
  16514. DESCRIPTION:
  16515. Toggle UGS-AD support.
  16517. EXAMPLES:
  16518. ugsAd -- Display current UGS-AD support.
  16519. ugsAd 1 -- Enable UGS-AD support.
  16520. ugsAd 0 -- Disable UGS-AD support.
  16522. ------------------------------------------------------------------------------
  16524. TABLE: non-vol/emtaConfigVoice
  16526. COMMAND: write
  16528. USAGE: write [both|perm|dyn]
  16530. DESCRIPTION:
  16531. Writes the specified section of non-volatile settings to non-volatile memory.
  16532. If 'both' is specified or there are no parameters, then both Permanent and
  16533. Dynamic settings will be written. Otherwise, only the section specified will
  16534. be written.
  16536. EXAMPLES:
  16537. write -- Writes both Permanent and Dynamic sections of settings.
  16538. write perm -- Writes only the Permanent section of non-vol settings.
  16540. ------------------------------------------------------------------------------
  16542. TABLE: non-vol/emtaSecurity
  16544. COMMAND: alternate_telephony_root_cert
  16546. USAGE: alternate_telephony_root_cert [enable]
  16548. DESCRIPTION:
  16549. Use the alternate telephony root certificate as provisioned in NVRAM instead
  16550. of the certificate embedded in the FW image. Normally this should be set to
  16551. 'false' (the default) so that the embedded cert will be used. Alternate cert
  16552. is generally used only for testing, development, or other special situations.
  16554. EXAMPLES:
  16555. alternate_telephony_root_cert true -- Use the telephony root cert from
  16556. NVRAM.
  16557. alternate_telephony_root_cert false -- Use the telephony root cert embedded
  16558. in the image.
  16560. ------------------------------------------------------------------------------
  16562. TABLE: non-vol/emtaSecurity
  16564. COMMAND: clear_device
  16566. USAGE: clear_device [both|perm|dyn]
  16568. DESCRIPTION:
  16569. Tells the nonvol device to wipe out the specified settings section. All data
  16570. will be lost; the device should be restored to its 'virgin' state. For flash
  16571. devices, the flash block is erased; for disk devices, the file is erased.
  16573. EXAMPLES:
  16574. clear_device -- Clears both Permanent and Dynamic sections.
  16575. clear_device perm -- Clears only the Permanent section.
  16577. ------------------------------------------------------------------------------
  16579. TABLE: non-vol/emtaSecurity
  16581. COMMAND: defaults
  16583. USAGE: defaults [both|perm|dyn]
  16585. DESCRIPTION:
  16586. Restores the settings to default values. NOTE: This does not write to
  16587. NonVol memory! You must do this manually. Also note that some settings do
  16588. not have good defaults, particularly the Permanent section! Use this command
  16589. with extreme care!
  16591. EXAMPLES:
  16592. defaults -- Sets both Permanent and Dynamic sections to defaults.
  16593. defaults perm -- Sets only the Permanent section to defaults.
  16595. ------------------------------------------------------------------------------
  16597. TABLE: non-vol/emtaSecurity
  16599. COMMAND: del_extra_data
  16601. USAGE: del_extra_data [both|perm|dyn]
  16603. DESCRIPTION:
  16604. Gets rid of any extra data that is assiociated with the settings. The extra
  16605. data is usually caused by a downgrade, where settings written by a newer
  16606. version are not understood by the older version, but are stored so that they
  16607. will still exist when the new code is run. However, in some cases, it is
  16608. desirable to get rid of them if they are not going to be used.
  16610. EXAMPLES:
  16611. del_extra_data perm -- Gets rid of extra permanent data.
  16613. ------------------------------------------------------------------------------
  16615. TABLE: non-vol/emtaSecurity
  16617. COMMAND: flush {disabled}
  16619. USAGE: flush
  16621. DESCRIPTION:
  16622. For Composite NonVol Settings objects (which contain 1 or more groups of
  16623. NonVol Settings), this command flushes out any unrecognized groups that were
  16624. read from the device. This is useful in cases where the settings group isn't
  16625. needed by another application, and would just waste space.
  16627. EXAMPLES:
  16628. flush --
  16630. ------------------------------------------------------------------------------
  16632. TABLE: non-vol/emtaSecurity
  16634. COMMAND: manufactured
  16636. USAGE: manufactured [both|perm|dyn]
  16638. DESCRIPTION:
  16639. Checks to see if the specified section is manufactured.
  16641. EXAMPLES:
  16642. manufactured -- Checks both Permanent and Dynamic sections
  16643. manufacturing state.
  16644. manufactured perm -- Checks only the Permanent section manufacturing state.
  16646. ------------------------------------------------------------------------------
  16648. TABLE: non-vol/emtaSecurity
  16650. COMMAND: read
  16652. USAGE: read [both|perm|dyn]
  16654. DESCRIPTION:
  16655. Reads the specified section of non-volatile settings from non-volatile
  16656. memory. If 'both' is specified or there are no parameters, then both
  16657. Permanent and Dynamic settings will be read. Otherwise, only the section
  16658. specified will be read. This will destroy any changes you have made if you
  16659. haven't written them!
  16661. EXAMPLES:
  16662. read -- Reads both Permanent and Dynamic sections of settings.
  16663. read perm -- Reads only the Permanent section of non-vol settings.
  16665. ------------------------------------------------------------------------------
  16667. TABLE: non-vol/emtaSecurity
  16669. COMMAND: show
  16671. USAGE: show
  16673. DESCRIPTION:
  16674. Displays the current non-volatile settings values for both the Permanent and
  16675. Dynamic sections.
  16677. EXAMPLES:
  16678. show --
  16680. ------------------------------------------------------------------------------
  16682. TABLE: non-vol/emtaSecurity
  16684. COMMAND: stats
  16686. USAGE: stats
  16688. DESCRIPTION:
  16689. Prints stats about buffer usage for Dynamic and Permanent settings.
  16691. EXAMPLES:
  16692. stats --
  16694. ------------------------------------------------------------------------------
  16696. TABLE: non-vol/emtaSecurity
  16698. COMMAND: tftp_read
  16700. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  16702. DESCRIPTION:
  16703. Causes the Permanent or Dynamic settings data to be read from a server via
  16704. TFTP. The file must be generated correctly, with all of the headers, CRC,
  16705. and other information that would exist on the NonVol device. The file will
  16706. be read and evaluated for correctness before it is stored in the device. If
  16707. the file is rejected then the settings will be read from the device to undo
  16708. any changes. Normally, this will operate on all settings groups; if you
  16709. specify -g then it will operate only on the current group (e.g. if you are in
  16710. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  16711. read).
  16713. EXAMPLES:
  16714. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  16715. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  16717. ------------------------------------------------------------------------------
  16719. TABLE: non-vol/emtaSecurity
  16721. COMMAND: tftp_write
  16723. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  16725. DESCRIPTION:
  16726. Causes the Permanent or Dynamic settings data to be written to a server via
  16727. TFTP. Normally, this will operate on all settings groups; if you specify -g
  16728. then it will operate only on the current group (e.g. if you are in the SNMP
  16729. nonvol dir, then -g will cause only the SNMP settings group to be written).
  16731. EXAMPLES:
  16732. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  16733. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  16735. ------------------------------------------------------------------------------
  16737. TABLE: non-vol/emtaSecurity
  16739. COMMAND: write
  16741. USAGE: write [both|perm|dyn]
  16743. DESCRIPTION:
  16744. Writes the specified section of non-volatile settings to non-volatile memory.
  16745. If 'both' is specified or there are no parameters, then both Permanent and
  16746. Dynamic settings will be written. Otherwise, only the section specified will
  16747. be written.
  16749. EXAMPLES:
  16750. write -- Writes both Permanent and Dynamic sections of settings.
  16751. write perm -- Writes only the Permanent section of non-vol settings.
  16753. ------------------------------------------------------------------------------
  16755. TABLE: non-vol/emtaSnmp
  16757. COMMAND: auth_key
  16759. USAGE: auth_key [show|set]
  16761. DESCRIPTION:
  16762. Sets or shows the MTA SNMP V3 Auth Key. You will be prompted for values when
  16763. setting the key.
  16765. EXAMPLES:
  16766. auth_key set
  16768. ------------------------------------------------------------------------------
  16770. TABLE: non-vol/emtaSnmp
  16772. COMMAND: clear_device
  16774. USAGE: clear_device [both|perm|dyn]
  16776. DESCRIPTION:
  16777. Tells the nonvol device to wipe out the specified settings section. All data
  16778. will be lost; the device should be restored to its 'virgin' state. For flash
  16779. devices, the flash block is erased; for disk devices, the file is erased.
  16781. EXAMPLES:
  16782. clear_device -- Clears both Permanent and Dynamic sections.
  16783. clear_device perm -- Clears only the Permanent section.
  16785. ------------------------------------------------------------------------------
  16787. TABLE: non-vol/emtaSnmp
  16789. COMMAND: defaults
  16791. USAGE: defaults [both|perm|dyn]
  16793. DESCRIPTION:
  16794. Restores the settings to default values. NOTE: This does not write to
  16795. NonVol memory! You must do this manually. Also note that some settings do
  16796. not have good defaults, particularly the Permanent section! Use this command
  16797. with extreme care!
  16799. EXAMPLES:
  16800. defaults -- Sets both Permanent and Dynamic sections to defaults.
  16801. defaults perm -- Sets only the Permanent section to defaults.
  16803. ------------------------------------------------------------------------------
  16805. TABLE: non-vol/emtaSnmp
  16807. COMMAND: del_extra_data
  16809. USAGE: del_extra_data [both|perm|dyn]
  16811. DESCRIPTION:
  16812. Gets rid of any extra data that is assiociated with the settings. The extra
  16813. data is usually caused by a downgrade, where settings written by a newer
  16814. version are not understood by the older version, but are stored so that they
  16815. will still exist when the new code is run. However, in some cases, it is
  16816. desirable to get rid of them if they are not going to be used.
  16818. EXAMPLES:
  16819. del_extra_data perm -- Gets rid of extra permanent data.
  16821. ------------------------------------------------------------------------------
  16823. TABLE: non-vol/emtaSnmp
  16825. COMMAND: endpoint_count
  16827. USAGE: endpoint_count [Number{1..255}]
  16829. DESCRIPTION:
  16830. Sets or shows the number of MTA endpoints.
  16832. EXAMPLES:
  16833. endpoint_count 4
  16835. ------------------------------------------------------------------------------
  16837. TABLE: non-vol/emtaSnmp
  16839. COMMAND: event
  16841. USAGE: event show|set|clear|delete Index{-1..255} [EventText{127}]
  16843. DESCRIPTION:
  16844. Allows you to modify entries in the event log. The first parameter tells
  16845. what
  16846. action you want to perform. You must specify an Index for the event to act
  16847. on.
  16848. An Index of -1 causes the action to be performed for all events. You must
  16849. specify the EventText for set.
  16851. EXAMPLES:
  16852. event show -1 Shows all event log entries.
  16853. event show 5 Shows the event at index 5 (the 6th
  16854. event).
  16855. event set 2 "Changed event" Changes the 3rd event.
  16856. event clear 2 Clears the 3rd event.
  16857. event delete 5 Deletes the 6th event.
  16858. event delete -1 Deletes all events.
  16860. ------------------------------------------------------------------------------
  16862. TABLE: non-vol/emtaSnmp
  16864. COMMAND: event_add
  16866. USAGE: event_add EventText{127}
  16868. DESCRIPTION:
  16869. Allows you to add entries to the event log. New entries are added to the
  16870. end.
  16872. EXAMPLES:
  16873. event_add "This is a new event" Adds an event.
  16875. ------------------------------------------------------------------------------
  16877. TABLE: non-vol/emtaSnmp
  16879. COMMAND: flush {disabled}
  16881. USAGE: flush
  16883. DESCRIPTION:
  16884. For Composite NonVol Settings objects (which contain 1 or more groups of
  16885. NonVol Settings), this command flushes out any unrecognized groups that were
  16886. read from the device. This is useful in cases where the settings group isn't
  16887. needed by another application, and would just waste space.
  16889. EXAMPLES:
  16890. flush --
  16892. ------------------------------------------------------------------------------
  16894. TABLE: non-vol/emtaSnmp
  16896. COMMAND: hardware_version
  16898. USAGE: hardware_version [String{47}]
  16900. DESCRIPTION:
  16901. Sets or shows the MTA hardware version. This is just a string parameter.
  16903. EXAMPLES:
  16904. hardware_version "Rev 123.5a"
  16906. ------------------------------------------------------------------------------
  16908. TABLE: non-vol/emtaSnmp
  16910. COMMAND: manufactured
  16912. USAGE: manufactured [both|perm|dyn]
  16914. DESCRIPTION:
  16915. Checks to see if the specified section is manufactured.
  16917. EXAMPLES:
  16918. manufactured -- Checks both Permanent and Dynamic sections
  16919. manufacturing state.
  16920. manufactured perm -- Checks only the Permanent section manufacturing state.
  16922. ------------------------------------------------------------------------------
  16924. TABLE: non-vol/emtaSnmp
  16926. COMMAND: privacy_key
  16928. USAGE: privacy_key [show|set]
  16930. DESCRIPTION:
  16931. Sets or shows the MTA SNMP V3 Privacy Key. You will be prompted for values
  16932. when
  16933. setting the key.
  16935. EXAMPLES:
  16936. privacy_key set
  16938. ------------------------------------------------------------------------------
  16940. TABLE: non-vol/emtaSnmp
  16942. COMMAND: read
  16944. USAGE: read [both|perm|dyn]
  16946. DESCRIPTION:
  16947. Reads the specified section of non-volatile settings from non-volatile
  16948. memory. If 'both' is specified or there are no parameters, then both
  16949. Permanent and Dynamic settings will be read. Otherwise, only the section
  16950. specified will be read. This will destroy any changes you have made if you
  16951. haven't written them!
  16953. EXAMPLES:
  16954. read -- Reads both Permanent and Dynamic sections of settings.
  16955. read perm -- Reads only the Permanent section of non-vol settings.
  16957. ------------------------------------------------------------------------------
  16959. TABLE: non-vol/emtaSnmp
  16961. COMMAND: serial_number
  16963. USAGE: serial_number [String{127}]
  16965. DESCRIPTION:
  16966. Sets or shows the MTA serial number. This is just a string parameter.
  16968. EXAMPLES:
  16969. serial_number abcd1234
  16971. ------------------------------------------------------------------------------
  16973. TABLE: non-vol/emtaSnmp
  16975. COMMAND: show
  16977. USAGE: show
  16979. DESCRIPTION:
  16980. Displays the current non-volatile settings values for both the Permanent and
  16981. Dynamic sections.
  16983. EXAMPLES:
  16984. show --
  16986. ------------------------------------------------------------------------------
  16988. TABLE: non-vol/emtaSnmp
  16990. COMMAND: stats
  16992. USAGE: stats
  16994. DESCRIPTION:
  16995. Prints stats about buffer usage for Dynamic and Permanent settings.
  16997. EXAMPLES:
  16998. stats --
  17000. ------------------------------------------------------------------------------
  17002. TABLE: non-vol/emtaSnmp
  17004. COMMAND: sysContact
  17006. USAGE: sysContact [String{254}]
  17008. DESCRIPTION:
  17009. Sets or shows the MTA sysContact value.
  17011. EXAMPLES:
  17012. sysContact "Somebody at my company"
  17014. ------------------------------------------------------------------------------
  17016. TABLE: non-vol/emtaSnmp
  17018. COMMAND: sysLocation
  17020. USAGE: sysLocation [String{254}]
  17022. DESCRIPTION:
  17023. Sets or shows the MTA sysLocation value.
  17025. EXAMPLES:
  17026. sysLocation "On my desk"
  17028. ------------------------------------------------------------------------------
  17030. TABLE: non-vol/emtaSnmp
  17032. COMMAND: sysName
  17034. USAGE: sysName [String{254}]
  17036. DESCRIPTION:
  17037. Sets or shows the MTA sysName value.
  17039. EXAMPLES:
  17040. sysName "Embedded MTA"
  17042. ------------------------------------------------------------------------------
  17044. TABLE: non-vol/emtaSnmp
  17046. COMMAND: tftp_read
  17048. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  17050. DESCRIPTION:
  17051. Causes the Permanent or Dynamic settings data to be read from a server via
  17052. TFTP. The file must be generated correctly, with all of the headers, CRC,
  17053. and other information that would exist on the NonVol device. The file will
  17054. be read and evaluated for correctness before it is stored in the device. If
  17055. the file is rejected then the settings will be read from the device to undo
  17056. any changes. Normally, this will operate on all settings groups; if you
  17057. specify -g then it will operate only on the current group (e.g. if you are in
  17058. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  17059. read).
  17061. EXAMPLES:
  17062. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  17063. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  17065. ------------------------------------------------------------------------------
  17067. TABLE: non-vol/emtaSnmp
  17069. COMMAND: tftp_write
  17071. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  17073. DESCRIPTION:
  17074. Causes the Permanent or Dynamic settings data to be written to a server via
  17075. TFTP. Normally, this will operate on all settings groups; if you specify -g
  17076. then it will operate only on the current group (e.g. if you are in the SNMP
  17077. nonvol dir, then -g will cause only the SNMP settings group to be written).
  17079. EXAMPLES:
  17080. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  17081. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  17083. ------------------------------------------------------------------------------
  17085. TABLE: non-vol/emtaSnmp
  17087. COMMAND: write
  17089. USAGE: write [both|perm|dyn]
  17091. DESCRIPTION:
  17092. Writes the specified section of non-volatile settings to non-volatile memory.
  17093. If 'both' is specified or there are no parameters, then both Permanent and
  17094. Dynamic settings will be written. Otherwise, only the section specified will
  17095. be written.
  17097. EXAMPLES:
  17098. write -- Writes both Permanent and Dynamic sections of settings.
  17099. write perm -- Writes only the Permanent section of non-vol settings.
  17101. ------------------------------------------------------------------------------
  17103. TABLE: non-vol/event_log
  17105. COMMAND: clear_device
  17107. USAGE: clear_device [both|perm|dyn]
  17109. DESCRIPTION:
  17110. Tells the nonvol device to wipe out the specified settings section. All data
  17111. will be lost; the device should be restored to its 'virgin' state. For flash
  17112. devices, the flash block is erased; for disk devices, the file is erased.
  17114. EXAMPLES:
  17115. clear_device -- Clears both Permanent and Dynamic sections.
  17116. clear_device perm -- Clears only the Permanent section.
  17118. ------------------------------------------------------------------------------
  17120. TABLE: non-vol/event_log
  17122. COMMAND: clear_event
  17124. USAGE: clear_event index{-1..2147483647}
  17126. DESCRIPTION:
  17127. Causes an event at the specified index to be cleared. If you specify -1,
  17128. then all will be cleared.
  17130. EXAMPLES:
  17131. clear_event 0 -- Clears the event at index 0.
  17133. ------------------------------------------------------------------------------
  17135. TABLE: non-vol/event_log
  17137. COMMAND: defaults
  17139. USAGE: defaults [both|perm|dyn]
  17141. DESCRIPTION:
  17142. Restores the settings to default values. NOTE: This does not write to
  17143. NonVol memory! You must do this manually. Also note that some settings do
  17144. not have good defaults, particularly the Permanent section! Use this command
  17145. with extreme care!
  17147. EXAMPLES:
  17148. defaults -- Sets both Permanent and Dynamic sections to defaults.
  17149. defaults perm -- Sets only the Permanent section to defaults.
  17151. ------------------------------------------------------------------------------
  17153. TABLE: non-vol/event_log
  17155. COMMAND: del_extra_data
  17157. USAGE: del_extra_data [both|perm|dyn]
  17159. DESCRIPTION:
  17160. Gets rid of any extra data that is assiociated with the settings. The extra
  17161. data is usually caused by a downgrade, where settings written by a newer
  17162. version are not understood by the older version, but are stored so that they
  17163. will still exist when the new code is run. However, in some cases, it is
  17164. desirable to get rid of them if they are not going to be used.
  17166. EXAMPLES:
  17167. del_extra_data perm -- Gets rid of extra permanent data.
  17169. ------------------------------------------------------------------------------
  17171. TABLE: non-vol/event_log
  17173. COMMAND: event
  17175. USAGE: event [index] [id] [count{1..65535}]
  17177. DESCRIPTION:
  17178. Causes an event at the specified index to be set to the id and count
  17179. specified. The id is a 32-bit value, and the count is a 16-bit value. The
  17180. first/last time values are taken as the current time.
  17182. EXAMPLES:
  17183. event 0 0x80015432 25 -- Sets event at index 0 to id 0x80015432, count 25.
  17185. ------------------------------------------------------------------------------
  17187. TABLE: non-vol/event_log
  17189. COMMAND: flush {disabled}
  17191. USAGE: flush
  17193. DESCRIPTION:
  17194. For Composite NonVol Settings objects (which contain 1 or more groups of
  17195. NonVol Settings), this command flushes out any unrecognized groups that were
  17196. read from the device. This is useful in cases where the settings group isn't
  17197. needed by another application, and would just waste space.
  17199. EXAMPLES:
  17200. flush --
  17202. ------------------------------------------------------------------------------
  17204. TABLE: non-vol/event_log
  17206. COMMAND: manufactured
  17208. USAGE: manufactured [both|perm|dyn]
  17210. DESCRIPTION:
  17211. Checks to see if the specified section is manufactured.
  17213. EXAMPLES:
  17214. manufactured -- Checks both Permanent and Dynamic sections
  17215. manufacturing state.
  17216. manufactured perm -- Checks only the Permanent section manufacturing state.
  17218. ------------------------------------------------------------------------------
  17220. TABLE: non-vol/event_log
  17222. COMMAND: read
  17224. USAGE: read [both|perm|dyn]
  17226. DESCRIPTION:
  17227. Reads the specified section of non-volatile settings from non-volatile
  17228. memory. If 'both' is specified or there are no parameters, then both
  17229. Permanent and Dynamic settings will be read. Otherwise, only the section
  17230. specified will be read. This will destroy any changes you have made if you
  17231. haven't written them!
  17233. EXAMPLES:
  17234. read -- Reads both Permanent and Dynamic sections of settings.
  17235. read perm -- Reads only the Permanent section of non-vol settings.
  17237. ------------------------------------------------------------------------------
  17239. TABLE: non-vol/event_log
  17241. COMMAND: show
  17243. USAGE: show
  17245. DESCRIPTION:
  17246. Displays the current non-volatile settings values for both the Permanent and
  17247. Dynamic sections.
  17249. EXAMPLES:
  17250. show --
  17252. ------------------------------------------------------------------------------
  17254. TABLE: non-vol/event_log
  17256. COMMAND: stats
  17258. USAGE: stats
  17260. DESCRIPTION:
  17261. Prints stats about buffer usage for Dynamic and Permanent settings.
  17263. EXAMPLES:
  17264. stats --
  17266. ------------------------------------------------------------------------------
  17268. TABLE: non-vol/event_log
  17270. COMMAND: tftp_read
  17272. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  17274. DESCRIPTION:
  17275. Causes the Permanent or Dynamic settings data to be read from a server via
  17276. TFTP. The file must be generated correctly, with all of the headers, CRC,
  17277. and other information that would exist on the NonVol device. The file will
  17278. be read and evaluated for correctness before it is stored in the device. If
  17279. the file is rejected then the settings will be read from the device to undo
  17280. any changes. Normally, this will operate on all settings groups; if you
  17281. specify -g then it will operate only on the current group (e.g. if you are in
  17282. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  17283. read).
  17285. EXAMPLES:
  17286. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  17287. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  17289. ------------------------------------------------------------------------------
  17291. TABLE: non-vol/event_log
  17293. COMMAND: tftp_write
  17295. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  17297. DESCRIPTION:
  17298. Causes the Permanent or Dynamic settings data to be written to a server via
  17299. TFTP. Normally, this will operate on all settings groups; if you specify -g
  17300. then it will operate only on the current group (e.g. if you are in the SNMP
  17301. nonvol dir, then -g will cause only the SNMP settings group to be written).
  17303. EXAMPLES:
  17304. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  17305. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  17307. ------------------------------------------------------------------------------
  17309. TABLE: non-vol/event_log
  17311. COMMAND: write
  17313. USAGE: write [both|perm|dyn]
  17315. DESCRIPTION:
  17316. Writes the specified section of non-volatile settings to non-volatile memory.
  17317. If 'both' is specified or there are no parameters, then both Permanent and
  17318. Dynamic settings will be written. Otherwise, only the section specified will
  17319. be written.
  17321. EXAMPLES:
  17322. write -- Writes both Permanent and Dynamic sections of settings.
  17323. write perm -- Writes only the Permanent section of non-vol settings.
  17325. ------------------------------------------------------------------------------
  17327. TABLE: non-vol/factory
  17329. COMMAND: clear_device
  17331. USAGE: clear_device [both|perm|dyn]
  17333. DESCRIPTION:
  17334. Tells the nonvol device to wipe out the specified settings section. All data
  17335. will be lost; the device should be restored to its 'virgin' state. For flash
  17336. devices, the flash block is erased; for disk devices, the file is erased.
  17338. EXAMPLES:
  17339. clear_device -- Clears both Permanent and Dynamic sections.
  17340. clear_device perm -- Clears only the Permanent section.
  17342. ------------------------------------------------------------------------------
  17344. TABLE: non-vol/factory
  17346. COMMAND: defaults
  17348. USAGE: defaults [both|perm|dyn]
  17350. DESCRIPTION:
  17351. Restores the settings to default values. NOTE: This does not write to
  17352. NonVol memory! You must do this manually. Also note that some settings do
  17353. not have good defaults, particularly the Permanent section! Use this command
  17354. with extreme care!
  17356. EXAMPLES:
  17357. defaults -- Sets both Permanent and Dynamic sections to defaults.
  17358. defaults perm -- Sets only the Permanent section to defaults.
  17360. ------------------------------------------------------------------------------
  17362. TABLE: non-vol/factory
  17364. COMMAND: del_extra_data
  17366. USAGE: del_extra_data [both|perm|dyn]
  17368. DESCRIPTION:
  17369. Gets rid of any extra data that is assiociated with the settings. The extra
  17370. data is usually caused by a downgrade, where settings written by a newer
  17371. version are not understood by the older version, but are stored so that they
  17372. will still exist when the new code is run. However, in some cases, it is
  17373. desirable to get rid of them if they are not going to be used.
  17375. EXAMPLES:
  17376. del_extra_data perm -- Gets rid of extra permanent data.
  17378. ------------------------------------------------------------------------------
  17380. TABLE: non-vol/factory
  17382. COMMAND: flush {disabled}
  17384. USAGE: flush
  17386. DESCRIPTION:
  17387. For Composite NonVol Settings objects (which contain 1 or more groups of
  17388. NonVol Settings), this command flushes out any unrecognized groups that were
  17389. read from the device. This is useful in cases where the settings group isn't
  17390. needed by another application, and would just waste space.
  17392. EXAMPLES:
  17393. flush --
  17395. ------------------------------------------------------------------------------
  17397. TABLE: non-vol/factory
  17399. COMMAND: key
  17401. USAGE: key [index{0..7}] [value{31}]
  17403. DESCRIPTION:
  17404. Sets the value of the specified key to the specified value.
  17406. EXAMPLES:
  17407. key 0 foo -- Set the value of key 0 to 'foo'.
  17408. key 0 "" -- Clear key 0.
  17410. ------------------------------------------------------------------------------
  17412. TABLE: non-vol/factory
  17414. COMMAND: manufactured
  17416. USAGE: manufactured [both|perm|dyn]
  17418. DESCRIPTION:
  17419. Checks to see if the specified section is manufactured.
  17421. EXAMPLES:
  17422. manufactured -- Checks both Permanent and Dynamic sections
  17423. manufacturing state.
  17424. manufactured perm -- Checks only the Permanent section manufacturing state.
  17426. ------------------------------------------------------------------------------
  17428. TABLE: non-vol/factory
  17430. COMMAND: read
  17432. USAGE: read [both|perm|dyn]
  17434. DESCRIPTION:
  17435. Reads the specified section of non-volatile settings from non-volatile
  17436. memory. If 'both' is specified or there are no parameters, then both
  17437. Permanent and Dynamic settings will be read. Otherwise, only the section
  17438. specified will be read. This will destroy any changes you have made if you
  17439. haven't written them!
  17441. EXAMPLES:
  17442. read -- Reads both Permanent and Dynamic sections of settings.
  17443. read perm -- Reads only the Permanent section of non-vol settings.
  17445. ------------------------------------------------------------------------------
  17447. TABLE: non-vol/factory
  17449. COMMAND: scratch_pad
  17451. USAGE: scratch_pad [value]
  17453. DESCRIPTION:
  17454. Sets the value of the scratch pad to the specified 32 bit value.
  17456. EXAMPLES:
  17457. scratch_pad 0x1A4 -- Set the value of the scratch pad to 0x1A4.
  17459. ------------------------------------------------------------------------------
  17461. TABLE: non-vol/factory
  17463. COMMAND: show
  17465. USAGE: show
  17467. DESCRIPTION:
  17468. Displays the current non-volatile settings values for both the Permanent and
  17469. Dynamic sections.
  17471. EXAMPLES:
  17472. show --
  17474. ------------------------------------------------------------------------------
  17476. TABLE: non-vol/factory
  17478. COMMAND: sn
  17480. USAGE: sn [index{0..3}] [value{31}]
  17482. DESCRIPTION:
  17483. Sets the value of the specified serial number to the specified value.
  17485. EXAMPLES:
  17486. sn 0 foo -- Set the value of serial number 0 to 'foo'.
  17487. sn 0 "" -- Clear serial number 0.
  17489. ------------------------------------------------------------------------------
  17491. TABLE: non-vol/factory
  17493. COMMAND: stats
  17495. USAGE: stats
  17497. DESCRIPTION:
  17498. Prints stats about buffer usage for Dynamic and Permanent settings.
  17500. EXAMPLES:
  17501. stats --
  17503. ------------------------------------------------------------------------------
  17505. TABLE: non-vol/factory
  17507. COMMAND: tftp_read
  17509. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  17511. DESCRIPTION:
  17512. Causes the Permanent or Dynamic settings data to be read from a server via
  17513. TFTP. The file must be generated correctly, with all of the headers, CRC,
  17514. and other information that would exist on the NonVol device. The file will
  17515. be read and evaluated for correctness before it is stored in the device. If
  17516. the file is rejected then the settings will be read from the device to undo
  17517. any changes. Normally, this will operate on all settings groups; if you
  17518. specify -g then it will operate only on the current group (e.g. if you are in
  17519. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  17520. read).
  17522. EXAMPLES:
  17523. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  17524. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  17526. ------------------------------------------------------------------------------
  17528. TABLE: non-vol/factory
  17530. COMMAND: tftp_write
  17532. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  17534. DESCRIPTION:
  17535. Causes the Permanent or Dynamic settings data to be written to a server via
  17536. TFTP. Normally, this will operate on all settings groups; if you specify -g
  17537. then it will operate only on the current group (e.g. if you are in the SNMP
  17538. nonvol dir, then -g will cause only the SNMP settings group to be written).
  17540. EXAMPLES:
  17541. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  17542. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  17544. ------------------------------------------------------------------------------
  17546. TABLE: non-vol/factory
  17548. COMMAND: write
  17550. USAGE: write [both|perm|dyn]
  17552. DESCRIPTION:
  17553. Writes the specified section of non-volatile settings to non-volatile memory.
  17554. If 'both' is specified or there are no parameters, then both Permanent and
  17555. Dynamic settings will be written. Otherwise, only the section specified will
  17556. be written.
  17558. EXAMPLES:
  17559. write -- Writes both Permanent and Dynamic sections of settings.
  17560. write perm -- Writes only the Permanent section of non-vol settings.
  17562. ------------------------------------------------------------------------------
  17564. TABLE: non-vol/firewall
  17566. COMMAND: clear_device
  17568. USAGE: clear_device [both|perm|dyn]
  17570. DESCRIPTION:
  17571. Tells the nonvol device to wipe out the specified settings section. All data
  17572. will be lost; the device should be restored to its 'virgin' state. For flash
  17573. devices, the flash block is erased; for disk devices, the file is erased.
  17575. EXAMPLES:
  17576. clear_device -- Clears both Permanent and Dynamic sections.
  17577. clear_device perm -- Clears only the Permanent section.
  17579. ------------------------------------------------------------------------------
  17581. TABLE: non-vol/firewall
  17583. COMMAND: defaults
  17585. USAGE: defaults [both|perm|dyn]
  17587. DESCRIPTION:
  17588. Restores the settings to default values. NOTE: This does not write to
  17589. NonVol memory! You must do this manually. Also note that some settings do
  17590. not have good defaults, particularly the Permanent section! Use this command
  17591. with extreme care!
  17593. EXAMPLES:
  17594. defaults -- Sets both Permanent and Dynamic sections to defaults.
  17595. defaults perm -- Sets only the Permanent section to defaults.
  17597. ------------------------------------------------------------------------------
  17599. TABLE: non-vol/firewall
  17601. COMMAND: del_extra_data
  17603. USAGE: del_extra_data [both|perm|dyn]
  17605. DESCRIPTION:
  17606. Gets rid of any extra data that is assiociated with the settings. The extra
  17607. data is usually caused by a downgrade, where settings written by a newer
  17608. version are not understood by the older version, but are stored so that they
  17609. will still exist when the new code is run. However, in some cases, it is
  17610. desirable to get rid of them if they are not going to be used.
  17612. EXAMPLES:
  17613. del_extra_data perm -- Gets rid of extra permanent data.
  17615. ------------------------------------------------------------------------------
  17617. TABLE: non-vol/firewall
  17619. COMMAND: domain_policy
  17621. USAGE: domain_policy [Number{1..2}]
  17623. DESCRIPTION:
  17624. Sets the domain policy.
  17625. 1 = block domains in list
  17626. 2 = allow domains in list
  17628. EXAMPLES:
  17629. domain_policy 0x1 -- Set domain policy to block domains in list
  17631. ------------------------------------------------------------------------------
  17633. TABLE: non-vol/firewall
  17635. COMMAND: features
  17637. USAGE: features [Bitmask{0xefff}]
  17639. DESCRIPTION:
  17640. Sets the bitmask which determines which firewall features are enabled:
  17641. URL Keyword blocking 0x00000001
  17642. URL Domain blocking 0x00000002
  17643. Disallow HTTP proxy 0x00000004
  17644. Disable cookies 0x00000008
  17645. Disable Java applets 0x00000010
  17646. Disable ActiveX controls 0x00000020
  17647. Disable Popup Windows 0x00000040
  17648. MAC TOD Filtering 0x00000080
  17649. E-mail alerts 0x00000100
  17650. Block Ip Fragments 0x00000800
  17651. Port Scan Alerts 0x00004000
  17652. SYN Flood detection 0x00008000
  17655. EXAMPLES:
  17656. features -- Shows the enabled interfaces.
  17657. features 0x1f -- Enables all features.
  17658. features 0 -- Disables all features.
  17659. features 0x01 -- Enables URL blocking ONLY.
  17661. ------------------------------------------------------------------------------
  17663. TABLE: non-vol/firewall
  17665. COMMAND: filter_end_day
  17667. USAGE: filter_end_day [sunday|monday|tuesday|wednesday|thursday|friday|saturday]
  17669. DESCRIPTION:
  17670. Sets the end day of the filtering interval.
  17673. EXAMPLES:
  17674. filter_end_day sunday -- Set the start day to sunday
  17676. ------------------------------------------------------------------------------
  17678. TABLE: non-vol/firewall
  17680. COMMAND: filter_end_time
  17682. USAGE: filter_end_time [String{5}]
  17684. DESCRIPTION:
  17685. Sets the end time for the filtering interval (24-hour notation)
  17687. EXAMPLES:
  17688. filter_end_time 16:00 -- Sets start time to 4:00 PM
  17690. ------------------------------------------------------------------------------
  17692. TABLE: non-vol/firewall
  17694. COMMAND: filter_policy
  17696. USAGE: filter_policy [Number{1..2}]
  17698. DESCRIPTION:
  17699. Sets the filter policy.
  17700. 1 = always apply content filtering
  17701. 2 = apply content filtering only during specified time period
  17703. EXAMPLES:
  17704. filter_policy 0x1 -- Set filter policy to always apply content filtering
  17706. ------------------------------------------------------------------------------
  17708. TABLE: non-vol/firewall
  17710. COMMAND: filter_start_day
  17712. USAGE: filter_start_day [sunday|monday|tuesday|wednesday|thursday|friday|saturday]
  17714. DESCRIPTION:
  17715. Sets the start day of the filtering interval.
  17718. EXAMPLES:
  17719. filter_start_day sunday -- Set the start day to sunday
  17721. ------------------------------------------------------------------------------
  17723. TABLE: non-vol/firewall
  17725. COMMAND: filter_start_time
  17727. USAGE: filter_start_time [String{5}]
  17729. DESCRIPTION:
  17730. Sets the start time for the filtering interval (24-hour notation)
  17732. EXAMPLES:
  17733. filter_start_time 08:00 -- Sets start time to 8:00 AM
  17735. ------------------------------------------------------------------------------
  17737. TABLE: non-vol/firewall
  17739. COMMAND: flush {disabled}
  17741. USAGE: flush
  17743. DESCRIPTION:
  17744. For Composite NonVol Settings objects (which contain 1 or more groups of
  17745. NonVol Settings), this command flushes out any unrecognized groups that were
  17746. read from the device. This is useful in cases where the settings group isn't
  17747. needed by another application, and would just waste space.
  17749. EXAMPLES:
  17750. flush --
  17752. ------------------------------------------------------------------------------
  17754. TABLE: non-vol/firewall
  17756. COMMAND: manufactured
  17758. USAGE: manufactured [both|perm|dyn]
  17760. DESCRIPTION:
  17761. Checks to see if the specified section is manufactured.
  17763. EXAMPLES:
  17764. manufactured -- Checks both Permanent and Dynamic sections
  17765. manufacturing state.
  17766. manufactured perm -- Checks only the Permanent section manufacturing state.
  17768. ------------------------------------------------------------------------------
  17770. TABLE: non-vol/firewall
  17772. COMMAND: read
  17774. USAGE: read [both|perm|dyn]
  17776. DESCRIPTION:
  17777. Reads the specified section of non-volatile settings from non-volatile
  17778. memory. If 'both' is specified or there are no parameters, then both
  17779. Permanent and Dynamic settings will be read. Otherwise, only the section
  17780. specified will be read. This will destroy any changes you have made if you
  17781. haven't written them!
  17783. EXAMPLES:
  17784. read -- Reads both Permanent and Dynamic sections of settings.
  17785. read perm -- Reads only the Permanent section of non-vol settings.
  17787. ------------------------------------------------------------------------------
  17789. TABLE: non-vol/firewall
  17791. COMMAND: show
  17793. USAGE: show
  17795. DESCRIPTION:
  17796. Displays the current non-volatile settings values for both the Permanent and
  17797. Dynamic sections.
  17799. EXAMPLES:
  17800. show --
  17802. ------------------------------------------------------------------------------
  17804. TABLE: non-vol/firewall
  17806. COMMAND: stats
  17808. USAGE: stats
  17810. DESCRIPTION:
  17811. Prints stats about buffer usage for Dynamic and Permanent settings.
  17813. EXAMPLES:
  17814. stats --
  17816. ------------------------------------------------------------------------------
  17818. TABLE: non-vol/firewall
  17820. COMMAND: tftp_read
  17822. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  17824. DESCRIPTION:
  17825. Causes the Permanent or Dynamic settings data to be read from a server via
  17826. TFTP. The file must be generated correctly, with all of the headers, CRC,
  17827. and other information that would exist on the NonVol device. The file will
  17828. be read and evaluated for correctness before it is stored in the device. If
  17829. the file is rejected then the settings will be read from the device to undo
  17830. any changes. Normally, this will operate on all settings groups; if you
  17831. specify -g then it will operate only on the current group (e.g. if you are in
  17832. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  17833. read).
  17835. EXAMPLES:
  17836. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  17837. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  17839. ------------------------------------------------------------------------------
  17841. TABLE: non-vol/firewall
  17843. COMMAND: tftp_write
  17845. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  17847. DESCRIPTION:
  17848. Causes the Permanent or Dynamic settings data to be written to a server via
  17849. TFTP. Normally, this will operate on all settings groups; if you specify -g
  17850. then it will operate only on the current group (e.g. if you are in the SNMP
  17851. nonvol dir, then -g will cause only the SNMP settings group to be written).
  17853. EXAMPLES:
  17854. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  17855. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  17857. ------------------------------------------------------------------------------
  17859. TABLE: non-vol/firewall
  17861. COMMAND: write
  17863. USAGE: write [both|perm|dyn]
  17865. DESCRIPTION:
  17866. Writes the specified section of non-volatile settings to non-volatile memory.
  17867. If 'both' is specified or there are no parameters, then both Permanent and
  17868. Dynamic settings will be written. Otherwise, only the section specified will
  17869. be written.
  17871. EXAMPLES:
  17872. write -- Writes both Permanent and Dynamic sections of settings.
  17873. write perm -- Writes only the Permanent section of non-vol settings.
  17875. ------------------------------------------------------------------------------
  17877. TABLE: non-vol/halif
  17879. COMMAND: 3420_optimized_map
  17881. USAGE: 3420_optimized_map [true|false]
  17883. DESCRIPTION:
  17884. Enables/disables use of the optimized frequency map for the 3420 tuner.
  17885. Note that this command has no meaning if tuner type is not 3420 (21).
  17887. EXAMPLES:
  17888. 3420_optimized_map true -- Enables use of optimized 3420 frequency map.
  17890. ------------------------------------------------------------------------------
  17892. TABLE: non-vol/halif
  17894. COMMAND: DS_AGI
  17896. USAGE: DS_AGI [value{0..255}]
  17898. DESCRIPTION:
  17899. Sets a CM AGC Control register; if you don't know what it means, then you
  17900. probably have no business reading or writing new values anyway...
  17902. EXAMPLES:
  17903. DS_AGI 0x18 -- Sets the value to 0x18.
  17905. ------------------------------------------------------------------------------
  17907. TABLE: non-vol/halif
  17909. COMMAND: DS_AGT
  17911. USAGE: DS_AGT [value{0..255}]
  17913. DESCRIPTION:
  17914. Sets a CM AGC Control register; if you don't know what it means, then you
  17915. probably have no business reading or writing new values anyway...
  17917. EXAMPLES:
  17918. DS_AGT 0x18 -- Sets the value to 0x18.
  17920. ------------------------------------------------------------------------------
  17922. TABLE: non-vol/halif
  17924. COMMAND: STABW1
  17926. USAGE: STABW1 [value{0..65535}]
  17928. DESCRIPTION:
  17929. Sets a CM AGC Control register; if you don't know what it means, then you
  17930. probably have no business reading or writing new values anyway...
  17932. EXAMPLES:
  17933. STABW1 0x18 -- Sets the value to 0x18.
  17935. ------------------------------------------------------------------------------
  17937. TABLE: non-vol/halif
  17939. COMMAND: STABW2
  17941. USAGE: STABW2 [value{0..65535}]
  17943. DESCRIPTION:
  17944. Sets a CM AGC Control register; if you don't know what it means, then you
  17945. probably have no business reading or writing new values anyway...
  17947. EXAMPLES:
  17948. STABW2 0x18 -- Sets the value to 0x18.
  17950. ------------------------------------------------------------------------------
  17952. TABLE: non-vol/halif
  17954. COMMAND: STAGI
  17956. USAGE: STAGI [value]
  17958. DESCRIPTION:
  17959. Sets a CM AGC Control register; if you don't know what it means, then you
  17960. probably have no business reading or writing new values anyway...
  17962. EXAMPLES:
  17963. STAGI 0x18 -- Sets the value to 0x18.
  17965. ------------------------------------------------------------------------------
  17967. TABLE: non-vol/halif
  17969. COMMAND: STAGT
  17971. USAGE: STAGT [value]
  17973. DESCRIPTION:
  17974. Sets a CM AGC Control register; if you don't know what it means, then you
  17975. probably have no business reading or writing new values anyway...
  17977. EXAMPLES:
  17978. STAGT 0x18 -- Sets the value to 0x18.
  17980. ------------------------------------------------------------------------------
  17982. TABLE: non-vol/halif
  17984. COMMAND: STATHR
  17986. USAGE: STATHR [value{0..65535}]
  17988. DESCRIPTION:
  17989. Sets a CM AGC Control register; if you don't know what it means, then you
  17990. probably have no business reading or writing new values anyway...
  17992. EXAMPLES:
  17993. STATHR 0x18 -- Sets the value to 0x18.
  17995. ------------------------------------------------------------------------------
  17997. TABLE: non-vol/halif
  17999. COMMAND: STPGA1
  18001. USAGE: STPGA1 [value{0..16777215}]
  18003. DESCRIPTION:
  18004. Sets a CM AGC Control register; if you don't know what it means, then you
  18005. probably have no business reading or writing new values anyway...
  18007. EXAMPLES:
  18008. STPGA1 0x18 -- Sets the value to 0x18.
  18010. ------------------------------------------------------------------------------
  18012. TABLE: non-vol/halif
  18014. COMMAND: bcmalloc
  18016. USAGE: bcmalloc [-s BufferSize{0..65535}] offset{0..32} [NumBuffers{0..65535}]
  18018. DESCRIPTION:
  18019. Shows or sets the number of buffers that will be created by BcmAlloc for the
  18020. specified buffer size. Also allows the buffer size to be set. This will
  18021. need to be tuned according to the number and type of interfaces that are
  18022. enabled, since each interface will tend to consume more buffers.
  18024. You must write and reboot for this to take effect!
  18026. EXAMPLES:
  18027. bcmalloc -s 1600 2 500 -- Sets the 3rd entry to a size of 1600 bytes, with
  18028. 500 buffers.
  18030. ------------------------------------------------------------------------------
  18032. TABLE: non-vol/halif
  18034. COMMAND: bcmalloc_numSizes
  18036. USAGE: bcmalloc_numSizes [NumSizes{0..32}]
  18038. DESCRIPTION:
  18039. Shows or sets the number of different buffer sizes that BcmAlloc will handle
  18040. (this is the size of the array that stores the buffer size and number of
  18041. buffers values). You will then have to configure the buffer sizes and number
  18042. of buffers for each entry in the array.
  18043. You must write and reboot for this to take effect!
  18045. EXAMPLES:
  18046. bcmalloc_numSizes 5 -- Sets the number of buffer sizes to 5.
  18048. ------------------------------------------------------------------------------
  18050. TABLE: non-vol/halif
  18052. COMMAND: board_rev
  18054. USAGE: board_rev [revision{0..18}]
  18056. DESCRIPTION:
  18057. Sets the board revision value. This is used by various drivers to help
  18058. determine which drivers to load, what hardware is present, and info about the
  18059. layout. Valid values for the revision are:
  18061. 0 -- Generic Unknown/Don't Care
  18062. 1 -- BCM93350A V2 US
  18063. 2 -- BCM93350A V3 US
  18064. 3 -- BCM93350C V0 US
  18065. 4 -- BCM93350i V1a US
  18066. 5 -- BCM93350i V1b US
  18067. 6 -- BCM93350V V1 US
  18068. 7 -- BCM93352V V0 US
  18069. 8 -- BCM93350A V2 EURO
  18070. 9 -- BCM93350A V3 EURO
  18071. 10 -- BCM93350C V0 EURO
  18072. 11 -- BCM93350i V1a EURO
  18073. 12 -- BCM93350i V1b EURO
  18074. 13 -- BCM93350V V1 EURO
  18075. 14 -- BCM93352V V0 EURO
  18076. 15 -- BCM93350C V2 US
  18077. 16 -- BCM93350C V2 EURO
  18078. 17 -- BCM93345i V0
  18079. 18 -- BCM93345A
  18081. EXAMPLES:
  18082. board_rev 2 -- Sets the board rev to BCM93350A V3 US.
  18084. ------------------------------------------------------------------------------
  18086. TABLE: non-vol/halif
  18088. COMMAND: bt_master_enable
  18090. USAGE: bt_master_enable [true|false]
  18092. DESCRIPTION:
  18093. Enables/disables Bluetooth Master mode.
  18095. EXAMPLES:
  18096. bt_master_enable true -- Enables Bluetooth master mode.
  18098. ------------------------------------------------------------------------------
  18100. TABLE: non-vol/halif
  18102. COMMAND: chan_plan_annex_b
  18104. USAGE: chan_plan_annex_b [value{0..2}]
  18106. DESCRIPTION:
  18107. Configures the channel plan of the CM HAL settings for Annex B operation; 0 =
  18108. STD, 1 = HRC, 2 = STD/HRC
  18110. EXAMPLES:
  18111. chan_plan_annex_b 2 --
  18113. ------------------------------------------------------------------------------
  18115. TABLE: non-vol/halif
  18117. COMMAND: clear_device
  18119. USAGE: clear_device [both|perm|dyn]
  18121. DESCRIPTION:
  18122. Tells the nonvol device to wipe out the specified settings section. All data
  18123. will be lost; the device should be restored to its 'virgin' state. For flash
  18124. devices, the flash block is erased; for disk devices, the file is erased.
  18126. EXAMPLES:
  18127. clear_device -- Clears both Permanent and Dynamic sections.
  18128. clear_device perm -- Clears only the Permanent section.
  18130. ------------------------------------------------------------------------------
  18132. TABLE: non-vol/halif
  18134. COMMAND: cm_1024qam
  18136. USAGE: cm_1024qam [true|false]
  18138. DESCRIPTION:
  18139. Enables/disables 1024QAM support.
  18141. EXAMPLES:
  18142. cm_1024qam true -- Enables 1024QAM support.
  18144. ------------------------------------------------------------------------------
  18146. TABLE: non-vol/halif
  18148. COMMAND: cm_20_clipping
  18150. USAGE: cm_20_clipping [true|false]
  18152. DESCRIPTION:
  18153. Enables/disables DOCSIS 2.0 clipping support.
  18155. EXAMPLES:
  18156. cm_20_clipping true -- Enables DOCSIS 2.0 clipping support.
  18158. ------------------------------------------------------------------------------
  18160. TABLE: non-vol/halif
  18162. COMMAND: cm_45
  18164. USAGE: cm_45
  18166. DESCRIPTION:
  18167. Configures all of the CM HAL settings for the BCM93345 board where the Tuner
  18168. is set to CMOS, and the upstream Amp is set to internal; the Ds Ref Freq is
  18169. set to 24.5 MHz; the Us Ref Freq is set to 28 MHz, and the PHY freq is set to
  18170. 43.75 MHz..
  18172. EXAMPLES:
  18173. cm_45 -- Configures the CM HAL for the BCM93345 board.
  18175. ------------------------------------------------------------------------------
  18177. TABLE: non-vol/halif
  18179. COMMAND: cm_45i
  18181. USAGE: cm_45i
  18183. DESCRIPTION:
  18184. Configures all of the CM HAL settings for the BCM93345 I (internal) board
  18185. where the Tuner is set to CMOS, and the upstream Amp is set to internal; the
  18186. Ds Ref Freq is set to 24.5 MHz; the Us Ref Freq is set to 28 MHz, and the PHY
  18187. freq is set to 43.75 MHz.
  18189. EXAMPLES:
  18190. cm_45i -- Configures the CM HAL for the BCM93345 I board.
  18192. ------------------------------------------------------------------------------
  18194. TABLE: non-vol/halif
  18196. COMMAND: cm_aboard_v2
  18198. USAGE: cm_aboard_v2
  18200. DESCRIPTION:
  18201. Configures all of the CM HAL settings for the BCM93350 A V2 board; the Tuner
  18202. is set to ALPS, and the upstream Amp is set to ADI 8322; the Us/Ds Ref Freq
  18203. is set to 24 MHz; and the PHY freq is set to 43.75 MHz.
  18205. EXAMPLES:
  18206. cm_aboard_v2 -- Configures the CM HAL for the BCM93350 A V2 board.
  18208. ------------------------------------------------------------------------------
  18210. TABLE: non-vol/halif
  18212. COMMAND: cm_aboard_v3
  18214. USAGE: cm_aboard_v3
  18216. DESCRIPTION:
  18217. Configures all of the CM HAL settings for the BCM93350 A V3 board; the Tuner
  18218. is set to ALPS, and the upstream Amp is set to MAXIM 3510; the Us/Ds Ref Freq
  18219. is set to 24 MHz; and the PHY freq is set to 43.75 MHz.
  18221. EXAMPLES:
  18222. cm_aboard_v3 -- Configures the CM HAL for the BCM93350 A V3 board.
  18224. ------------------------------------------------------------------------------
  18226. TABLE: non-vol/halif
  18228. COMMAND: cm_adv_map_runahead
  18230. USAGE: cm_adv_map_runahead [true|false]
  18232. DESCRIPTION:
  18233. Enables/disables Advance Map RunAhead support on supported hardware
  18234. platforms. Advance Map RunAhead feature uses an additional Docsis Map
  18235. processor to provide advance notice of upstream transmit opportunities and
  18236. therefore enables more efficient use of concatenation.
  18238. EXAMPLES:
  18239. cm_adv_map_runahead true -- Enables Advance Map RunAhead support.
  18241. ------------------------------------------------------------------------------
  18243. TABLE: non-vol/halif
  18245. COMMAND: cm_amp
  18247. USAGE: cm_amp [amp{1..12}]
  18249. DESCRIPTION:
  18250. Sets the type of CM amp that is installed on the modem. This is necessary
  18251. because most amps cannot be automatically detected by software. This only
  18252. takes effect at system startup. You will need to reboot after changing this.
  18253. These are the valid amp types:
  18255. 1 -- LUCENT ATTV4910
  18256. 2 -- LUCENT ATTV4911
  18257. 3 -- CEL ISG2000 AMP
  18258. 4 -- ANADIGICS ARA5050
  18259. 5 -- ADI 8321
  18260. 6 -- MAXIM 3510
  18261. 7 -- CEL ISG3300 AMP
  18262. 8 -- ADI 8322
  18263. 9 -- BCM Internal AMP
  18264. 10 -- Anadigics 2001S23
  18265. 11 -- AD 8325
  18266. 12 -- VENDOR AMP
  18268. EXAMPLES:
  18269. cm_amp -- Shows the CM amp.
  18270. cm_amp 3 -- Sets the CM amp to CEL ISG2000 AMP.
  18272. ------------------------------------------------------------------------------
  18274. TABLE: non-vol/halif
  18276. COMMAND: cm_annex
  18278. USAGE: cm_annex [annex{0..4}]
  18280. DESCRIPTION:
  18281. Sets the CM DOCSIS Annex mode. For operation in the US, this will generally
  18282. be Annex B; in Europe it is generally Annex A. These are the valid Annex
  18283. modes:
  18285. 0 -- Annex B
  18286. 1 -- Annex A
  18287. 2 -- Annex J
  18288. 3 -- Annex Other
  18289. 4 -- Annex C
  18291. EXAMPLES:
  18292. cm_annex -- Shows the CM DOCSIS ANNEX mode.
  18293. cm_annex 0 -- Sets the CM DOCSIS ANNEX mode to Annex B.
  18295. ------------------------------------------------------------------------------
  18297. TABLE: non-vol/halif
  18299. COMMAND: cm_cboard
  18301. USAGE: cm_cboard
  18303. DESCRIPTION:
  18304. Configures all of the CM HAL settings for the BCM93350 C board; the Tuner is
  18305. set to BCM3415, and the upstream Amp is set to ADI 8322; the Us/Ds Ref Freq
  18306. is set to 24 MHz; and the PHY freq is set to 43.75 MHz.
  18308. EXAMPLES:
  18309. cm_cboard -- Configures the CM HAL for the BCM93350 C board.
  18311. ------------------------------------------------------------------------------
  18313. TABLE: non-vol/halif
  18315. COMMAND: cm_clc
  18317. USAGE: cm_clc
  18319. DESCRIPTION:
  18320. Configures all of the CM HAL settings for the BCM93350 CLC board; the Tuner
  18321. is set to TEMIC 4736; the Amp is set to MAXIM 3510; the Us/Ds Ref Freq is set
  18322. to 24 MHz; and the PHY freq is set to 43.75 MHz.
  18324. EXAMPLES:
  18325. cm_clc -- Configures the CM HAL for the BCM93350 CLC board.
  18327. ------------------------------------------------------------------------------
  18329. TABLE: non-vol/halif
  18331. COMMAND: cm_diplexer
  18333. USAGE: cm_diplexer [lowsplit|midsplit]
  18335. DESCRIPTION:
  18336. Sets the type of diplexer that is installed on the modem. This primarily
  18337. affects the offset table frequency range for upstream calibration.
  18339. EXAMPLES:
  18340. cm_diplexer lowsplit -- Sets the CM diplexer to lowsplit.
  18343. ------------------------------------------------------------------------------
  18345. TABLE: non-vol/halif
  18347. COMMAND: cm_ds_ref_freq
  18349. USAGE: cm_ds_ref_freq [frequency{1..4294967295}]
  18351. DESCRIPTION:
  18352. Allows you to specify the reference frequency that is being provided to the
  18353. CM downstream tuner. This depends on what oscillator/crystal is installed on
  18354. the modem board. This only takes effect at system startup; you will need to
  18355. reboot.
  18357. EXAMPLES:
  18358. cm_ds_ref_freq -- Shows the CM Downstream Reference Frequency.
  18359. cm_ds_ref_freq 24000000 -- Sets the CM Downstream Reference Frequency to 24
  18360. MHz.
  18362. ------------------------------------------------------------------------------
  18364. TABLE: non-vol/halif
  18366. COMMAND: cm_iboard_v1a
  18368. USAGE: cm_iboard_v1a
  18370. DESCRIPTION:
  18371. Configures all of the CM HAL settings for the BCM93350 I (internal) board
  18372. (V1a) where the Tuner is set to ALPS, and the upstream Amp is set to MAXIM
  18373. 3510; the Us/Ds Ref Freq is set to 24 MHz; and the PHY freq is set to 43.75
  18374. MHz.
  18376. EXAMPLES:
  18377. cm_iboard_v1a -- Configures the CM HAL for the BCM93350 I board (V1a).
  18379. ------------------------------------------------------------------------------
  18381. TABLE: non-vol/halif
  18383. COMMAND: cm_iboard_v1b
  18385. USAGE: cm_iboard_v1b
  18387. DESCRIPTION:
  18388. Configures all of the CM HAL settings for the BCM93350 I (internal) board
  18389. (V1b) where the Tuner is set to ALPS, and the upstream Amp is set to MAXIM
  18390. 3510; the Us/Ds Ref Freq is set to 24 MHz; and the PHY freq is set to 43.75
  18391. MHz. This is the same as the V1a board, but it doesn't have an external
  18392. Ethernet PHY.
  18394. EXAMPLES:
  18395. cm_iboard_v1b -- Configures the CM HAL for the BCM93350 I board (V1b).
  18397. ------------------------------------------------------------------------------
  18399. TABLE: non-vol/halif
  18401. COMMAND: cm_phy_ref_freq
  18403. USAGE: cm_phy_ref_freq [frequency{1..4294967295}]
  18405. DESCRIPTION:
  18406. Allows you to specify the reference frequency that is being provided to the
  18407. CM PHY. This depends on what oscillator/crystal is installed on the modem
  18408. board. This only takes effect at system startup; you will need to reboot.
  18410. EXAMPLES:
  18411. cm_phy_ref_freq -- Shows the CM PHY Reference Frequency.
  18412. cm_phy_ref_freq 6000000 -- Sets the CM PHY Reference Frequency to 6 MHz.
  18414. ------------------------------------------------------------------------------
  18416. TABLE: non-vol/halif
  18418. COMMAND: cm_sboard
  18420. USAGE: cm_sboard
  18422. DESCRIPTION:
  18423. Configures all of the CM HAL settings for the BCM93350 S board; the Tuner and
  18424. Amp are set to CEL ISG2000; the Us/Ds Ref Freq is set to 24 MHz; and the PHY
  18425. freq is set to 6 MHz.
  18427. EXAMPLES:
  18428. cm_sboard -- Configures the CM HAL for the BCM93350 S board.
  18430. ------------------------------------------------------------------------------
  18432. TABLE: non-vol/halif
  18434. COMMAND: cm_tuner
  18436. USAGE: cm_tuner [tuner{1..24}]
  18438. DESCRIPTION:
  18439. Sets the type of CM tuner that is installed on the modem. This is necessary
  18440. because most tuners cannot be automatically detected by software. This only
  18441. takes effect at system startup. You will need to reboot after changing this.
  18442. These are the valid tuner types:
  18444. 1 -- TEMIC 4737/4736/4732
  18445. 2 -- TEMIC 4937
  18446. 3 -- CEL ISG2000
  18447. 4 -- CEL ISG2000EU
  18448. 5 -- CEL ISG3300
  18449. 6 -- CEL ISG3300EU
  18450. 7 -- CEL ISG3300DS
  18451. 8 -- CEL ISG3300DSEU
  18452. 9 -- PANASONIC ET10
  18453. 10 -- PANASONIC ET03
  18454. 11 -- ALPS
  18455. 12 -- BCM3400
  18456. 13 -- TEMIC 4706
  18457. 14 -- BCM3415 (not for use in North America)
  18458. 15 -- ALPS EU
  18459. 16 -- PHILIPS 1236
  18460. 17 -- VENDOR TUNER
  18461. 18 -- BCM3416
  18462. 19 -- BCM3419
  18463. 20 -- BCM3418
  18464. 21 -- BCM3420
  18465. 22 -- BCM3421
  18466. 23 -- BCM3422
  18467. 24 -- BCM Internal
  18469. EXAMPLES:
  18470. cm_tuner -- Shows the CM tuner.
  18471. cm_tuner 3 -- Sets the CM tuner to CEL ISG2000.
  18473. ------------------------------------------------------------------------------
  18475. TABLE: non-vol/halif
  18477. COMMAND: cm_upstream_priority_queue_support
  18479. USAGE: cm_upstream_priority_queue_support [true|false]
  18481. DESCRIPTION:
  18482. Enables/disables Docsis Upstream Priority Queue Support.Docsis Upstream
  18483. Priority Queue Support enhances Upstream, Downstream, and Bidirectional
  18484. TCP/IP packet performance by allowing TCP Ack packets to be expedited via a
  18485. priority.
  18487. EXAMPLES:
  18488. cm_upstream_priority_queue_support true -- Enables Docsis Upstream Priority
  18489. Queue support.
  18491. ------------------------------------------------------------------------------
  18493. TABLE: non-vol/halif
  18495. COMMAND: cm_us_ref_freq
  18497. USAGE: cm_us_ref_freq [frequency{1..4294967295}]
  18499. DESCRIPTION:
  18500. Allows you to specify the reference frequency that is being provided to the
  18501. CM upstream amp. This depends on what oscillator/crystal is installed on the
  18502. modem board. This only takes effect at system startup; you will need to
  18503. reboot.
  18505. EXAMPLES:
  18506. cm_us_ref_freq -- Shows the CM Upstream Reference Frequency.
  18507. cm_us_ref_freq 24000000 -- Sets the CM Upstream Reference Frequency to 24
  18508. MHz.
  18510. ------------------------------------------------------------------------------
  18512. TABLE: non-vol/halif
  18514. COMMAND: cm_us_sample_freq
  18516. USAGE: cm_us_sample_freq [frequency{1..4294967295}]
  18518. DESCRIPTION:
  18519. Allows you to specify the upstream sample frequency, which has something to
  18520. do with the DAC. Ask Dean...
  18522. EXAMPLES:
  18523. cm_us_sample_freq 384000000 -- Sets the CM Upstream Sample Frequency to 384
  18524. MHz.
  18526. ------------------------------------------------------------------------------
  18528. TABLE: non-vol/halif
  18530. COMMAND: defaults
  18532. USAGE: defaults [both|perm|dyn]
  18534. DESCRIPTION:
  18535. Restores the settings to default values. NOTE: This does not write to
  18536. NonVol memory! You must do this manually. Also note that some settings do
  18537. not have good defaults, particularly the Permanent section! Use this command
  18538. with extreme care!
  18540. EXAMPLES:
  18541. defaults -- Sets both Permanent and Dynamic sections to defaults.
  18542. defaults perm -- Sets only the Permanent section to defaults.
  18544. ------------------------------------------------------------------------------
  18546. TABLE: non-vol/halif
  18548. COMMAND: del_extra_data
  18550. USAGE: del_extra_data [both|perm|dyn]
  18552. DESCRIPTION:
  18553. Gets rid of any extra data that is assiociated with the settings. The extra
  18554. data is usually caused by a downgrade, where settings written by a newer
  18555. version are not understood by the older version, but are stored so that they
  18556. will still exist when the new code is run. However, in some cases, it is
  18557. desirable to get rid of them if they are not going to be used.
  18559. EXAMPLES:
  18560. del_extra_data perm -- Gets rid of extra permanent data.
  18562. ------------------------------------------------------------------------------
  18564. TABLE: non-vol/halif
  18566. COMMAND: eth_autoneg
  18568. USAGE: eth_autoneg [true|false]
  18570. DESCRIPTION:
  18571. Enables or disables the ethernet autonegotiation feature. If enabled, the
  18572. ethernet driver will automatically detect and negotiate the link speed and
  18573. duplex parameters, allowing it to coexist on various networks. If disabled,
  18574. then the ethernet driver will use the link parameters stored in NonVol
  18575. Settings, which may cause collisions and/or link errors if they are not set
  18576. correctly. In general, you will want to leave autonegotiation on, but there
  18577. are some cases where it is desirable or necessary to set the link manually.
  18578. You must reboot for this to take effect!
  18580. EXAMPLES:
  18581. eth_autoneg -- Shows the ethernet autonegotiation setting.
  18582. eth_autoneg true -- Enables ethernet autonegotiation.
  18583. eth_autoneg false -- Disables ethernet autonegotiation.
  18585. ------------------------------------------------------------------------------
  18587. TABLE: non-vol/halif
  18589. COMMAND: eth_duplex_full
  18591. USAGE: eth_duplex_full [true|false]
  18593. DESCRIPTION:
  18594. Allows you to specify the default ethernet link duplex This only takes
  18595. effect at system startup, and only if ethernet autonegotiation is disabled.
  18596. If set to true, then the link will be full duplex; otherwise it will be half
  18597. duplex.
  18599. EXAMPLES:
  18600. eth_duplex_full -- Shows the default ethernet link duplex.
  18601. eth_duplex_full true -- Sets the default ethernet link to full duplex.
  18602. eth_duplex_full false -- Sets the default ethernet link to half duplex.
  18604. ------------------------------------------------------------------------------
  18606. TABLE: non-vol/halif
  18608. COMMAND: eth_reject_cam
  18610. USAGE: eth_reject_cam [true|false]
  18612. DESCRIPTION:
  18613. Enables or disables the ethernet reject CAM (if supported by h/w). If
  18614. enabled, the reject CAM will filter out local ethernet traffic, which keeps
  18615. the CPU from having to process packets that will be dropped anyway. You must
  18616. reboot for this to take effect!
  18618. EXAMPLES:
  18619. eth_reject_cam -- Shows the ethernet reject CAM setting.
  18620. eth_reject_cam true -- Enables ethernet reject CAM.
  18621. eth_reject_cam false -- Disables ethernet reject CAM.
  18623. ------------------------------------------------------------------------------
  18625. TABLE: non-vol/halif
  18627. COMMAND: eth_speed
  18629. USAGE: eth_speed [10|100]
  18631. DESCRIPTION:
  18632. Allows you to specify the default ethernet link speed. This only takes
  18633. effect at system startup, and only if ethernet autonegotiation is disabled.
  18634. The parameter is specified in units of Mbps.
  18636. EXAMPLES:
  18637. eth_speed -- Shows the default ethernet link speed.
  18638. eth_speed 10 -- Sets the default ethernet link speed to 10 Mbps.
  18639. eth_speed 100 -- Sets the default ethernet link speed to 100 Mbps.
  18642. ------------------------------------------------------------------------------
  18644. TABLE: non-vol/halif
  18646. COMMAND: flush {disabled}
  18648. USAGE: flush
  18650. DESCRIPTION:
  18651. For Composite NonVol Settings objects (which contain 1 or more groups of
  18652. NonVol Settings), this command flushes out any unrecognized groups that were
  18653. read from the device. This is useful in cases where the settings group isn't
  18654. needed by another application, and would just waste space.
  18656. EXAMPLES:
  18657. flush --
  18659. ------------------------------------------------------------------------------
  18661. TABLE: non-vol/halif
  18663. COMMAND: high_output_pa
  18665. USAGE: high_output_pa [true|false]
  18667. DESCRIPTION:
  18668. Enables/disables support for high output power amp mode on the CM.
  18670. EXAMPLES:
  18671. high_output_pa true -- Enables support for high output power amp mode on the
  18672. CM.
  18674. ------------------------------------------------------------------------------
  18676. TABLE: non-vol/halif
  18678. COMMAND: hpna_message_level
  18680. USAGE: hpna_message_level [level{1..4294967295}]
  18682. DESCRIPTION:
  18683. Sets or shows the default HPNA message level that will be used when the
  18684. system boots up. See HPNA docs for the meanings of the message level values.
  18686. EXAMPLES:
  18687. hpna_message_level 3 --
  18689. ------------------------------------------------------------------------------
  18691. TABLE: non-vol/halif
  18693. COMMAND: interfaces
  18695. USAGE: interfaces [Bitmask{0x7ffff}] [true|false]
  18697. DESCRIPTION:
  18698. Sets the mask of bits that determine whether a given HAL interface is to be
  18699. enabled or disabled. A 1 bit means that the interface will be enabled; a 0
  18700. means that it will be disabled. A disabled interface will not be installed
  18701. and cannot be used to send/receive data. NOTE: This only takes effect at
  18702. system startup! You must reboot for this to take effect. These are the bits
  18703. for each interface:
  18705. 0x00001 -- DOCSIS CM HAL
  18706. 0x00002 -- Ethernet HAL
  18707. 0x00004 -- HPNA HAL
  18708. 0x00008 -- USB HAL
  18709. 0x00010 -- IP Stack 1 HAL
  18710. 0x00020 -- IP Stack 2 HAL
  18711. 0x00040 -- IP Stack 3 HAL
  18712. 0x00080 -- IP Stack 4 HAL
  18713. 0x00100 -- Davic HAL
  18714. 0x00200 -- PCI HAL
  18715. 0x00400 -- Bluetooth HAL
  18716. 0x00800 -- 802.11 HAL
  18717. 0x01000 -- PacketGenerator HAL
  18718. 0x02000 -- IP Stack 5 HAL
  18719. 0x04000 -- IP Stack 6 HAL
  18720. 0x08000 -- IP Stack 7 HAL
  18721. 0x10000 -- IP Stack 8 HAL
  18722. 0x20000 -- WAN Ethernet HAL
  18723. 0x40000 -- SCB HAL
  18725. EXAMPLES:
  18726. interfaces -- Shows the enabled interfaces.
  18727. interfaces 0x7fff -- Enables all interfaces.
  18728. interfaces 0 -- Disables all interfaces.
  18729. interfaces 0x13 -- Enables the DOCSIS CM, Ethernet, and IP Stack1 HALs.
  18730. interfaces 0x1 true -- Enables the DOCSIS CM along with the current enabled
  18731. interfaces
  18732. interfaces 0x1 false -- Disables ONLY the DOCSIS CMinterface
  18735. ------------------------------------------------------------------------------
  18737. TABLE: non-vol/halif
  18739. COMMAND: local_bt_mac_address
  18741. USAGE: local_bt_mac_address [MacAddress]
  18743. DESCRIPTION:
  18744. Sets or shows the Bluetooth MAC address; this is the MAC SA that will be used
  18745. when building the LLC header for packets from the PC attached via Bluetooth.
  18747. EXAMPLES:
  18748. local_bt_mac_address -- Shows the Bluetooth MAC address.
  18749. local_bt_mac_address 00:10:18:00:11:22 -- Sets the Bluetooth MAC address.
  18751. ------------------------------------------------------------------------------
  18753. TABLE: non-vol/halif
  18755. COMMAND: mac_address
  18757. USAGE: mac_address StackNum{1..8} [MacAddress]
  18759. DESCRIPTION:
  18760. Shows or sets the MAC address associated with the specified IP stack number.
  18761. This used to be set via the pSOS boot dialog, but is now handled here for
  18762. portability, and support for multiple IP stacks. You must reboot for this to
  18763. take effect!
  18765. EXAMPLES:
  18766. mac_address 2 -- Shows the MAC addr for stack 2.
  18767. mac_address 1 00:10:18:50:10:32 -- Sets the MAC addr for stack 1.
  18769. ------------------------------------------------------------------------------
  18771. TABLE: non-vol/halif
  18773. COMMAND: manufactured
  18775. USAGE: manufactured [both|perm|dyn]
  18777. DESCRIPTION:
  18778. Checks to see if the specified section is manufactured.
  18780. EXAMPLES:
  18781. manufactured -- Checks both Permanent and Dynamic sections
  18782. manufacturing state.
  18783. manufactured perm -- Checks only the Permanent section manufacturing state.
  18785. ------------------------------------------------------------------------------
  18787. TABLE: non-vol/halif
  18789. COMMAND: power_save_enable
  18791. USAGE: power_save_enable [true|false]
  18793. DESCRIPTION:
  18794. Enables/disables power save mode.
  18796. EXAMPLES:
  18797. power_save_enable true -- Enables power save mode.
  18799. ------------------------------------------------------------------------------
  18801. TABLE: non-vol/halif
  18803. COMMAND: read
  18805. USAGE: read [both|perm|dyn]
  18807. DESCRIPTION:
  18808. Reads the specified section of non-volatile settings from non-volatile
  18809. memory. If 'both' is specified or there are no parameters, then both
  18810. Permanent and Dynamic settings will be read. Otherwise, only the section
  18811. specified will be read. This will destroy any changes you have made if you
  18812. haven't written them!
  18814. EXAMPLES:
  18815. read -- Reads both Permanent and Dynamic sections of settings.
  18816. read perm -- Reads only the Permanent section of non-vol settings.
  18818. ------------------------------------------------------------------------------
  18820. TABLE: non-vol/halif
  18822. COMMAND: remote_bt_mac_address
  18824. USAGE: remote_bt_mac_address [MacAddress]
  18826. DESCRIPTION:
  18827. Sets or shows the Remote Bluetooth MAC address; this is the MAC SA that will
  18828. be used when connecting to a remote Bluetooth device.
  18830. EXAMPLES:
  18831. remote_bt_mac_address -- Shows the Bluetooth MAC address.
  18832. remote_bt_mac_address 00:10:18:00:11:22 -- Sets the Bluetooth MAC address.
  18834. ------------------------------------------------------------------------------
  18836. TABLE: non-vol/halif
  18838. COMMAND: scdma_code_matrix
  18840. USAGE: scdma_code_matrix [proprietary|docsis_compliant]
  18842. DESCRIPTION:
  18843. Enables/disables proprietary SCDMA code matrix support. Selecting
  18844. proprietary mode will make the modem non-DOCSIS compliant.
  18846. EXAMPLES:
  18847. scdma_code_matrix proprietary -- Enables proprietary SCDMA code matrix
  18848. support.
  18849. scdma_code_matrix docsis_compliant -- Enables DOCSIS-compliant SCDMA code
  18850. matrix support.
  18852. ------------------------------------------------------------------------------
  18854. TABLE: non-vol/halif
  18856. COMMAND: shack_tries
  18858. USAGE: shack_tries [NumTries{0..255}]
  18860. DESCRIPTION:
  18861. Shows or sets the number of times the CM HAL will perform the 'short
  18862. acquisition' (SHACK) thing, when downstream interruption is detected. Note
  18863. that 0 is a valid value, which effectively turns SHACK off.
  18864. You must write and reboot for this to take effect!
  18866. EXAMPLES:
  18867. shack_tries 3 -- Sets the number of SHACK tries to 3.
  18869. ------------------------------------------------------------------------------
  18871. TABLE: non-vol/halif
  18873. COMMAND: show
  18875. USAGE: show
  18877. DESCRIPTION:
  18878. Displays the current non-volatile settings values for both the Permanent and
  18879. Dynamic sections.
  18881. EXAMPLES:
  18882. show --
  18884. ------------------------------------------------------------------------------
  18886. TABLE: non-vol/halif
  18888. COMMAND: spreader_scale
  18890. USAGE: spreader_scale [scale{1..8}]
  18892. DESCRIPTION:
  18893. Sets the spreader scale value. Ask Ray what this is and how it's used.
  18895. EXAMPLES:
  18896. spreader_scale 2 -- Sets the spreader scale value to 2.
  18898. ------------------------------------------------------------------------------
  18900. TABLE: non-vol/halif
  18902. COMMAND: stats
  18904. USAGE: stats
  18906. DESCRIPTION:
  18907. Prints stats about buffer usage for Dynamic and Permanent settings.
  18909. EXAMPLES:
  18910. stats --
  18912. ------------------------------------------------------------------------------
  18914. TABLE: non-vol/halif
  18916. COMMAND: tftp_read
  18918. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  18920. DESCRIPTION:
  18921. Causes the Permanent or Dynamic settings data to be read from a server via
  18922. TFTP. The file must be generated correctly, with all of the headers, CRC,
  18923. and other information that would exist on the NonVol device. The file will
  18924. be read and evaluated for correctness before it is stored in the device. If
  18925. the file is rejected then the settings will be read from the device to undo
  18926. any changes. Normally, this will operate on all settings groups; if you
  18927. specify -g then it will operate only on the current group (e.g. if you are in
  18928. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  18929. read).
  18931. EXAMPLES:
  18932. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  18933. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  18935. ------------------------------------------------------------------------------
  18937. TABLE: non-vol/halif
  18939. COMMAND: tftp_write
  18941. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  18943. DESCRIPTION:
  18944. Causes the Permanent or Dynamic settings data to be written to a server via
  18945. TFTP. Normally, this will operate on all settings groups; if you specify -g
  18946. then it will operate only on the current group (e.g. if you are in the SNMP
  18947. nonvol dir, then -g will cause only the SNMP settings group to be written).
  18949. EXAMPLES:
  18950. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  18951. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  18953. ------------------------------------------------------------------------------
  18955. TABLE: non-vol/halif
  18957. COMMAND: usb_device_id
  18959. USAGE: usb_device_id [id{0..65535}]
  18961. DESCRIPTION:
  18962. Sets or shows the USB Device Id that will be used during USB enumeration.
  18963. This is used by the PC in combination with the USB Vendor Id to select a USB
  18964. driver.
  18966. EXAMPLES:
  18967. usb_device_id -- Shows the current USB Device Id.
  18968. usb_device_id 0x0201 -- Sets the USB Device Id.
  18970. ------------------------------------------------------------------------------
  18972. TABLE: non-vol/halif
  18974. COMMAND: usb_mac_address
  18976. USAGE: usb_mac_address [MacAddress]
  18978. DESCRIPTION:
  18979. Sets or shows the USB MAC address; this is the MAC SA that will be used when
  18980. building the LLC header for packets from the PC attached via USB.
  18982. EXAMPLES:
  18983. usb_mac_address -- Shows the USB MAC address.
  18984. usb_mac_address 00:10:18:00:11:22 -- Sets the USB MAC address.
  18986. ------------------------------------------------------------------------------
  18988. TABLE: non-vol/halif
  18990. COMMAND: usb_rndis
  18992. USAGE: usb_rndis [true|false]
  18994. DESCRIPTION:
  18995. Enables or Disables the USB RNDIS Driver that will be used during USB
  18996. enumeration. This is used by the PC in combination with the USB Vendor Id
  18997. and USB Device Id to select a USB driver.
  18999. EXAMPLES:
  19000. usb_rndis -- Shows the current USB RNDIS Driver enabled or disabled.
  19001. usb_rndis false -- Disables the USB RNDIS Driver.
  19002. usb_rndis true -- Enables the USB RNDIS Driver.
  19004. ------------------------------------------------------------------------------
  19006. TABLE: non-vol/halif
  19008. COMMAND: usb_vendor_id
  19010. USAGE: usb_vendor_id [id{0..65535}]
  19012. DESCRIPTION:
  19013. Sets or shows the USB Vendor Id that will be used during USB enumeration.
  19014. This is used by the PC in combination with the USB Device Id to select a USB
  19015. driver.
  19017. EXAMPLES:
  19018. usb_vendor_id -- Shows the current USB Vendor Id.
  19019. usb_vendor_id 0x14e4 -- Sets the USB Vendor Id.
  19021. ------------------------------------------------------------------------------
  19023. TABLE: non-vol/halif
  19025. COMMAND: wdog_enable
  19027. USAGE: wdog_enable [true|false]
  19029. DESCRIPTION:
  19030. Enables/disables the watchdog timer. If the watchdog expires, the system
  19031. will be reset. Mostly used to handle system crashes.
  19033. EXAMPLES:
  19034. wdog_enable true -- Enables the watchdog timer.
  19036. ------------------------------------------------------------------------------
  19038. TABLE: non-vol/halif
  19040. COMMAND: wdog_timeout
  19042. USAGE: wdog_timeout [seconds{1..255}]
  19044. DESCRIPTION:
  19045. Sets the watchdog timer timeout value.
  19047. EXAMPLES:
  19048. wdog_timeout 10 -- Sets the watchdog timer timeout to 10 seconds.
  19050. ------------------------------------------------------------------------------
  19052. TABLE: non-vol/halif
  19054. COMMAND: write
  19056. USAGE: write [both|perm|dyn]
  19058. DESCRIPTION:
  19059. Writes the specified section of non-volatile settings to non-volatile memory.
  19060. If 'both' is specified or there are no parameters, then both Permanent and
  19061. Dynamic settings will be written. Otherwise, only the section specified will
  19062. be written.
  19064. EXAMPLES:
  19065. write -- Writes both Permanent and Dynamic sections of settings.
  19066. write perm -- Writes only the Permanent section of non-vol settings.
  19068. ------------------------------------------------------------------------------
  19070. TABLE: non-vol/halif
  19072. COMMAND: zone
  19074. USAGE: zone [Bitmask{0xffff}]
  19076. DESCRIPTION:
  19077. Prints or sets the HAL debug zones; this determines what debug messages will
  19078. be displayed by HAL drivers. These bits correspond to the HAL debug zones:
  19080. 0x0001 -- INIT
  19081. 0x0002 -- TEST1
  19082. 0x0004 -- TEST2
  19083. 0x0008 -- TEST3
  19084. 0x0010 -- TEST4
  19085. 0x0020 -- TEST5
  19086. 0x0040 -- TEST6
  19087. 0x0080 -- BPI
  19088. 0x0100 -- DOWNSTREAM
  19089. 0x0200 -- UPSTREAM
  19090. 0x0400 -- TUNER
  19091. 0x0800 -- RANGING
  19092. 0x1000 -- TESTSRAM
  19093. 0x2000 -- TESTREG
  19094. 0x4000 -- WARNING
  19095. 0x8000 -- ERROR
  19097. EXAMPLES:
  19098. zone -- Shows the enabled HAL debug zones.
  19099. zone 0xffff -- Enables all HAL debug zones.
  19100. zone 0xc000 -- Enables Error and Warning zones.
  19101. zone 0 -- Disables all HAL debug zones.
  19103. ------------------------------------------------------------------------------
  19105. TABLE: non-vol/ipsec
  19107. COMMAND: clear_device
  19109. USAGE: clear_device [both|perm|dyn]
  19111. DESCRIPTION:
  19112. Tells the nonvol device to wipe out the specified settings section. All data
  19113. will be lost; the device should be restored to its 'virgin' state. For flash
  19114. devices, the flash block is erased; for disk devices, the file is erased.
  19116. EXAMPLES:
  19117. clear_device -- Clears both Permanent and Dynamic sections.
  19118. clear_device perm -- Clears only the Permanent section.
  19120. ------------------------------------------------------------------------------
  19122. TABLE: non-vol/ipsec
  19124. COMMAND: configure
  19126. USAGE: configure
  19128. DESCRIPTION:
  19129. Configure the library with the current settings
  19131. EXAMPLES:
  19132. configure
  19134. ------------------------------------------------------------------------------
  19136. TABLE: non-vol/ipsec
  19138. COMMAND: defaults
  19140. USAGE: defaults [both|perm|dyn]
  19142. DESCRIPTION:
  19143. Restores the settings to default values. NOTE: This does not write to
  19144. NonVol memory! You must do this manually. Also note that some settings do
  19145. not have good defaults, particularly the Permanent section! Use this command
  19146. with extreme care!
  19148. EXAMPLES:
  19149. defaults -- Sets both Permanent and Dynamic sections to defaults.
  19150. defaults perm -- Sets only the Permanent section to defaults.
  19152. ------------------------------------------------------------------------------
  19154. TABLE: non-vol/ipsec
  19156. COMMAND: del_extra_data
  19158. USAGE: del_extra_data [both|perm|dyn]
  19160. DESCRIPTION:
  19161. Gets rid of any extra data that is assiociated with the settings. The extra
  19162. data is usually caused by a downgrade, where settings written by a newer
  19163. version are not understood by the older version, but are stored so that they
  19164. will still exist when the new code is run. However, in some cases, it is
  19165. desirable to get rid of them if they are not going to be used.
  19167. EXAMPLES:
  19168. del_extra_data perm -- Gets rid of extra permanent data.
  19170. ------------------------------------------------------------------------------
  19172. TABLE: non-vol/ipsec
  19174. COMMAND: dump
  19176. USAGE: dump
  19178. DESCRIPTION:
  19179. Dumps the SAD and SPD
  19181. EXAMPLES:
  19182. dump
  19184. ------------------------------------------------------------------------------
  19186. TABLE: non-vol/ipsec
  19188. COMMAND: entry_delete
  19190. USAGE: entry_delete in|out entry_id
  19192. DESCRIPTION:
  19193. Deletes an entry (policy) with a specified IPSEC_ENTRY ID
  19195. EXAMPLES:
  19196. entry_delete [in|out] [entryid]
  19198. ------------------------------------------------------------------------------
  19200. TABLE: non-vol/ipsec
  19202. COMMAND: flush {disabled}
  19204. USAGE: flush
  19206. DESCRIPTION:
  19207. For Composite NonVol Settings objects (which contain 1 or more groups of
  19208. NonVol Settings), this command flushes out any unrecognized groups that were
  19209. read from the device. This is useful in cases where the settings group isn't
  19210. needed by another application, and would just waste space.
  19212. EXAMPLES:
  19213. flush --
  19215. ------------------------------------------------------------------------------
  19217. TABLE: non-vol/ipsec
  19219. COMMAND: inauthkey
  19221. USAGE: inauthkey [key{128}]
  19223. DESCRIPTION:
  19224. key -- Hexadecimal key value for the specified key. If the length
  19225. entered is less than required then the key is padded with zeros (
  19226. must be multiple of 2)
  19228. EXAMPLES:
  19229. inauthkey 0102030405060708 --
  19231. ------------------------------------------------------------------------------
  19233. TABLE: non-vol/ipsec
  19235. COMMAND: incipherkey
  19237. USAGE: incipherkey [key{48}]
  19239. DESCRIPTION:
  19240. key -- Hexadecimal key value for the specified key. If the length
  19241. entered is less than required then the key is padded with zeros (
  19242. must be multiple of 2)
  19244. EXAMPLES:
  19245. incipherkey 0A1E030405060708 --
  19247. ------------------------------------------------------------------------------
  19249. TABLE: non-vol/ipsec
  19251. COMMAND: manufactured
  19253. USAGE: manufactured [both|perm|dyn]
  19255. DESCRIPTION:
  19256. Checks to see if the specified section is manufactured.
  19258. EXAMPLES:
  19259. manufactured -- Checks both Permanent and Dynamic sections
  19260. manufacturing state.
  19261. manufactured perm -- Checks only the Permanent section manufacturing state.
  19263. ------------------------------------------------------------------------------
  19265. TABLE: non-vol/ipsec
  19267. COMMAND: outauthkey
  19269. USAGE: outauthkey [outauthkey{128}]
  19271. DESCRIPTION:
  19272. key -- Hexadecimal key value for the specified key. If the length
  19273. entered is less than required then the key is padded with zeros (
  19274. must be multiple of 2)
  19276. EXAMPLES:
  19277. outauthkey 0A0B0C1D1E060708 --
  19279. ------------------------------------------------------------------------------
  19281. TABLE: non-vol/ipsec
  19283. COMMAND: outcipherkey
  19285. USAGE: outcipherkey [key{48}]
  19287. DESCRIPTION:
  19288. key -- Hexadecimal key value for the specified key. If the length
  19289. entered is less than required then the key is padded with zeros (
  19290. must be multiple of 2)
  19292. EXAMPLES:
  19293. outcipherkey 0A0B030405060708 --
  19295. ------------------------------------------------------------------------------
  19297. TABLE: non-vol/ipsec
  19299. COMMAND: read
  19301. USAGE: read [both|perm|dyn]
  19303. DESCRIPTION:
  19304. Reads the specified section of non-volatile settings from non-volatile
  19305. memory. If 'both' is specified or there are no parameters, then both
  19306. Permanent and Dynamic settings will be read. Otherwise, only the section
  19307. specified will be read. This will destroy any changes you have made if you
  19308. haven't written them!
  19310. EXAMPLES:
  19311. read -- Reads both Permanent and Dynamic sections of settings.
  19312. read perm -- Reads only the Permanent section of non-vol settings.
  19314. ------------------------------------------------------------------------------
  19316. TABLE: non-vol/ipsec
  19318. COMMAND: show
  19320. USAGE: show
  19322. DESCRIPTION:
  19323. Displays the current non-volatile settings values for both the Permanent and
  19324. Dynamic sections.
  19326. EXAMPLES:
  19327. show --
  19329. ------------------------------------------------------------------------------
  19331. TABLE: non-vol/ipsec
  19333. COMMAND: spec_delete
  19335. USAGE: spec_delete in|out entry_id spec_id
  19337. DESCRIPTION:
  19338. Deletes a spec (SA) and it's associated entry (policy) with a specified
  19339. IPSEC_SPEC ID and ENTRY_ID
  19341. EXAMPLES:
  19342. spec_delete [in|out] [entry_id] [spec_id]
  19344. ------------------------------------------------------------------------------
  19346. TABLE: non-vol/ipsec
  19348. COMMAND: standalone
  19350. USAGE: standalone [true|false]
  19352. DESCRIPTION:
  19353. Enables/disables standalone mode. If Standalone mode is enabledthen IPsec
  19354. will run on top of the Ethernet Halif, otherwise on top of CMHAL (HFC).
  19356. EXAMPLES:
  19357. standalone true/false --
  19359. ------------------------------------------------------------------------------
  19361. TABLE: non-vol/ipsec
  19363. COMMAND: stats
  19365. USAGE: stats
  19367. DESCRIPTION:
  19368. Prints stats about buffer usage for Dynamic and Permanent settings.
  19370. EXAMPLES:
  19371. stats --
  19373. ------------------------------------------------------------------------------
  19375. TABLE: non-vol/ipsec
  19377. COMMAND: tftp_read
  19379. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  19381. DESCRIPTION:
  19382. Causes the Permanent or Dynamic settings data to be read from a server via
  19383. TFTP. The file must be generated correctly, with all of the headers, CRC,
  19384. and other information that would exist on the NonVol device. The file will
  19385. be read and evaluated for correctness before it is stored in the device. If
  19386. the file is rejected then the settings will be read from the device to undo
  19387. any changes. Normally, this will operate on all settings groups; if you
  19388. specify -g then it will operate only on the current group (e.g. if you are in
  19389. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  19390. read).
  19392. EXAMPLES:
  19393. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  19394. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  19396. ------------------------------------------------------------------------------
  19398. TABLE: non-vol/ipsec
  19400. COMMAND: tftp_write
  19402. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  19404. DESCRIPTION:
  19405. Causes the Permanent or Dynamic settings data to be written to a server via
  19406. TFTP. Normally, this will operate on all settings groups; if you specify -g
  19407. then it will operate only on the current group (e.g. if you are in the SNMP
  19408. nonvol dir, then -g will cause only the SNMP settings group to be written).
  19410. EXAMPLES:
  19411. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  19412. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  19414. ------------------------------------------------------------------------------
  19416. TABLE: non-vol/ipsec
  19418. COMMAND: transport
  19420. USAGE: transport deststart destend 0|1|6|17 sport{0..65535} dport{0..65535} outspi inspi 2|3|11 0|1|2
  19422. DESCRIPTION:
  19423. deststart -- Start destination address
  19424. destend -- End destination address
  19425. protl -- (0-any, 1-ICMP, 6-TCP, 17-UPD)
  19426. sport -- Source port(valid only for TCP or UDP)
  19427. dport -- Destination port (valid only for TCP or UDP)
  19428. outspi -- Outbound Security parameter index
  19429. inspi -- Inbound Security parameter index
  19430. ealgo -- Encrypt algo (0-None,2-DES,3-3DES,11-ESP NONE)
  19431. aalgo -- Authentication algo (0-None, 1-MD5, 2-SHA)
  19434. EXAMPLES:
  19435. transport 192.168.100.0 192.168.100.200 0 0 0 111 112 3 0 --
  19437. ------------------------------------------------------------------------------
  19439. TABLE: non-vol/ipsec
  19441. COMMAND: tunnel
  19443. USAGE: tunnel deststart destend 0|1|6|17 sport{0..255} dport{0..255} outspi inspi 0|2|3|11 0|1|2 tsrc tdst macaddr
  19445. DESCRIPTION:
  19446. dstart -- Destination start address
  19447. dend -- End destination address
  19448. sport -- Source port(valid only for TCP or UDP)
  19449. dport -- Destination port (valid only for TCP or UDP)
  19450. outspi -- Outbound Security parameter index
  19451. inspi -- Inbound Security parameter index
  19452. ealgo -- Encrypt algo (0-None,2-DES,3-3DES,11-ESP NONE)
  19453. aalgo -- Authentication algo (0-None, 1-MD5, 2-SHA)
  19454. tsrc -- Source address of the tunnel
  19455. tdst -- Destination address of the tunnel
  19456. macaddr -- Mac address associated with the SPI
  19458. EXAMPLES:
  19459. tunnel 11.24.1.0 11.24.1.200 0 0 0 111 112 3 0 11.24.1.168 11.24.1.178
  19460. 0.33.44.55.66.77 --
  19462. ------------------------------------------------------------------------------
  19464. TABLE: non-vol/ipsec
  19466. COMMAND: write
  19468. USAGE: write [both|perm|dyn]
  19470. DESCRIPTION:
  19471. Writes the specified section of non-volatile settings to non-volatile memory.
  19472. If 'both' is specified or there are no parameters, then both Permanent and
  19473. Dynamic settings will be written. Otherwise, only the section specified will
  19474. be written.
  19476. EXAMPLES:
  19477. write -- Writes both Permanent and Dynamic sections of settings.
  19478. write perm -- Writes only the Permanent section of non-vol settings.
  19480. ------------------------------------------------------------------------------
  19482. TABLE: non-vol/parental
  19484. COMMAND: clear_device
  19486. USAGE: clear_device [both|perm|dyn]
  19488. DESCRIPTION:
  19489. Tells the nonvol device to wipe out the specified settings section. All data
  19490. will be lost; the device should be restored to its 'virgin' state. For flash
  19491. devices, the flash block is erased; for disk devices, the file is erased.
  19493. EXAMPLES:
  19494. clear_device -- Clears both Permanent and Dynamic sections.
  19495. clear_device perm -- Clears only the Permanent section.
  19497. ------------------------------------------------------------------------------
  19499. TABLE: non-vol/parental
  19501. COMMAND: content_policies
  19503. USAGE: content_policies
  19505. DESCRIPTION:
  19506. Prints content policy list
  19508. EXAMPLES:
  19509. content_policies --
  19511. ------------------------------------------------------------------------------
  19513. TABLE: non-vol/parental
  19515. COMMAND: defaults
  19517. USAGE: defaults [both|perm|dyn]
  19519. DESCRIPTION:
  19520. Restores the settings to default values. NOTE: This does not write to
  19521. NonVol memory! You must do this manually. Also note that some settings do
  19522. not have good defaults, particularly the Permanent section! Use this command
  19523. with extreme care!
  19525. EXAMPLES:
  19526. defaults -- Sets both Permanent and Dynamic sections to defaults.
  19527. defaults perm -- Sets only the Permanent section to defaults.
  19529. ------------------------------------------------------------------------------
  19531. TABLE: non-vol/parental
  19533. COMMAND: del_extra_data
  19535. USAGE: del_extra_data [both|perm|dyn]
  19537. DESCRIPTION:
  19538. Gets rid of any extra data that is assiociated with the settings. The extra
  19539. data is usually caused by a downgrade, where settings written by a newer
  19540. version are not understood by the older version, but are stored so that they
  19541. will still exist when the new code is run. However, in some cases, it is
  19542. desirable to get rid of them if they are not going to be used.
  19544. EXAMPLES:
  19545. del_extra_data perm -- Gets rid of extra permanent data.
  19547. ------------------------------------------------------------------------------
  19549. TABLE: non-vol/parental
  19551. COMMAND: domain_add
  19553. USAGE: domain_add [ruleIndex{0..7}] [String{254}]
  19555. DESCRIPTION:
  19556. Adds a domain to the specified rule's blocked domain list.
  19557. Use content_policies command to find the rule index of the content rule
  19558. you want to add the domain to.
  19560. EXAMPLES:
  19561. domain_add <rule index> <domain name>
  19562. domain_add 1 www.broadcom.com
  19564. ------------------------------------------------------------------------------
  19566. TABLE: non-vol/parental
  19568. COMMAND: domain_remove
  19570. USAGE: domain_remove [ruleIndex{0..7}] [String{254}]
  19572. DESCRIPTION:
  19573. Removes a domain from the specified rule's blocked domain list.
  19574. Use content_policies command to find the rule index of the content rule
  19575. you want to remove the domain from.
  19577. EXAMPLES:
  19578. domain_remove <rule index> <domain name>
  19579. domain_remove 1 www.broadcom.com
  19581. ------------------------------------------------------------------------------
  19583. TABLE: non-vol/parental
  19585. COMMAND: flush {disabled}
  19587. USAGE: flush
  19589. DESCRIPTION:
  19590. For Composite NonVol Settings objects (which contain 1 or more groups of
  19591. NonVol Settings), this command flushes out any unrecognized groups that were
  19592. read from the device. This is useful in cases where the settings group isn't
  19593. needed by another application, and would just waste space.
  19595. EXAMPLES:
  19596. flush --
  19598. ------------------------------------------------------------------------------
  19600. TABLE: non-vol/parental
  19602. COMMAND: manufactured
  19604. USAGE: manufactured [both|perm|dyn]
  19606. DESCRIPTION:
  19607. Checks to see if the specified section is manufactured.
  19609. EXAMPLES:
  19610. manufactured -- Checks both Permanent and Dynamic sections
  19611. manufacturing state.
  19612. manufactured perm -- Checks only the Permanent section manufacturing state.
  19614. ------------------------------------------------------------------------------
  19616. TABLE: non-vol/parental
  19618. COMMAND: read
  19620. USAGE: read [both|perm|dyn]
  19622. DESCRIPTION:
  19623. Reads the specified section of non-volatile settings from non-volatile
  19624. memory. If 'both' is specified or there are no parameters, then both
  19625. Permanent and Dynamic settings will be read. Otherwise, only the section
  19626. specified will be read. This will destroy any changes you have made if you
  19627. haven't written them!
  19629. EXAMPLES:
  19630. read -- Reads both Permanent and Dynamic sections of settings.
  19631. read perm -- Reads only the Permanent section of non-vol settings.
  19633. ------------------------------------------------------------------------------
  19635. TABLE: non-vol/parental
  19637. COMMAND: sessions
  19639. USAGE: sessions [String{254}]
  19641. DESCRIPTION:
  19642. Displays active user sessions.
  19645. EXAMPLES:
  19646. sessions --
  19648. ------------------------------------------------------------------------------
  19650. TABLE: non-vol/parental
  19652. COMMAND: show
  19654. USAGE: show
  19656. DESCRIPTION:
  19657. Displays the current non-volatile settings values for both the Permanent and
  19658. Dynamic sections.
  19660. EXAMPLES:
  19661. show --
  19663. ------------------------------------------------------------------------------
  19665. TABLE: non-vol/parental
  19667. COMMAND: stats
  19669. USAGE: stats
  19671. DESCRIPTION:
  19672. Prints stats about buffer usage for Dynamic and Permanent settings.
  19674. EXAMPLES:
  19675. stats --
  19677. ------------------------------------------------------------------------------
  19679. TABLE: non-vol/parental
  19681. COMMAND: tftp_read
  19683. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  19685. DESCRIPTION:
  19686. Causes the Permanent or Dynamic settings data to be read from a server via
  19687. TFTP. The file must be generated correctly, with all of the headers, CRC,
  19688. and other information that would exist on the NonVol device. The file will
  19689. be read and evaluated for correctness before it is stored in the device. If
  19690. the file is rejected then the settings will be read from the device to undo
  19691. any changes. Normally, this will operate on all settings groups; if you
  19692. specify -g then it will operate only on the current group (e.g. if you are in
  19693. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  19694. read).
  19696. EXAMPLES:
  19697. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  19698. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  19700. ------------------------------------------------------------------------------
  19702. TABLE: non-vol/parental
  19704. COMMAND: tftp_write
  19706. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  19708. DESCRIPTION:
  19709. Causes the Permanent or Dynamic settings data to be written to a server via
  19710. TFTP. Normally, this will operate on all settings groups; if you specify -g
  19711. then it will operate only on the current group (e.g. if you are in the SNMP
  19712. nonvol dir, then -g will cause only the SNMP settings group to be written).
  19714. EXAMPLES:
  19715. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  19716. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  19718. Sending Ssdp hanp:rootdevice reply!
  19719. ------------------------------------------------------------------------------
  19721. TABLE: non-vol/parental
  19723. COMMAND: user_profiles
  19725. USAGE: user_profiles
  19727. DESCRIPTION:
  19728. Prints user list
  19730. EXAMPLES:
  19731. user_profiles --
  19733. ------------------------------------------------------------------------------
  19735. TABLE: non-vol/parental
  19737. COMMAND: write
  19739. USAGE: write [both|perm|dyn]
  19741. DESCRIPTION:
  19742. Writes the specified section of non-volatile settings to non-volatile memory.
  19743. If 'both' is specified or there are no parameters, then both Permanent and
  19744. Dynamic settings will be written. Otherwise, only the section specified will
  19745. be written.
  19747. EXAMPLES:
  19748. write -- Writes both Permanent and Dynamic sections of settings.
  19749. write perm -- Writes only the Permanent section of non-vol settings.
  19751. ------------------------------------------------------------------------------
  19753. TABLE: non-vol/propane
  19755. COMMAND: clear_device
  19757. USAGE: clear_device [both|perm|dyn]
  19759. DESCRIPTION:
  19760. Tells the nonvol device to wipe out the specified settings section. All data
  19761. will be lost; the device should be restored to its 'virgin' state. For flash
  19762. devices, the flash block is erased; for disk devices, the file is erased.
  19764. EXAMPLES:
  19765. clear_device -- Clears both Permanent and Dynamic sections.
  19766. clear_device perm -- Clears only the Permanent section.
  19768. ------------------------------------------------------------------------------
  19770. TABLE: non-vol/propane
  19772. COMMAND: defaults
  19774. USAGE: defaults [both|perm|dyn]
  19776. DESCRIPTION:
  19777. Restores the settings to default values. NOTE: This does not write to
  19778. NonVol memory! You must do this manually. Also note that some settings do
  19779. not have good defaults, particularly the Permanent section! Use this command
  19780. with extreme care!
  19782. EXAMPLES:
  19783. defaults -- Sets both Permanent and Dynamic sections to defaults.
  19784. defaults perm -- Sets only the Permanent section to defaults.
  19786. ------------------------------------------------------------------------------
  19788. TABLE: non-vol/propane
  19790. COMMAND: del_extra_data
  19792. USAGE: del_extra_data [both|perm|dyn]
  19794. DESCRIPTION:
  19795. Gets rid of any extra data that is assiociated with the settings. The extra
  19796. data is usually caused by a downgrade, where settings written by a newer
  19797. version are not understood by the older version, but are stored so that they
  19798. will still exist when the new code is run. However, in some cases, it is
  19799. desirable to get rid of them if they are not going to be used.
  19801. EXAMPLES:
  19802. del_extra_data perm -- Gets rid of extra permanent data.
  19804. ------------------------------------------------------------------------------
  19806. TABLE: non-vol/propane
  19808. COMMAND: enable_propane
  19810. USAGE: enable_propane [true|false]
  19812. DESCRIPTION:
  19813. Enables or disables Propane features. If disabled, then the Propane
  19814. subsystem will not run, and will not respond to input.
  19816. EXAMPLES:
  19817. enable_propane true -- Enables Propane features.
  19819. ------------------------------------------------------------------------------
  19821. TABLE: non-vol/propane
  19823. COMMAND: flush {disabled}
  19825. USAGE: flush
  19827. DESCRIPTION:
  19828. For Composite NonVol Settings objects (which contain 1 or more groups of
  19829. NonVol Settings), this command flushes out any unrecognized groups that were
  19830. read from the device. This is useful in cases where the settings group isn't
  19831. needed by another application, and would just waste space.
  19833. EXAMPLES:
  19834. flush --
  19836. ------------------------------------------------------------------------------
  19838. TABLE: non-vol/propane
  19840. COMMAND: manufactured
  19842. USAGE: manufactured [both|perm|dyn]
  19844. DESCRIPTION:
  19845. Checks to see if the specified section is manufactured.
  19847. EXAMPLES:
  19848. manufactured -- Checks both Permanent and Dynamic sections
  19849. manufacturing state.
  19850. manufactured perm -- Checks only the Permanent section manufacturing state.
  19852. ------------------------------------------------------------------------------
  19854. TABLE: non-vol/propane
  19856. COMMAND: read
  19858. USAGE: read [both|perm|dyn]
  19860. DESCRIPTION:
  19861. Reads the specified section of non-volatile settings from non-volatile
  19862. memory. If 'both' is specified or there are no parameters, then both
  19863. Permanent and Dynamic settings will be read. Otherwise, only the section
  19864. specified will be read. This will destroy any changes you have made if you
  19865. haven't written them!
  19867. EXAMPLES:
  19868. read -- Reads both Permanent and Dynamic sections of settings.
  19869. read perm -- Reads only the Permanent section of non-vol settings.
  19871. ------------------------------------------------------------------------------
  19873. TABLE: non-vol/propane
  19875. COMMAND: show
  19877. USAGE: show
  19879. DESCRIPTION:
  19880. Displays the current non-volatile settings values for both the Permanent and
  19881. Dynamic sections.
  19883. EXAMPLES:
  19884. show --
  19886. ------------------------------------------------------------------------------
  19888. TABLE: non-vol/propane
  19890. COMMAND: stats
  19892. USAGE: stats
  19894. DESCRIPTION:
  19895. Prints stats about buffer usage for Dynamic and Permanent settings.
  19897. EXAMPLES:
  19898. stats --
  19900. ------------------------------------------------------------------------------
  19902. TABLE: non-vol/propane
  19904. COMMAND: tftp_read
  19906. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  19908. DESCRIPTION:
  19909. Causes the Permanent or Dynamic settings data to be read from a server via
  19910. TFTP. The file must be generated correctly, with all of the headers, CRC,
  19911. and other information that would exist on the NonVol device. The file will
  19912. be read and evaluated for correctness before it is stored in the device. If
  19913. the file is rejected then the settings will be read from the device to undo
  19914. any changes. Normally, this will operate on all settings groups; if you
  19915. specify -g then it will operate only on the current group (e.g. if you are in
  19916. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  19917. read).
  19919. EXAMPLES:
  19920. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  19921. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  19923. ------------------------------------------------------------------------------
  19925. TABLE: non-vol/propane
  19927. COMMAND: tftp_write
  19929. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  19931. DESCRIPTION:
  19932. Causes the Permanent or Dynamic settings data to be written to a server via
  19933. TFTP. Normally, this will operate on all settings groups; if you specify -g
  19934. then it will operate only on the current group (e.g. if you are in the SNMP
  19935. nonvol dir, then -g will cause only the SNMP settings group to be written).
  19937. EXAMPLES:
  19938. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  19939. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  19941. ------------------------------------------------------------------------------
  19943. TABLE: non-vol/propane
  19945. COMMAND: timer
  19947. USAGE: timer Bitmask{0x3} true|false
  19949. DESCRIPTION:
  19950. Enables and disables various Propane timers. If disabled, then the timer
  19951. will still run, but will be ignored when it times out. This is only useful
  19952. for debugging.
  19954. EXAMPLES:
  19955. timer 0x01 true -- Enables timer P1.
  19957. ------------------------------------------------------------------------------
  19959. TABLE: non-vol/propane
  19961. COMMAND: write
  19963. USAGE: write [both|perm|dyn]
  19965. DESCRIPTION:
  19966. Writes the specified section of non-volatile settings to non-volatile memory.
  19967. If 'both' is specified or there are no parameters, then both Permanent and
  19968. Dynamic settings will be written. Otherwise, only the section specified will
  19969. be written.
  19971. EXAMPLES:
  19972. write -- Writes both Permanent and Dynamic sections of settings.
  19973. write perm -- Writes only the Permanent section of non-vol settings.
  19975. ------------------------------------------------------------------------------
  19977. TABLE: non-vol/psdev
  19979. COMMAND: agg_wireless_admin_status
  19981. USAGE: agg_wireless_admin_status [timer{1..2}]
  19983. DESCRIPTION:
  19984. Tells whether the Aggregated Wireless LAN ifAdminStatus
  19986. EXAMPLES:
  19987. agg_wireless_admin_status 1 => (up) --
  19989. ------------------------------------------------------------------------------
  19991. TABLE: non-vol/psdev
  19993. COMMAND: cablehome_mode
  19995. USAGE: cablehome_mode [mode{0..2}] [location(perm|dyn){4}]
  19997. DESCRIPTION:
  19998. (0) CableHome is disabled
  19999. (1) CableHome 1.0 (not supported)
  20000. (2) CableHome 1.1 enabled
  20002. EXAMPLES:
  20003. cablehome_mode 0 - sets device to run as a non-CableHome RG device.
  20004. cablehome_mode 2 - sets device to run as a CableHome1.1 device.
  20005. cablehome_mode 2 perm - sets the device to be CableHome1.1 enabled, permanent
  20006. location.
  20007. cablehome_mode 2 dyn - sets the device to be CableHome1.1 enabled, dynamic
  20008. location.
  20011. ------------------------------------------------------------------------------
  20013. TABLE: non-vol/psdev
  20015. Sending Ssdp hanp:rootdevice reply!
  20016. COMMAND: cablehome_upnp
  20018. USAGE: cablehome_upnp [true|false]
  20020. DESCRIPTION:
  20021. CableHome UPnP enable/disable flag
  20023. EXAMPLES:
  20024. cablehome_upnp false - turns off UPnP.
  20025. cablehome_upnp true - turns on UPnP.
  20028. ------------------------------------------------------------------------------
  20030. TABLE: non-vol/psdev
  20032. COMMAND: cableoffice_mode
  20034. USAGE: cableoffice_mode [true|false] [location(perm|dyn){4}]
  20036. DESCRIPTION:
  20037. CableHome CableOffice enable/disable flag
  20039. EXAMPLES:
  20040. cableoffice_mode 0 - turns off the CableOffice capable feature.
  20041. cableoffice_mode 1 - turns on the CableOffice capable feature.
  20042. cableoffice_mode true perm - sets the device to be CableOffice capable,
  20043. permanent location.
  20044. cableoffice_mode true dyn - sets the device to be CableOffice capable,
  20045. dynamic location.
  20048. ------------------------------------------------------------------------------
  20050. TABLE: non-vol/psdev
  20052. COMMAND: clear_device
  20054. USAGE: clear_device [both|perm|dyn]
  20056. DESCRIPTION:
  20057. Tells the nonvol device to wipe out the specified settings section. All data
  20058. will be lost; the device should be restored to its 'virgin' state. For flash
  20059. devices, the flash block is erased; for disk devices, the file is erased.
  20061. EXAMPLES:
  20062. clear_device -- Clears both Permanent and Dynamic sections.
  20063. clear_device perm -- Clears only the Permanent section.
  20065. ------------------------------------------------------------------------------
  20067. TABLE: non-vol/psdev
  20069. COMMAND: defaults
  20071. USAGE: defaults [both|perm|dyn]
  20073. DESCRIPTION:
  20074. Restores the settings to default values. NOTE: This does not write to
  20075. NonVol memory! You must do this manually. Also note that some settings do
  20076. not have good defaults, particularly the Permanent section! Use this command
  20077. with extreme care!
  20079. EXAMPLES:
  20080. defaults -- Sets both Permanent and Dynamic sections to defaults.
  20081. defaults perm -- Sets only the Permanent section to defaults.
  20083. ------------------------------------------------------------------------------
  20085. TABLE: non-vol/psdev
  20087. COMMAND: del_extra_data
  20089. USAGE: del_extra_data [both|perm|dyn]
  20091. DESCRIPTION:
  20092. Gets rid of any extra data that is assiociated with the settings. The extra
  20093. data is usually caused by a downgrade, where settings written by a newer
  20094. version are not understood by the older version, but are stored so that they
  20095. will still exist when the new code is run. However, in some cases, it is
  20096. desirable to get rid of them if they are not going to be used.
  20098. EXAMPLES:
  20099. del_extra_data perm -- Gets rid of extra permanent data.
  20101. ------------------------------------------------------------------------------
  20103. TABLE: non-vol/psdev
  20105. COMMAND: dloadTLSKey
  20107. USAGE: dloadTLSKey IpAddress [Filename{127}]
  20109. DESCRIPTION:
  20110. Causes the CableHome PsDev Control thread to download and store the specified
  20111. TLS Key file via TFTP from the specified TFTP Server IP address.
  20113. EXAMPLES:
  20114. dloadTLSKey 10.15.3.5 BRCM231_PSS03RS1.bin -- TFTPs BRCM231_PSS03RS1.bin
  20115. from the server.
  20118. ------------------------------------------------------------------------------
  20120. TABLE: non-vol/psdev
  20122. COMMAND: flush {disabled}
  20124. USAGE: flush
  20126. DESCRIPTION:
  20127. For Composite NonVol Settings objects (which contain 1 or more groups of
  20128. NonVol Settings), this command flushes out any unrecognized groups that were
  20129. read from the device. This is useful in cases where the settings group isn't
  20130. needed by another application, and would just waste space.
  20132. EXAMPLES:
  20133. flush --
  20135. ------------------------------------------------------------------------------
  20137. TABLE: non-vol/psdev
  20139. COMMAND: manufactured
  20141. USAGE: manufactured [both|perm|dyn]
  20143. DESCRIPTION:
  20144. Checks to see if the specified section is manufactured.
  20146. EXAMPLES:
  20147. manufactured -- Checks both Permanent and Dynamic sections
  20148. manufacturing state.
  20149. manufactured perm -- Checks only the Permanent section manufacturing state.
  20151. ------------------------------------------------------------------------------
  20153. TABLE: non-vol/psdev
  20155. COMMAND: prov_key_timeout
  20157. USAGE: prov_key_timeout [timeout{15..600}]
  20159. DESCRIPTION:
  20160. CableHome provisioning key timeout
  20162. EXAMPLES:
  20163. prov_key_timeout --
  20165. ------------------------------------------------------------------------------
  20167. TABLE: non-vol/psdev
  20169. COMMAND: prov_timer
  20171. USAGE: prov_timer [timer{0..16383}]
  20173. DESCRIPTION:
  20174. CableHome provisioning timer
  20176. EXAMPLES:
  20177. prov_timer --
  20179. ------------------------------------------------------------------------------
  20181. TABLE: non-vol/psdev
  20183. COMMAND: read
  20185. USAGE: read [both|perm|dyn]
  20187. DESCRIPTION:
  20188. Reads the specified section of non-volatile settings from non-volatile
  20189. memory. If 'both' is specified or there are no parameters, then both
  20190. Permanent and Dynamic settings will be read. Otherwise, only the section
  20191. specified will be read. This will destroy any changes you have made if you
  20192. haven't written them!
  20194. EXAMPLES:
  20195. read -- Reads both Permanent and Dynamic sections of settings.
  20196. read perm -- Reads only the Permanent section of non-vol settings.
  20198. ------------------------------------------------------------------------------
  20200. TABLE: non-vol/psdev
  20202. COMMAND: show
  20204. USAGE: show
  20206. DESCRIPTION:
  20207. Displays the current non-volatile settings values for both the Permanent and
  20208. Dynamic sections.
  20210. EXAMPLES:
  20211. show --
  20213. ------------------------------------------------------------------------------
  20215. TABLE: non-vol/psdev
  20217. COMMAND: stats
  20219. USAGE: stats
  20221. DESCRIPTION:
  20222. Prints stats about buffer usage for Dynamic and Permanent settings.
  20224. EXAMPLES:
  20225. stats --
  20227. ------------------------------------------------------------------------------
  20229. TABLE: non-vol/psdev
  20231. COMMAND: tftp_read
  20233. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  20235. DESCRIPTION:
  20236. Causes the Permanent or Dynamic settings data to be read from a server via
  20237. TFTP. The file must be generated correctly, with all of the headers, CRC,
  20238. and other information that would exist on the NonVol device. The file will
  20239. be read and evaluated for correctness before it is stored in the device. If
  20240. the file is rejected then the settings will be read from the device to undo
  20241. any changes. Normally, this will operate on all settings groups; if you
  20242. specify -g then it will operate only on the current group (e.g. if you are in
  20243. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  20244. read).
  20246. EXAMPLES:
  20247. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  20248. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  20250. ------------------------------------------------------------------------------
  20252. TABLE: non-vol/psdev
  20254. COMMAND: tftp_write
  20256. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  20258. DESCRIPTION:
  20259. Causes the Permanent or Dynamic settings data to be written to a server via
  20260. TFTP. Normally, this will operate on all settings groups; if you specify -g
  20261. then it will operate only on the current group (e.g. if you are in the SNMP
  20262. nonvol dir, then -g will cause only the SNMP settings group to be written).
  20264. EXAMPLES:
  20265. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  20266. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  20268. ------------------------------------------------------------------------------
  20270. TABLE: non-vol/psdev
  20272. COMMAND: write
  20274. USAGE: write [both|perm|dyn]
  20276. DESCRIPTION:
  20277. Writes the specified section of non-volatile settings to non-volatile memory.
  20278. If 'both' is specified or there are no parameters, then both Permanent and
  20279. Dynamic settings will be written. Otherwise, only the section specified will
  20280. be written.
  20282. EXAMPLES:
  20283. write -- Writes both Permanent and Dynamic sections of settings.
  20284. write perm -- Writes only the Permanent section of non-vol settings.
  20286. ------------------------------------------------------------------------------
  20288. TABLE: non-vol/rg
  20290. COMMAND: AntiVirusURL
  20292. USAGE: AntiVirusURL String{255}
  20294. DESCRIPTION:
  20295. Prompts user to set download antivirus software URL
  20297. EXAMPLES:
  20298. AntiVirusURL http://www.antivirus.com
  20301. ------------------------------------------------------------------------------
  20303. TABLE: non-vol/rg
  20305. COMMAND: clear_device
  20307. USAGE: clear_device [both|perm|dyn]
  20309. DESCRIPTION:
  20310. Tells the nonvol device to wipe out the specified settings section. All data
  20311. will be lost; the device should be restored to its 'virgin' state. For flash
  20312. devices, the flash block is erased; for disk devices, the file is erased.
  20314. EXAMPLES:
  20315. Sending Ssdp hanp:rootdevice reply!
  20316. clear_device -- Clears both Permanent and Dynamic sections.
  20317. clear_device perm -- Clears only the Permanent section.
  20319. ------------------------------------------------------------------------------
  20321. TABLE: non-vol/rg
  20323. COMMAND: defaults
  20325. USAGE: defaults [both|perm|dyn]
  20327. DESCRIPTION:
  20328. Restores the settings to default values. NOTE: This does not write to
  20329. NonVol memory! You must do this manually. Also note that some settings do
  20330. not have good defaults, particularly the Permanent section! Use this command
  20331. with extreme care!
  20333. EXAMPLES:
  20334. defaults -- Sets both Permanent and Dynamic sections to defaults.
  20335. defaults perm -- Sets only the Permanent section to defaults.
  20337. ------------------------------------------------------------------------------
  20339. TABLE: non-vol/rg
  20341. COMMAND: del_extra_data
  20343. USAGE: del_extra_data [both|perm|dyn]
  20345. DESCRIPTION:
  20346. Gets rid of any extra data that is assiociated with the settings. The extra
  20347. data is usually caused by a downgrade, where settings written by a newer
  20348. version are not understood by the older version, but are stored so that they
  20349. will still exist when the new code is run. However, in some cases, it is
  20350. desirable to get rid of them if they are not going to be used.
  20352. EXAMPLES:
  20353. del_extra_data perm -- Gets rid of extra permanent data.
  20355. ------------------------------------------------------------------------------
  20357. TABLE: non-vol/rg
  20359. COMMAND: flush {disabled}
  20361. USAGE: flush
  20363. DESCRIPTION:
  20364. For Composite NonVol Settings objects (which contain 1 or more groups of
  20365. NonVol Settings), this command flushes out any unrecognized groups that were
  20366. read from the device. This is useful in cases where the settings group isn't
  20367. needed by another application, and would just waste space.
  20369. EXAMPLES:
  20370. flush --
  20372. ------------------------------------------------------------------------------
  20374. TABLE: non-vol/rg
  20376. COMMAND: lan_feature_config
  20378. USAGE: lan_feature_config upnp|http_server|dhcp_server|routed_subnet [true|false]
  20380. DESCRIPTION:
  20381. Configure a LAN side service or feature:
  20383. upnp -- Enable or disable UPnP feature
  20384. http_server -- Enable or disable the HTTP server
  20385. dhcp_server -- Enable or disable the DHCP server
  20386. routed_subnet -- Configure routed subnets and settings
  20389. EXAMPLES:
  20390. lan_feature_config routed_subnet true -- Enables routed subnets feature and
  20391. prompts user for settings.
  20392. lan_feature_config routed_subnet -- Displays the current status Routed
  20393. Subnet settings.
  20396. ------------------------------------------------------------------------------
  20398. TABLE: non-vol/rg
  20400. COMMAND: manufactured
  20402. USAGE: manufactured [both|perm|dyn]
  20404. DESCRIPTION:
  20405. Checks to see if the specified section is manufactured.
  20407. EXAMPLES:
  20408. manufactured -- Checks both Permanent and Dynamic sections
  20409. manufacturing state.
  20410. manufactured perm -- Checks only the Permanent section manufacturing state.
  20412. ------------------------------------------------------------------------------
  20414. TABLE: non-vol/rg
  20416. COMMAND: max_mtu_size
  20418. USAGE: max_mtu_size [Number{0..1500}]
  20420. DESCRIPTION:
  20421. Sets the max MTU size (256-1500 bytes, 0=default).
  20423. EXAMPLES:
  20424. max_mtu_size -- Shows the max MTU size.
  20425. max_mtu_size 500 -- Sets the max MTU size to 500 bytes
  20427. ------------------------------------------------------------------------------
  20429. TABLE: non-vol/rg
  20431. COMMAND: nat_show
  20433. USAGE: nat_show
  20435. DESCRIPTION:
  20436. {No command help available...}
  20438. EXAMPLES:
  20439. nat_show
  20442. ------------------------------------------------------------------------------
  20444. TABLE: non-vol/rg
  20446. COMMAND: password
  20448. USAGE: password String{8}
  20450. DESCRIPTION:
  20451. sets the login password
  20453. EXAMPLES:
  20454. password hello
  20457. ------------------------------------------------------------------------------
  20459. TABLE: non-vol/rg
  20461. COMMAND: primary_default_override
  20463. USAGE: primary_default_override [true|false]
  20465. DESCRIPTION:
  20466. {No command help available...}
  20468. EXAMPLES:
  20469. primary_default_override true -- .
  20471. ------------------------------------------------------------------------------
  20473. TABLE: non-vol/rg
  20475. COMMAND: read
  20477. USAGE: read [both|perm|dyn]
  20479. DESCRIPTION:
  20480. Reads the specified section of non-volatile settings from non-volatile
  20481. memory. If 'both' is specified or there are no parameters, then both
  20482. Permanent and Dynamic settings will be read. Otherwise, only the section
  20483. specified will be read. This will destroy any changes you have made if you
  20484. haven't written them!
  20486. EXAMPLES:
  20487. read -- Reads both Permanent and Dynamic sections of settings.
  20488. read perm -- Reads only the Permanent section of non-vol settings.
  20490. ------------------------------------------------------------------------------
  20492. TABLE: non-vol/rg
  20494. COMMAND: realm
  20496. USAGE: realm String{255}
  20498. DESCRIPTION:
  20499. sets the login realm
  20501. EXAMPLES:
  20502. realm hello
  20505. ------------------------------------------------------------------------------
  20507. TABLE: non-vol/rg
  20509. COMMAND: rg_enable
  20511. USAGE: rg_enable [true|false] [location(perm|dyn){4}]
  20513. DESCRIPTION:
  20514. Enables or disables the Residential Gateway Mode
  20516. EXAMPLES:
  20517. rg_enable true - enable RG mode in default location.
  20518. rg_enable true dyn - enable RG mode in dynamic location.
  20519. rg_enable true perm - enable RG mode in permanent location.
  20522. ------------------------------------------------------------------------------
  20524. TABLE: non-vol/rg
  20526. COMMAND: set_feature_enable
  20528. USAGE: set_feature_enable ipsec_pass|pptp_pass|port_triggers|mac_filters|ip_filters|port_filters|mcast_support|nat_debug [true|false]
  20530. DESCRIPTION:
  20531. Enable or Disable specific Residential Gateway Features:
  20533. ipsec_pass -- Enable or disable IPSEC passthrough support
  20534. pptp_pass -- Enable or disable PPTP passthrough support
  20535. port_triggers -- Enable or disable port trigger support
  20536. mac_filters -- Enable or disable the MAC filtering support
  20537. ip_filters -- Enable or disable the IP filtering support
  20538. port_filters -- Enable or disable the port filtering support
  20539. mcast_support -- Enable or disable passing of multicast traffic
  20540. nat_debug -- Enable or disable NAT debugging
  20543. EXAMPLES:
  20544. set_feature_enable mac_filters true -- Enables mac filtering support.
  20545. set_feature_enable mac_filters -- Displays whether mac filtering
  20546. feature is enabled or disabled.
  20549. *****************************************************************************
  20550. !NOTE: The previous 'set_features' command has been split into (4) commands
  20551. (1) wan_connection_type - sets the WAN client connection type
  20552. (2) wan_feature_config - configures WAN-side features
  20553. (3) lan_feature_config - configures LAN-side features
  20554. (4) set_feature_enable - configures misc. gateway features
  20555. *****************************************************************************
  20558. ------------------------------------------------------------------------------
  20560. TABLE: non-vol/rg
  20562. COMMAND: show
  20564. USAGE: show
  20566. DESCRIPTION:
  20567. Displays the current non-volatile settings values for both the Permanent and
  20568. Dynamic sections.
  20570. EXAMPLES:
  20571. show --
  20573. ------------------------------------------------------------------------------
  20575. TABLE: non-vol/rg
  20577. COMMAND: stats
  20579. USAGE: stats
  20581. DESCRIPTION:
  20582. Prints stats about buffer usage for Dynamic and Permanent settings.
  20584. EXAMPLES:
  20585. stats --
  20587. ------------------------------------------------------------------------------
  20589. TABLE: non-vol/rg
  20591. COMMAND: tftp_read
  20593. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  20595. DESCRIPTION:
  20596. Causes the Permanent or Dynamic settings data to be read from a server via
  20597. TFTP. The file must be generated correctly, with all of the headers, CRC,
  20598. and other information that would exist on the NonVol device. The file will
  20599. be read and evaluated for correctness before it is stored in the device. If
  20600. the file is rejected then the settings will be read from the device to undo
  20601. any changes. Normally, this will operate on all settings groups; if you
  20602. specify -g then it will operate only on the current group (e.g. if you are in
  20603. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  20604. read).
  20606. EXAMPLES:
  20607. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  20608. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  20610. ------------------------------------------------------------------------------
  20612. TABLE: non-vol/rg
  20613. Sending Ssdp hanp:rootdevice reply!
  20615. COMMAND: tftp_write
  20617. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  20619. DESCRIPTION:
  20620. Causes the Permanent or Dynamic settings data to be written to a server via
  20621. TFTP. Normally, this will operate on all settings groups; if you specify -g
  20622. then it will operate only on the current group (e.g. if you are in the SNMP
  20623. nonvol dir, then -g will cause only the SNMP settings group to be written).
  20625. EXAMPLES:
  20626. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  20627. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  20629. ------------------------------------------------------------------------------
  20631. TABLE: non-vol/rg
  20633. COMMAND: wan_connection_type
  20635. USAGE: wan_connection_type [static|dhcp|pptp|pppoe|l2tp]
  20637. DESCRIPTION:
  20638. Selects the Residential Gateway WAN interface connection type:
  20640. static -- Static WAN IP address connection
  20641. dhcp -- Dynamic Host Control Protocol client IP address connection
  20642. pptp -- Point-to-Point Tunnelling Protocol client WAN connection
  20643. pppoe -- PPP over Ethernet client connection
  20644. l2tp -- Layer 2 Tunnelling Protocol client WAN connection
  20647. EXAMPLES:
  20648. wan_connection_type pppoe -- Sets the PPPoE client as the default WAN
  20649. connection type.
  20652. ------------------------------------------------------------------------------
  20654. TABLE: non-vol/rg
  20656. COMMAND: wan_feature_config
  20658. USAGE: wan_feature_config sntp|rip|ddns|remote_mgmt|wan_block|l2tp_server|pptp_server|capt_skip_dhcp [true|false]
  20660. DESCRIPTION:
  20661. Configure a WAN side service or feature:
  20663. sntp -- Configure SNTP (Time Protocol) settings
  20664. rip -- Configure RIP settings
  20665. remote_mgmt -- Enable or disable remote management feature
  20666. ddns -- Enable or disable Dynamic DNS feature
  20667. wan_block -- Enable or disable WAN blocking feature
  20668. l2tp_server -- Configure L2TP server settings
  20669. pptp_server -- Configure PPTP server settings
  20670. capt_skip_dhcp -- Configure if WAN DHCP is done also when running in
  20671. passthrough mode
  20674. EXAMPLES:
  20675. wan_feature_config rip true -- Enables RIP feature and prompts user for
  20676. settings.
  20677. wan_feature_config rip -- Displays the current status of the RIP
  20678. feature.
  20681. ------------------------------------------------------------------------------
  20683. TABLE: non-vol/rg
  20685. COMMAND: write
  20687. USAGE: write [both|perm|dyn]
  20689. DESCRIPTION:
  20690. Writes the specified section of non-volatile settings to non-volatile memory.
  20691. If 'both' is specified or there are no parameters, then both Permanent and
  20692. Dynamic settings will be written. Otherwise, only the section specified will
  20693. be written.
  20695. EXAMPLES:
  20696. write -- Writes both Permanent and Dynamic sections of settings.
  20697. write perm -- Writes only the Permanent section of non-vol settings.
  20699. ------------------------------------------------------------------------------
  20701. TABLE: non-vol/snmp_cm
  20703. COMMAND: allow_config
  20705. USAGE: allow_config [true|false]
  20707. DESCRIPTION:
  20708. Enables/disables configuration of various sytem components which are
  20709. not normally configurable in standard operational mode. Also in some
  20710. ways affects system behaviour. This should more properly be called
  20711. 'factory_mode' because in general it is used to support factory mode
  20712. things like US/DS calibration, etc.
  20714. Note that setting this to 'true' will set the Broadcom private MIB
  20715. object cdPrivateMibEnable to engineering(2), which will expose both
  20716. the cableDataPrivateFactory and cableDataPrivateEngineering branches.
  20717. Setting it to 'false' will set cdPrivateMibEnable to disabled(0), which
  20718. will result in both of these branches being hidden.
  20721. EXAMPLES:
  20722. allow_config true -- Enables configuration / factory mode.
  20724. ------------------------------------------------------------------------------
  20726. TABLE: non-vol/snmp_cm
  20728. COMMAND: clear_device
  20730. USAGE: clear_device [both|perm|dyn]
  20732. DESCRIPTION:
  20733. Tells the nonvol device to wipe out the specified settings section. All data
  20734. will be lost; the device should be restored to its 'virgin' state. For flash
  20735. devices, the flash block is erased; for disk devices, the file is erased.
  20737. EXAMPLES:
  20738. clear_device -- Clears both Permanent and Dynamic sections.
  20739. clear_device perm -- Clears only the Permanent section.
  20741. ------------------------------------------------------------------------------
  20743. TABLE: non-vol/snmp_cm
  20745. COMMAND: defaults
  20747. USAGE: defaults [both|perm|dyn]
  20749. DESCRIPTION:
  20750. Restores the settings to default values. NOTE: This does not write to
  20751. NonVol memory! You must do this manually. Also note that some settings do
  20752. not have good defaults, particularly the Permanent section! Use this command
  20753. with extreme care!
  20755. EXAMPLES:
  20756. defaults -- Sets both Permanent and Dynamic sections to defaults.
  20757. defaults perm -- Sets only the Permanent section to defaults.
  20759. ------------------------------------------------------------------------------
  20761. TABLE: non-vol/snmp_cm
  20763. COMMAND: del_extra_data
  20765. USAGE: del_extra_data [both|perm|dyn]
  20767. DESCRIPTION:
  20768. Gets rid of any extra data that is assiociated with the settings. The extra
  20769. data is usually caused by a downgrade, where settings written by a newer
  20770. version are not understood by the older version, but are stored so that they
  20771. will still exist when the new code is run. However, in some cases, it is
  20772. desirable to get rid of them if they are not going to be used.
  20774. EXAMPLES:
  20775. del_extra_data perm -- Gets rid of extra permanent data.
  20777. ------------------------------------------------------------------------------
  20779. TABLE: non-vol/snmp_cm
  20781. COMMAND: dload_tries
  20783. USAGE: dload_tries [numTries]
  20785. DESCRIPTION:
  20786. Sets the number of download attempts that have been made. Normally this is
  20787. set by software when a dload is starting.
  20789. EXAMPLES:
  20790. dload_tries 0 -- Sets the number of dload tries to 0.
  20792. ------------------------------------------------------------------------------
  20794. TABLE: non-vol/snmp_cm
  20796. COMMAND: docsDevSerialNumber
  20798. USAGE: docsDevSerialNumber [String{127}]
  20800. DESCRIPTION:
  20801. Sets the docsDevSerialNumber string that will be reported via SNMP.
  20803. EXAMPLES:
  20804. docsDevSerialNumber 12345ZYX --
  20806. ------------------------------------------------------------------------------
  20808. TABLE: non-vol/snmp_cm
  20810. COMMAND: docsDevSwAdminStatus
  20812. USAGE: docsDevSwAdminStatus [Number{1..3}]
  20814. DESCRIPTION:
  20815. Sets the docsDevSwAdminStatus value that will be reported via SNMP. Valid
  20816. values are:
  20818. 1 -- upgradeFromMgt
  20819. 2 -- allowProvisioningUpgrade
  20820. 3 -- ignoreProvisioningUpgrade
  20822. EXAMPLES:
  20823. docsDevSwAdminStatus 2 --
  20825. ------------------------------------------------------------------------------
  20827. TABLE: non-vol/snmp_cm
  20829. COMMAND: docsDevSwFilename
  20831. USAGE: docsDevSwFilename [String{127}]
  20833. DESCRIPTION:
  20834. Sets the docsDevSwFilename string that will be reported via SNMP.
  20836. EXAMPLES:
  20837. docsDevSwFilename myfile.bin --
  20839. ------------------------------------------------------------------------------
  20841. TABLE: non-vol/snmp_cm
  20843. COMMAND: docsDevSwOperStatus
  20845. USAGE: docsDevSwOperStatus [Number{1..5}]
  20847. DESCRIPTION:
  20848. Sets the docsDevSwOperStatus value that will be reported via SNMP. Valid
  20849. values are:
  20851. 1 -- inProgress
  20852. 2 -- completeFromProvisioning
  20853. 3 -- completeFromMgt
  20854. 4 -- failed
  20855. 5 -- other
  20857. EXAMPLES:
  20858. docsDevSwOperStatus 5 --
  20860. ------------------------------------------------------------------------------
  20862. TABLE: non-vol/snmp_cm
  20864. COMMAND: docsDevSwServer
  20866. USAGE: docsDevSwServer [IpAddress]
  20868. DESCRIPTION:
  20869. Sets the docsDevSwServer IP address that will be reported via SNMP.
  20871. EXAMPLES:
  20872. docsDevSwServer 11.24.4.3 --
  20874. ------------------------------------------------------------------------------
  20876. TABLE: non-vol/snmp_cm
  20878. COMMAND: flush {disabled}
  20880. USAGE: flush
  20882. DESCRIPTION:
  20883. For Composite NonVol Settings objects (which contain 1 or more groups of
  20884. NonVol Settings), this command flushes out any unrecognized groups that were
  20885. read from the device. This is useful in cases where the settings group isn't
  20886. needed by another application, and would just waste space.
  20888. EXAMPLES:
  20889. flush --
  20891. ------------------------------------------------------------------------------
  20893. TABLE: non-vol/snmp_cm
  20895. COMMAND: manufactured
  20897. USAGE: manufactured [both|perm|dyn]
  20899. DESCRIPTION:
  20900. Checks to see if the specified section is manufactured.
  20902. EXAMPLES:
  20903. manufactured -- Checks both Permanent and Dynamic sections
  20904. manufacturing state.
  20905. manufactured perm -- Checks only the Permanent section manufacturing state.
  20907. ------------------------------------------------------------------------------
  20909. TABLE: non-vol/snmp_cm
  20911. Sending Ssdp hanp:rootdevice reply!
  20912. COMMAND: max_dload_tries
  20914. USAGE: max_dload_tries [numTries]
  20916. DESCRIPTION:
  20917. Sets the max number of download attempts that will made before giving up.
  20918. The spec says '3 retries', but some people (and the ATP) interprit this to
  20919. mean 3 tries. We now allow this parameter to be configured.
  20921. EXAMPLES:
  20922. max_dload_tries 4 -- Sets the max number of dload tries to 4.
  20924. ------------------------------------------------------------------------------
  20926. TABLE: non-vol/snmp_cm
  20928. COMMAND: read
  20930. USAGE: read [both|perm|dyn]
  20932. DESCRIPTION:
  20933. Reads the specified section of non-volatile settings from non-volatile
  20934. memory. If 'both' is specified or there are no parameters, then both
  20935. Permanent and Dynamic settings will be read. Otherwise, only the section
  20936. specified will be read. This will destroy any changes you have made if you
  20937. haven't written them!
  20939. EXAMPLES:
  20940. read -- Reads both Permanent and Dynamic sections of settings.
  20941. read perm -- Reads only the Permanent section of non-vol settings.
  20943. ------------------------------------------------------------------------------
  20945. TABLE: non-vol/snmp_cm
  20947. COMMAND: show
  20949. USAGE: show
  20951. DESCRIPTION:
  20952. Displays the current non-volatile settings values for both the Permanent and
  20953. Dynamic sections.
  20955. EXAMPLES:
  20956. show --
  20958. ------------------------------------------------------------------------------
  20960. TABLE: non-vol/snmp_cm
  20962. COMMAND: stats
  20964. USAGE: stats
  20966. DESCRIPTION:
  20967. Prints stats about buffer usage for Dynamic and Permanent settings.
  20969. EXAMPLES:
  20970. stats --
  20972. ------------------------------------------------------------------------------
  20974. TABLE: non-vol/snmp_cm
  20976. COMMAND: sysContact
  20978. USAGE: sysContact [String{127}]
  20980. DESCRIPTION:
  20981. Sets the sysContact string that will be reported via SNMP.
  20983. EXAMPLES:
  20984. sysContact me myself and I --
  20986. ------------------------------------------------------------------------------
  20988. TABLE: non-vol/snmp_cm
  20990. COMMAND: sysLocation
  20992. USAGE: sysLocation [String{127}]
  20994. DESCRIPTION:
  20995. Sets the sysLocation string that will be reported via SNMP.
  20997. EXAMPLES:
  20998. sysLocation wherever you are --
  21000. ------------------------------------------------------------------------------
  21002. TABLE: non-vol/snmp_cm
  21004. COMMAND: sysName
  21006. USAGE: sysName [String{127}]
  21008. DESCRIPTION:
  21009. Sets the sysName string that will be reported via SNMP.
  21011. EXAMPLES:
  21012. sysName whoever you are --
  21014. ------------------------------------------------------------------------------
  21016. TABLE: non-vol/snmp_cm
  21018. COMMAND: tftp_read
  21020. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  21022. DESCRIPTION:
  21023. Causes the Permanent or Dynamic settings data to be read from a server via
  21024. TFTP. The file must be generated correctly, with all of the headers, CRC,
  21025. and other information that would exist on the NonVol device. The file will
  21026. be read and evaluated for correctness before it is stored in the device. If
  21027. the file is rejected then the settings will be read from the device to undo
  21028. any changes. Normally, this will operate on all settings groups; if you
  21029. specify -g then it will operate only on the current group (e.g. if you are in
  21030. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  21031. read).
  21033. EXAMPLES:
  21034. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  21035. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  21037. ------------------------------------------------------------------------------
  21039. TABLE: non-vol/snmp_cm
  21041. COMMAND: tftp_write
  21043. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  21045. DESCRIPTION:
  21046. Causes the Permanent or Dynamic settings data to be written to a server via
  21047. TFTP. Normally, this will operate on all settings groups; if you specify -g
  21048. then it will operate only on the current group (e.g. if you are in the SNMP
  21049. nonvol dir, then -g will cause only the SNMP settings group to be written).
  21051. EXAMPLES:
  21052. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  21053. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  21055. ------------------------------------------------------------------------------
  21057. TABLE: non-vol/snmp_cm
  21059. COMMAND: write
  21061. USAGE: write [both|perm|dyn]
  21063. DESCRIPTION:
  21064. Writes the specified section of non-volatile settings to non-volatile memory.
  21065. If 'both' is specified or there are no parameters, then both Permanent and
  21066. Dynamic settings will be written. Otherwise, only the section specified will
  21067. be written.
  21069. EXAMPLES:
  21070. write -- Writes both Permanent and Dynamic sections of settings.
  21071. write perm -- Writes only the Permanent section of non-vol settings.
  21073. ------------------------------------------------------------------------------
  21075. TABLE: non-vol/us-cal
  21077. COMMAND: board_rev
  21079. USAGE: board_rev [rev{0..18}]
  21081. DESCRIPTION:
  21082. Sets the board revision that the tables have been calibrated for; it helps
  21083. the app warn the user about incorrect configurations (loading a table that
  21084. has been calibrated for a different modem). These values are the same as
  21085. those found in the HAL non-vol settings:
  21087. 0 -- Generic Unknown/Don't Care
  21088. 1 -- BCM93350A V2 US
  21089. 2 -- BCM93350A V3 US
  21090. 3 -- BCM93350C V0 US
  21091. 4 -- BCM93350i V1a US
  21092. 5 -- BCM93350i V1b US
  21093. 6 -- BCM93350V V1 US
  21094. 7 -- BCM93352V V0 US
  21095. 8 -- BCM93350A V2 EURO
  21096. 9 -- BCM93350A V3 EURO
  21097. 10 -- BCM93350C V0 EURO
  21098. 11 -- BCM93350i V1a EURO
  21099. 12 -- BCM93350i V1b EURO
  21100. 13 -- BCM93350V V1 EURO
  21101. 14 -- BCM93352V V0 EURO
  21102. 15 -- BCM93350C V2 US
  21103. 16 -- BCM93350C V2 EURO
  21104. 17 -- BCM93345I
  21105. 18 -- BCM93345A
  21107. EXAMPLES:
  21108. board_rev 2 --
  21110. ------------------------------------------------------------------------------
  21112. TABLE: non-vol/us-cal
  21114. COMMAND: clear_device
  21116. USAGE: clear_device [both|perm|dyn]
  21118. DESCRIPTION:
  21119. Tells the nonvol device to wipe out the specified settings section. All data
  21120. will be lost; the device should be restored to its 'virgin' state. For flash
  21121. devices, the flash block is erased; for disk devices, the file is erased.
  21123. EXAMPLES:
  21124. clear_device -- Clears both Permanent and Dynamic sections.
  21125. clear_device perm -- Clears only the Permanent section.
  21127. ------------------------------------------------------------------------------
  21129. TABLE: non-vol/us-cal
  21131. COMMAND: clear_table
  21133. USAGE: clear_table control|offset
  21135. DESCRIPTION:
  21136. Causes the Control Table or Offset Table to be filled with zeros. NOTE:
  21137. This is NOT recommended unless the modem is already not functioning
  21138. correctly!
  21140. EXAMPLES:
  21141. clear_table offset -- Clears the Offset Table.
  21143. ------------------------------------------------------------------------------
  21145. TABLE: non-vol/us-cal
  21147. COMMAND: cm_amp
  21149. USAGE: cm_amp [rev{1..9}]
  21151. DESCRIPTION:
  21152. Sets the upstream amp that the tables have been calibrated for; it helps the
  21153. app warn the user about incorrect configurations. These values are the same
  21154. as those found in the HAL non-vol settings:
  21156. 1 -- LUCENT ATTV4910
  21157. 2 -- LUCENT ATTV4911
  21158. 3 -- CEL ISG2000 AMP
  21159. 4 -- ANADIGICS ARA5050
  21160. 5 -- ADI 8321
  21161. 6 -- MAXIM 3510
  21162. 7 -- CEL ISG3300 AMP
  21163. 8 -- ADI 8322
  21164. 9 -- BROADCOM INTERNAL AMP
  21166. EXAMPLES:
  21167. cm_amp 2 --
  21169. ------------------------------------------------------------------------------
  21171. TABLE: non-vol/us-cal
  21173. COMMAND: config
  21175. USAGE: config control|offset [start{0..255}] [end{0..255}] [res{0..255}]
  21177. DESCRIPTION:
  21178. Configures the specified table, setting the start/end points, and the
  21179. resolution. For the Control Table, the start/end points are in dBmV units,
  21180. and the resolution is in 0.01 dBmV units. For the Offset Table, start/end is
  21181. in MHz units, and the resolution is in 0.01 MHz units. This causes data in
  21182. the table to be 'interpolated' to fit the new table size, and takes effect
  21183. immediately (don't need to reboot).
  21185. EXAMPLES:
  21186. config control 3 64 25 -- Control Table, 3-63 dBmV, 0.25 dBmV steps.
  21187. config offset 0 65 100 -- Offset Table, 0-65 MHz, 1.0 MHz steps.
  21189. ------------------------------------------------------------------------------
  21191. TABLE: non-vol/us-cal
  21193. COMMAND: control
  21195. USAGE: control power{0..65535} [gain{0..255}] [dac{0..255}]
  21197. DESCRIPTION:
  21198. For the specified power level (in 0.01 dBmV units), this sets the (Amp Gain,
  21199. DAC Control) values in the Control Table. The power must be an integral of
  21200. the table resolution. The change takes effect immediately (don't need to
  21201. reboot).
  21203. EXAMPLES:
  21204. control 325 0x87 0x16 -- Power 3.25 dBmV, (0x87 0x16).
  21206. ------------------------------------------------------------------------------
  21208. TABLE: non-vol/us-cal
  21210. Sending Ssdp hanp:rootdevice reply!
  21211. COMMAND: copy
  21213. USAGE: copy [fromInstance{0..4}]
  21215. DESCRIPTION:
  21216. Copies the settings from the fromSource instance to this instance.
  21218. EXAMPLES:
  21219. copy (1) 0 -- Copies the settings from instance 0 to instance 1.
  21221. ------------------------------------------------------------------------------
  21223. TABLE: non-vol/us-cal
  21225. COMMAND: def_table
  21227. USAGE: def_table control|offset
  21229. DESCRIPTION:
  21230. Causes the Control Table or Offset Table to be set to default size and values
  21231. for the Amp and Board Rev that are currently selected. This is different
  21232. from resetting the whole section to default, which also modifies the Amp and
  21233. Board Rev settings.
  21235. EXAMPLES:
  21236. def_table offset -- Sets the Offset Table to default size and values.
  21238. ------------------------------------------------------------------------------
  21240. TABLE: non-vol/us-cal
  21242. COMMAND: defaults
  21244. USAGE: defaults [both|perm|dyn]
  21246. DESCRIPTION:
  21247. Restores the settings to default values. NOTE: This does not write to
  21248. NonVol memory! You must do this manually. Also note that some settings do
  21249. not have good defaults, particularly the Permanent section! Use this command
  21250. with extreme care!
  21252. EXAMPLES:
  21253. defaults -- Sets both Permanent and Dynamic sections to defaults.
  21254. defaults perm -- Sets only the Permanent section to defaults.
  21256. ------------------------------------------------------------------------------
  21258. TABLE: non-vol/us-cal
  21260. COMMAND: del_extra_data
  21262. USAGE: del_extra_data [both|perm|dyn]
  21264. DESCRIPTION:
  21265. Gets rid of any extra data that is assiociated with the settings. The extra
  21266. data is usually caused by a downgrade, where settings written by a newer
  21267. version are not understood by the older version, but are stored so that they
  21268. will still exist when the new code is run. However, in some cases, it is
  21269. desirable to get rid of them if they are not going to be used.
  21271. EXAMPLES:
  21272. del_extra_data perm -- Gets rid of extra permanent data.
  21274. ------------------------------------------------------------------------------
  21276. TABLE: non-vol/us-cal
  21278. COMMAND: flush {disabled}
  21280. USAGE: flush
  21282. DESCRIPTION:
  21283. For Composite NonVol Settings objects (which contain 1 or more groups of
  21284. NonVol Settings), this command flushes out any unrecognized groups that were
  21285. read from the device. This is useful in cases where the settings group isn't
  21286. needed by another application, and would just waste space.
  21288. EXAMPLES:
  21289. flush --
  21291. ------------------------------------------------------------------------------
  21293. TABLE: non-vol/us-cal
  21295. COMMAND: manufactured
  21297. USAGE: manufactured [both|perm|dyn]
  21299. DESCRIPTION:
  21300. Checks to see if the specified section is manufactured.
  21302. EXAMPLES:
  21303. manufactured -- Checks both Permanent and Dynamic sections
  21304. manufacturing state.
  21305. manufactured perm -- Checks only the Permanent section manufacturing state.
  21307. ------------------------------------------------------------------------------
  21309. TABLE: non-vol/us-cal
  21311. COMMAND: offset
  21313. USAGE: offset freq [power{-32768..32767}]
  21315. DESCRIPTION:
  21316. For the specified frequency (in 0.01 MHz units), this sets the offset that
  21317. will be used when indexing into the Control Table. The freq must be an
  21318. integral of the table resolution. The power is a signed offset in 0.01 dBmV
  21319. units. The change takes effect immediately (don't need to reboot).
  21321. EXAMPLES:
  21322. offset 100 -150 -- Freq 1.0 MHz, offset -1.5 dBmV.
  21324. ------------------------------------------------------------------------------
  21326. TABLE: non-vol/us-cal
  21328. COMMAND: print
  21330. USAGE: print control|offset
  21332. DESCRIPTION:
  21333. Causes the Control Table or Offset Table to be printed out.
  21335. EXAMPLES:
  21336. print control -- Prints the Control Table.
  21338. ------------------------------------------------------------------------------
  21340. TABLE: non-vol/us-cal
  21342. COMMAND: read
  21344. USAGE: read [both|perm|dyn]
  21346. DESCRIPTION:
  21347. Reads the specified section of non-volatile settings from non-volatile
  21348. memory. If 'both' is specified or there are no parameters, then both
  21349. Permanent and Dynamic settings will be read. Otherwise, only the section
  21350. specified will be read. This will destroy any changes you have made if you
  21351. haven't written them!
  21353. EXAMPLES:
  21354. read -- Reads both Permanent and Dynamic sections of settings.
  21355. read perm -- Reads only the Permanent section of non-vol settings.
  21357. ------------------------------------------------------------------------------
  21359. TABLE: non-vol/us-cal
  21361. COMMAND: show
  21363. USAGE: show
  21365. DESCRIPTION:
  21366. Displays the current non-volatile settings values for both the Permanent and
  21367. Dynamic sections.
  21369. EXAMPLES:
  21370. show --
  21372. ------------------------------------------------------------------------------
  21374. TABLE: non-vol/us-cal
  21376. COMMAND: stats
  21378. USAGE: stats
  21380. DESCRIPTION:
  21381. Prints stats about buffer usage for Dynamic and Permanent settings.
  21383. EXAMPLES:
  21384. stats --
  21386. ------------------------------------------------------------------------------
  21388. TABLE: non-vol/us-cal
  21390. COMMAND: tftp_read
  21392. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  21394. DESCRIPTION:
  21395. Causes the Permanent or Dynamic settings data to be read from a server via
  21396. TFTP. The file must be generated correctly, with all of the headers, CRC,
  21397. and other information that would exist on the NonVol device. The file will
  21398. be read and evaluated for correctness before it is stored in the device. If
  21399. the file is rejected then the settings will be read from the device to undo
  21400. any changes. Normally, this will operate on all settings groups; if you
  21401. specify -g then it will operate only on the current group (e.g. if you are in
  21402. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  21403. read).
  21405. EXAMPLES:
  21406. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  21407. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  21409. ------------------------------------------------------------------------------
  21411. TABLE: non-vol/us-cal
  21413. COMMAND: tftp_write
  21415. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  21417. DESCRIPTION:
  21418. Causes the Permanent or Dynamic settings data to be written to a server via
  21419. TFTP. Normally, this will operate on all settings groups; if you specify -g
  21420. then it will operate only on the current group (e.g. if you are in the SNMP
  21421. nonvol dir, then -g will cause only the SNMP settings group to be written).
  21423. EXAMPLES:
  21424. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  21425. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  21427. ------------------------------------------------------------------------------
  21429. TABLE: non-vol/us-cal
  21431. COMMAND: write
  21433. USAGE: write [both|perm|dyn]
  21435. DESCRIPTION:
  21436. Writes the specified section of non-volatile settings to non-volatile memory.
  21437. If 'both' is specified or there are no parameters, then both Permanent and
  21438. Dynamic settings will be written. Otherwise, only the section specified will
  21439. be written.
  21441. EXAMPLES:
  21442. write -- Writes both Permanent and Dynamic sections of settings.
  21443. write perm -- Writes only the Permanent section of non-vol settings.
  21445. ------------------------------------------------------------------------------
  21447. TABLE: non-vol/userif
  21449. COMMAND: clear_device
  21451. USAGE: clear_device [both|perm|dyn]
  21453. DESCRIPTION:
  21454. Tells the nonvol device to wipe out the specified settings section. All data
  21455. will be lost; the device should be restored to its 'virgin' state. For flash
  21456. devices, the flash block is erased; for disk devices, the file is erased.
  21458. EXAMPLES:
  21459. clear_device -- Clears both Permanent and Dynamic sections.
  21460. clear_device perm -- Clears only the Permanent section.
  21462. ------------------------------------------------------------------------------
  21464. TABLE: non-vol/userif
  21466. COMMAND: defaults
  21468. USAGE: defaults [both|perm|dyn]
  21470. DESCRIPTION:
  21471. Restores the settings to default values. NOTE: This does not write to
  21472. NonVol memory! You must do this manually. Also note that some settings do
  21473. not have good defaults, particularly the Permanent section! Use this command
  21474. with extreme care!
  21476. EXAMPLES:
  21477. defaults -- Sets both Permanent and Dynamic sections to defaults.
  21478. defaults perm -- Sets only the Permanent section to defaults.
  21480. ------------------------------------------------------------------------------
  21482. TABLE: non-vol/userif
  21484. COMMAND: del_extra_data
  21486. USAGE: del_extra_data [both|perm|dyn]
  21488. DESCRIPTION:
  21489. Gets rid of any extra data that is assiociated with the settings. The extra
  21490. data is usually caused by a downgrade, where settings written by a newer
  21491. version are not understood by the older version, but are stored so that they
  21492. will still exist when the new code is run. However, in some cases, it is
  21493. desirable to get rid of them if they are not going to be used.
  21495. EXAMPLES:
  21496. del_extra_data perm -- Gets rid of extra permanent data.
  21498. ------------------------------------------------------------------------------
  21500. TABLE: non-vol/userif
  21502. COMMAND: dhcp_settings
  21504. USAGE: dhcp_settings
  21506. DESCRIPTION:
  21507. Prompts you for the IP address, subnet mask, and router IP adress to be used
  21508. by the remote access server. The router must be on the same subnet as the IP
  21509. address for the server, but the router doesn't really have to exist (i.e. you
  21510. can specify an unused IP address, as long as it is on the same subnet).
  21512. EXAMPLES:
  21513. dhcp_settings -- Begins prompting for the new settings.
  21515. ------------------------------------------------------------------------------
  21517. TABLE: non-vol/userif
  21519. COMMAND: fields
  21521. USAGE: fields [Bitmask{0x7f}]
  21523. DESCRIPTION:
  21524. Prints or sets the default message fields that will be displayed. Different
  21525. message fields can then be enabled or disabled at run-time for a particular
  21526. object or for sets of objects. This can be done via the message logging
  21527. command table. Message field bit definitions:
  21529. 0x01 -- The severity of the message (INFO, WARNING, ERROR, etc.)
  21530. 0x02 -- The instance name of the object that generated the message.
  21531. 0x04 -- The function/method in which the message was generated.
  21532. 0x08 -- The name of the module/class in which the message was
  21533. generated.
  21534. 0x10 -- The system timestamp (Time of Day).
  21535. 0x20 -- The thread Id.
  21536. 0x40 -- The system timestamp (millisecond, in hex).
  21538. EXAMPLES:
  21539. fields -- Shows the default message fields.
  21540. fields 0x7f -- Enables all fields.
  21541. fields 0 -- Disables all fields.
  21543. ------------------------------------------------------------------------------
  21545. TABLE: non-vol/userif
  21547. COMMAND: flush {disabled}
  21549. USAGE: flush
  21551. DESCRIPTION:
  21552. For Composite NonVol Settings objects (which contain 1 or more groups of
  21553. NonVol Settings), this command flushes out any unrecognized groups that were
  21554. read from the device. This is useful in cases where the settings group isn't
  21555. needed by another application, and would just waste space.
  21557. EXAMPLES:
  21558. flush --
  21560. ------------------------------------------------------------------------------
  21562. TABLE: non-vol/userif
  21564. COMMAND: http_acl_host_add
  21566. USAGE: http_acl_host_add IpAddress [IpAddress]
  21568. DESCRIPTION:
  21569. Adds a remote host IP or range to the authorized list
  21571. EXAMPLES:
  21572. http_acl_host_add 10.15.3.10 -- Adds IP 10.15.3.10 to the
  21573. authorized hosts list
  21574. http_acl_host_add 10.15.3.10 10.15.3.100 -- Add the range
  21575. 10.15.3.10-10.15.3.100 to the a
  21576. uthorized hosts list
  21578. ------------------------------------------------------------------------------
  21580. TABLE: non-vol/userif
  21582. COMMAND: http_acl_host_remove
  21584. USAGE: http_acl_host_remove IpAddress [IpAddress]
  21586. DESCRIPTION:
  21587. Removes a remote host IP or range from the authorized list
  21589. EXAMPLES:
  21590. http_acl_host_remove 10.15.3.10 -- Removes IP 10.15.3.10 from
  21591. the authorized hosts list
  21592. http_acl_host_remove 10.15.3.10 10.15.3.100 -- Removes the range
  21593. 10.15.3.10-10.15.3.100 from t
  21594. he authorized hosts list
  21596. ------------------------------------------------------------------------------
  21598. TABLE: non-vol/userif
  21600. COMMAND: http_acl_hosts_clear
  21602. USAGE: http_acl_hosts_clear
  21604. DESCRIPTION:
  21605. Clear the remote hosts list
  21607. EXAMPLES:
  21608. http_acl_hosts_clear -- Clears the remote hosts list
  21610. ------------------------------------------------------------------------------
  21612. TABLE: non-vol/userif
  21614. COMMAND: http_admin
  21616. USAGE: http_admin [ID{31}] [password{31}]
  21618. DESCRIPTION:
  21619. Sets or displays the HTTP admin ID and password.
  21621. EXAMPLES:
  21622. http_admin foo bar -- Sets the HTTP admin ID to 'foo' and password to 'bar'.
  21623. http_admin "" "" -- Sets the HTTP admin ID and password to empty strings.
  21625. ------------------------------------------------------------------------------
  21627. TABLE: non-vol/userif
  21629. COMMAND: http_adv_ipstacks
  21631. USAGE: http_adv_ipstacks [Bitmask{0xff}]
  21633. DESCRIPTION:
  21634. Sets the bitmask of IP stacks that the HTTP server will allow advanced
  21635. access. Of course, the specified IP stacks must be enabled if you want to be
  21636. able to HTTP in. Once the IP stack has an address (either static or DHCP),
  21637. we create a listen socket and bind it to that address.
  21639. EXAMPLES:
  21640. http_adv_ipstacks 0x2 -- Allow advanced access only on IP stack2
  21641. http_adv_ipstacks 0x3 -- Allow advanced access on IP stack1 and stack2
  21643. ------------------------------------------------------------------------------
  21645. TABLE: non-vol/userif
  21647. COMMAND: http_enable
  21649. USAGE: http_enable [true|false]
  21651. DESCRIPTION:
  21652. Enables/disables remote access to the console via HTTP. The HTTP server runs
  21653. on the IP stack with the IP address specified in other settings. In order
  21654. for a user to gain access, he/she must enter the user name and password
  21655. configured.
  21657. EXAMPLES:
  21658. http_enable -- Shows the HTTP enable state.
  21659. http_enable true -- Enables HTTP access.
  21661. ------------------------------------------------------------------------------
  21663. TABLE: non-vol/userif
  21665. COMMAND: http_ipstacks
  21667. USAGE: http_ipstacks [Bitmask{0xff}]
  21669. DESCRIPTION:
  21670. Sets the bitmask of IP stacks that the HTTP server will listen for
  21671. connections. Of course, the specified IP stacks must be enabled if you want
  21672. to be able to HTTP in. Once the IP stack has an address (either static or
  21673. DHCP), we create a listen socket and bind it to that address.
  21675. EXAMPLES:
  21676. http_ipstacks 0x2 -- Allow connections only on IP stack2
  21677. http_ipstacks 0x3 -- Allow connections only on IP stack1 and stack2
  21679. ------------------------------------------------------------------------------
  21681. TABLE: non-vol/userif
  21683. COMMAND: http_password_idle_timeout
  21685. USAGE: http_password_idle_timeout [seconds{0..86400}]
  21687. DESCRIPTION:
  21688. Sets the number of seconds after which a connected HTTP session will be
  21689. disconnected if there is no activity. Setting to 0 (the default) results in
  21690. the session never being disconnected.
  21692. EXAMPLES:
  21693. http_password_idle_timeout 900 -- Sets the inactivity timeout to 15 minutes.
  21694. http_password_idle_timeout 0 -- Sets the inactivity timeout to no timeout.
  21696. ------------------------------------------------------------------------------
  21698. TABLE: non-vol/userif
  21700. COMMAND: http_password_seed
  21702. USAGE: http_password_seed [Seed{40}]
  21704. DESCRIPTION:
  21705. Sets or displays the HTTP password seed.
  21707. EXAMPLES:
  21708. http_password_seed foobar -- Sets the HTTP password seed to 'foobar'.
  21709. http_password_seed "" "" -- Sets the HTTP password seed to empty string.
  21711. ------------------------------------------------------------------------------
  21713. TABLE: non-vol/userif
  21715. COMMAND: http_socket_show
  21717. USAGE: http_socket_show
  21719. DESCRIPTION:
  21720. Print HTTP listen sockets to the console.
  21722. EXAMPLES:
  21723. http_socket_show --
  21725. ------------------------------------------------------------------------------
  21727. TABLE: non-vol/userif
  21729. COMMAND: http_user
  21731. USAGE: http_user [ID{31}] [password{31}]
  21733. DESCRIPTION:
  21734. Sets or displays the HTTP user ID and password.
  21736. EXAMPLES:
  21737. http_user foo bar -- Sets the HTTP user ID to 'foo' and password to 'bar'.
  21738. http_user "" "" -- Sets the HTTP user ID and password to empty strings.
  21740. ------------------------------------------------------------------------------
  21742. TABLE: non-vol/userif
  21744. COMMAND: inactivity_timeout
  21746. USAGE: inactivity_timeout [seconds{0..86400}]
  21748. DESCRIPTION:
  21749. Sets the number of seconds after which a connected telnet or SSH session will
  21750. be disconnected if there is no activity. Setting to 0 (the default) results
  21751. in the session never being disconnected.
  21753. EXAMPLES:
  21754. inactivity_timeout 900 -- Sets the inactivity timeout to 15 minutes.
  21755. inactivity_timeout 0 -- Sets the inactivity timeout to no timeout.
  21757. ------------------------------------------------------------------------------
  21759. TABLE: non-vol/userif
  21761. COMMAND: ip_stack_number
  21763. USAGE: ip_stack_number [Number{0..255}]
  21765. DESCRIPTION:
  21766. Allows you to show/change the IP stack number that the remote access server
  21767. will use. The system may have more than 1 IP stack, so we need to be told
  21768. which one to use. NOTE: This IP stack must NOT be used by any other
  21769. application, because the server will force the IP address to the values
  21770. entered in the DHCP settings!
  21772. EXAMPLES:
  21773. ip_stack_number -- Shows the IP stack number.
  21774. ip_stack_number 3 -- Configures the server to use IP stack 3.
  21776. ------------------------------------------------------------------------------
  21778. TABLE: non-vol/userif
  21780. COMMAND: manufactured
  21782. USAGE: manufactured [both|perm|dyn]
  21784. DESCRIPTION:
  21785. Checks to see if the specified section is manufactured.
  21787. EXAMPLES:
  21788. manufactured -- Checks both Permanent and Dynamic sections
  21789. manufacturing state.
  21790. manufactured perm -- Checks only the Permanent section manufacturing state.
  21792. ------------------------------------------------------------------------------
  21794. TABLE: non-vol/userif
  21796. COMMAND: password
  21798. USAGE: password [Password{15}]
  21800. DESCRIPTION:
  21801. Allows you to show/change the password that must be used when accessing the
  21802. console via remote access. If the password is empty, then none is required.
  21803. The password is case sensitive.
  21805. EXAMPLES:
  21806. password -- Shows the current password.
  21807. password CableModem -- Sets the password.
  21809. ------------------------------------------------------------------------------
  21811. TABLE: non-vol/userif
  21813. COMMAND: read
  21815. USAGE: read [both|perm|dyn]
  21817. DESCRIPTION:
  21818. Reads the specified section of non-volatile settings from non-volatile
  21819. memory. If 'both' is specified or there are no parameters, then both
  21820. Permanent and Dynamic settings will be read. Otherwise, only the section
  21821. specified will be read. This will destroy any changes you have made if you
  21822. haven't written them!
  21824. EXAMPLES:
  21825. read -- Reads both Permanent and Dynamic sections of settings.
  21826. read perm -- Reads only the Permanent section of non-vol settings.
  21828. ------------------------------------------------------------------------------
  21830. TABLE: non-vol/userif
  21832. COMMAND: severities
  21834. USAGE: severities [Bitmask]
  21836. DESCRIPTION:
  21837. Prints or sets the default message logging levels that are to be applied at
  21838. system startup. Different logging levels can then be enabled or disabled at
  21839. run-time for a particular object or for sets of objects. This can be done
  21840. via the message logging command table. Message logging bit definitions:
  21842. 0x00000001 -- Fatal Errors
  21843. 0x00000002 -- Errors
  21844. 0x00000004 -- Warnings
  21845. 0x00000008 -- Initialization
  21846. 0x00000010 -- Function entry/exit
  21847. 0x00000020 -- Informational
  21848. 0xffffffc0 -- Application-specific
  21849. 0xffffffff -- All messages
  21851. EXAMPLES:
  21852. severities -- Shows the default logging levels.
  21853. severities 0x7 -- Enables Fatal Errors, Errors, and Warnings.
  21854. severities 0 -- Disables all levels.
  21856. ------------------------------------------------------------------------------
  21858. TABLE: non-vol/userif
  21860. COMMAND: show
  21862. USAGE: show
  21864. DESCRIPTION:
  21865. Displays the current non-volatile settings values for both the Permanent and
  21866. Dynamic sections.
  21868. EXAMPLES:
  21869. show --
  21871. ------------------------------------------------------------------------------
  21873. TABLE: non-vol/userif
  21875. COMMAND: ssh_enable
  21877. USAGE: ssh_enable [true|false]
  21879. DESCRIPTION:
  21880. Enables/disables remote access to the console via SSH at startup.
  21882. EXAMPLES:
  21883. ssh_enable -- Shows the ssh enable state.
  21884. ssh_enable true -- Enables telnet access at startup.
  21886. ------------------------------------------------------------------------------
  21888. TABLE: non-vol/userif
  21890. COMMAND: ssh_ipstacks
  21892. USAGE: ssh_ipstacks [Bitmask{0xff}]
  21894. DESCRIPTION:
  21895. Sets the bitmask of IP stacks that the SSH server will listen for
  21896. connections. Of course, the specified IP stacks must be enabled if you want
  21897. to be able to SSH in. Once the IP stack has an address (either static or
  21898. DHCP), we create a listen socket and bind it to that address.
  21900. EXAMPLES:
  21901. ssh_ipstacks 0x2 -- Allow connections only on IP stack2
  21902. ssh_ipstacks 0x3 -- Allow connections only on IP stack1 and stack2
  21904. ------------------------------------------------------------------------------
  21906. TABLE: non-vol/userif
  21908. COMMAND: stats
  21910. USAGE: stats
  21912. DESCRIPTION:
  21913. Prints stats about buffer usage for Dynamic and Permanent settings.
  21915. EXAMPLES:
  21916. stats --
  21918. ------------------------------------------------------------------------------
  21920. TABLE: non-vol/userif
  21922. COMMAND: telnet_enable
  21924. USAGE: telnet_enable [true|false]
  21926. DESCRIPTION:
  21927. Enables/disables remote access to the console via Telnet at startup. Note
  21928. that the Telnet server can be started after the system is running regardless
  21929. of the state of this setting. The Telnet server runs on the IP stack(s)
  21930. specified in other settings. In order for a user to gain access, he/she must
  21931. enter the user name and password configured.
  21933. EXAMPLES:
  21934. telnet_enable -- Shows the telnet enable state.
  21935. telnet_enable true -- Enables telnet access at startup.
  21937. ------------------------------------------------------------------------------
  21939. TABLE: non-vol/userif
  21941. COMMAND: telnet_ipstacks
  21943. USAGE: telnet_ipstacks [Bitmask{0xff}]
  21945. DESCRIPTION:
  21946. Sets the bitmask of IP stacks that the telnet server will listen for
  21947. connections. Of course, the specified IP stacks must be enabled if you want
  21948. to be able to telnet in. Once the IP stack has an address (either static or
  21949. DHCP), we create a listen socket and bind it to that address.
  21951. EXAMPLES:
  21952. telnet_ipstacks 0x2 -- Allow connections only on IP stack2
  21953. telnet_ipstacks 0x3 -- Allow connections only on IP stack1 and stack2
  21955. ------------------------------------------------------------------------------
  21957. TABLE: non-vol/userif
  21959. COMMAND: tftp_read
  21961. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  21963. DESCRIPTION:
  21964. Causes the Permanent or Dynamic settings data to be read from a server via
  21965. TFTP. The file must be generated correctly, with all of the headers, CRC,
  21966. and other information that would exist on the NonVol device. The file will
  21967. be read and evaluated for correctness before it is stored in the device. If
  21968. the file is rejected then the settings will be read from the device to undo
  21969. any changes. Normally, this will operate on all settings groups; if you
  21970. specify -g then it will operate only on the current group (e.g. if you are in
  21971. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  21972. read).
  21974. EXAMPLES:
  21975. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  21976. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  21978. ------------------------------------------------------------------------------
  21980. TABLE: non-vol/userif
  21982. COMMAND: tftp_write
  21984. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  21986. DESCRIPTION:
  21987. Causes the Permanent or Dynamic settings data to be written to a server via
  21988. TFTP. Normally, this will operate on all settings groups; if you specify -g
  21989. then it will operate only on the current group (e.g. if you are in the SNMP
  21990. nonvol dir, then -g will cause only the SNMP settings group to be written).
  21992. EXAMPLES:
  21993. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  21994. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  21996. ------------------------------------------------------------------------------
  21998. TABLE: non-vol/userif
  22000. COMMAND: user_name
  22002. USAGE: user_name [Name{15}]
  22004. DESCRIPTION:
  22005. Allows you to show/change the user name that must be used when accessing the
  22006. console via remote access. If the user name is empty, then none is required.
  22007. The user name is case sensitive.
  22009. EXAMPLES:
  22010. user_name -- Shows the current user name.
  22011. user_name CableModem -- Sets the user name.
  22013. ------------------------------------------------------------------------------
  22015. TABLE: non-vol/userif
  22017. COMMAND: write
  22019. USAGE: write [both|perm|dyn]
  22021. DESCRIPTION:
  22022. Writes the specified section of non-volatile settings to non-volatile memory.
  22023. If 'both' is specified or there are no parameters, then both Permanent and
  22024. Dynamic settings will be written. Otherwise, only the section specified will
  22025. be written.
  22027. EXAMPLES:
  22028. write -- Writes both Permanent and Dynamic sections of settings.
  22029. write perm -- Writes only the Permanent section of non-vol settings.
  22031. ------------------------------------------------------------------------------
  22033. TABLE: non-vol/vpn
  22035. COMMAND: add_empty_tunnel
  22037. USAGE: add_empty_tunnel
  22039. DESCRIPTION:
  22040. Add an empty tunnel to the end of the list
  22042. EXAMPLES:
  22043. add_empty_tunnel --
  22045. ------------------------------------------------------------------------------
  22047. TABLE: non-vol/vpn
  22049. COMMAND: change_tunnel
  22051. USAGE: change_tunnel [Number{0..64}]
  22053. DESCRIPTION:
  22054. Change a tunnel settings. You will be prompted for the values.
  22056. EXAMPLES:
  22057. change_tunnel_settings 0 - change the 0th tunnel entry --
  22059. ------------------------------------------------------------------------------
  22061. TABLE: non-vol/vpn
  22063. COMMAND: clear_device
  22065. USAGE: clear_device [both|perm|dyn]
  22067. DESCRIPTION:
  22068. Tells the nonvol device to wipe out the specified settings section. All data
  22069. will be lost; the device should be restored to its 'virgin' state. For flash
  22070. devices, the flash block is erased; for disk devices, the file is erased.
  22072. EXAMPLES:
  22073. clear_device -- Clears both Permanent and Dynamic sections.
  22074. clear_device perm -- Clears only the Permanent section.
  22076. ------------------------------------------------------------------------------
  22078. TABLE: non-vol/vpn
  22080. COMMAND: defaults
  22082. USAGE: defaults [both|perm|dyn]
  22084. DESCRIPTION:
  22085. Restores the settings to default values. NOTE: This does not write to
  22086. NonVol memory! You must do this manually. Also note that some settings do
  22087. not have good defaults, particularly the Permanent section! Use this command
  22088. with extreme care!
  22090. EXAMPLES:
  22091. defaults -- Sets both Permanent and Dynamic sections to defaults.
  22092. defaults perm -- Sets only the Permanent section to defaults.
  22094. ------------------------------------------------------------------------------
  22096. TABLE: non-vol/vpn
  22098. COMMAND: del_extra_data
  22100. USAGE: del_extra_data [both|perm|dyn]
  22102. DESCRIPTION:
  22103. Gets rid of any extra data that is assiociated with the settings. The extra
  22104. data is usually caused by a downgrade, where settings written by a newer
  22105. version are not understood by the older version, but are stored so that they
  22106. will still exist when the new code is run. However, in some cases, it is
  22107. desirable to get rid of them if they are not going to be used.
  22109. EXAMPLES:
  22110. del_extra_data perm -- Gets rid of extra permanent data.
  22112. ------------------------------------------------------------------------------
  22114. TABLE: non-vol/vpn
  22116. COMMAND: delete_tunnel
  22118. USAGE: delete_tunnel [Number{0..64}]
  22120. DESCRIPTION:
  22121. Delete tunnel settings. Use zero based index.
  22123. EXAMPLES:
  22124. delete_tunnel_settings 0 - delete the 0th tunnel entry --
  22126. ------------------------------------------------------------------------------
  22128. TABLE: non-vol/vpn
  22130. COMMAND: enable
  22132. USAGE: enable [true|false]
  22134. DESCRIPTION:
  22135. Enable or Disable VPN
  22137. EXAMPLES:
  22138. enable 1 - enables the VPN --
  22140. ------------------------------------------------------------------------------
  22142. TABLE: non-vol/vpn
  22144. COMMAND: flush {disabled}
  22146. USAGE: flush
  22148. DESCRIPTION:
  22149. For Composite NonVol Settings objects (which contain 1 or more groups of
  22150. NonVol Settings), this command flushes out any unrecognized groups that were
  22151. read from the device. This is useful in cases where the settings group isn't
  22152. needed by another application, and would just waste space.
  22154. EXAMPLES:
  22155. flush --
  22157. ------------------------------------------------------------------------------
  22159. TABLE: non-vol/vpn
  22161. COMMAND: manufactured
  22163. USAGE: manufactured [both|perm|dyn]
  22165. DESCRIPTION:
  22166. Checks to see if the specified section is manufactured.
  22168. EXAMPLES:
  22169. manufactured -- Checks both Permanent and Dynamic sections
  22170. manufacturing state.
  22171. manufactured perm -- Checks only the Permanent section manufacturing state.
  22173. ------------------------------------------------------------------------------
  22175. TABLE: non-vol/vpn
  22177. COMMAND: read
  22179. USAGE: read [both|perm|dyn]
  22181. DESCRIPTION:
  22182. Reads the specified section of non-volatile settings from non-volatile
  22183. memory. If 'both' is specified or there are no parameters, then both
  22184. Permanent and Dynamic settings will be read. Otherwise, only the section
  22185. specified will be read. This will destroy any changes you have made if you
  22186. haven't written them!
  22188. EXAMPLES:
  22189. read -- Reads both Permanent and Dynamic sections of settings.
  22190. read perm -- Reads only the Permanent section of non-vol settings.
  22192. ------------------------------------------------------------------------------
  22194. TABLE: non-vol/vpn
  22196. COMMAND: show
  22198. USAGE: show
  22200. DESCRIPTION:
  22201. Displays the current non-volatile settings values for both the Permanent and
  22202. Dynamic sections.
  22204. EXAMPLES:
  22205. show --
  22207. ------------------------------------------------------------------------------
  22209. TABLE: non-vol/vpn
  22211. COMMAND: stats
  22213. USAGE: stats
  22215. DESCRIPTION:
  22216. Prints stats about buffer usage for Dynamic and Permanent settings.
  22218. EXAMPLES:
  22219. stats --
  22221. ------------------------------------------------------------------------------
  22223. TABLE: non-vol/vpn
  22225. COMMAND: tftp_read
  22227. USAGE: tftp_read [-g] perm|dyn IpAddress Filename{127}
  22229. DESCRIPTION:
  22230. Causes the Permanent or Dynamic settings data to be read from a server via
  22231. TFTP. The file must be generated correctly, with all of the headers, CRC,
  22232. and other information that would exist on the NonVol device. The file will
  22233. be read and evaluated for correctness before it is stored in the device. If
  22234. the file is rejected then the settings will be read from the device to undo
  22235. any changes. Normally, this will operate on all settings groups; if you
  22236. specify -g then it will operate only on the current group (e.g. if you are in
  22237. the SNMP nonvol dir, then -g will cause only the SNMP settings group to be
  22238. read).
  22240. EXAMPLES:
  22241. tftp_read perm 11.24.4.3 allsettings.bin -- Reads all groups.
  22242. tftp_read -g perm 11.24.4.3 bpi.bin -- Reads only the current group.
  22244. ------------------------------------------------------------------------------
  22246. TABLE: non-vol/vpn
  22248. COMMAND: tftp_write
  22250. USAGE: tftp_write [-g] perm|dyn IpAddress Filename{127}
  22252. DESCRIPTION:
  22253. Causes the Permanent or Dynamic settings data to be written to a server via
  22254. TFTP. Normally, this will operate on all settings groups; if you specify -g
  22255. then it will operate only on the current group (e.g. if you are in the SNMP
  22256. nonvol dir, then -g will cause only the SNMP settings group to be written).
  22258. EXAMPLES:
  22259. tftp_write perm 11.24.4.3 nvsettings.bin -- Writes all groups.
  22260. tftp_write -g perm 11.24.4.3 bpi.bin -- Writes only the current group.
  22262. ------------------------------------------------------------------------------
  22264. TABLE: non-vol/vpn
  22266. COMMAND: vpndebug
  22268. USAGE: vpndebug [true|false]
  22270. DESCRIPTION:
  22271. Enable or Disable VPN Debug
  22273. EXAMPLES:
  22274. vpndebug 1 - enables VPN debug --
  22276. ------------------------------------------------------------------------------
  22278. TABLE: non-vol/vpn
  22280. COMMAND: write
  22282. USAGE: write [both|perm|dyn]
  22284. DESCRIPTION:
  22285. Writes the specified section of non-volatile settings to non-volatile memory.
  22286. If 'both' is specified or there are no parameters, then both Permanent and
  22287. Dynamic settings will be written. Otherwise, only the section specified will
  22288. be written.
  22290. EXAMPLES:
  22291. write -- Writes both Permanent and Dynamic sections of settings.
  22292. write perm -- Writes only the Permanent section of non-vol settings.
  22294. ------------------------------------------------------------------------------
  22296. TABLE: Console/pingHelper
  22298. COMMAND: all_sizes
  22300. USAGE: all_sizes
  22302. DESCRIPTION:
  22303. Configures the settings for sweeping all packet sizes from 64-1518, with
  22304. waiting and verification enabled. The time between pings is set to 0 ms, the
  22305. verbosity is set to full, and the reply wait time is set to 1/2 second. The
  22306. IP address is not changed.
  22308. EXAMPLES:
  22309. all_sizes --
  22311. ------------------------------------------------------------------------------
  22313. TABLE: Console/pingHelper
  22315. COMMAND: end_size
  22317. USAGE: end_size [size{64..1518}]
  22319. DESCRIPTION:
  22320. Sets or shows the size of the largest ping packet that will be sent
  22321. (including LLC and IP header overhead). After the packet size is increased
  22322. by the step amount, if it is larger than this value, then the size is reset
  22323. to the start size. This must be between start_size..1518 (MTU), inclusive.
  22325. EXAMPLES:
  22326. end_size 1518 -- Sets the end size to the maximum allowed.
  22328. ------------------------------------------------------------------------------
  22330. TABLE: Console/pingHelper
  22332. COMMAND: hs_nowait
  22334. USAGE: hs_nowait
  22336. DESCRIPTION:
  22337. Configures the settings for doing high-speed pings (infinite), without
  22338. waiting for the reply. The display verbosity is set to 2 (display only a
  22339. 'p'), the time between pings is set to 0, and waiting for replies is
  22340. disabled. None of the other settings are changed.
  22342. EXAMPLES:
  22343. hs_nowait --
  22345. ------------------------------------------------------------------------------
  22347. TABLE: Console/pingHelper
  22349. COMMAND: hs_wait
  22351. USAGE: hs_wait
  22353. DESCRIPTION:
  22354. Configures the settings for doing high-speed pings (infinite), waiting for
  22355. the reply. The display verbosity is set to 2 (display only a 'p'), the time
  22356. between pings is set to 0, and waiting for replies is enabled. None of the
  22357. other settings are changed.
  22359. EXAMPLES:
  22360. hs_wait --
  22362. ------------------------------------------------------------------------------
  22364. TABLE: Console/pingHelper
  22366. COMMAND: ip_address
  22368. USAGE: ip_address [IpAddress]
  22370. DESCRIPTION:
  22371. Sets or shows the IP address of the device to be pinged.
  22373. EXAMPLES:
  22374. ip_address 10.24.4.3 --
  22376. ------------------------------------------------------------------------------
  22378. TABLE: Console/pingHelper
  22380. COMMAND: ip_stack
  22382. USAGE: ip_stack [Number{0..255}]
  22384. DESCRIPTION:
  22385. Sets the IP stack number that the pings should be sent to. If 0, then the
  22386. default stack will be used. The stackNum parameter must correspond to a
  22387. valid IP stack that has been installed and initialized with an IP address.
  22389. EXAMPLES:
  22390. ip_stack 2 -- Forces pings to go out IP stack 2.
  22392. ------------------------------------------------------------------------------
  22394. TABLE: Console/pingHelper
  22396. COMMAND: ip_sweep
  22398. USAGE: ip_sweep Subnet StartingIp
  22400. DESCRIPTION:
  22401. Pings all IP addresses on the specified subnet, starting with the address
  22402. specified, reporting success or failure for each one. It changes the ping
  22403. settings so that only a single ping is sent. This is often used to discover
  22404. all of the IP addresses on the subnet. The address will be incremented from
  22405. 1..254, skipping .0 and .255 since these are often used for local broadcast
  22406. addresses.
  22408. EXAMPLES:
  22409. ip_sweep 255.255.255.0 10.24.4.5 -- Pings 10.24.4.5 through 10.24.4.254.
  22411. ------------------------------------------------------------------------------
  22413. TABLE: Console/pingHelper
  22415. COMMAND: number_of_pings
  22417. USAGE: number_of_pings [Number{-1..2147483647}]
  22419. DESCRIPTION:
  22420. Sets or shows the number of pings to be sent. Note that 0 means infinite
  22421. (you will need to press a key or type 'stop' to abort). A value of -1 causes
  22422. the number of pings to be calculated based on the end size, start size, and
  22423. step amount, so that it will span the range exactly once; num = (end - start
  22424. + 1) / step.
  22426. EXAMPLES:
  22427. number_of_pings 3 -- Limits the number of pings to 3.
  22428. number_of_pings 0 -- Sets the number of pings to infinite.
  22429. number_of_pings -1 -- Calculates the number of pings to span the range.
  22431. ------------------------------------------------------------------------------
  22433. TABLE: Console/pingHelper
  22435. COMMAND: ping
  22437. USAGE: ping [-s] [IpAddress]
  22439. DESCRIPTION:
  22440. Begins pinging the specified IP address, using the current settings. If the
  22441. IP address is missing, then it uses the one that was previously set. If you
  22442. specify -s, then pinging will happen int he background until you type stop.
  22443. Otherwise, it will poll for a keypress.
  22445. EXAMPLES:
  22446. ping 10.24.4.3 -- Ping until a key is pressed.
  22447. ping -s -- Ping until the user types stop.
  22449. ------------------------------------------------------------------------------
  22451. TABLE: Console/pingHelper
  22453. COMMAND: restore_defaults
  22455. USAGE: restore_defaults
  22457. DESCRIPTION:
  22458. Restores all of the options to their default values (excluding the IP
  22459. address, which is not modified). The default values cause ping to behave
  22460. like most host-based ping utilities (3 packets, 64 bytes, wait 5 seconds,
  22461. etc.).
  22463. EXAMPLES:
  22464. restore_defaults --
  22466. ------------------------------------------------------------------------------
  22468. TABLE: Console/pingHelper
  22470. COMMAND: show_settings
  22472. USAGE: show_settings
  22474. DESCRIPTION:
  22475. Displays the current ping settings.
  22477. EXAMPLES:
  22478. show_settings --
  22480. ------------------------------------------------------------------------------
  22482. TABLE: Console/pingHelper
  22484. COMMAND: start_size
  22486. USAGE: start_size [size{64..1518}]
  22488. DESCRIPTION:
  22489. Sets or shows the size of the first ping packet that will be sent (including
  22490. LLC and IP header overhead). The packet size will be increased by the step
  22491. amount for each packet. This must be between 64..end_size, inclusive.
  22493. EXAMPLES:
  22494. start_size 64 -- Sets the start size to the minimum allowed.
  22496. ------------------------------------------------------------------------------
  22498. TABLE: Console/pingHelper
  22500. COMMAND: stats
  22502. USAGE: stats
  22504. DESCRIPTION:
  22505. Displays the ping statistics summary from the last set of pings. This is the
  22506. same summary that is displayed at the end of the pings (if verbosity is > 0).
  22508. EXAMPLES:
  22509. stats --
  22511. ------------------------------------------------------------------------------
  22513. TABLE: Console/pingHelper
  22515. COMMAND: step_amount
  22517. USAGE: step_amount [size]
  22519. DESCRIPTION:
  22520. Sets or shows the amount that the packet size will be increased for each
  22521. packet. This can be any number (including 0, which means to keep the size
  22522. constant for every packet). Note that if you set it too large, then the
  22523. packet size will wrap around to the start size every time, since it will
  22524. never be allowed to be larger than the end_size. You can also specify a
  22525. negative number which causes the ping size to start with the end size
  22526. parameter and step down to the start size, then wrap back around to the end
  22527. size.
  22529. EXAMPLES:
  22530. step_amount 1 -- Increases the packet size by 1 each time.
  22531. step_amount -1 -- Decreases the packet size by 1 each time.
  22533. ------------------------------------------------------------------------------
  22535. TABLE: Console/pingHelper
  22537. COMMAND: stop
  22539. USAGE: stop
  22541. DESCRIPTION:
  22542. Stops the ping that is currently running. This is necessary if you used the
  22543. -s parameter with ping.
  22545. EXAMPLES:
  22546. stop -- Stops the ping that is running.
  22548. ------------------------------------------------------------------------------
  22550. TABLE: Console/pingHelper
  22552. COMMAND: time_between_pings
  22554. USAGE: time_between_pings [Milliseconds]
  22556. DESCRIPTION:
  22557. Sets or shows the number of milliseconds that the ping helper will wait
  22558. before sending the next ping. Note that this does not include time spent
  22559. waiting for the reply or verifying it, or for time spent printing status
  22560. information. The actual resolution and accuracy of this depends on the
  22561. system (pSOS generally runs with a 10ms clock tick, so 10ms is the same as
  22562. 15ms on that system).
  22564. EXAMPLES:
  22565. time_between_pings 100 -- Waits 100ms before sending the next ping.
  22567. ------------------------------------------------------------------------------
  22569. TABLE: Console/pingHelper
  22571. COMMAND: verbosity
  22573. USAGE: verbosity [Number{0..3}]
  22575. DESCRIPTION:
  22576. Sets the level of information that will be displayed while pinging. A higher
  22577. number provides more information, but also slows down the rate at which pings
  22578. can be sent. Most host-based ping utilities provide output equivalent to 3.
  22579. For high-performance, high packet rate pings, values of 1 or 2 are best.
  22581. EXAMPLES:
  22582. verbosity 0 -- Disables printing of all ping status output.
  22583. verbosity 1 -- Displays only the summary of statistics at the end.
  22584. verbosity 2 -- Displays a 'p' every second to show progress, and the
  22585. summary.
  22586. verbosity 3 -- Displays full ping info for every packet, and the summary.
  22588. ------------------------------------------------------------------------------
  22590. TABLE: Console/pingHelper
  22592. COMMAND: verify_enable
  22594. USAGE: verify_enable [true|false]
  22596. DESCRIPTION:
  22597. Enables/disables verification of ping replies. If enabled, and if waiting
  22598. for replies is enabled, then if a reply is received, it will verify that it
  22599. matches the ping that was sent, and that all of the data is intact.
  22601. EXAMPLES:
  22602. verify_enable 1 -- Enables verification of the ping reply.
  22604. ------------------------------------------------------------------------------
  22606. TABLE: Console/pingHelper
  22608. COMMAND: wait_enable
  22610. USAGE: wait_enable [true|false]
  22612. DESCRIPTION:
  22613. Enables/disables waiting for ping replies. If enabled, the ping helper will
  22614. wait a number of milliseconds for the reply, and will process it if received.
  22615. This is true even if the timeout is 0ms; it will always check for and process
  22616. the response. If disabled, then no attempt will be made to check for or
  22617. process a response. This is generally only of interest when you need to send
  22618. data very quickly, with no variability.
  22620. EXAMPLES:
  22621. wait_enable 1 -- Enables waiting for the ping reply.
  22623. ------------------------------------------------------------------------------
  22625. TABLE: Console/pingHelper
  22627. COMMAND: wait_time
  22629. USAGE: wait_time [Milliseconds]
  22631. DESCRIPTION:
  22632. Sets or shows the number of milliseconds that the ping helper will wait for a
  22633. ping response before continuing. This only takes effect if waiting is
  22634. enabled. The actual resolution and accuracy of this depends on the system
  22635. (pSOS generally runs with a 10ms clock tick, so 10ms is the same as 15ms on
  22636. that system).
  22638. EXAMPLES:
  22639. wait_time 5000 -- Sets the reply wait timeout to 5 seconds.
  22641. ------------------------------------------------------------------------------
  22643. TABLE: snmp
  22645. COMMAND: agent_core_show
  22647. USAGE: agent_core_show
  22649. DESCRIPTION:
  22650. Print agent-core specific info to the console.
  22652. EXAMPLES:
  22653. agent_core_show --
  22655. ------------------------------------------------------------------------------
  22657. TABLE: snmp
  22659. COMMAND: ch_cfgfile
  22661. USAGE: ch_cfgfile [IP] [path{254}]
  22663. DESCRIPTION:
  22664. Load the specified config file. If IP or path are not specified, then the
  22665. settings from DOCSIS NV / dhcp settings will be used.
  22666. NOTE: Only CHomeSnmpAgent objects support this command.
  22668. EXAMPLES:
  22669. ch_cfgfile 10.24.192.200 /home/broadcom/cu.cfg
  22672. ------------------------------------------------------------------------------
  22674. TABLE: snmp
  22676. COMMAND: cm_cfgfile
  22678. USAGE: cm_cfgfile [IP] [path{254}]
  22680. DESCRIPTION:
  22681. Load the specified config file. If IP or path are not specified, then the
  22682. settings from DOCSIS NV / dhcp settings will be used.
  22683. NOTE: Only CmSnmpAgent objects support this command.
  22685. EXAMPLES:
  22686. cm_cfgfile 10.24.192.200 /home/broadcom/cu.cfg
  22689. ------------------------------------------------------------------------------
  22691. TABLE: snmp
  22693. COMMAND: cm_filter_test
  22695. USAGE: cm_filter_test inbound ifIndex{1..32} outbound ifIndex{1..32} [num packets{1..1000000}]
  22697. DESCRIPTION:
  22698. Test the DOCSIS filters. Send the specified number of packets from the
  22699. specified inbound interface to the specified outbound interface. Note that
  22700. interface values refer to ifIndex values from the ifTable.
  22701. NOTE: Only CmSnmpAgent objects support this command.
  22703. EXAMPLES:
  22704. cm_filter_test 1 2 1 -- Send a single packet from IF 1 to IF 2.
  22705. debug 9 -- Set the core agent to max verbosity.
  22707. ------------------------------------------------------------------------------
  22709. TABLE: snmp
  22711. COMMAND: debug
  22713. USAGE: debug [Number{0..9}]
  22715. DESCRIPTION:
  22716. Set the debug level of the core agent.
  22718. EXAMPLES:
  22719. debug 0 -- Set the core agent to be silent.
  22720. debug 9 -- Set the core agent to max verbosity.
  22722. ------------------------------------------------------------------------------
  22724. TABLE: snmp
  22726. COMMAND: emta_api
  22728. USAGE: emta_api
  22730. DESCRIPTION:
  22731. Print the addresses of API functions registered by the CableXChange library.
  22732. NOTE: Only EmtaSnmpAgent objects support this command.
  22734. EXAMPLES:
  22735. emta_api --
  22737. ------------------------------------------------------------------------------
  22739. TABLE: snmp
  22741. COMMAND: emta_cxc_objs
  22743. USAGE: emta_cxc_objs
  22745. DESCRIPTION:
  22746. Print the objects registered by the CableXChange library.
  22747. NOTE: Only EmtaSnmpAgent objects support this command.
  22749. EXAMPLES:
  22750. emta_cxc_objs --
  22752. ------------------------------------------------------------------------------
  22754. TABLE: snmp
  22756. COMMAND: emta_secmode
  22758. USAGE: emta_secmode [open|community|coexistence|packetcable] [optional view{254}]
  22760. DESCRIPTION:
  22761. Set EMTA security mode (open|community|coexistence|packetcable), and
  22762. optionally view for SNMPv1 & SNMPv2c.
  22764. EXAMPLES:
  22765. emta_secmode open -- Enable wide-open (no restrictions)
  22766. security.
  22767. emta_secmode community -- Enable community-restricted (from
  22768. provisioned list) security.
  22769. emta_secmode coexistence -- Enable community-based coexistence
  22770. (RFC-2576) security.
  22771. emta_secmode packetcable -- Enable SNMPv3-only (PacketCable standard)
  22772. security.
  22773. emta_secmode open unrestricted -- Enable wide-open mode and use view
  22774. 'unrestricted'.
  22775. NOTE: Only EmtaSnmpAgent objects support this command.
  22777. ------------------------------------------------------------------------------
  22779. TABLE: snmp
  22781. COMMAND: flush
  22783. USAGE: flush table_name{254}
  22785. DESCRIPTION:
  22786. Flush the specified SNMP table.
  22789. EXAMPLES:
  22790. set sysName.0 STRING device.vendor.com --
  22792. ------------------------------------------------------------------------------
  22794. TABLE: snmp
  22796. COMMAND: get
  22798. USAGE: get object.index{254}
  22800. DESCRIPTION:
  22801. Get the specified SNMP object.
  22802. If no index is specified, gets the first instance available.
  22803. To query a table entry, use [tablename].[index], not [entryname].[index].
  22805. EXAMPLES:
  22806. get sysDescr.0 --
  22807. get ifTable.1 --
  22809. ------------------------------------------------------------------------------
  22811. TABLE: snmp
  22813. COMMAND: group_members
  22815. USAGE: group_members group name{254}
  22817. DESCRIPTION:
  22818. List the members of a given group.
  22821. EXAMPLES:
  22822. group_members iso -- Lists the members of the iso (.1) group for the given
  22823. agent.
  22826. ------------------------------------------------------------------------------
  22828. TABLE: snmp
  22830. COMMAND: install_group
  22832. USAGE: install_group vacmGroupName{31} dhPublicKey{31}
  22834. DESCRIPTION:
  22835. Install one of the standard DOCSIS 1.1 groups. Supported groups are:
  22837. docsisManager
  22838. docsisOperator
  22839. docsisMonitor
  22840. docsisUser
  22842. vacmGroupName is one of the above names. dhPublicKey is any old text string
  22843. to use as the public key (no spaces).
  22844. NOTE: Only SnmpV3Agent objects support this command.
  22846. EXAMPLES:
  22847. install_group docsisManager broadcom --
  22849. ------------------------------------------------------------------------------
  22851. TABLE: snmp
  22853. COMMAND: key_v3
  22855. USAGE: key_v3 userName{31}
  22857. DESCRIPTION:
  22858. Get the SNMP v3 keys given the user name.
  22859. NOTE: Only SnmpV3Agent objects support this command.
  22861. EXAMPLES:
  22864. ------------------------------------------------------------------------------
  22866. TABLE: snmp
  22868. COMMAND: log
  22870. USAGE: log req|nm|filt|events|thread|trap|time enable
  22872. DESCRIPTION:
  22873. Enable or disable various kinds of SNMP logging.
  22875. EXAMPLES:
  22876. log req true -- Enable SNMP request debug.
  22877. log nm true -- Enable SNMP NM authentication debug.
  22878. log filt true -- Enable packet filter debug.
  22879. log events true -- Enable event log debug.
  22880. log thread true -- Enable SNMP thread debug.
  22883. ------------------------------------------------------------------------------
  22885. TABLE: snmp
  22887. COMMAND: n2m
  22889. USAGE: n2m
  22891. DESCRIPTION:
  22892. Print the NetToMedia mappings to the console.
  22893. Note that this is a superset of the ipNetToMediaTable, because it may
  22894. contain off-net entries as well as on-net ones.
  22896. EXAMPLES:
  22897. n2m
  22899. ------------------------------------------------------------------------------
  22901. TABLE: snmp
  22903. COMMAND: notify_setup
  22905. USAGE: notify_setup
  22907. DESCRIPTION:
  22908. Setup Notify Mibs to enable SNMPv3 Notify. Uses default entries.
  22909. NOTE: Only SnmpV3Agent objects support this command.
  22911. EXAMPLES:
  22912. notify_setup --
  22914. ------------------------------------------------------------------------------
  22916. TABLE: snmp
  22918. COMMAND: parent_chain
  22920. USAGE: parent_chain object name{254}
  22922. DESCRIPTION:
  22923. Recurse the parent chain for the given object.
  22926. EXAMPLES:
  22927. parent_chain sysDescr -- Recurses the parent chain for the sysDescr object
  22928. for the given agent.
  22931. ------------------------------------------------------------------------------
  22933. TABLE: snmp
  22935. COMMAND: set
  22937. USAGE: set object.index{254} int|uint|string|oid|ip value{254}
  22939. DESCRIPTION:
  22940. Set the specified SNMP object to the specified value.
  22942. EXAMPLES:
  22943. set sysName.0 STRING device.vendor.com --
  22945. ------------------------------------------------------------------------------
  22947. TABLE: snmp
  22949. COMMAND: severities
  22951. USAGE: severities
  22953. DESCRIPTION:
  22954. List SNMP message log app-specific severity bits.
  22956. EXAMPLES:
  22957. severities --
  22959. ------------------------------------------------------------------------------
  22961. TABLE: snmp
  22963. COMMAND: show
  22965. USAGE: show
  22967. DESCRIPTION:
  22968. Print the SNMP agent's settings to the console.
  22970. EXAMPLES:
  22971. show --
  22973. ------------------------------------------------------------------------------
  22975. TABLE: snmp
  22977. COMMAND: test
  22979. USAGE: test [optional IP{254}]
  22981. DESCRIPTION:
  22982. This command is a placeholder to provide an easy way to add temporary
  22983. commands during development. In released code this command does nothing.
  22986. EXAMPLES:
  22987. test --
  22989. ------------------------------------------------------------------------------
  22991. TABLE: snmp
  22993. COMMAND: thread_info
  22995. USAGE: thread_info
  22997. DESCRIPTION:
  22998. Print the state of the SNMP thread and related info.
  23000. EXAMPLES:
  23001. thread_info --
  23003. ------------------------------------------------------------------------------
  23005. TABLE: snmp
  23007. COMMAND: throttle
  23009. USAGE: throttle [milliseconds]
  23011. DESCRIPTION:
  23012. Set the throttle time for packet processing.
  23014. EXAMPLES:
  23015. throttle 100 -- Only process 1 packet per 100 milliseconds (10 packets per
  23016. second).
  23017. throttle 0 -- Apply no packet throttling (default).
  23019. ------------------------------------------------------------------------------
  23021. TABLE: snmp
  23023. COMMAND: tlv_55
  23025. USAGE: tlv_55 [enable]
  23027. DESCRIPTION:
  23028. Enable/disable SNMP management from the CPE. An SnmpCpeAccessEnable (TLV-55)
  23029. equivalent.
  23031. EXAMPLES:
  23032. tlv_55 true
  23035. ------------------------------------------------------------------------------
  23037. TABLE: snmp
  23039. COMMAND: trap
  23041. USAGE: trap coldStart|warmStart|linkDown|linkUp|authFail [snmpVersion{1..3}] [destIp] [community{254}]
  23043. DESCRIPTION:
  23044. Send the specified trap type using specified snmpVersion to destIp with
  23045. specified community string
  23046. snmpVersion -- 2=SNMPv1 trap
  23047. snmpVersion -- 2=SNMPv2c trap
  23048. snmpVersion -- 3=Notify
  23050. EXAMPLES:
  23051. trap coldStart 1 10.24.65.171 public -- Send a COLD_START SNMPv1 trap to
  23052. 10.24.65.171 with community '
  23053. public'.
  23055. ------------------------------------------------------------------------------
  23057. TABLE: snmp
  23059. COMMAND: view_v1v2
  23061. USAGE: view_v1v2 community{254}
  23063. DESCRIPTION:
  23064. Set the view used for SNMPv1/v2c queries for the specified agent.
  23066. EXAMPLES:
  23067. view_v1v2 docsisManagerView --
  23069. ------------------------------------------------------------------------------
  23071. TABLE: snoop
  23073. COMMAND: debug
  23075. USAGE: debug [-s] [-d] [in|out] [true|false]
  23077. DESCRIPTION:
  23078. Enables or disables Snoop debugging (if compiled in). If enabled, then the
  23079. Snoop will display extra info as the packet is processed.
  23081. EXAMPLES:
  23082. debug in true -- Enables inbound debugging of the snoop.
  23083. debug true -- Enables inbound and outbound debugging of the snoop.
  23084. debug -d true -- Enables snoop inbound and outbound debugging for only
  23085. discarded packets.
  23086. debug -s true -- Enables non-verbose snoop inbound and outbound debugging.
  23089. ------------------------------------------------------------------------------
  23091. TABLE: snoop
  23093. COMMAND: enable
  23095. USAGE: enable [true|false]
  23097. DESCRIPTION:
  23098. Enables or disables the Snoop. If disabled, then all packets will be passed
  23099. without processing.
  23101. EXAMPLES:
  23102. enable false -- Disables all Snoops.
  23104. ------------------------------------------------------------------------------
  23106. TABLE: snoop
  23108. COMMAND: priority
  23110. USAGE: priority in|out [Priority]
  23112. DESCRIPTION:
  23113. Sets or gets the inbound or outbound priority of the Snoop. The priority
  23114. determines the order of Snoops in the list. When setting the priority, the
  23115. lists will automatically be re-sorted.
  23117. EXAMPLES:
  23118. priority in 64 -- Sets the inbound priority to 64, then sorts the list.
  23120. ------------------------------------------------------------------------------
  23122. TABLE: snoop
  23124. COMMAND: show
  23126. USAGE: show
  23128. DESCRIPTION:
  23129. Causes the Snoops to display their internal state.
  23131. EXAMPLES:
  23132. show --
  23134. ------------------------------------------------------------------------------
  23136. TABLE: usb_hal
  23138. COMMAND: hal_show
  23140. USAGE: hal_show
  23142. DESCRIPTION:
  23143. Causes the USB HAL to display its internal state.
  23145. EXAMPLES:
  23146. hal_show --
  23148. ------------------------------------------------------------------------------
  23150. TABLE: usb_hal
  23152. COMMAND: show
  23154. USAGE: show
  23156. DESCRIPTION:
  23157. Causes the HalIf object to display its state.
  23159. EXAMPLES:
  23160. show --
  23162. ------------------------------------------------------------------------------
  23164. TABLE: usb_hal
  23166. COMMAND: usb_powerdown
  23168. USAGE: usb_powerdown [true|false]
  23170. DESCRIPTION:
  23171. Putting the USB IF into powerdown mode does the following in the specified
  23172. order:
  23174. 1 -- Disables interrupts from the USB
  23175. 2 -- Disables the clock to the USB
  23177. The USB IF is returned to operation state by negating these actions in
  23178. reverse order. However, the USB configuration RAM is also reprogrammed and
  23179. the buffer pointers are reinitialized.
  23181. EXAMPLES:
  23182. usb_powerdown true -- Puts the USB IF in powerdown mode.
  23183. usb_powerdown false -- Restores the USB IF to operational state.
  23185. ------------------------------------------------------------------------------
  23188. CM>