VIRATA ATMOS Console Command Reference Manual Download Page 67

Page: 67 / 248

BUN Console commands

ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)

5.2

help

5.2.1 Syntax

help [<command>]

5.2.2 Description

Display command information

If used without the optional command name, a summary of the
commands available will be displayed.

If used with a command name, brief usage information will be shown
for the command.

Note

: Commands listed but which are not covered by this

documentation are

not

supported, and may not be present in

future software releases.

5.2.3 Examples

help

help set port

Note

: This command is not intended to replace this

documentation, and provides only a very basic level of detail.

Summary of Contents for ATMOS Console

Page 1: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 2: ...are the property of their respective owners ATMOS Console Commands Reference Manual Binary DO 008530 PR Virata Company Proprietary Trademarks Virata EmStack and EmWeb are registered trademarks of Vir...

Page 3: ...Reference Manual Binary DO 008530 PS Draft B 26th April 2001 iii Contents 1 About this Guide 1 1 1 Introduction 2 1 2 Scope 2 1 3 Audience 2 1 4 Related Documents 2 1 5 Typographical conventions 3 1...

Page 4: ...6 process process command 11 2 7 history mechanism 13 2 8 commands 14 2 9 Special purpose commands 16 2 10 list 17 2 11 echo 18 2 12 tell process 19 2 13 exit exit 20 2 14 debug 21 2 15 crlf nocrlf 2...

Page 5: ...44 3 9 interface 45 3 10 portfilter 46 3 11 spanning 48 3 12 status 49 3 13 version 50 4 BUN Console commands 51 4 1 Introduction 52 4 2 help 55 4 3 version 56 4 4 build 57 4 5 config 58 4 6 list con...

Page 6: ...5 6 DHCP related IP process commands 79 5 7 ip device 80 6 DHCP server Console commands 81 6 1 config 82 6 2 help 84 6 3 pool 85 6 4 reset 86 6 5 status 87 6 6 trace 88 6 7 version 89 7 NAT Console c...

Page 7: ...nnel lcpmaxconfigure 120 8 14 channel lcpmaxfailure 121 8 15 channel lcpmaxterminate 122 8 16 channel llc 123 8 17 channel pvc 124 8 18 channel qos 126 8 19 channel remoteip 127 8 21 channel theylogin...

Page 8: ...10 13 flush 171 10 14 get 172 10 15 help 173 10 16 ipatm abort 174 10 17 ipatm arp 175 10 18 ipatm arpserver 176 10 19 ipatm files 177 10 20 ipatm help 178 10 21 ipatm lifetime 179 10 22 ipatm pvc 180...

Page 9: ...10 43 rip trigger 204 10 44 route 205 10 45 routeflush 207 10 46 routes 208 10 47 snmp 209 10 48 stats 210 10 49 subnet 211 10 50 trace 213 10 51 untrace 215 10 52 uptime 216 10 53 version 217 10 54 2...

Page 10: ...Contents x ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 11: ...s Guide This chapter tells you about The scope of this guide and its intended audience The typographical conventions used in this guide How to read and provide feedback about this guide The informatio...

Page 12: ...ware For examples see the example network configurations chapter of the software user s guide for your hardware platform 1 3 Audience This document is targeted at binary licensees evaluating or develo...

Page 13: ...quitting Text like this is used for text that you type as a command or entry to a field in a dialogue box Variables to a command are shown in text like this Text like this is used for text that you s...

Page 14: ...on 1 6 Reading this guide 1 6 1 Providing feedback on this guide Please report problems and questions via the Problem Reports area on the Virata licensee web server at http ls virata com When submitti...

Page 15: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 5 2 ATMOS Console commands This chapter describes the ATMOS Console commands...

Page 16: ...le Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 2 1 General notes Example output is shown only to clarify the description of the commands the actual output is not necessarily...

Page 17: ...vent r displays the most recent background output stored in the memory buffer event previous or event p displays the background output immediately preceding that last displayed event next or event n d...

Page 18: ...008530 PS Draft B 26th April 2001 2 3 restart 2 3 1 Syntax restart 2 3 2 Description Reboots the ATMOS system The reboot will cause the loss of any configuration which has not yet been saved using the...

Page 19: ...nary DO 008530 PS Draft B 26th April 2001 9 2 4 uptime 2 4 1 Syntax uptime 2 4 2 Description Displays the time for which the system has been up ie the time since the system has been powered up or rest...

Page 20: ...version 10 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 2 5 version 2 5 1 Syntax version 2 5 2 Description Displays the system type and version...

Page 21: ...LL messages to the process as if they had been preceded by the process name until the command home is issued The prompt is changed to reflect this moreover if a help command with no arguments is issue...

Page 22: ...command or process command However the console will remain at the same process prompt The command home process will change the prompt from the current process to a new process process 2 6 4 Example pr...

Page 23: ...nsole Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 13 2 7 history mechanism 2 7 1 Syntax 2 7 2 Description Repeats the previous console command 2 7 3 Example prompt isfs versi...

Page 24: ...s followed by a space or any non alphanumeric character the remainder of the line is treated as a console command as if the device were not bound The process line form passes line to a file if any ope...

Page 25: ...ATMOS Console commands ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 15 2 8 4 See also bind process unbind on page 23...

Page 26: ...Draft B 26th April 2001 2 9 Special purpose commands This section lists commands that are normally useful only to developers rather than to normal users or else are retained only for consistency with...

Page 27: ...or each file the list shows the name of the process that opened the file and the number of read commands outstanding on the file If the file is bound to a device then the list shows which device it is...

Page 28: ...le Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 2 11 echo 2 11 1 Syntax echo text 2 11 2 Description Echoes the text Not a very useful command 2 11 3 Example prompt echo hello...

Page 29: ...s command 2 12 2 Description Sends the command as a TELL message to a specific process Note that for many processes the tell can be omitted see process process command on page 11 2 12 3 Example prompt...

Page 30: ...1 2 13 exit exit 2 13 1 Syntax exit exit 2 13 2 Description Exits from ATMOS to the boot ROM Without the exclamation mark the command works only from the serial interface with the exclamation mark it...

Page 31: ...DO 008530 PS Draft B 26th April 2001 21 2 14 debug 2 14 1 Syntax debug 2 14 2 Description Enters the ATMOS debugger Only works when issued at the serial interface Since the ATMOS debugger talks to th...

Page 32: ...O 008530 PS Draft B 26th April 2001 2 15 crlf nocrlf 2 15 1 Syntax crlf nocrlf 2 15 2 Description Controls whether line feed characters written to this console device are output as carriage return lin...

Page 33: ...scription The former command binds this console device to the specified process that is binds this device to the file if any opened for read by that process and binds every file opened by the process...

Page 34: ...2 17 1 Syntax buildid 2 17 2 Description This command displays the build ID a unique identifier for the image that you have built If you need to contact the Virata Technical Advice Center regarding th...

Page 35: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 25 3 Chips Process Console commands This chapter describes the ATMOS Console commands for the chips process...

Page 36: ...pu 3 1 2 Description Displays the recent CPU utilization as a percentage This is a fairly crude measurement the ATMOS kernel measures the time that the CPU spends in the idle loop over successive thre...

Page 37: ...Chips Process Console commands ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 27 3 2 debug 3 2 1 Syntax debug 3 2 2 Description Enters the ATMOS debugger...

Page 38: ...ole Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 3 3 exit 3 3 1 Syntax exit 3 3 2 Description Exits from ATMOS to the boot ROM Note This command is now deprecated and provides...

Page 39: ...erence Manual Binary DO 008530 PS Draft B 26th April 2001 29 3 4 help 3 4 1 Syntax help help command 3 4 2 Description The help command lists all chips commands is a synonym for this command help comm...

Page 40: ...rence Manual Binary DO 008530 PS Draft B 26th April 2001 3 5 info 3 5 1 Syntax info 3 5 2 Description Displays some system type information version number and the MAC addresses 3 5 3 Example info word...

Page 41: ...th April 2001 31 3 6 mem 3 6 1 Syntax mem 3 6 2 Description Displays a summary of how much memory is used by each ATMOS process distinguishing between heap and thread stacks along with some other mino...

Page 42: ...word rh at a specified address or writes a specified value to the byte wb word ww or half word wh Addresses and values are specified in hexadecimal with an optional 0x prefix 3 7 3 Example rw 1c4b54...

Page 43: ...Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 33 3 8 tell 3 8 1 Syntax tell process command 3 8 2 Description Sends the command as a TELL message to a specific process...

Page 44: ...tell 34 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 45: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 35 4 Bridge Console commands This chapter describes the Bridge Console commands...

Page 46: ...table below shows devices which may be attached to the bridge although not all systems may support all devices Configuration saving saves this information 4 1 3 Example Simple examples device add edd...

Page 47: ...ated BUN port is called rfc_port and it has been configured in the following way device rfc_dev rfc1483 nec98408 utopia port rfc_port rfc_dev PhysicalPort 0 PortSpeed 59111 If we want to attach the de...

Page 48: ...Syntax device delete device 4 2 2 Description This command deletes a device from the bridge configuration The syntax of the device name is the same as that for the device add command Configuration sav...

Page 49: ...device list 4 3 1 Syntax device list 4 3 2 Description This command lists all the devices that are currently attached to the bridge It does not show the stored configuration which can be seen with th...

Page 50: ...eived By default all bridge ports are set to any which means that the type of the packet will never be checked The meaning of the other options is as follows The port is specified as an integer as dis...

Page 51: ...e s filter table The MAC entries for each device are shown in turn together with the time that the MAC address was last seen by the bridge The command also shows the current filter ageing time in seco...

Page 52: ...me is the time after which MAC addresses are removed from the filter table when there has been no activity The time is specified in seconds and may be any integer value in the range 10 100 000 seconds...

Page 53: ...mmand allows the MAC entries for a specified port or all ports to be removed from the filter table The port number for a device may be determined using the device list or status commands If the port n...

Page 54: ...ry DO 008530 PS Draft B 26th April 2001 4 8 info 4 8 1 Syntax info 4 8 2 Description This command displays build information about the bridge process The version command is a synonym for this command...

Page 55: ...y DO 008530 PS Draft B 26th April 2001 45 4 9 interface 4 9 1 Syntax interface sub command 4 9 2 Description This command accesses the ethernet support library sub commands for the bridge itself not f...

Page 56: ...ll other ports retain their default behaviour Note that this command does not force packets arriving on the source port to be sent to all specified destination ports The bridge retains its learning be...

Page 57: ...e commands ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 47 4 10 4 Example 2 portfilter 2 all portfilter 3 all 4 10 5 See also device add on page 36 and device li...

Page 58: ...states hellotime time Reads or sets the time in seconds after which the spanning tree process sends notification of topology changes to the root bridge info Displays the version number of the spanning...

Page 59: ...OS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 49 status Reports the status of the spanning tree version Displays the version number of the spanning tree implementati...

Page 60: ...his command shows the status of the bridge and its ports The status information for a port includes the SNMP type information about time exceeded packets packets discarded etc It also includes the bro...

Page 61: ...ence Manual Binary DO 008530 PS Draft B 26th April 2001 51 4 13 version 4 13 1 Syntax version 4 13 2 Description This command displays build information about the bridge process The info command is a...

Page 62: ...version 52 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 63: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 53 5 BUN Console commands This chapter describes the BUN Console commands...

Page 64: ...e from a device configuration request Device names may contain upper or lower case letters but use case insensitive matching portname The name of a port This can take several forms The name given on t...

Page 65: ...hdlc All ports using an HDLC hardware interface pci All ports using a PCI hardware interface usb All ports using a USB hardware interface A running system may contain additional classes specified via...

Page 66: ...Introduction 56 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 67: ...name a summary of the commands available will be displayed If used with a command name brief usage information will be shown for the command Note Commands listed but which are not covered by this doc...

Page 68: ...Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 5 3 version 5 3 1 Syntax version 5 3 2 Description Display the BUN software version 5 3 3 Example version 5 3 4 See also...

Page 69: ...y DO 008530 PS Draft B 26th April 2001 59 5 4 build 5 4 1 Syntax build 5 4 2 Description Display information about compile time build options For example if tracing or debug code has been compiled int...

Page 70: ...rings to BUN This may be used to create new devices or ports at run time using the same syntax as the configuration strings in the SYSTEM file BUN_CONFIG_ n directives This can be particularly useful...

Page 71: ...fully Pending the request is stalled pending creation of a as yet non existent device Failed the request failed Each request is displayed together with any relevant information In the case of failed r...

Page 72: ...l available devices This will show all devices regardless of how they were created This includes devices which were compiled into the system such as the utopia device and compound devices which were c...

Page 73: ...e This is the same as the name passed to the show device command The device description is a brief string describing the device For compiled in devices this string is provided by the driver code For c...

Page 74: ...April 2001 5 9 list classes 5 9 1 Syntax list classes 5 9 2 Description List available port classes on the console The class name is displayed together with the necessary attributes for a port to be...

Page 75: ...s Reference Manual Binary DO 008530 PS Draft B 26th April 2001 65 5 10 show class 5 10 1 Syntax class classname 5 10 2 Description List members of the specified port class 5 10 3 Example show class at...

Page 76: ...scription List all available ports on the console in the following format portnumber portname All BUN console which require a port to be identified can accept either the port number or port name as an...

Page 77: ...port 5 12 1 Syntax port portname 5 12 2 Description Display detailed information about a port This command enumerates all attributes for a port and displays them on the console It is useful to determi...

Page 78: ...ttribute This command may be used to modify an attribute on a port overriding any values specified in the original port configuration request The effects of changing any such attributes are device dep...

Page 79: ...s on all ports will be displayed The channels are shown with their identification number and a selection of useful attributes A full attribute list can be obtained via the show channel command All cha...

Page 80: ...st channels command The list channels command shows channels which are either enabled or open The list all open channels command only shows channels which are open If no portname is specified all chan...

Page 81: ...he channel are displayed on the console Note that you must specify both a port name and channel number Channel numbers are only unique within a given port It is also possible to display channels that...

Page 82: ...ill be device dependent Use this command with extreme caution The same warnings about an application closing and reopening a channel handle apply as they do for the show channel command Also beware th...

Page 83: ...2 Description Re initialise port hardware This may be used to request that a device re initialise the underlying hardware Not all devices implement this command This command is primarily intended for...

Page 84: ...reset port 74 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 85: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 75 6 DHCP client Console commands This chapter describes the DHCP client Console commands...

Page 86: ...6 1 2 Description This command displays the current configuration of the DHCP client including selected DHCP options 6 1 3 Example prompt dhcpclient config DHCP client configuration file isfs dhclient...

Page 87: ...mmand all 6 2 2 Description This command provides help on the various console commands provided by the ATMOS DHCP client Specifying the command name gives detailed help and specifying the argument all...

Page 88: ...d is helpful in determining the optimum memory pool size for the client For example supporting DHCP client functionality on several interfaces simultaneously will require proportionately more memory T...

Page 89: ...ewal subnet mask and DHCP server address Including the all option shows for each valid interface the active lease leases which are being or have been offered to the interface and any leases which are...

Page 90: ...with the option names to be disabled Saving configuration does not preserve the current tracing options that are enabled By default tracing of error warn and note are enabled 6 5 3 Example prompt dhc...

Page 91: ...mmands ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 81 6 6 DHCP related IP process commands The following commands are not provided by the DHCP client process bu...

Page 92: ...ice command lists the current configuration of any devices attached to the IP stack A device configured to use DHCP will show dhcp in the IP address column followed by the actual IP address discovered...

Page 93: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 83 7 DHCP server Console commands This chapter describes the DHCP server Console commands...

Page 94: ...firming the changes made if the parse is successful Use of the delete option deletes the last line from the configuration file Use of the flush argument deletes the whole configuration Following any c...

Page 95: ...Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 85 prompt dhcpserver config Current DHCP server configuration Issue dhcpserver config confirm followed by flashfs update t...

Page 96: ...Description This command provides help on the various console commands provided by the ATMOS DHCP server Specifying a command name gives detailed help on the command Specifying all gives detailed hel...

Page 97: ...1 Syntax dhcpserver pool verbose 7 3 2 Description This command gives a summary of DHCP server memory usage The verbose option shows the entire memory allocation free list 7 3 3 Example prompt dhcpser...

Page 98: ...e however you should still save the configuration file to FLASH if you want the configuration to be preserved upon rebooting the whole system The advantage of this command is that it allows configurat...

Page 99: ...those with no specified lease time or client identifier 7 5 3 Example prompt dhcpserver status DHCP Server Lease Status Interface ethernet IP address Client UID hw addr Expiry 192 168 219 1 01 00 20...

Page 100: ...abled by using the untrace command in the same way Saving configuration does not preserve the current tracing options that are enabled By default only tracing of error is enabled 7 6 3 Example prompt...

Page 101: ...Manual Binary DO 008530 PS Draft B 26th April 2001 91 7 7 version 7 7 1 Syntax dhcpserver version 7 7 2 Description This command displays the current version number of the ATMOS DHCP software 7 7 3 Ex...

Page 102: ...version 92 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 103: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 93 8 DNS Relay Console commands This chapter describes the DNS Relay Console commands...

Page 104: ...retries the relay will attempt in the event of a failed connection and whether or not the relay has managed to connect results in the configuration being reset to factory default settings 8 1 3 Exampl...

Page 105: ...command all 8 2 2 Description This command provides help on the various console commands provided by the ATMOS DNS relay Specifying the command name gives detailed help and specifying the argument all...

Page 106: ...dnsrelay pool verbose 8 3 2 Description This command displays the state of the memory pool being used by the DNS relay The verbose option lists all allocated and freed memory chunks 8 3 3 Example pro...

Page 107: ...retry 8 4 1 Syntax dnsrelay retry retry value 8 4 2 Description This command sets the maximum number of retries the DNS relay is allowed to perform in the event of connection or transmission failure...

Page 108: ...the DNS relay which DNS server to contact Caution must be exercised when using this command if the DNS relay already knows which DNS server to contact then all existing connections will be reset all...

Page 109: ...elay including whether or not it knows which DNS server to try and contact and if so whether or not it has successfully connected to the server 8 6 3 Example prompt dnsrelay status DNS relay status DN...

Page 110: ...socket related I O query Trace DNS resolver queries response Trace DNS server responses error Report all serious error level events warn Report all minor warning level events conn Trace DNS server co...

Page 111: ...Binary DO 008530 PS Draft B 26th April 2001 101 8 8 dnsrelay version 8 8 1 Syntax dnsrelay version 8 8 2 Description The version command displays the current ATMOS DNS relay software version 8 8 3 Ex...

Page 112: ...dnsrelay version 102 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 113: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 103 9 NAT Console commands This chapter describes the NAT Network Address Translation Console commands...

Page 114: ...output For example All trace messages are printed as background output and therefore will not be displayed asynchronously on the console unless the event show command has been issued 9 1 3 Example pro...

Page 115: ...e Manual Binary DO 008530 PS Draft B 26th April 2001 105 9 2 help 9 2 1 Syntax nat help command 9 2 2 Description Lists the commands provided by the NAT console interface If an optional command name i...

Page 116: ...urrently enabled For each of these a status and IP address is listed The IP address is discovered automatically from the IP stack The status shows the user whether NAT is currently operational on that...

Page 117: ...to match in the incoming traffic proto is the IP protocol either udp or tcp new IP is the new IP address on the private network which the packet s destination IP address should be translated to If a...

Page 118: ...y DO 008530 PS Draft B 26th April 2001 9 4 3 Example prompt nat inbound add ethernet 80 TCP 192 168 219 38 prompt nat inbound list Interface Port Proto New IP address 1 ethernet 80 tcp 192 168 219 38...

Page 119: ...y usage is also displayed 9 5 3 Example prompt nat info Interface table size 1 116 bytes Session table size per interface 128 6656 bytes Total 6656 bytes Hash table size per interface 128 512 bytes To...

Page 120: ...9 6 1 Syntax nat protocols 9 6 2 Description The nat protocols command lists the application level gateways ALGs provided in the current image in order to support particular higher level protocols and...

Page 121: ...s and port number and the local port number and the age of the session are printed The all option causes the sessions command to print out information on every session including sessions which have ti...

Page 122: ...reset keyword was given The nat stats command does not provide the total number of packets or bytes transferred as this information is normally available from the device driver on the interface which...

Page 123: ...ence Manual Binary DO 008530 PS Draft B 26th April 2001 113 9 9 version 9 9 1 Syntax nat version 9 9 2 Description This command displays NAT s internal version number 9 9 3 Example prompt nat version...

Page 124: ...mp 9 10 1 Syntax nat dump on off 9 10 2 Description This command is only available in debug builds nat dump causes a detailed dump of the information in each packet s header to be printed both before...

Page 125: ...e 9 11 2 Description This command is only available in debug builds nat fragments prints information on the queues in which NAT holds fragmented IP datagrams displaying the IP datagram identifier the...

Page 126: ...e i f name 9 12 2 Description This command is only available in debug builds nat hashtable prints the number of sessions linked to each entry in the hashtable used to look up outgoing packet on the gi...

Page 127: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 117 10 PPP Console commands This chapter describes the PPP Console commands...

Page 128: ...t have distinct names The user console command controls these 10 1 3 Tunnels A tunnel is a PPTP connection Tunnels are numbered from 1 PPP channels must be associated with a tunnel to be involved in P...

Page 129: ...p event 5 at the console of the PPP ATMOS system ppp 1 pvc 32 ppp 2 pvc 33 ppp 1 enable ppp 2 enable they should now swap packets and synchronise ppp 1 status This should show that the two ends are co...

Page 130: ...to the far end The server interface will take address 192 168 200 99 ip device add ppp_device3 ether ppp DEVICE 3 192 168 220 99 Further IP setup may be needed for instance to route the result to som...

Page 131: ...121 ppp 1 enable If required multiple interfaces can be attached to the bridge of a single ATMOS system so that a single master site is bridged to several satellites Each incoming bridging PPP channe...

Page 132: ...Reference Manual Binary DO 008530 PS Draft B 26th April 2001 10 3 channel clear 10 3 1 Syntax channel clear 10 3 2 Description Clear all aspects of this channel back to their default settings If ther...

Page 133: ...Description Clear the enable flag for a PPP channel This is the default setting Disabling does not remove other configured information about this channel In the PPP state machine this sets the PPP lin...

Page 134: ...packet type but does not generate a return This can be used for more careful tests of data transfer on the link for instance at sizes near the negotiated MRU This command sends an LCP Discard packet...

Page 135: ...nd sends an LCP Echo packet of the specified size If no size is given a minimal sized packet is sent If a size greater than the remote Maximum Receive Unit size is specified the value is reduced to th...

Page 136: ...el to confirm the continued presence of an open PPP connection by sending an LCP echo every few seconds and requiring an echo reply The number of seconds between echo requests is specified as a parame...

Page 137: ...hannel enable 10 8 2 Description Set the enable flag for a PPP channel By default this is disabled In the PPP state machine this flag sets the PPP link to open If it is already open there is no effect...

Page 138: ...e output level Configuration saving does not save this value The default event level is 1 The event levels are shown in the table below Level Description 1 Only very serious errors reported 2 Definite...

Page 139: ...e other non standard implementations If 0 disable this Call with no argument to find the current setting The default value is 0 disabled Configuration saving saves this information If not set and a pa...

Page 140: ...April 2001 10 11 channel info 10 11 1 Syntax channel info all 10 11 2 Description Provide information about the current settings of this channel This includes all configured state and also current pr...

Page 141: ...It should be used for any PPP channel over which IPCP communication with the local system s IP router is desired Other interfaces can be created for bridging A single PPP channel can only be associat...

Page 142: ...lcpmaxconfigure n 10 13 2 Description Set the Max Configure parameter for LCP as described in Section 4 6 of RFC1661 This is the maximum number of Configure Requests that will be sent without reply be...

Page 143: ...maxfailure n 10 14 2 Description Set the Max Failure parameter for LCP as described in Section 4 6 of RFC1661 This is the maximum number of consecutive Configure Naks that will be sent before assuming...

Page 144: ...lcpmaxterminate n 10 15 2 Description Set the Max Terminate parameter for LCP as described in Section 4 6 of RFC1661 This is the maximum number of Terminate Requests that will be sent without reply be...

Page 145: ...er AAL5 RFC 2364 p4 when using LLC encapsulated PPP If 0 disable this Call with no argument to find the current setting The default value is 0 disabled Configuration saving saves this information If n...

Page 146: ...ction one of IP data controlled by the IPCP protocol or MAC data for BCP If neither is provided ip is assumed If the channel is not linked to an interface and the channel is for IP data the channel is...

Page 147: ...e Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 137 10 17 3 Example ppp 3 pvc 3 32 set channel 3 to be VPI 3 VCI 32 ppp 4 pvc read PVC settings for channel 4 ppp 5 pvc 0 remove...

Page 148: ...r the connection If two values are specified then they are the transmit and receive PCRs respectively If called while not attached to a VC then the settings are saved for use when a VC is created If t...

Page 149: ...vide the given IP address to the remote end of the connection PPP will refuse to complete the connection if the other end will not accept this This is normally used for channels on which the remote pa...

Page 150: ...round Because of this exact names and passwords are not attached to individual channels but are matched to particular users as defined using the user command This command specifies that when using thi...

Page 151: ...nnel with the specified PPTP tunnel A single PPP channel can only be associated with a single interface or a single tunnel Use info to find the current setting Calling with n 0 removes any association...

Page 152: ...the far end when a connection is established A name and password are supplied and whether these should be used with the PAP or CHAP authentication protocol CHAP is the default To remove this informat...

Page 153: ...rs for BCP the Bridge Control Protocol which is used to transport MAC Ethernet packets over the PPP link If stp is specified the Spanning Tree Protocol is in use by the Bridges to control bridge loops...

Page 154: ...for a particular interface the local IP address to be associated with the local end For interface 1 this should be the same IP address as possessed by the device ppp_device in the IP stack See the IP...

Page 155: ...scription The interface is regarded by the operating system as an Ethernet like device which can be attached to the bridge or router like other Ethernet devices in ATMOS It also provides an ifEntry to...

Page 156: ...nts an individual When user is called on its own information about all existing users is listed When user name is called with no further arguments details of that user alone are printed Passwords are...

Page 157: ...ommands ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 147 10 27 version 10 27 1 Syntax version 10 27 2 Description Provide the version number for the source of th...

Page 158: ...version 148 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 159: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 149 11 PPTP Console commands This chapter describes the PPTP Point to Point Tunnelling Protocol Console commands...

Page 160: ...the PPTP Access Concentrator PAC Obviously the PPP client or server and the PNS must also be configured Dial Out The PPTP process uses functionality provided by the PPP process Configure PPP channel...

Page 161: ...gure the PPTP process to bind to an Ethernet interface with an IP address for example 192 168 10 1 and set up tunnel 1 with the PAC initiating the connection to a PNS with IP address for example 192 1...

Page 162: ...ny interface If none is specified no incoming control connections will be accepted in this case tunnels may only be established via the local create and connect commands Configuration saving saves thi...

Page 163: ...o the remote PNS that create specified establishing the control connection 11 3 3 Example To connect tunnel 1 to configured PNS enter pptp 1 connect 11 3 4 See also tunnel create on page 154 using the...

Page 164: ...for use by an incoming control connection from a remote PNS At least one such tunnel must exist if any incoming connections are to be accepted at all Incoming connections are mapped to the first avai...

Page 165: ...ax tunnel delete 11 5 2 Description Delete a tunnel object the opposite of create If the tunnel is currently connected any active data connections across the tunnel are terminated and the control conn...

Page 166: ...nnection is closed If the tunnel object is associated with a particular remote PNS as created with tunnel create ipaddress it may be reconnected later either explicitly with another connect command or...

Page 167: ...guration saving does not save this value The default event level is 1 only very serious errors are reported The Event levels are listed in the table below Level Description 1 Only very serious errors...

Page 168: ...th April 2001 11 8 tunnel info 11 8 1 Syntax tunnel info all 11 8 2 Description Provide information about the current settings of this tunnel This includes all configured state and also current protoc...

Page 169: ...sole Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 159 11 9 list 11 9 1 Syntax list 11 9 2 Description Lists all currently created tunnel objects and the IP address of the remo...

Page 170: ...160 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 11 10 version 11 10 1 Syntax version 11 10 2 Description Provide the version number for the source of the pptp...

Page 171: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 161 12 TCP IP Console commands This chapter describes the TCP IP Console commands...

Page 172: ...ows the console commands mentioned in the ip help output and which set some configuration that is saved in flash memory Command Shown by Help Saved in configuration abort arp arprouting autoloop confi...

Page 173: ...2001 163 The key for the above table is shown below restart rip route routeflush routes snmp stats subnet trace untrace uptime version Symbol Description Yes May be inserted explicitly in isfs resolve...

Page 174: ...s of the software it may be unwise to rely on their working in the same way in later versions of the software There are also some obsolescent features that are supported only for commands presented to...

Page 175: ...n as shown by the files command Currently ATMOS IP version 1 29 this seems to be unreliable on UDP associations and can cause a crash possibly because of lax error handling by the application that ope...

Page 176: ...s happened Entries added with arp add do not time out like those discovered by use of the ARP protocol but they are deleted by arp flush and will not survive a restart they are not saved by configurat...

Page 177: ...ether 192 168 50 1 08 00 20 19 9a d9 forever arp add ether 192 168 50 57 00 20 af 2e fa 3c 3m13s prompt ip arp flush prompt ip arp atm ARP table is empty ether ARP table is empty prompt ip arp arp add...

Page 178: ...ption The arprouting command was intended to control whether a router would perform proxy ARP on an Ethernet like interface that is reply with its own MAC address to an ARP request for any IP address...

Page 179: ...loopback addresses 127 will be looped back Configuration saving saves this information By default autoloop is disabled The autoloop command is hidden not shown by ip help 12 5 3 Example prompt ip aut...

Page 180: ...p if that process is present However when accessed through the config process the snmp configuration is included 12 6 3 Example prompt ip config 192 168 88 50 ip config device add ipoa atmpvc atm mtu...

Page 181: ...on saved 12 6 4 See also snmp on page 214 The other commands which are used for setting configuration displayed and saved by config are listed below autoloop on page 169 device on page 172 ipatm help...

Page 182: ...d are described below i f is an arbitrary label for the interface which is used in referring to it in subsequent commands It is often chosen to be the same as type though this is perhaps slightly conf...

Page 183: ...IP over ATM MTU value has been changed in the TCP IP build time configuration system file Normally there is no point in setting the MTU less than this so the mtu option is of little use IP address is...

Page 184: ...0 192 168 2 1 device ipoa atmpvc atm mtu 1500 192 168 55 1 prompt ip device add loop loop 127 0 0 1 prompt ip device delete ipoa prompt ip device type dev file IP address device ether ether edd mtu 15...

Page 185: ...75 12 8 disable 12 8 1 Syntax disable i f 12 8 2 Description Disables all interfaces or just a specified interface 12 8 3 Example prompt ip disable ethernet prompt ip device type dev file IP address d...

Page 186: ...interface when enabling it or change them on an interface that is already enabled see device on page 172 for details on the interfaces Configuration saving saves the MTU and IP addresses but not the...

Page 187: ...il 2001 177 12 10 errors 12 10 1Syntax errors 12 10 2Description Turns on tracing of various unusual events equivalent to trace errors The errors command is hidden not shown by ip help 12 10 3Example...

Page 188: ...12 11 etherfiles 12 11 1Syntax etherfiles 12 11 2Description Lists the file names for the underlying devices for all Ethernet like interfaces The etherfiles command is hidden not shown by ip help 12 1...

Page 189: ...host it may change each time a packet is sent to a different destination In other cases it will normally change only as a result of routing changes The files command is hidden not shown by ip help 12...

Page 190: ...n number see files on page 179 that corresponds to a TCP association this does a TCP push see RFC 793 which roughly speaking causes the data sent so far to be delivered as quickly as possible to the r...

Page 191: ...14 1Syntax get file 12 14 2Description Reads and executes commands from a file The commands in the file are in the same format as those documented in this chapter with no ip prefix They can contain c...

Page 192: ...n Summary on page 162 some commands are hidden and are not displayed by help or help all help is still available on these using the help cmd form if you know the name of the command 12 15 3Example pro...

Page 193: ...ATM connections listens and slots for available connections 12 16 3Example prompt ip ipatm files i f atm 0 transmissions queued 6 free connections 4 listeners 0 on atm Connected to 192 168 220 48 idle...

Page 194: ...p 12 17 1Syntax ipatm help cmd all 12 17 2Description Displays help on ipatm subcommands 12 17 3Example prompt ip ipatm help Commands are abort arp arpserver files help lifetime pvc Use ip ipatm help...

Page 195: ...he PVC The range of possible VPIs depends on the system vci is the VCI to use for the PVC The range of possible VCIs depends on the system IP address is the IP address of the machine at the other end...

Page 196: ...itch ip device add ipoa atm The following commands can be used to create and configure PVCs The label ipoa is used to refer to the device myswitch ip ipatm pvc add ipoa a3 60 myswitch ip ipatm pvc add...

Page 197: ...en an IP address and a symbolic name deletes all such mappings lists the mappings or displays help on the iphostname command The symbolic names can be used in most IP commands where an IP address is r...

Page 198: ...nterface name is the name as listed by the ip device command NAT should always be enabled only on the interface connecting to the public network not the interface connecting to the private network 12...

Page 199: ...21 noerrors 12 21 1Syntax noerrors 12 21 2Description Undoes the effect of the errors command equivalent to untrace errors The noerrors command is hidden not shown by ip help 12 21 3Example prompt ip...

Page 200: ...between interfaces see the relay command for more details The command norelay with no parameters is equivalent to norelay all it turns off all forwarding Configuration saving saves this information 1...

Page 201: ...message if none arrives it reports the lack of a reply and returns the TELL message or redisplays the prompt Any reply arriving after this time out will be reported as a background message Whereas a r...

Page 202: ...tes LPORT and RPORT provided the protocol type UDP or TCP is appropriate They are also displayed in place of port numbers when a suitable mapping exists protocol should be either UDP or TCP it can be...

Page 203: ...TCP IP Console commands ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 193 someport 105 TCP...

Page 204: ...2 25 2Description Displays information on the protocols supported by ATMOS TCP IP The output will always be the same for a given version of ATMOS TCP IP The protocols command is hidden not shown by ip...

Page 205: ...ing use the norelay command See norelay on page 190 Configuration saving saves this information By default all forwarding is disabled 12 26 3Example prompt ip relay No relaying is being performed prom...

Page 206: ...0 PS Draft B 26th April 2001 prompt ip relay ether forward relay ether ether relay ether atm forward prompt ip relay ether atm relay ether ether relay ether atm prompt ip relay all relay ether ether r...

Page 207: ...0 PS Draft B 26th April 2001 197 12 27 restart 12 27 1Syntax restart 12 27 2Description Reboots the system This command is deprecated To reboot the system use the restart command from the ATMOS top le...

Page 208: ...58 or RIP version 2 RFC 1723 ATMOS TCP IP will accept incoming information on each interface Configuration saving saves this information By default both RIP versions are accepted on all interfaces rip...

Page 209: ...99 12 29 rip allowed 12 29 1Syntax rip allowed 12 29 2Description Displays the RIP versions that will be accepted and sent on each interface 12 29 3Example prompt ip rip allowed rip send ether 2 rip s...

Page 210: ...rip boot 12 30 2Description Broadcasts a request for RIP information from other machines ATMOS TCP IP does this automatically when it first starts up and the routing information should be kept up to d...

Page 211: ...cmd all 12 31 2Description Displays help on rip subcommands 12 31 3Example prompt ip rip help Commands are accept allowed boot help hostroutes killrelay poison relay relays rxstatus send trigger Use t...

Page 212: ...he network containing the host RIP version 2 routes to individual hosts will be ignored The reason for this difference is that RIP version 1 does not allow specification of subnet masks a RIP version...

Page 213: ...ence Manual Binary DO 008530 PS Draft B 26th April 2001 203 12 33 rip killrelay 12 33 1Syntax rip killrelay relay 12 33 2Description Deletes a RIP relay See the rip relay command for more information...

Page 214: ...or clears the poisoned reverse flag If this flag is on ATMOS TCP IP performs poisoned reverse as defined in RFC 1058 see that RFC for discussion of when this is a good thing To see the state of the fl...

Page 215: ...ing RIP on a non broadcast medium currently only IP over ATM on such an interface ATMOS TCP IP will send RIP information individually to each configured RIP relay instead of broadcasting it Note RIP r...

Page 216: ...Reference Manual Binary DO 008530 PS Draft B 26th April 2001 12 36 rip relays 12 36 1Syntax rip relays 12 36 2Description Displays the configured RIP relays See rip relay for information on RIP relays...

Page 217: ...RIP packet reception mechanism This command is mainly used for debugging purposes 12 37 3Example prompt ip rip rxstatus RIP has 2 reading threads and 1 worker The worker is waiting for something to do...

Page 218: ...rface If both versions are specified routing information is broadcast in duplicate once using each version Specifying all affects all interfaces except the loopback interface if any Configuration savi...

Page 219: ...r 12 39 1Syntax rip trigger 12 39 2Description Triggers broadcast of routing information Normally the routing information is broadcast every 30 seconds rip trigger causes it to be sent almost immediat...

Page 220: ...0 0 0 0 is a default route matches everything without a more specific route ff ff ff 0 would match a Class C network ff ff ff ff is a route to a single host Note the default is not always sensible in...

Page 221: ...the route was added recently and RIP has not yet processed the change the asterisk should disappear within 30 seconds when RIP next considers broadcasting routing information Configuration saving save...

Page 222: ...s from the route table If an interface i f is specified only routes through the named interface are removed If all is not specified only host routes those with a mask of ff ff ff ff are removed The ro...

Page 223: ...3 12 42 routes 12 42 1Syntax routes 12 42 2Description Lists routes The same as route with no parameters 12 42 3Example prompt ip routes route add testnet1 192 168 101 0 192 168 2 34 ff ff ff 00 1 MAN...

Page 224: ...list of SNMP community names also used as passwords by other applications such as telnet and the list of SNMP trap destinations The snmp version command displays the version number of ATMOS SNMP Note...

Page 225: ...Displays or clears a subset of IP statistics 12 44 3Example prompt ip stats udp ip UDP receptions delivered to users 0 ip UDP receptions with no users 170 ip Otherwise discarded UDP receptions 0 ip Tr...

Page 226: ...of dest corresponding to bits set in mask are relevant mask is the subnet mask of the subnet being defined specified as four hexadecimal numbers separated by colons A subnet is defined automatically f...

Page 227: ...ubnet ipoa home 192 168 55 0 ff ff ff 00 ipoa subnet ether home 192 168 2 0 ff ff ff 00 ether prompt ip subnet add ipoa home 192 168 55 1 ff ff fc 0 prompt ip subnet subnet ipoa home 192 168 52 0 ff f...

Page 228: ...n and reception on that association for a UDP association it has no effect The files command shows by appending TRACE whether each association has tracing enabled An interface name see the command dev...

Page 229: ...nds ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 219 ip currently tracing nothing prompt ip trace tcp ip currently tracing tcp 12 46 4See also errors on page 177...

Page 230: ...il 2001 12 47 untrace 12 47 1Syntax untrace option 12 47 2Description Turns off IP tracing options The syntax is the same as for trace in particular untrace all turns off all tracing The untrace comma...

Page 231: ...48 uptime 12 48 1Syntax uptime 12 48 2Description Displays the time for which the ATMOS system has been running Note This command is deprecated To display this information use the uptime command from...

Page 232: ...Description Displays the version of the IP process ATM address and MAC address An obsolescent option ip still exists but version ip now displays misleading information and should not be used 12 49 3Ex...

Page 233: ...e Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 223 12 50 12 50 1Syntax cmd all 12 50 2Description The command is simply a synonym for the help command and behaves in the same...

Page 234: ...224 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 235: ...ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001 225 13 TFTP Console commands This chapter describes the TFTP Console commands...

Page 236: ...paddresses configuration file or an IP address in the form abc def ghi jkl If the node name is not recognised or the IP address does not convert correctly an error is signalled The non appearance of a...

Page 237: ...rom the remote host previously specified using the connect command Only files that fit within the file storage area within the session data currently 8K can be retrieved This means that it not possibl...

Page 238: ...lists the commonly used TFTP commands The init command is not listed in the help text The trace command has a large number of optional parameters and detail on this command may be displayed by typing...

Page 239: ...B 26th April 2001 229 13 4 init 13 4 1 Syntax init 13 4 2 Description The init command causes all sessions to be initialised to an idle state This command can be used during testing but is not requir...

Page 240: ...nce Manual Binary DO 008530 PS Draft B 26th April 2001 13 5 list 13 5 1 Syntax list 13 5 2 Description The list command displays the status of any active sessions This command is primarily intended fo...

Page 241: ...2 Scope Client mode only 13 6 3 Description The put command requests TFTP to transmit a file to the remote host previously specified using the connect command By default the file is named remotely as...

Page 242: ...trace help event1 event2 13 7 2 Description The trace command allows the user to examine the currently set trace types or add subtract trace types Trace help lists all the available tracing types If...

Page 243: ...erence Manual Binary DO 008530 PS Draft B 26th April 2001 233 13 8 version 13 8 1 Syntax version 13 8 2 Description The version command displays software version information about the process 13 8 3 E...

Page 244: ...version 234 ATMOS Console Commands Reference Manual Binary DO 008530 PS Draft B 26th April 2001...

Page 245: ...channel enable PPP 115 channel event PPP 116 channel hdlc PPP 117 channel info PPP 118 channel interface PPP 119 channel lcpmaxconfigure PPP 120 channel lcpmaxfailure PPP 121 channel lcpmaxterminate...

Page 246: ...Nat 104 help ATMOS 28 help Bun 55 help DHCPClient 75 help DHCPServer 84 help IP 173 help Nat 93 help TFTP 222 I inbound Nat 95 info ATMOS 29 info Bridge 44 info Nat 97 init TFTP 223 interface Bridge 4...

Page 247: ...un 71 restart ATMOS 8 restart IP 192 rh ATMOS 31 rip accept IP 193 rip allowed IP 194 rip boot IP 195 rip help IP 196 rip hostroutes IP 197 rip killrelay IP 198 rip poison IP 199 rip relay IP 200 rip...

Page 248: ...create PPTP 144 tunnel delete PPTP 145 tunnel disconnect PPTP 146 tunnel event PPTP 147 tunnel info PPTP 148 typographical conventions 3 U unbind ATMOS 23 untrace IP 215 uptime ATMOS 9 uptime IP 216...

Search results

Summary of Contents for ATMOS Console

Reviews:

Related manuals for ATMOS Console

Brands by name

Popular brands

VIRATA ATMOS Console, Command Reference Manual

Search results

Summary of Contents for ATMOS Console

Reviews:

Related manuals for ATMOS Console

Brands by name

Popular brands