Chapter 1 Operation Introduction ................................................................................................... 1-4 The Command Processor ............................................................................... 1-4 Normal Mode and Security Mode ............................................................ 1-4 User Privilege Levels ................................................................................. 1-7 Remote Security Officer ........................................
1-2 AR Series Router Reference Manual Releases ................................................................................................ 1-33 Patches ................................................................................................. 1-35 Router Startup Operations ..................................................................... 1-35 Downloading Releases and Patches into the Router ............................... 1-37 Install Information ...........................................
Operation 1-3 SET HTTP SERVER .................................................................................. 1-81 SET INSTALL .......................................................................................... 1-82 SET LOADER .......................................................................................... 1-83 SET MAIL ............................................................................................... 1-85 SET MANAGER PORT ..................................................
1-4 AR Series Router Reference Manual Introduction This section describes the functions and commands available on the router to support day-to-day operational and network management activities. The commands described in this section fall into six functional groups: ■ The command processor and router configuration. ■ The User Authentication Facility. ■ Monitoring and fault diagnosis of the router and the network. ■ Managing the nonvolatile storage (NVS).
Operation 1-5 security functions such as IP authentication, Secure Shell (see Chapter 32, Secure Shell), encryption (Chapter 15, Compression and Encryption Services) or IPsec (Chapter 34, IP Security (IPsec)). Security mode is enabled using the command: ENABLE SYSTEM SECURITY_MODE which also creates a security mode enabler file in the router’s file subsystem. This file can not be manually modified, displayed, deleted, copied or renamed.
1-6 AR Series Router Reference Manual Table 1-1: Commands requiring SECURITY OFFICER privilege when the router is operating in security mode.
Operation 1-7 Table 1-1: Commands requiring SECURITY OFFICER privilege when the router is operating in security mode.
1-8 AR Series Router Reference Manual ■ Using the command: LOGIN from any port or Telnet session to login under a login name that has MANAGER privilege. The command prompts for a login name and password. The password is case-sensitive and must be entered exactly as defined. If the password is entered correctly, the port or Telnet connection gains MANAGER privilege and the prompt changes to the MANAGER level prompt.
Operation 1-9 Remote Security Officer The Remote Security Officer (RSO) feature enables a remote user to connect to a router via Telnet from an authorised IP address, and login using a login name with SECURITY OFFICER privilege as if the user were at a terminal connected directly to the router. By default the Remote Security Officer feature is disabled.
1-10 AR Series Router Reference Manual Table 1-2: Command line editing functions and keystrokes.
Operation 1-11 Figure 1-1: Using the question mark character (“?”) to display help for the current command.
1-12 AR Series Router Reference Manual The CREATE CONFIG command on page 1-49 writes the MD5 digest, not the cleartext, of passwords in commands to the configuration file. When a configuration script is executed the command processor can determine whether the password value is cleartext or an MD5 digest. If the file name specified is boot.
Operation 1-13 The users authenticated by the UAF can be operators or other routers. If the user is another router, the authentication will occur without appearing in a terminal screen. The UAF supports three methods of user authentication, an internal database called the User Authentication Database, and interrogation of external RADIUS (Remote Authentication Dial In User Service) or TACACS (Terminal Access Controller Access System) servers. The UAF first queries the User Authentication Database.
1-14 AR Series Router Reference Manual Additional users can be added to the User Authentication Database using the command: ADD USER=login-name PASSWORD=password [CALLINGNUMBER=number] [CBNUMBER=e164number] [DESCRIPTION=description] [PRIVILEGE={USER|MANAGER|SECURITYOFFICER}] [TELNET={YES| NO}] [IPADDRESS=ipadd] [IPXNETWORK=network] [NETMASK=ipadd] [MTU=40..1500] The number of entries in the database is limited only by the amount of memory available. Only the login name and password must be specified.
Operation 1-15 ■ Do include both uppercase and lowercase characters. The passwords stored by the router are case-sensitive, so “bgz4kal” and “Bgz4Kal” are different. ■ Do avoid words found in a dictionary, unless combined with other random alphabetic and numeric characters. ■ Do not use the login name, or the word “password” as the password. ■ Do not use your name, your mothers name, your spouses name, your pets name, or the name of your favourite cologne, actor, food or song.
1-16 AR Series Router Reference Manual Table 1-3: Secure commands controlled by the security timer. Command Description ADD TACACS SERVER Adds a TACACS server to the list of TACACS servers used for user authentication. ADD USER Adds a user to the User Authentication Database. DELETE TACACS SERVER Deletes a TACACS server from the list of TACACS servers used for user authentication. DELETE USER Deletes a user from the User Authentication Database.
Operation 1-17 Recovering Lost Passwords If a user forgets their password, the password can be reset from an account with MANAGER privilege, using the command: SET USER=login-name PASSWORD=password Passwords for accounts with MANAGER privilege can be reset with the same command, provided the manager can login to at least one account with MANAGER privilege.
1-18 AR Series Router Reference Manual Telneting from the Router The router provides three modes of access to host services: ■ Using the CONNECT command on page 11-13 of Chapter 11, Terminal Server to access asynchronous services. These are typically hosts connected directly to asynchronous ports on the router and defined as services using the SET SERVICE command on page 11-17 of Chapter 11, Terminal Server.
Operation 1-19 All counters are stored in nonvolatile storage so that they are retained across router reboots and power cycles.
1-20 AR Series Router Reference Manual Table 1-4 on page 1-20 lists the RADIUS attributes supported by the router. Table 1-4: RADIUS attributes supported by the router. RADIUS Attribute Name When Used Description User-Name Authentication request Accounting request The name of the user to be authenticated. User-Password Authentication request The password of the user to be authenticated, or the user’s input following an Access-Challenge.
Operation 1-21 TACACS The router supports the use of TACACS (Terminal Access Controller Access System) servers as an alternative method of user authentication. The router sends a TACACS request, which includes the username and password, to each TACACS server in turn. The TACACS server responds with an “accept” or “reject” response. If the response is “accept” then the user is authenticated. If the response is “reject”, a request is sent to the next server in the list until all servers have been queried.
1-22 AR Series Router Reference Manual Monitoring and Fault Diagnosis Event Logging The router responds to certain significant events by generating an event log message. Each router maintains a local event log of the most recent log messages. To view the log, use the command: SHOW LOG The logging facility provides a powerful, flexible and easily configurable tool for monitoring network activity and selecting and displaying the results.
Operation 1-23 likely to be a problem with the router itself. The problem can be corrected in the short term by restarting the router, but it should be reported to your supplier. Fast buffer memory, on power PC based routers and switches only) is cached by the CPU and is available only for program variable storage. It cannot be used for packet buffers.
1-24 AR Series Router Reference Manual Nonvolatile Storage (NVS) The nonvolatile storage (NVS) module provides a facility to store information so that it is not destroyed when the router is reset or powered off. The type of information that may be stored in the NVS are module configuration tables, interface configurations, patches and script files. The NVS is organised as blocks of contiguous memory of varying size.
Operation 1-25 deleted, read and written by any router module. Files can also be manipulated directly using the command line interface. This allows FLASH to be used to store any type of data, including releases, patches, configurations and logs. Physical Characteristics FLASH memory is a special type of nonvolatile memory which can be erased and reprogrammed many times in-situ.
1-26 AR Series Router Reference Manual ■ filename is a descriptive name for the file, and may be one to eight characters in length. Valid characters are lowercase letters (a–z), uppercase letters (A–Z), digits (0–9) and the hyphen character (-). ■ ext is a file name extension, one to three characters in length. Valid characters are lowercase letters (a–z), uppercase letters (A–Z), digits (0–9) and the hyphen character (-).
Operation 1-27 Working With Files To display a directory of the files stored on the router, in both FLASH and NVS, use the command: SHOW FILE To limit the display to certain files, use the command: SHOW FILE=filename filename may contain wildcard characters. Files can be permanently deleted using the command: DELETE FILE=filename filename may contain wildcard characters.
1-28 AR Series Router Reference Manual Wildcards are allowed in the filename and ext fields of the file name, but are not allowed in the device field. The file is marked as deleted but the space occupied by the file is not freed until the next compaction process. The FLASH memory can be completely erased using the command: CLEAR FLASH TOTALLY This command totally erases all stored FLASH information and reformats the FLASH file structure.
Operation 1-29 command line (Figure 1-3 on page 1-29). The status bar displays the current file name, line and column position in the file and the editing mode (overstrike or insert). When additional command information is required, such as a file name or search text, then a prompt is displayed in the status bar. Figure 1-3: The editor screen layout.
1-30 AR Series Router Reference Manual When a user attempts to access the router via a web browser, the HTTP server will request authentication from the browser. The browser will prompt the user for a username and password (Figure 1-4 on page 1-30). Figure 1-4: Logging in to the router from a web browser. The username and password entered by the user must match a user defined in the User Authentication Database (see “The User Authentication Database” on page 1-13).
Operation 1-31 Configuration Wizard to download updates from a support web site. To display the current status of the HTTP client, use the command: SHOW HTTP CLIENT Resolving Uniform Resource Locators (URLs) When the HTTP server receives a request for a URL, it uses the following procedure to resolve the URL: ■ If the URL matches the name of a file stored in the router’s FLASH memory, the file will be loaded and sent to the browser.
1-32 AR Series Router Reference Manual The progress of mail messages can be monitored using the mail subsystem’s debugging option, which is enabled or disabled with the commands: ENABLE MAIL DEBUG DISABLE MAIL DEBUG Configuration Examples The following procedures illustrate the steps required to configure the mail subsystem and transmit email messages. It is assumed that IP has already been enabled and correctly configured on the router. To configure the mail subsystem: 1. Configure a DNS Server.
Operation 1-33 The script contains the following line: MAIL TO=netman@company.com SUBJECT=”WARNING: Load high” MESSAGE=”CPU utilisation exceeded 80%” Note that it is not necessary to identify the router in either the Subject field or the message as the mail system automatically inserts the router’s host name in the From field of the message header. 2. Create a trigger to activate the script.
1-34 AR Series Router Reference Manual where mm identifies the router model (Table 1-7 on page 1-34) and rrr is the release number (e.g. 761 for Software Release 7.6.1). Table 1-7: Software Release filename formats Filename Format Router Model 8-rrr.REL AR300 Series routers 52-rrr.REL AR720 router 18-rrr.REL Network iQ 1800 Series routers 28-rrr.REL Network iQ 1000/2800/3000/3800 Series routers 48-rrr.
Operation 1-35 A software release is specific to a particular router series. It is not possible to run a release on any router series other than that for which the release was made. The same router release will, however, run on all models in the same series. If an attempt is made to load the wrong software release into the router the boot process will fail. Patches A router patch contains changes to the router software.
1-36 AR Series Router Reference Manual If a terminal is connected to port 0, a series of status and progress messages, similar to those shown in Figure 1-5 on page 1-36, are displayed during the startup process. Figure 1-5: Router startup messages. INFO: INFO: PASS: INFO: PASS: PASS: INFO: INFO: Force INFO: INFO: INFO: Self tests beginning. RAM test beginning. RAM test, 4096k bytes found. BBR tests beginning. BBR test, 128k bytes found. BBR test. Battery OK.
Operation 1-37 Downloading Releases and Patches into the Router The LOADER module is responsible for loading and storing releases, patches and other files into either NVS or FLASH. The LOADER module uses the Trivial File Transfer Protocol (TFTP), Hypertext Transfer Protocol (HTTP) or ZMODEM over an asynchronous port, to retrieve files from a network host. The FFS and NVS modules are used to create, write and destroy release and patch files.
1-38 AR Series Router Reference Manual The header in the release or patch file should not be altered. At best, this will cause the file load or install to fail, at worst the router could be put into a state where it will not boot correctly until field service action is taken. Install Information The INSTALL module is responsible for maintaining install information and loading the correct install at boot. An install is a record identifying a release and an optional patch.
Operation 1-39 To display the current install information, including which install is currently running in the router, and how the install information was checked at the last reboot, use the command: SHOW INSTALL Examples Installing a Standard Release using TFTP This example assumes that the router is correctly configured to allow TFTP to function. This means that IP has been configured and the router is able to communicate with the designated TFTP server.
1-40 AR Series Router Reference Manual The install information can be checked with the command: SHOW INSTALL The router is then rebooted, and the install is checked again. This display should indicate, in the install history, that the temporary install was loaded. 5. Make the release the default (permanent) release. If the router operates correctly with the new release, the release may be made permanent with the command: SET INSTALL=PREFERRED RELEASE=8-761.
Operation 1-41 2. Download the release files to the router. The compressed release files are downloaded to the router with the commands: LOAD FILE=8-761.REZ The process of downloading a release file can take some time, even if the router and the TFTP server are connected by high speed links. An indicative time for downloading a release over Ethernet is 5 to 10 minutes.
1-42 AR Series Router Reference Manual 2. Test the patch. As with the release, the patch should first be checked by incorporating it into a temporary install, with the command: SET INSTALL=TEMPORARY RELEASE=EPROM PATCH=8761-01.PAZ The router is then rebooted, and the install is checked again. This display should indicate, in the install history, that the temporary install was loaded. 3. Make the patch the default (permanent) patch.
Operation ACTIVATE FLASH COMPACTION 1-43 Command Reference This section describes the commands available on the router to support day-today operational and management activities. See “Conventions” on page lxxi of Preface for details of the conventions used to describe command syntax. See Appendix B, Messages for a complete list of messages and their meanings. ACTIVATE FLASH COMPACTION Syntax Description ACTIVATE FLASH COMPACTION This command activates the FLASH compaction process.
1-44 ADD ALIAS AR Series Router Reference Manual ADD ALIAS Syntax ADD ALIAS=name STRING=substitution Where: Description ■ name is a character string 1 to 132 characters in length. It may contain any printable character. If name contains spaces it must be enclosed in double quotes. It is case-sensitive. ■ substitution is a character string 1 to 132 characters in length. It may contain any printable character. If substitution contains spaces it must be enclosed in double quotes. It is case-sensitive.
Operation ADD RADIUS SERVER 1-45 ADD RADIUS SERVER Syntax ADD RADIUS SERVER=ipadd SECRET=secret PORT=port-number ACCPORT=port-number where: Description ■ secret is a character string, 1 to 63 characters in length. It may contain uppercase letters (A–Z), lowercase letters (a–z), digits (0–9) and the underscore character (“_”). If the string contains spaces it must be enclosed in double quotes. It is case-sensitive. ■ ipadd is an IP address in dotted decimal notation.
1-46 ADD TACACS SERVER See Also AR Series Router Reference Manual DELETE RADIUS SERVER SHOW RADIUS ADD TACACS SERVER Syntax ADD TACACS SERVER=ipadd where: ■ Description ipadd is an IP address in dotted decimal notation. This command adds a TACACS server to the list of TACACS servers used for authenticating login names. The SERVER parameter specifies the IP address of the server in dotted decimal notation.
Operation ADD USER Description ■ ipadd is an IP address in dotted decimal notation. ■ network is a valid Novell network number, expressed as a hexadecimal number. Leading zeros may be omitted. 1-47 This command adds a user to the User Authentication Database. The USER parameter specifies the login name for the user. It is case insensitive. The PASSWORD parameter specifies the password for the user. The password is case sensitive.
1-48 ADD USER RSO AR Series Router Reference Manual The IPADDRESS, NETMASK and MTU parameters are only required if the user is to login in order to make a PPP or SLIP connection to the router over a modem connected to an asynchronous port.
Operation CREATE CONFIG 1-49 For security reasons this command will only be accepted if the user has SECURITY OFFICER privilege. Examples To add the IP addresses 192.168.11.7 and 192.168.202.9 as Remote Security Officers, use the commands: ADD USER RSO IP=192.168.11.7 ADD USER RSO IP=192.168.202.9 See Also DELETE USER RSO DISABLE USER RSO ENABLE USER RSO SHOW USER RSO CLEAR FLASH TOTALLY Syntax Description CLEAR FLASH TOTALLY This command completely clears the FLASH memory to an erased state.
1-50 CREATE FFILE AR Series Router Reference Manual The CONFIG parameter specifies the name of the script or configuration file to create. The file extension must be “scp” or “cfg”. If the file already exists, it is replaced. If the file does not exist it is created. The CREATE CONFIG command on page 1-49 writes the MD5 digest, not the cleartext, of passwords in commands to the configuration file.
Operation DELETE ALIAS 1-51 Care must be taken when using this command to avoid creating an invalid file which a module will then try to use. If a module recognises the file name it may try to use the file, with unpredictable results if the file contents are not in the expected format. Do not use this command unless specifically instructed to do so by your distributor or reseller. Examples To create a file called FLASH:TINY.
1-52 DELETE FFILE AR Series Router Reference Manual DELETE FFILE Syntax DELETE FFILE=filename where: ■ Description filename is a file identifier of the form device:filename.ext. Valid characters are the lowercase letters (a–z), digits (0–9) and the hyphen character (-). Wildcards are allowed in the name and extension elements. This command deletes an FFS file. Wildcards are allowed in the name and type elements of the file identifier.
Operation DELETE INSTALL 1-53 For security reasons this command will only be accepted if the user has SECURITY OFFICER privilege. Examples To delete all the patch files on the router, use the command: DELETE FILE=*:*.PAT To delete the release file 28-72.REL, use the command: DELETE FILE=28-72.REL See Also RENAME SHOW FILE DELETE INSTALL Syntax Description DELETE INSTALL={TEMPORARY|PREFERRED|DEFAULT} This command deletes the specified install from the install information.
1-54 DELETE MAIL AR Series Router Reference Manual DELETE MAIL Syntax DELETE MAIL=id where: ■ Description id is a hexadecimal number in the range 0x0 to 0xffff. This command deletes the specified mail message from the transmission queue. The MAIL parameter specifies the message id of the mail message to be deleted. The message id can be determined from the output of the SHOW SHOW MAIL command on page 1-116.
Operation DELETE USER 1-55 DELETE TACACS SERVER Syntax DELETE TACACS SERVER=ipadd where: ■ ipadd is an IP address in dotted decimal notation. Description This command deletes a TACACS server from the list of TACACS servers used for authenticating login names. The SERVER parameter specifies the IP address of the server in dotted decimal notation. Examples To delete the TACACS server with the IP address 172.16.8.5 use the command: DELETE TACACS SERVER=172.16.8.
1-56 DELETE USER RSO AR Series Router Reference Manual DELETE USER RSO Syntax DELETE USER RSO IP=ipadd where: ■ Description ipadd is an IP address in dotted decimal notation. This command deletes a Remote Security Officer address range from the remote access user list. Remote Security Officers who currently have SECURITY OFFICER privilege will lose SECURITY OFFICER privilege immediately. The IP parameter specifies the base IP address for this range of Remote Security Officer addresses.
Operation DISABLE HTTP DEBUG 1-57 DISABLE FEATURE Syntax DISABLE FEATURE={featurename|index} where: Description ■ featurename is a character string, 1 to 12 characters in length. Valid characters are any printable character. ■ index is a decimal number in the range 1 to the number of special feature licences. This command disables the specified special feature licence.
1-58 DISABLE HTTP SERVER See Also AR Series Router Reference Manual DISABLE HTTP SERVER ENABLE HTTP DEBUG ENABLE HTTP SERVER RESET HTTP SERVER SHOW HTTP CLIENT SHOW HTTP DEBUG SHOW HTTP SERVER SHOW HTTP SESSION DISABLE HTTP SERVER Syntax Description Examples DISABLE HTTP SERVER This command disables the HTTP server. The HTTP server serves HTML pages out of the router’s FLASH memory to a web browser, and allows users to login into the router. The server is enabled by default.
Operation DISABLE SYSTEM SECURITY_MODE 1-59 DISABLE RELEASE Syntax DISABLE RELEASE=release-name where: ■ Description release-name is the name of a release file, of the form device:filename.ext. Valid characters are the lowercase letters (a–z), digits (0–9) and the hyphen character (-). Wildcards are not allowed. This command removes the licence for the specified release file. The RELEASE parameter specifies the name of the release file. If the device field is not specified, the default is FLASH.
1-60 DISABLE USER AR Series Router Reference Manual DISABLE USER Syntax DISABLE USER=login-name where: ■ Description See Also login-name is a character string, 1 to 64 characters in length. Valid characters are uppercase letters (A–Z), lowercase letters (a–z), and decimal digits (0–9). The string may not contain spaces. This command temporarily disables a user login name. The login name must be currently enabled. The USER parameter specifies the login name for the user. It is case insensitive.
Operation DUMP 1-61 DUMP Syntax DUMP [ADDR=address] [LEN=length] [SIZE={BYTE|LONG|WORD}] [SPACE={SD|SP|UD|UP|UR}] where: Description ■ address is the first address (in hexadecimal) to be dumped. ■ length is the number of bytes (in hexadecimal) to dump. This command displays the contents of the router’s memory. The block of memory to be displayed is specified by the parameters ADDR, LEN and SPACE.
1-62 EDIT AR Series Router Reference Manual Figure 1-6: Example output from the DUMP command.
Operation EDIT 1-63 Table 1-10: Editor functions and keystrokes.
1-64 EDIT AR Series Router Reference Manual Figure 1-7: The editor screen layout. The editor is invoked with the command: EDIT [filename] The file name is optional as a file can be loaded, or a new file can be created from within the editor itself. The editor is currently limited to editing one file at a time. To overcome this limitation use the cut and paste facility to transfer text between files.
Operation ENABLE HTTP DEBUG 1-65 ENABLE FEATURE Syntax ENABLE FEATURE=featurename PASSWORD=password where: Description ■ featurename is a character string, 1 to 12 characters in length. Valid characters are any printable character. ■ password is a character string, at least 16 characters in length. Valid characters are hexadecimal characters (0–9, a–f, A–F). This command enables the special feature licence identified by the special feature licence name and password.
1-66 ENABLE HTTP SERVER Examples AR Series Router Reference Manual To enable debugging of authentication attempts and HTTP GET/SET messages, use the commands: ENABLE HTTP DEBUG=AUTH ENABLE HTTP DEBUG=MSG See Also DISABLE HTTP DEBUG DISABLE HTTP SERVER ENABLE HTTP SERVER RESET HTTP SERVER SET HTTP SERVER SHOW HTTP CLIENT SHOW HTTP DEBUG SHOW HTTP SERVER SHOW HTTP SESSION ENABLE HTTP SERVER Syntax Description Examples ENABLE HTTP SERVER This command enables the HTTP server.
Operation ENABLE RELEASE See Also 1-67 DISABLE MAIL DEBUG SHOW MAIL ENABLE RELEASE Syntax ENABLE RELEASE=release-name [PASSWORD=password] NUMBER=release-number where: Description ■ release-name is the name of a release file, of the form device:filename.ext. Valid characters are the lowercase letters (a–z), digits (0–9) and the hyphen character (-). Wildcards are not allowed. ■ password is the password to licence this release, expressed as a string of hexadecimal characters (A–F, 0–9).
1-68 ENABLE SYSTEM SECURITY_MODE Examples AR Series Router Reference Manual To enable release 28-761.rel with the password CE645398FBE for software release 7.6.1, use the command: ENABLE RELEASE=28-761.REL PASSWORD=CE645398FBE NUMBER=7.6.1 See Also DISABLE RELEASE SHOW RELEASE ENABLE SYSTEM SECURITY_MODE Syntax Description ENABLE SYSTEM SECURITY_MODE This command enables security mode on the router.
Operation HELP See Also 1-69 ADD USER DELETE USER DISABLE USER PURGE USER RESET USER SET USER SHOW USER ENABLE USER RSO Syntax Description ENABLE USER RSO This command enables Remote Security Officer access. Authorised IP addresses must be added with the ADD USER RSO command on page 1-48 before Remote Security Officer access can be used. For security reasons this command will only be accepted if the user has SECURITY OFFICER privilege.
1-70 LOAD AR Series Router Reference Manual LOAD Syntax LOAD [METHOD=TFTP] [DELAY=delay] [DESTINATION={FLASH|NVS}] [FILE=filename] [SERVER={hostname|ipadd}] LOAD [METHOD={HTTP|WEB|WWW}] [DELAY=delay] [DESTINATION={FLASH|NVS}] [FILE=filename] [HTTPPROXY={hostname|ipadd} [PROXYPORT=1..
Operation LOAD 1-71 valid file names are of the form filename.ext where filename is one to eight characters in length and ext is three characters in length. The following are examples of valid file names for methods TFTP, ZMODEM or NONE: \user\public\filename.ext ; UNIX or DOS server [network.cfg]filename.ext ; DEC VAX server Note that, starting at the end of the file name and working backwards, the first character not valid in file names delimits a valid file name for the router.
1-72 LOAD AR Series Router Reference Manual For security reasons this command will only be accepted if the user has SECURITY OFFICER privilege. Examples To download a release using the default values set previously with the SET LOADER command on page 1-83, use the command: LOAD To download release 28-761.rel into the FLASH File System from a TFTP server with an IP address of 172.16.8.5, with a delay of one minute, use the command: LOAD FILE=28-761.REL DESTINATION=FLASH SERVER=172.16.8.
Operation LOGIN 1-73 LOGIN Syntax LOGIN [login-name] where: ■ Description login-name is a character string, 1 to 64 characters in length. Valid characters are uppercase letters (A–Z), lowercase letters (a–z), and decimal digits (0–9). The string may not contain spaces. This command is used to login to the router. The User Authentication Facility prompts the user for a login name (if not specified) and a password. The user must enter appropriate responses, pressing [Return] after each response.
1-74 LOGOFF AR Series Router Reference Manual LOGOFF Syntax Description See Also LOGOFF This command is used to log out from the router. For a terminal attached to an asynchronous port, the port returns to its default prompting state, either the login prompt for a port in SECURE mode, or the command prompt. For a Telnet session the TCP connection is terminated. LOGOUT is an alias for the LOGOFF and both commands may be abbreviated to LO.
Operation MODIFY 1-75 The MESSAGE parameter specifies a single line of text to send in the body of the email. The parameters MESSAGE and FILE are mutually exclusive. The SUBJECT parameter specifies the subject line to appear in the email. This field is not required but should normally be present in an email. The ETRN parameter sends an ETRN request (as defined in RFC 1985) to the remote mail server to forward any queued mail messages for the specified mail domain or host name.
1-76 PURGE USER AR Series Router Reference Manual It is possible to use this command to modify any memory or I/O devices. This may interrupt the operation of the router. The MODIFY command is provided mainly as a diagnostic tool. It should not be needed for normal operation of the router. For security reasons this command will only be accepted if the user has SECURITY OFFICER privilege.
Operation RESET LOADER 1-77 Caution must be taken when renaming files, such as patches, releases, licences and configurations, since they contain information which is vital to the intended operation of the router. For security reasons this command will only be accepted if the user has SECURITY OFFICER privilege. Examples To rename the file boot.cfg to saveboot.cfg, use the command: RENAME BOOT.CFG SAVEBOOT.
1-78 RESET USER AR Series Router Reference Manual RESET USER Syntax RESET USER[=login-name] [COUNTER[={ALL|GLOBAL|USER}]] where: ■ Description login-name is a character string, 1 to 64 characters in length. Valid characters are uppercase letters (A–Z), lowercase letters (a–z), and decimal digits (0–9). The string may not contain spaces. This command is used to reset User Authentication Database counters for one or all users, or to reset global counters for the User Authentication Facility.
Operation RESTART 1-79 RESTART Syntax RESTART {REBOOT|ROUTER} [CONFIG0={filename|NONE}] where: ■ Description filename is a file name of the form device:filename.ext. Valid characters are the lowercase letters (a–z), digits (0–9) and the hyphen character (-). Wildcards are not allowed. This command restarts the router with either the current configuration file (set with the SET CONFIG command on page 1-80) or the specified configuration file.
1-80 SET CONFIG AR Series Router Reference Manual SET CONFIG Syntax SET CONFIG=filename where: ■ Description filename is a file name of the form device:filename.ext. Valid characters are the lowercase letters (a–z), digits (0–9) and the hyphen character (-). Wildcards are not allowed. This command sets the script file which the router will use as its default configuration. The file name is stored in either an NVS block if the router is fitted with NVS, or in a FLASH File System file.
Operation SET HTTP SERVER See Also 1-81 HELP SHOW SYSTEM SET HTTP SERVER Syntax SET HTTP SERVER HOMEPAGE=filename where: ■ Description Example filename is a filename 1 to 8 characters in length, followed by an extension of .HTM. Valid characters are lowercase letters (a–z), uppercase letters (A– Z), digits (0–9) and the hyphen character (-). The router does not distinguish upper- and lowercase letters. This command sets the home page for the router’s HTTP server.
1-82 SET INSTALL AR Series Router Reference Manual SET INSTALL Syntax SET INSTALL={TEMPORARY|PREFERRED|DEFAULT} [RELEASE={release-name|EPROM}] [PATCH[=patch-name]] where: Description ■ release-name is the name of a release file, of the form device:filename.ext. Valid characters are the lowercase letters (a–z), digits (0–9) and the hyphen character (-). Wildcards are not allowed. ■ patch-name is the name of the patch file to set in this install.
Operation SET LOADER 1-83 SET LOADER Syntax SET LOADER [DELAY={delay|DEFAULT}] [DESTINATION={FLASH| NVS|DEFAULT}] [FILE=filename] [HTTPPROXY={hostname| ipadd|DEFAULT}] [METHOD={HTTP|TFTP|WEB|WWW|ZMODEM|NONE| DEFAULT}] [PORT={port|DEFAULT}] [PROXYPORT={1..65535| DEFAULT}] [SERVER={hostname|ipadd|DEFAULT}] where: Description ■ delay is a time delay, in seconds. ■ filename is a character string, 1 to 100 characters in length.
1-84 SET LOADER AR Series Router Reference Manual Note that, starting at the end of the file name and working backwards, the first character not valid in file names delimits a valid file name for the router. If the slash at the beginning of the path is omitted in this command, the LOAD command adds it. The following are examples of valid file names for method HTTP: /path/filename.ext path/filename.ext The HTTPPROXY parameter specifies the proxy server used to handle HTTP requests.
Operation SET MAIL Examples 1-85 To set the default download parameters to be release 28-72.rel downloaded into the FLASH File System from the TFTP server with IP address 172.16.8.5, with a delay of one minute, use the command: SET LOAD FILE=28-72.REL DESTINATION=FLASH SERVER=172.16.8.
1-86 SET MANAGER PORT AR Series Router Reference Manual SET MANAGER PORT Syntax SET MANAGER PORT={port-number|NONE} where: ■ Description port-number is the number of the port. Ports are numbered sequentially starting with port 0. This command sets the semipermanent manager port. If a valid port number is specified the port becomes the semipermanent manager port. If the specified port was secure before the command was entered it loses its secure setting.
Operation SET NVS DELETE 1-87 SET NVS CREATE Syntax SET NVS CREATE BLOCK=id INDEX=index LENGTH=length CREATOR=creator where: Description ■ id is the block ID in hexadecimal of the block to create. ■ index is the index in hexadecimal of the block. ■ length is the size (in bytes) in hexadecimal of the block. ■ creator is the creator ID in hexadecimal of the block. This command creates a new nonvolatile storage (NVS) block identified by BLOCK and INDEX.
1-88 SET NVS MODIFY AR Series Router Reference Manual For security reasons this command will only be accepted if the user has SECURITY OFFICER privilege.
Operation SET SYSTEM CONTACT 1-89 SET PASSWORD Syntax Description SET PASSWORD This command changes the login password for the user currently logged in to the port from which the command was entered. If a user is not logged in to the port an error message is displayed. If a user is logged in to the port, the user is prompted for the existing password, the new password and confirmation of the new password. The passwords entered are not echoed to the screen.
1-90 SET SYSTEM LOCATION AR Series Router Reference Manual SET SYSTEM LOCATION Syntax SET SYSTEM LOCATION=location where: ■ Description Examples location is a character string, 1 to 256 characters in length. Valid characters are any printable character. If the string includes spaces it must be enclosed in double quotes. This command assigns a string defining the physical location of this router. For example “Laboratory, First Floor, Head Office Building”.
Operation SET SYSTEM TERRITORY 1-91 SET SYSTEM RPSMONITOR Syntax Description SET SYSTEM RPSMONITOR={ON|OFF} This command turns monitoring of the redundant power supply (RPS) on or off (on models that support RPS monitoring only). When RPS monitoring is on, the state of the RPS connection, power supply and fan can be displayed with the SHOW SYSTEM command on page 1-124, and any failures will be indicated by flashing LED patterns (Table 1-11). By default, RPS monitoring is off.
1-92 SET TIME AR Series Router Reference Manual See Also SET SYSTEM CONTACT SET PBX in Chapter 25, Telephony Services SET PRI in Chapter 5, Integrated Services Digital Network (ISDN) SET Q931 in Chapter 5, Integrated Services Digital Network (ISDN) SET SYSTEM LOCATION SET SYSTEM NAME SHOW PBX in Chapter 25, Telephony Services SHOW PRI CONFIGURATION in Chapter 5, Integrated Services Digital Network (ISDN) SHOW PRI STATE in Chapter 5, Integrated Services Digital Network (ISDN) SHOW Q931 in Chapter 5, Inte
Operation SET USER 1-93 SET USER Syntax SET USER=login-name [CALLINGNUMBER=number] [CBNUMBER=e164number] [DESCRIPTION=description] [PASSWORD=password] [PRIVILEGE={USER|MANAGER| SECURITYOFFICER}] [TELNET={YES|NO}] [IPADDRESS=ipadd] [IPXNETWORK=network] [NETMASK=ipadd] [MTU=40..1500] SET USER [LOGINFAIL=1..10] [LOCKOUTPD=0..30000] [MANPWDFAIL=1..5] [SECUREDELAY=10..600] [MINPWDLEN=1..23] [TACRETRIES=0..10] [TACTIMEOUT=1..
1-94 SET USER AR Series Router Reference Manual The DESCRIPTION parameter specifies a descriptive text for the entry, such as the full name and location of the user. This string may contain any printing character and the case is preserved in output. The PASSWORD parameter specifies the password for the user. The password is case sensitive.
Operation SHOW ALIAS 1-95 The SECUREDELAY parameter sets the number of seconds that may elapse between the entry of one security command and the next without the user being required to re-enter the SECURITY OFFICER password to validate the command. The default is 60 seconds. The MINPWDLEN parameter sets the minimum password length that will be enforced for the ADD USER commands and SET PASSWORD commands. The default is 6 characters.
1-96 SHOW BUFFER AR Series Router Reference Manual Table 1-12: Parameters displayed in the output of the SHOW ALIAS command. See Also Parameter Meaning Alias The name of the alias. String The string substituted for the alias when it appears in a command line. ADD ALIAS DELETE ALIAS SHOW BUFFER Syntax SHOW BUFFER [SCAN[=address [QUEUEPOINTERS]]] where: ■ Description address is the memory address of a section of router code, expressed in hexadecimal.
Operation SHOW BUFFER 1-97 Table 1-13: Parameters displayed in the output of the SHOW BUFFER command. Parameter Meaning Memory (DRAM) The total amount of DRAM installed in the router. Free memory The amount of free (unused) memory, as a percentage of total available memory. Free fast buffers [Power PC based routers and switches only] The number of free (unused) fast memory buffers. Fast buffer memory is cached by the CPU and is available only for program variable storage.
1-98 SHOW CONFIG AR Series Router Reference Manual Figure 1-11: Example output from the SHOW BUFFER SCAN command for a specified address. 002c93bc 002d65bc 002eb5bc 002ce7bc 002df8bc 002ec3bc 002d42bc 002dffbc 002ecabc Memory ( DRAM ) .......... Free Memory .............. Free fast buffers ........ Total fast buffers ....... Free buffers ............. Total buffers ............ Buffer level 3 ........... Buffer level 2 ........... Buffer level 1 ...........
Operation SHOW CONFIG 1-99 The DYNAMIC parameter displays the current dynamic configuration of the router, or of the specified software module. The information displayed is the sequence of router commands required to recreate the current dynamic configuration. Figure 1-13: Example output from the SHOW CONFIG command. Boot configuration file: boot.cfg (exists) Current configuration: boot.cfg Table 1-14: Parameters displayed in the output of the SHOW CONFIG command.
1-100 SHOW CPU AR Series Router Reference Manual Table 1-14: Parameters displayed in the output of the SHOW CONFIG command. Parameter Meaning Current configuration (continued) “ (warm restart)”: The router booted up using , but this was a warm restart (RESTART ROUTER CONF=). “None (file not found)”: The router booted up with no configuration because the required configuration file was not found.
Operation SHOW DEBUG 1-101 Figure 1-14: Example output from the SHOW CPU command. CPU Utilisation ( as a percentage ) ---------------------------------------Maximum since router restarted ..... 62 Average since router restarted ..... 0 Average over last minute ........... 0 Average over last 10 seconds ....... 2 Average over last second ........... 1 ---------------------------------------- Table 1-15: Parameters displayed in the output of the SHOW CPU command.
1-102 SHOW DEBUG AR Series Router Reference Manual Figure 1-15: Sample output from the SHOW DEBUG STACK command after a software reboot -----------------------------------------------------This is a production version of code -----------------------------------------------------Router RESTART occurred Check exception table for restart cause STACK DUMP -----------------------------------------------------00012830: 00012840: 00012850: 00012860: 00012870: 00012880: 00012890: 000128a0: 000128b0: 000128c0: 00
Operation SHOW EXCEPTION 1-103 SHOW EXCEPTION Syntax Description SHOW EXCEPTION This command displays the router exception list (Figure 1-17 on page 1-103). There may be up to ten entries in the list, ordered from most recent (event 01) to least recent (event 10). The explicit format of each entry depends on the exception type and hence what information was stored for that event. The Spurious interrupts field is the number of spurious interrupts handled by the router since startup.
1-104 SHOW FEATURE AR Series Router Reference Manual SHOW FEATURE Syntax SHOW FEATURE[={featurename|index}] where: Description ■ featurename is a character string, 1 to 12 characters in length. Valid characters are any printable character. ■ index is a decimal number in the range 1 to the number of special feature licences. This command displays information about the special feature licences in the router.
Operation SHOW FFILE 1-105 Figure 1-19: Example output from the SHOW FEATURE command for a specified special feature licence. The special feature licence : ENCO Licence Type : full Period : - The included features : 3des Encryption Table 1-17: Parameters displayed in the output of the SHOW FEATURE command for a specified special feature licence. Examples Parameter Meaning The special feature licence The name assigned to the special feature licence with the ENABLE FEATURE command on page 1-65.
1-106 SHOW FFILE AR Series Router Reference Manual If the CHECK parameter is specified then the command output may take a number of seconds to complete when larger files are being checked. Figure 1-20: Example output from the SHOW FFILE command.
Operation SHOW FILE 1-107 SHOW FILE Syntax SHOW FILE[=filename] where: ■ Description filename is a file identifier of the form [device:]name.ext. Valid characters are the lowercase letters (a–z), digits (0–9) and the hyphen character (-). Wildcards are allowed in the name and extension elements. This command displays a list of the files in the file subsystem that match the specified file name (Figure 1-21 on page 1-107, Table 1-19 on page 1-107).
1-108 SHOW FLASH AR Series Router Reference Manual SHOW FLASH Syntax Description SHOW FLASH [FFS] This command displays general status information about the FLASH File System (FFS). The FFS provides a consistent file-based interface to the physical FLASH memory structure, and housekeeping and management functions (Figure 1-22 on page 1-108, Table 1-20 on page 1-108). Figure 1-22: Example output from the SHOW FLASH command. FFS info: global operation ...... none compaction count ......
Operation SHOW FLASH PHYSICAL 1-109 FFS failure counts do not necessarily mean that an error has occurred, but are also incremented if the file specified could not be found. For example attempting to delete a file which does not exist will result in the delete failures count being incremented.
1-110 SHOW HTTP CLIENT AR Series Router Reference Manual SHOW HTTP CLIENT Syntax Description SHOW HTTP CLIENT This command displays the current state of the HTTP client (Figure 1-24 on page 1-110, Table 1-22 on page 1-110). Figure 1-24: Example output from the SHOW HTTP CLIENT command. HTTP Client -----------------------------------------------------------Sessions opened .............. 1 Sessions closed .............. 1 Transmitted requests ......... 1 Received replies .............
Operation SHOW HTTP DEBUG 1-111 SHOW HTTP DEBUG Syntax Description SHOW HTTP DEBUG This command displays the debugging options currently enabled for the HTTP server (Figure 1-25 on page 1-111, Table 1-23 on page 1-111). Figure 1-25: Example output from the SHOW HTTP DEBUG command.
1-112 SHOW HTTP SERVER AR Series Router Reference Manual SHOW HTTP SERVER Syntax Description SHOW HTTP SERVER This command displays configuration and status information for the HTTP server (Figure 1-26 on page 1-112, Table 1-24 on page 1-112). Figure 1-26: Example output from the SHOW HTTP SERVER command. HTTP Server ------------------------------------------------------Status ....................... Enabled Homepage ..................... homepage.htm Listen port ..................
Operation SHOW HTTP SESSION Examples 1-113 To display the current status of the HTTP server, use the command: SHOW HTTP SERVER See Also DISABLE HTTP DEBUG DISABLE HTTP SERVER ENABLE HTTP DEBUG ENABLE HTTP SERVER RESET HTTP SERVER SET HTTP SERVER SHOW HTTP CLIENT SHOW HTTP DEBUG SHOW HTTP SESSION SHOW HTTP SESSION Syntax Description SHOW HTTP SESSION This command displays TCP session information for the HTTP server (Figure 1-27 on page 1-113, Table 1-25 on page 1-113).
1-114 SHOW INSTALL AR Series Router Reference Manual Table 1-25: Parameters displayed in the output of the SHOW HTTP SESSION command. (Continued) Examples Parameter Meaning Activations The number of times the session has been activated.
Operation SHOW LOADER 1-115 Table 1-26: Parameters displayed in the output of the SHOW INSTALL command. See Also Parameter Meaning Install The type of install; one of “Temporary”, “Preferred” or “Default”. Release The release file for the install. Patch The patch file for the install. Dmp The third party Data Manipulation Program for the install. This is not present on most models and software releases. Current install The install currently running in the router.
1-116 SHOW MAIL AR Series Router Reference Manual Table 1-27: Parameters displayed in the output of the SHOW LOADER command. See Also Parameter Meaning Defaults This section lists the default values used for parameters not specified in the LOAD and UPLOAD commands. Current Load This section lists the values currently being used to load a file to or from the router. Last Load This section lists the values last used to load a file to or from the router.
Operation SHOW MAIL 1-117 Figure 1-30: Example output from the SHOW MAIL command MAIL Host Name ............ State ................ Debug ................ Mails Sent ........... router2.company.com alive disabled 0 Date/Time Id To Subject State Retries -----------------------------------------------------------------------------29 15:00:05 0002 jb@it.company.
1-118 SHOW MANAGER PORT See Also AR Series Router Reference Manual DELETE MAIL DISABLE MAIL DEBUG ENABLE MAIL DEBUG MAIL SHOW MAIL SHOW MANAGER PORT Syntax Description SHOW MANAGER PORT This command displays the port number of the current semipermanent manager port, if any. There may be no more than one semipermanent manager port at any time. If a semipermanent manager port is defined, a message like: The manager port is port 0 is displayed.
Operation SHOW NVS 1-119 Figure 1-31: Example output from the SHOW NVS command.
1-120 SHOW NVS DUMP AR Series Router Reference Manual SHOW NVS DUMP Syntax SHOW NVS DUMP [BLOCK=id] [INDEX=index] [LENGTH=length] [OFFSET=offset] [SIZE={BYTE|LONG|WORD}] where: Description ■ id is the block ID in hexadecimal. ■ index is the block index in hexadecimal. ■ length is the length of data to be dumped in hexadecimal. ■ offset is the offset into the data to start dumping from in hexadecimal.
Operation SHOW NVS FREE 1-121 Table 1-30: Parameters displayed in the output of the SHOW NVS DUMP command. See Also Parameter Meaning ID The block ID (in hexadecimal) of the block displayed. Index The block index in (hexadecimal) of the block displayed. Offset The offset (in hexadecimal) of the data displayed. Length The length of data in (hexadecimal) displayed. Size The units in which the data is displayed: one of “BYTE”, “LONG” or “WORD”.
1-122 SHOW PATCH AR Series Router Reference Manual SHOW PATCH Syntax Description SHOW PATCH This command displays all patch files stored in NVS (Figure 1-34 on page 1-122, Table 1-31 on page 1-122). Patch or release files stored in FLASH are not displayed; these can be displayed with the SHOW FILE command on page 1-107. Figure 1-34: Example output from the SHOW PATCH command. Patch files Name Device Size Version --------------------------------------------28-74.pat flash 376032 7.4.0-11 28760-02.
Operation SHOW RELEASE 1-123 Table 1-32: Parameters displayed in the output of the SHOW RADIUS command. Examples Parameter Meaning Server The IP address of this RADIUS server. Port The port number used to communicate with the RADIUS authentication server. AccPort The port number used to communicate with the RADIUS accounting server. Secret The shared secret used in communications between the router and the RADIUS server.
1-124 SHOW STARTUP AR Series Router Reference Manual SHOW STARTUP Syntax Description SHOW STARTUP This command prints the state of the bits in the router Startup Status Flag (Figure 1-37 on page 1-124). This command can be used to check the state of the router when it last started up. If a given bit signals an error then its message has an > appended to the front of it. Figure 1-37: Example output from the SHOW STARTUP command.
Operation SHOW SYSTEM 1-125 Figure 1-38: Example output from the SHOW SYSTEM command. Router System Status Time 17:10:06 Date 25-Sep-1999.
1-126 SHOW SYSTEM AR Series Router Reference Manual Table 1-34: Parameters displayed in the output of the SHOW SYSTEM command. (Continued) Parameter Meaning SysLocation A string specifying the location of the router. This is set with the SET SYSTEM LOCATION command on page 1-90. SysName A string specifying the name (usually the complete IP domain name) of the router. This is set with the SET SYSTEM NAME command on page 1-90.
Operation SHOW TIME 1-127 Table 1-34: Parameters displayed in the output of the SHOW SYSTEM command. (Continued) See Also Parameter Meaning Name The name of a patch file. Device The memory device where the patch file is stored; one of “nvs” or “flash”. Size The size of the patch file in bytes. Version The version number of the patch, consisting of the version number of the release to which the patch applies, followed by a hyphen and the generation number of the patch itself.
1-128 SHOW USER See Also AR Series Router Reference Manual SET TIME SHOW USER Syntax SHOW USER[=login-name] [CONFIGURATION] where: ■ Description login-name is a character string, 1 to 64 characters in length. Valid characters are uppercase letters (A–Z), lowercase letters (a–z), and decimal digits (0–9). The string may not contain spaces. This command displays the contents of the User Authentication Database or global configuration parameters and counters for the User Authentication Facility.
Operation SHOW USER 1-129 Figure 1-40: Example output from the SHOW USER command. Number of logged in Security Officers currently active ...1 User Authentication Database ------------------------------------------------------------------------------Username: tony () Status: enabled Privilege: user Telnet: no Ip address: 192.168.1.5 Netmask: 255.255.255.
1-130 SHOW USER AR Series Router Reference Manual Table 1-35: Parameters displayed in the output of the SHOW USER command. Parameter Meaning Logins The number of times a successful login has been made using this login name. Fails The number of times an incorrect password was given for this login name. Sent The number of octets sent by the user to the router. Rcvd The number of octets set to the user from the router.
Operation SHOW USER 1-131 Table 1-36: Parameters displayed in the output of the SHOW USER CONFIGURATION command. (Continued) Software Release 2.0.1 C613-03018-00 REV A Parameter Meaning manager password failures... The default number of successive failures a manager may make entering the login password before the session is logged off. maximum security command...
1-132 SHOW USER RSO See Also AR Series Router Reference Manual ADD USER DELETE USER DISABLE SYSTEM SECURITY_MODE DISABLE USER ENABLE SYSTEM SECURITY_MODE ENABLE USER PURGE USER RESET USER SET USER SHOW USER RSO Syntax Description SHOW USER RSO This command displays information about the current state of Remote Security Officer access and the log of access events (Figure 1-42 on page 1-132, Table 1-37 on page 1-133).
Operation SHOW USER RSO 1-133 Table 1-37: Parameters displayed in the output of the SHOW USER RSO command. Parameter Meaning Remote Security Officer Access The current state of Remote Security Officer access; one of is... “enabled” or “disabled”. Examples Remote Security Officer Log The list of Remote Security Officers and a log of access events for those Remote Security Officers. Remote Security Officer The address range (IP address and mask) of a Remote Security Officer. A mask other than 255.
1-134 UPLOAD AR Series Router Reference Manual UPLOAD Syntax UPLOAD [METHOD=TFTP] [FILE=filename] [SERVER={hostname| ipadd}] UPLOAD [METHOD=ZMODEM] [FILE=filename] [PORT=port] where: Description ■ filename is the name of the file to upload. This may be a full path name for the file in the syntax of the TFTP server. ■ ipadd is an IP address in dotted decimal notation. ■ hostname is a character string up to 40 characters in length. ■ port is the number of an asynchronous port.
Operation UPLOAD Examples To upload the file SHOW.SCP stored in FLASH memory to a TFTP server with an IP address of 172.16.8.5, use the command: UPLOAD FILE=SHOW.SCP SERVER=172.16.8.5 See Also Software Release 2.0.
