Ref: 99980013 Title: NCS/AT Command Summary Date: 3/1/87 Copyright 3Com Corporation, 1991. All rights reserved. This section describes the NCS/AT commands. Commands are presented in alphabetical order. You may issue all NCS/AT commands in the Command/Utility screen on the NCS/AT console or on a terminal logged in to the NCS/AT through a serial port. You may also enter most of the commands in remote mode from a terminal attached to an asynchronous port on a CS/1, CS/100 or CS/200 on the network. You can access remote mode using the REMOTE command. Press after entering any command. Enter a question mark (?) to list the syntaxes of all available commands. Enter a command followed by a question make to display more detailed information about the command. Conventions used in syntax descriptions are described below. Include only the hyphen or parentheses in the commands you type; do not enter the angle brackets, square brackets, vertical bar, or ellipsis. case Uppercase characters indicate letters that you must enter; lowercase characters indicate optional letters. You may enter commands in upper, lower, or mixed case, but pathnames must be entered in the proper case. < > Items listed in angle brackets represent variable parameters or values. Do not enter the angle brackets. [ ] Items listed in square brackets represent optional parameters. Do not enter the square brackets. | Items separated by a vertical bar within a list represent mutually exclusive choices, one of which may be entered. Do not enter the vertical bar. ... Items followed by an ellipsis may be repeated in the same command line. Do not enter ellipsis. ( ) Parentheses are used to enclose an optional address in the BRoadcase and SET commands. If you specify an address, you must enclose it in parentheses. - A letter preceded by a hyphen represents a command option. If you specify such an option, you must enter the hyphen. If you use more than one option, enter only one hyphen, followed by an unpunctuated list of options (ie., no spaces or other delimiters between option letter). If a specific type of address is required, the command discussiion lists the required type. Where the term "address" is used, you may specify an Internet address or Internet name. For example, the syntax "BInd
", indicates that the first parameter must be an Ethernet address and the second parameter may be an Internet address or Internet name. If you include and Internet address's hexadecimal equivalent (e.g., C009C850), the hexadecimal characters must be entered in uppercase. Filenames specified in commands on the NCS/AT must include the pathname, which is a descending list of the subdirectories in which the file is stored, ending with the name of the file itself. Files specified in commands are assumed to be in the /usr/NCS directory and the required pathname is a slash followed by the subdirectory name, if any, followed by the filename. For example, you must specify the file /usr/NCS/BIN/cs1x. The case of all characters (upper, lower, mixed) in pathnames must be correct. In commands, you must precede the pathname with a slash (e.g., /pathname). When you enter a command in remote mode to the NCS/AT, the length of its output is limited to approximately 1000 characters or 49 lines. If the output exceeds either limit, the system displays the first 100 characters or 49 lines followed by the message "(trunated)". Any NCS/AT command that produces output can be given in its unabbreviated form as an argument to the Print utility to redirect the output to the system printer. NCS/AT Command Summary Table Command Description ----------------------------------------------------- BEcome Establish an NCS/AT as primary or secondary BInd Add a Communications Server to the NCS/AT's list of client servers BRoadcast Send a message across the network CoPyfile Copy a file from one NCS/AT to another or two another file on the NCS/AT DEFine Create a macro and specify its contents LiSt Display directories and filenames MoVe Rename a file NAme Create an Internet name ReBoot Reboot a specified server REMOTE Execute commands remotely on another server ReMove Remove a file from the NCS/AT disk SET Specify the date and time SETDefault Specify global parameters SHow Display statistics, parameters, and so on. UNBind Remove a server from the list of client servers UNDefine Delete a macro from the NCS/AT disk UNName Remove an Internet name UTility Invoke utility mode and display the utility prompt or allow a utility to be invoked at the command prompt ZeroStats Set value of busiest minutes data statistics to 0 *This command is not available in remote mode. .h1;BEcome Command .br;SYNTAX .br;BEcome Primary|Secondary .br;DESCRIPTION .br;The become command has two effects. First, it establishes the NCS/AT on which the command is entered as either a primary NCS (if you specify the Primary option) or a secondary NCS (if you specify the Secondary option). You must enter the command on the NCS/AT that is to become primary or secondary. Second, if the BEcome Primary command is executed, it remotely changes the FileServerAddr parameter of each active client Communications Server to the NCS/AT's own network address. This change allows the Communications Servers to access the configuration and macro files on the new primry NCS/AT. You need not reboot the Communictions Servers for this change to take effect. You may use the BEcome command to change a secondary NCS/AT into a primary NCS/AT or vice versa. ** NOTE ** If the primary NCS/AT does not respond to requests to boot service of Internet name service, the secondary NCS/AT automatically answers these requests. However, the secondary NCS/ AT does not automatically answer configuration file or macro file server requests. For the secondary configuration file or macro file service requests. For the secondary NCS/AT to answer file service requests, you must establish the secondary NCS/AT as the primary NCS/AT by executing the BEcome Primary command. Use the SHow BootStatistics command to determine whether the NCS/ AT is currently primary or secondary. The BEcome command affects only the NCS/AT on which it is entered and the servers that are bound to that NCS/AT; it has no effect on any other NCS/AT. The BEcome command is not available in remote mode. .br;EXAMPLE .br;become s This example establishes the NCS/AT on which the command is entered as a secondary NCS/AT. .br;NORMAL RESPONSE If the NCS/AT is being specified as primary, the message "Informing
... ok" is displayed for each client server. The message "NCS/AT is now primary|secondary", where the address is that of the affected NCS/AT, is displayed, followed by a new prompt. .br;ERROR MESSAGES .br;"BootServer doesn't answer...BEcome failed" .br;"Informing
... (timeout failure)" .br;"Invalid BEcome syntax" .br;"Informing
... remote errors encountered" .br;"Usage:BEcome Primary|Secondary" .h1;BInd Command .br;SYNTAX .br;BInd
[-f][] .br;DESCRIPTION The BInd command instructs the NCS/AT on which the command is entered to create support files for the Communications Server with the specified address and to add the address to its list of client servers. The first address must be the Ethernet address of the client server. The second address may be either an Internet address or an Internet name. If you specify an Internet name, the NCS/AT looks up the corresponding address and binds the client using that address, not the name. The next time the bound server issues a boot requests, the NCS/AT downloads system software to it. If you omit the option bootfile from the BEnd command, the system downloads either the CS/1 Connection Service software (cs1x), the CS/100 Connection Service software (cs100x), the CS/200 Connection Service software (cs200x), or the IVECS Connection Service software (ivecsx), depending on the model of the requesting server. If you specify a bootfile, the NCS/AT downloads the specified bootfile, which must be stored in the subdirectory /usr/NCS/BIN. You must precede the bootfile name with "-f" to identify it as a filename; a space must be entered between "-f" and the bootfile name. The bootfile name may contain no more than 14 characters, made up of the alphanumeric characters, hypen (-), underscore (_), and period (.). If you specify the nports parameter, the NCS/AT creates port configurations only for the number of ports specified, which save disk space if some of the available ports on the client server are not used. If you do not give the nports parameter, the NCS/ AT creates port configurations for 32 ports. You must include the nports parameters for any server that provides more than 32 ports, such as an IVECS, which provides up to 48 virtual ports, or a CS/1 with four SIO-16 boards, which provides up to 64 ports. In response to the BInd command, the NCS/AT creates two support files for the client server: one file for port configurations (cfg.) and one file for global parameters (gbl., where xxxxxxxx is the server's Internet address in hexadecimal). Initially, these files contain the system default configurations and parameter settings, which are listed in the Configuration Guide. You can alter the default parameter values with the SETDefault command or the SAve and ReaD commands issued on the client server. Whenever you change a default value, the NCS/AT modifies these files. After binding the Communications Servers to their primary NCS/AT and altering the servers' configuration and parameter files, update the secondary NCS/AT using the Ncsbackup and Ncsrestore utilities. If you specify the addresses of a server that has already been bound (as indicated by an entry for that address in the NCS/AT's list of client servers), the command does not rebind the server to the NCS/AT nor does it create new cfg. and gbl. files are created only if they do not already exist. Use the SHow BootStatistics command to display the lsit of servers currently bound to the NCS/AT. To delete an address from the list of client servers, use the UNBind command; to remove the associated support files from the disk, use the ReMove command. To change the Ethernet address, Internet address, or bootfile for a client server, you myst unbind the server and then issue a new BInd command with the appropriate address or bootfile name. To change the number of ports listed for a client server, you must unbind the server, remove its support files, and then issue a new BInd command with the appropriate bootfile and nports parameters. An NCS/AT can support up to 128 nodes, booting from one of up to ten bootfiles. .br;EXAMPLE 1 .br;bind %08000200043a 192.9.200.80 This example bindst the Communications Server with the Ethernet address %08000200043a and the Internet address 192.9.200.80 to the NCS/AT on which the command is entered. .br;EXAMPLE 2 .br;bind %080002000e12 192.9.200.077 -f ivecs.a 48 This example binds an IVECS with the Ethernet address %080002000e12 and the Internet address 192.9.200.077 to the NCS/ AT on which the command is entered. The command also specifies ivecs.a as the bootfile name and specifies 48 IVECS ports. .br;NORMAL RESPONSE .br;A new prompt appears. .br;ERROR MESSAGES .br;"BInd failed...bind table is full" .br;"BInd failed...hot is already bound" .br;"BootServer doesn't answer BInd failed" .br;"Internet name not found" .br;"Invalid
syntax" .br;"Invalid BInd syntax" .br;"Name Server doesn't answer" .br;"Usage: .br;BInd
[-f][}" .h1;BRoadcast Command .br;SYNTAX .br;BRoadcast (
)"" .br;DESCRIPTION .br;The BRoadcast command transmits text messages across the network. The text string must follow the syntax described in the Connection Service User's Guide. If you specify an address and reception of broadcast messages is disabled for the specified port (i.e., if its InterAction parameter is set to BroadcastOFF), the NCS/AT returns an error message. The address may be an Internet address or an Internet name. If you specify no address, the message is sent to the terminal(s) logged in through an NCS/AT serial port and to each NCS/AT console screen. You may use the broadcast address 255.255.255.255 to specify all terminal ports on all servers on the network that are running TCP/ IP protocols, all terminal logged in through an NCS/AT serial port, and each NCS/AT console screen. .br;EXAMPLE 1 .br;broadcast (192.9.200.80)"Printing requests due at 1700" This example sends the specified text to all terminal ports of the Communications Server with the Internet address 192.9.200.80. .br;EXAMPLE 2 .br;br(255.255.255.255)"Meeting in the conference room in 5 minutes" This example sends the specified message to all terminal ports on all TCP/IP servers on the network. .br;NORMAL RESPONSE .br;A new prompt appears. .br;ERROR MESSAGES .br;"Broadcast is not enabled on that port" .br;"Invalid BRoadcast syntax" .br;"Invalid network manager syntax" .br;"(timeout failure)" .br;"Usage:BRoadcast (
)""" .br;CoPyfile Command .br;SYNTAX .br;CoPyfile[
:][
:][] .br;DESCRIPTION The CoPyfile command copies a file from an NCS/AT over the network to another NCS or copies one file to another file on the same NCS/AT. If the file being copied to does not exist, the CoPyfile command create it. You can use this command to back up individual files on the primary NCS/AT by copying them to the secondary NCS/AT. For example, the file /usr/NCS/macros can be copied from one NCS/AT to another NCS/AT. Because of size difference, only the following files can be copied between different NCS models (e.g., between an NCS/AT and an NCS/150): .br; /CONFIGS/cgf. .br; /GLOBALS/gbl. .br; /passwd ** NOTE ** Do not use the CoPyfile command to copy the files names.pag, names.dir, or btdata. If you omit the address and colon, the system assumes the address of the NCS/AT on which you entered the command by default. If you omit the second pathname, the system copies to a file with the same pathname as the source file. The address may be an Internet address or an Internet name. You must include the correct pathnames. Files are assumed to be in the /user/NCS directory. For example, you must specify the file /usr/NCS/BIN/cs1x as /BIN/cs1x. .br;EXAMPLE 1 .br;cp ncsa:/macros ncsb:/macros This example copies the file named macros from the NCS/AT named ncsa to the file named macros on the NCS/AT named ncsb. .br;EXAMPLE 2 .br;cp ncsa;/macros ncsb: This example has the same effect as Example 1: it copies the file named macros from the NCS/AT named ncsa to a file of the same name (macros) on the NCS/AT named ncsb. .br;EXAMPLE 3 .br;cp /macros ncsb: This example copies the file named macros from the NCS/AT on which the command is entered to a file of the same name (macros) on the NCS/AT names ncsb. .br;EXAMPLE 4 .br;cp /CONFIGS/cfg.C009C850 /CONGIFS/cfg.C009C84D This example copies the file name cfg.C009C850 in the directory CONFIGS on the NCS/AT on which the command is entered to the file named cfg.C009C84D in the same directory on the same NCS/AT. .br;EXAMPLE 5 .br;cp /CONFIGS/cfg.C009C850 ncsb: This example copies the file named cfg.C009C850 in the directory CONFIGS from the NCS/AT on which the command is entered to a file of the same name (cfg.C009C850) in a directory of the same name (CONFIGS) on the NCS names ncsb. .br;NORMAL RESPONSE .br;ERROR MESSAGES .br;"CoPyfile:can't create " .br;"CoPyfile:can't open destination " .br;"CoPyfile: not found" .br;"CoPyfile:read fails, copy aborted" .br;"CoPyfile:write fails, copy aborted" .br;"Filename too long: .br;"FileServer doesn't answer" .br;"Invalid
syntax" .br;"Invalid CoPyfile syntax" .br;"Invalid CoPyfile syntax...null address given" .br;"Invalid filename specified...missing /" .br;"NameServer doesn't answer" .br;"Usage:CoPyfile[
:][
:][] .h1;DEFine Command .br;SYNTAX .br;DEFine .br;DESCRIPTION The DEFine command creates a macro and specifies its contents. All terminal ports on all of the NCS/AT's client servers can execute a macro defined on the NCS/AT. When you create a new macro with the same name as an existing macro, the new macro contents replace the old macro contents. The NCS/AT does not distinguish between uppercase and lowercase in macro names. Macro names beginning with the letter "init" are reserved for system initialization macros. Every time a Communications Server is booted from an NCS/AT, it checks the NCS/AT's disk for a macro called init. (where xxxxxxxx represents the Communications Server's Internet address in hexadecimal). If the macro exists, the server executes it. When you issue the DEFine command, the NCS/AT responds with the prompt "Macro:". Enter a line of the macro and press . The NCS/AT continues to prompt for additional lines until you enter a single right parenthesis in column 1 and press . All characters entered after the first "Macro:" prompt and before the closing parenthesis are part of the macro contents. The macro may contain internal parentheses in balanced pairs. A single macro may contain no more than 256 characters. A macro may, however, include the Connection Service DO command to call another macro. The DO command is described in the Connection Service User's Guide. The NCS/AT DEFine command differs from the Connection Service DEFine command in that you cannot enter macro text on the command line and you must enter the terminating right parentheses is column 1. A macro can contain any valid Connection Service command except the DEFine command. The Pause command is usually included in a login macro to give the host time to produce a prompt before the login process starts. If you wish to cancel the DEFine command, press , at any time before entering the terminating right parenthesis. Once defined, a macro is executed with the Connection Service DO command, displayed with the SHow Macro command, and undefined with the UNDefine command. You can modify macros that have already been defined and stored on the NCS/AT with the Macroedit utility. The NCS/AT supports up to 512 macros. Follow the guidelines listed in the Network Management Guide when writing macros. The DEFine command is not available in remote mode to the NCS/AT. .br;EXAMPLE NCS/AT> define tek Macro: set duplex=help interaction=nolfi Macro: set localediting=(nce,nde) Macro: ) macro tek create This example defines a macro called tek that sets a number of terminal characteristic parameters. .br;NORMAL RESPONSE The message "macro created" or the message "macro replaced". .br;ERROR MESSAGES .br;"Can't -- macro directory full" .br;"Invalid DEFine syntax" .br;"Macro truncated to 256 bytes" .br;"Usage: DEFine " .h1;LiSt Command .br;SYNTAX .br;LiSt [-lsCR] [...] .br;DESCRIPTION THe LiSt command displays information about the files or subdirectories within the NCS/AT file system. If you do not specify a pathname, the system lists the contents of the /usr/NCS directory. If the specified pathname ends with the name of a directory, the system lists information about all files and subdirectories within that directory. If the specified pathname ends with the name of a file, the system lists information about that file only. With no options, the LiSt command lists only the names of files and subdirectories, as listed in EXAMPLE 4 below. The list does not include the contents of each subdirectory. .br;The LiSt command has four options: -1 Displays information in the long format, which includes the total usage in kilobytes and the following information for each file and subdirectory: .br;* mode .br;* number of links (in decimal) .br;* owner .br;* group .br;* size in bytes (in decimal) .br;* date and time the file was last modified .br;* filename or directory name The long display for the NCS/AT follows the format shown in Example 1, below. -s Limits the display to the filename and size in kilobytes, plus the total size of all files. .br;-C Displays output in multiple columns. .br;-R Recursively lists subdirectories encountered. .br;EXAMPLE .br;ls -1 This example displays a long list of all files and subdirectories in /usr/NCS, as shown below: total 170 drwxr-xr-x 2 ncs ncs 2048 Dec 5 12:37 AUDIT_TRAIL drwxr-xr-x 2 ncs ncs 1536 Dec 4 16:30 BIN drwxr-xr-x 2 ncs ncs 1536 Nov 21 10:51 CONFIGS drwxr-xr-x 2 ncs ncs 64 Nov 21 10:51 DUMP drwxr-xr-x 2 ncs ncs 48 Nov 21 10:51 ETC drwxr-xr-x 2 ncs ncs 1536 Nov 21 10:51 GLOBALS -rw-r--r-- 1 ncs ncs 8192 Dec 4 16:09 btdata drwxr-xr-x 2 ncs ncs 512 Dec 5 16:29 dev drwxrwxrwx 2 ncs ncs 1056 Dec 5 14:23 lost+found -rw-r--r-- 1 ncs ncs 139264 Dec 4 11:11 macros -rs-r--r-- 1 ncs ncs 4096 Nov 20 11:07 names.dir -rw-r--r-- 1 ncs ncs 16384 Dec 14 17:30 names.pag -rw-r--r-- 1 ncs ncs 512 Dec 1 13:02 passwd -r--r--r-- 1 ncs ncs 5195 Dec 22 12:01 showaudit .br;EXAMPLE 2 ls -1 /BIN This example displays a long list of all files and subdirectories within the /usr/NCS/BIN subdirectory, for example: total 333 -rw-r--r-- 1 ncs ncs 208410 Jul 3 16:30 cs1x -rw-r--r-- 1 root root 62718 Nov 3 22:40 iepc .br;EXAMPLE 3 .br;ls -s /CONFIGS This example displays a list of the files in the /usr/NCS/CONFIGS subdirectory and their sizes, for example: total 25 2 cfg.C009C849 2 cfg.C009C84C 3 cfg.C009C84D 2 cfg.C009C84E 2 cfg.C009C850 3 cfg.C009C8AA 2 cfg.C009C8BB 7 cfg.C009C8CA 2 cfg.C009C8FE .br;EXAMPLE 4 .br;list .br;This example lists only the names of files and subdirectories in /usr/NCS< as shown below. The list does not include the contents of each subdirectory. AUDIT_TRAIL BIN CONFIGS DUMP ETC GLOBALS btdata dev lost+found macros names.dir names.pag passwd showaudit .br;NORMAL RESPONSE This list of files or directories, followed by a new prompt. .br;ERROR MESSAGES .br;" not found" .br;" unreadable" .h1;LOgout Command .br;SYNTAX .br;LOgout .br;DESCRIPTION The LOgout command terminates the Command/Utility screen in which it is entered and logs you out. When you execute LOgout, the system displays a message that indicates the number of the screen you are logging out and the date and time. For example, the following message indicates that you are logging out from screen 2 ("/dev/tty02"): .br;... logging out from /dev/tty02 at Wed Mar 11 13:44:14 PST 1987 If you are still loggied in on other Command/Utility screens, the NCS/AT displays a note that lists the other screens. For example, the following display indicates that screens 3 and 4 (tty03 and tty04) are still active: .br;...NOTE -- there are other screens logged in ... NAME LINE TIME IDLE PID COMMENTS ncs tty03 Mar 11 10:01 3:38 73 ncs tty04 Mar 11 10:02 3:41 74 .br; *** NOTE *** To be completely logged out of the NCS/AT, you must execute the LOgout command in each active Command/Utility screen. .br;The LOgout command is not available in remote mode to the NCS/ AT. .br;NORMAL RESPONSE When you logout on the NCS/AT console or on a directly attached terminal, the NCS/AT displays a new login prompt. If you enter the command on a terminal attached to a Communications Server and connected to an NCS/AT serial port through the Connection Service Connect command, you are logged out, but no prompt appears. .h1;MoVe Command .br;SYNTAX .br;MoVe .br;DESCRIPTION The MoVe command changes the name of a file from the first filename listed to the second filename listed. You must include the correct pathnames. Files are assumed to be in the /usr/NCS directory. For example, you must specify the file /usr/NCS/BIN/ cs1x as /BIN/cs1x. If the file with the second filename already exists, it is replaced. You cannot use this command to move a file to another NCS/AT. To copy a file over the network to another NCS, use the CoPyfile command. .br;EXAMPLE 1 .br;move /BIN/cs100/BIN/cs100a This example changes the name of a file in the subdirectory BIN from cs100 to cs100a. The file remains in the same subdirectory. .br;EXAMPLE 2 .br;mv /CONFIGS/cgf/C009C850 /CONFIGS/cfg.C009C84D This command changes the name of the configuration file cfg.C009C850 to cfg.C009C84D. The change effectively converts the configuration file for the Communications Server whose Internet address expressed in hexadecimal is C009C850 into a configuration file for the Communications Server whose Internet address expressed in hexadecimal is C009C84D. .br;EXAMPLE 3 .br;nv /GLOBALS/gbl.C009C850 /GLOBALS/gbl.C009C84D The effect of this example is similar to Example 2, above: it changes the name of the global parameter file gbl.C009C850 to gbl.C009C84D. This change effectively converts the global parameter file for the Communications Server whose Internet address expressed in hexadecimal is C009C850 into a global parameter file for the Communications Server whose Internet address expressed in hexadecimal is C009C84D. .br;NORMAL RESPONSE .br;A new prompt appears .br;Error Message .br;"mv:cannot access " .br;"mv: and are identical" .br;"mv: : rename : permission denied" .h1;NAme Command .br;SYNTAX .br;NAme =
.br;DESCRIPTION The NAme command assigns a logical name to either an Internet address or another Internet name. .br;An NCS/AT can support up to 2,048 names. Each name may consist of all alphanumeric characters, the underscore (_), period (.), and dash (-), and may be no more than 40 characters long. NCS/AT names are case-sensitive. You must establish all names for an NCS/AT's client Communications Servers either from the NCS/AT console terminal or in remote mode to the NCS/AT from a terminal attached to another server. The names cannot be established on the client server itself.