The na utility provides the commands for managing the Annex. These
commands allow you to:
•Set and display the operating characteristics of the Annex and its
ports.
•Reboot or reset the Annex and its ports.
•Broadcast administrative messages to the Annex ports.
The na utility is stored on and accessed from a UNIX host.
The Annex stores the parameters set using na in non-volatile memory.
After a reboot or a reset, the Annex updates its run-time parameters with
the non-volatile parameters changed by na. The na utility can
communicate with the Annex only when the Annex is running its
operational code.
All na commands are taken from the na standard input: you can run na
interactively or provide it with input through a file or pipeline. You can
create a script file containing na commands to configure an Annex. This
script file can save the configuration information for a specific Annex
and, when required, restore the configuration.
This chapter illustrates command names, parameter names, and keywords
in their long forms. Examples ofna commands sometimes appear without
the interactive command prompt, and with embedded comments that
describe the functions being performed. This format resembles the
appearance of na scripts; the portion of the script entered at the terminal
in response to the command prompt appears in bold type.
Book C-1Remote Annex Administrator’s Guide for UNIX
Page 20
Chapter 1 na Commands
Command Notation
Interactivena sessions allow you to enter na commands with or without
arguments or parameters. If you enter the command without arguments
or parameters, na prompts for them. The conventions for an interactive
session are:
•You can abbreviate commands and parameter names to the
•Type a new-line character to end a command entry. To continue
•To enter a space as an argument, enclose it in double quotes ("
Book C
minimum number of characters that uniquely distinguish the
name from any other name that may appear in the same context.
an entry onto the next line, type a backslash (\) character
immediately preceding the new-line character.
"); otherwise the space is assumed to be a delimiter.
•The UNIX interrupt character (usually
CTRL-C) returns you to
the command prompt.
Additionally, na permits comments when the # character is present at the
beginning of a comment line. All characters between the # and the next
new line are ignored.T able C-1 describes the supported arguments forna.
Book C-2
Remote Annex Administrator’s Guide for UNIX
Page 21
Book C
Chapter 1 na Commands
Table C-1. Arguments for the na Commands
ArgumentDescription
annex_identifierA symbolic name or an IP address assigned to an
Annex: lab or 132.245.254.38 or
0xC0.0x9.0xC8.0x64
annex_listA list of one or more annex_identifiers separated by
commas: support,132.245.254.42,lab
annex_parameters
A list of one or more Annex parameters and
values separated by white space (space, tab, new
pref_load_addr 132.245.254.66
line):
pref_dump_addr 132.245.254.66
interface_identifierThe name of an interface, a list of interface names
separated by commas, or a range of interface names
separated by hyphens. An interface is an Annex port
over which a network protocol can run. Ethernet,
SLIP, and PPP ports are interfaces; CLI and LAT
ports are not. The name of the Ethernet interface is
en0. SLIP and PPP interface names are of the form
asyn, where n is the SLIP or PPP port number. For
example, specify asy2 for PPP port 2. In a list of
asyn interface names, fully specify each name, e.g.,
asy1,asy2,asy3. In a range of asyn names, fully
specify the beginning of the range and specify n for
the end of the range, e.g., asy1-4. When followed by
an @ and an annex_identifier, interface_identifier
specifies an interface on a specific Annex:
port_identifierA serial port number, a list of port numbers
separated by commas, or a range of port numbers
separated by hyphens. When followed by an @ and
an annex_identifier, port_identifier specifies a port
for a specific Annex:
port_parametersA list of one or more serial port parameters, with or
without values, separated by white space:
input_flow_control eia
printer_parametersA list of one or more parallel printer port
parameters, with or without values, separated by
white space: map_to_upper N
Book C-4
Remote Annex Administrator’s Guide for UNIX
Page 23
Book C
Commands
Chapter 1 na Commands
Table C-2 lists the na commands; the following subsections describe
them.
Table C-2. The na Commands
CommandDescription
annexDefines a default annex_list used with subsequent
commands.
bootBoots the Annex.
broadcastSends a broadcast message to one or more ports.
copyCopies configuration parameters.
dumpbootBoots the Annex and produces a dump.
echoWrites the remainder of the line to the standard output.
help or ?Displays help for commands and parameters.
interfaceDefines a default interface set used with subsequent
commands.
passwordDefines a default administrative password used to
communicate with an Annex.
portDefines a default port_set used with subsequent commands.
printerDefines a default printer_set used with subsequent
commands.
quitTerminates na.
readReads and executes a script file.
(continued on next page)
Remote Annex Administrator’s Guide for UNIX
Book C-5
Page 24
Chapter 1 na Commands
Book C
Table C-2. The na Commands (continued)
CommandDescription
resetResets a port, interface, or subsystem.
setDefines or modifies the value of a parameter.
showDisplays the current value of a parameter.
writeWrites the current configuration to a script file.
After installing na on a UNIX host, type na at a terminal connected to
this host. No arguments or command line options are available.
% na
Annex network administrator Rx.x
command:
Seven of the na commands use standard UNIX superuser protection –
only a superuser at the host can execute these commands: boot,
broadcast, copy, dumpboot, read, reset, and set.
annex
The annex command establishes a default annex_list that is used in
subsequent commands. Before issuing an na command, specify the
Annex to which the executed command refers. The Annexes you specify
using theannex command become the defaultannex_list. You can group
several Annexes into a single list, and then issue one command for the
entire group of Annexes. The syntax is:
annex annex_list
Book C-6
Remote Annex Administrator’s Guide for UNIX
Page 25
Book C
Chapter 1 na Commands
The following example creates an annex_listcontaining one Annex with
the Internet address 132.245.6.40:
command: annex 132.245.6.40
The following example creates an annex_list containing two Annexes
–one specified by its IP address, and the other specified by its name:
command: annex 132.245.6.40,frontlobby
The following example shows how na prompts for missing arguments:
command: annex
enter default annex list: 132.245.6.40,frontlobby
The following annex command displays a message identifying the
specified Annex, its Internet address, the number of serial lines it has,
and its software version:
command: annex 132.245.6.1
132.245.6.1: Remote Annex Rx.x,72 ports
The following annex command causes an Annex to prompt for an
administrative password, provided that the password has been set and
security has been enabled:
If you use the na command password to define a default password for
this na session, and that password matches the Annex administrative
password, no password prompt appears and normal processing
continues (see password on page A-17).
Remote Annex Administrator’s Guide for UNIX
Book C-7
Page 26
Chapter 1 na Commands
Book C
The password is not echoed when entered using the annex command. If
you enter an incorrect password, na prompts for the correct one. If the
password is incorrect a second time, na drops the Annex from the
annex_list. If an Annex in the list does not respond,naignores that Annex
and prints a status message:
132.245.6.1: Not responding
Warning:132.245.6.1 has been dropped from the list
The na utility drops an Annex from the annex_list if its name could not
be translated to an Internet address, if it does not respond because it is
down, or if the wrong Internet address was entered using the annex
command.
boot
Thebootcommand reboots all Annexes in the annex_list and, optionally,
produces a dump of the Annex’s memory, including the operational code.
You can set a time at which the boot is to take place. The boot command
can send a warning message to users attached to the Annex. Table C-3
lists the supported arguments for the boot command. The syntax is:
When the Annex reboots, it terminates all active connections.
If you try to boot software Release 8.0 and above on a unit
with less than 2 MB of system RAM, the Net, Load, and Status 8
indicators will flash until the Reset button is pressed.
If you try to boot with a non-existent image file name, the Annex will
hang as it searches for the image. You must press the Reset button to
recover.
Book C-8
Remote Annex Administrator’s Guide for UNIX
Page 27
Book C
Chapter 1 na Commands
Table C-3. Supported Arguments for the boot Command
ArgumentDescription
–aAborts any delayed boots that are pending.
–dCauses a dump before rebooting.
–hCauses a diagnostic boot using the ROM Monitor boot
command if the Annex is in Test mode.
–lBoots the operational image and stores it on local media; for
use with the stand-alone file system. Only ROM revisions
0600 and greater with the self-boot option loaded support –l.
After a boot –l is ex ecuted, the ls command may not show the
newly-loaded image.
–qCauses a boot without sending a warning message.
HH:MMThe exact clock time for the boot, e.g., 15:15 indicates 3:15
p.m.
+HH:MMThe number of hours and minutes before the boot takes place,
e.g., +2:15 indicates a boot will occur in two hours and fifteen
minutes.
annex_listSpecifies the Annexes to be booted. If you do not include an
annex_list, the command prompts for it. Pressing the Return
key accepts the default annex_list.
filenameIdentifies the name of the file in which the Annex’s image is
maintained. If you do not enter a filename, the Annex prompts
for one. Pressing the Return key at the prompt directs the
Annex to boot the default filename.
warningAllows an additional 249-character message. Warning
messages are sent out to users periodically. If you do not
specify a time delay or message, the boot command generates
an automatic warning message.
Remote Annex Administrator’s Guide for UNIX
Book C-9
Page 28
Chapter 1 na Commands
Book C
The following sample boot command requests a boot in one hour and
fifteen minutes:
command: boot +1:15
annex list (return for default): thirdfloor, 132.245.6.40
filename (return for default): <cr>
warning: Shutting down for PM
The Annex can request its boot file from a defined preferred load host. If
that host is not defined, or does not respond, the Annex broadcasts its
request and boots from the first load host to respond.
broadcast
The broadcast command sends a message to specified ports at the
identified Annexes. The syntax is:
broadcast [=port_set | =keyword [@annex_identifier]] message
The port_set argument indicates the port(s) to which the message is to
be broadcast. If the message requires more than one line, using the \
character at the end of each line inserts a new line. Table C-4 lists the
available keywords.
Table C-4. Supported Keywords for the broadcast Command
Keyword Description
allBroadcasts to all serial ports and all virtual connections.
serialBroadcasts to all serial ports.
virtualBroadcasts to all virtual CLI connections (you cannot broadcast
to a single virtual CLI connection).
Book C-10
Remote Annex Administrator’s Guide for UNIX
Page 29
Book C
Chapter 1 na Commands
copy
The copy command requires superuser privileges.
The copy command copies a given set of parameters from one Annex (or
port) to another Annex (or port). T able C-5 defines each copy command.
The syntax is:
CommandDescription
copy annexCopies all Annex parameters except the IP
address, the administrative password, the access
control protocol key, LAT key, option key, and
the virtual CLI password from the specified
Annex to the annex_list.
copy interfaceCopies all interface parameters from the
specified interface to the interface_set.
copy printerCopies all printer parameters to multiple parallel
printer ports.
copy [port |
asynchronous]
Copies all asynchronous port parameters except
the port password from the specified
asynchronous port to the port_set.
Remote Annex Administrator’s Guide for UNIX
Book C-11
Page 30
Chapter 1 na Commands
Book C
To copy port 1 parameters to the remaining ports on the same Annex:
The dumpboot command requires superuser privileges. When the
Annex dumpboots, it terminates all active connections.
The dumpboot command performs a dump of every Annex specified in
the annex_list and then reboots the Annex. You can set the boot time,
and the dumpboot command sends a warning message to users attached
to the Annex. Table C-6 describes the arguments for dumpboot. The
syntax is:
dumpboot [–aq] [[+] [HH:] [MM]] [annex_list] [filename] [warning]
The following is an example of the dumpboot command:
command: dumpboot
annex list (return for default): backhall
filename (return for default): <cr>
warning: Diagnostic testing
The Annex sends the dump to a defined preferred dump host. If that host
is not defined or does not respond, the Annex broadcasts its dump request
and dumps to the first host that responds.
Book C-12
Remote Annex Administrator’s Guide for UNIX
Page 31
Book C
Chapter 1 na Commands
Table C-6. Arguments for the dumpboot Command
ArgumentDescription
–aAborts any delayed dump boots that are pending.
–qPerforms a boot without sending a warning message.
HH:MMThe exact clock time for the boot, i.e., 15:15 indicates 3:15
p.m.
+HH:MMThe number of hours and minutes before the boot takes place,
e.g., +2:15 indicates a boot will occur in two hours and fifteen
minutes.
annex_listSpecifies the Annexes for which dumps and boots are to be
performed. If you do not include annex_list, the command
prompts for it. Pressing the Return key accepts the default
annex_list.
filenameIdentifies the name of the file in which the Annex’s image is
maintained. If you do not enter a filename, the Annex prompts
for one. Pressing the Return key at the prompt directs the
Annex to boot the default filename. The Annex requests the
boot file from a preferred load host if it is defined and
available; otherwise, it broadcasts a boot request.
warningAllows you to enter an additional 250-character message.
Warning messages are sent out to users periodically. If you do
not specify a time delay or message, the dumpboot command
generates an automatic warning message.
Remote Annex Administrator’s Guide for UNIX
Book C-13
Page 32
Chapter 1 na Commands
Book C
echo
The echo command writes its argument to the standard output. This
command is intended for use in script files. The write command
automatically puts echo commands in the script file it writes. The write
commandsection of this chapter includes an example ofechocommands
included in the script file created by the write command. The syntax is:
echo message
help
The help (or ?) command displays on-line help information about na.
Entering help without arguments displays a list of na commands.
Table C-7 defines the arguments for help. The syntax is:
help [command_name | parameter_name | * | syntax]
Table C-7. Arguments for the help Command
command_nameDisplays the command syntax, along with a
description of the command and its arguments.
parameter_nameDisplays the legal values for that parameter.
*Displays available information for all commands and
parameters.
syntaxDisplays the syntax for all commands.
Book C-14
Remote Annex Administrator’s Guide for UNIX
Page 33
Book C
Chapter 1 na Commands
The help command_name display looks like this:
command: help boot
command: boot Syntax: boot [–adlq][[+][HH:][MM]]\
[<filename>] [<warning>
The help parameter_name display looks like this:
command: help timezone_minuteswest
timezone_minuteswest (annex parameter):
Minutes west of GMT: an integer
Entering help followed by the first letter or first few letters of the
command or parameter name displays all entries beginning with the
string. The following example represents an abbreviated display:
command: help t
telnet_escape (serial port parameter):
escape character to use with the telnet command: a character
term_var (serial port parameter):
Terminal variable: a string, maximum sixteen characters
time_broadcast (annex parameter):
broadcast for time server to use if none found:
Y or y to enable; N or n to disable
timezone_minuteswest (annex parameter):
Minutes west of GMT: an integer
toggle_output (serial port parameter):
character used to toggle output: a character
type (printer parameter):
printer interface style: (dataproducts or centronics)
Remote Annex Administrator’s Guide for UNIX
Book C-15
Page 34
Chapter 1 na Commands
Book C
interface
The interface command establishes a default interface_set used in
subsequent commands until another interface or list of interfaces is
specified. Grouping interfaces using an interface_set allows you to issue
onena command to examine or change the parameter values for multiple
interfaces. The syntax is:
interface interface_set | all
If you do not identify a specific Annex using the @ symbol and a name
or Internet address when entering the interface_set, all Annexes in the
current annex_list are used. An interface_set referring to the default
annex_list is updated if a newannex command is issued. Specifying all
sets the default interface_ set to all SLIP and PPP interfaces plus en0.
This example defines the default interface_set as interface asy1 on the
Annex whose Internet address is 132.254.6.34:
The next example defines the default interface_set as interfaces asy1
through asy3on the same Annex as above, plusasy2 on the Annex whose
Internet address is 132.254.35.120:
This example defines the default interface_set as all but interface asy2
on every Annex in the default annex_ list:
command: interface en0,asy1,asy3–16
Book C-16
Remote Annex Administrator’s Guide for UNIX
Page 35
Book C
Chapter 1 na Commands
password
The password command allows you to define a default password for the
current na session. This command is useful when administering several
Annexes with the same password. The syntax is:
password [password]
If you enter the command without giving the password, the Annex
prompts for one, but does not echo it:
command: password
password:
When accessing an Annex with security enabled using the annex
command, na will try to match the Annex’s default password with the
administrative password. If they match, access is authorized
automatically; if they do not match, na prompts for the Annex-specific
administrative password. Enter a password for a given Annex only once
during an na session, even if the Annex is dropped or the default
annex_list is changed.
port
The port command establishes a default port_set used in subsequent
commands until another port or a list of ports is specified. Grouping ports
using a port_set allows you to issue one na command to examine or
change the parameter values for multiple ports. The syntax is:
[port | asynchronous] [port_set | keyword]
Remote Annex Administrator’s Guide for UNIX
Book C-17
Page 36
Chapter 1 na Commands
Book C
If you do not identify a specific Annex using the @ symbol and a name
or Internet address when entering the port_set, all Annexes in the current
annex_list are used. A port_set referring to the default annex_list is
updated if a new annex command is issued. The keyword identifies
groups of ports. Table C-8 defines the supported keywords for port.
Table C-8. Supported Keywords for the port Command
Keyword Definition
allSets default port_set to all serial ports and virtual CLI
connections.
serialSets default port_set to all serial ports.
The following example defines port 1 on the Annex using the Internet
address 132.245.6.34 as the default port_set:
This example defines all but port 6 on every Annex in the default
annex_ list:
command: port 1–5,7–16
Book C-18
Remote Annex Administrator’s Guide for UNIX
Page 37
Book C
Chapter 1 na Commands
printer
The printer command selects a subset of the parallel printer ports. The
syntax is:
printer printer_set
If you do not specify a printer_set, na prompts for one. The default
printer_set is all printers.
quit
The quit command terminates the na program from a script file;naquits
when it receives an end-of-file character (usually
reaches the end of an input file. The syntax is:
CTRL-D) or when it
quit
read
The read command requires superuser privileges.
The read command reads a script file that contains na commands. The
naprogram executes these commands as if they were entered at a terminal
in interactive mode. Use read either to restore an Annex configuration
that has been lost, or to copy parameter settings from one Annex to
another. The syntax is:
read filenameYou can create script files using a text editor or the write command.
Remote Annex Administrator’s Guide for UNIX
Book C-19
Page 38
Chapter 1 na Commands
Book C
If you plan to use LAT or a feature enabled through the option_key
parameter, set the lat_key and option_key parameters manually (using
na or admin) and reboot the Annex before issuing the read command.
Thelat_keyandoption_key parameters are not enabled until you reboot,
and any LAT- or option_key-related parameters in the script file are not
recognized until lat_key or option_key is enabled. Also, make sure the
script file does not contain a differentoption_k ey setting; if it does, delete
the setting before issuing a read.
If a script file was written from an Annex that had option_key enabled,
and you are reading the file to an Annex on which option_key has not
been enabled, delete the option_key and all related parameters from the
script file before issuing a read.
The read command loads parameters even if the subsystem
is disabled.
The following sample script file, called testscript, modifies Annex
parameters:
# standard parameters for Annexes on our network
set annex pref_load_addr 132.245.6.63
set annex pref_dump_addr 132.245.6.63
set annex load_broadcast Y
set annex name_server_1 dns
set annex pref_name1_addr 132.245.6.9
set annex host_table_size 30
set annex cli_prompt “%n%s%p%c”
set annex timezone_minuteswest 360
set annex daylight_savings usa
set annex enable_security Y
set annex vcli_security Y
set annex syslog_mask all
set annex syslog_host 132.245.6.9
The reset command requires superuser privileges. A reset issued to a
serial, virtual, or port_set, terminates any active connections.
The reset command (available from na or admin) changes some of the
current attributes of all the Annexes in the default annex_list without
rebooting them. Unless you use the reset command, changes to
configuration parameters for a specific port, virtual CLI connection,
security, or name server become effective only after booting the Annex.
T able C-9describes the supportedkeywords for theresetcommand. The
syntax is:
nameserver, macros, dialout, modem_table, lat, syslog, and all.
Thereset t1 command resets the T1 engine and T1 statistics information.
This command is used to change the T1 engine’s parameter configuration.
The T1 soft, hard, and esf keywords are described in Table C-10. The
syntax is:
reset t1 [soft | hard | esf]
The reset int_modem command (available fromna oradmin) resets the
specified T1 modem_set. There is no physical reset button. A modem
reset forces the port to be reset. In addition, if the signal protocol is set
to wink start or immediate start, a special AT command is sent to the
modem to select the dialtone detection mechanism. The syntax is:
reset int_modem <modem_set>
Remote Annex Administrator’s Guide for UNIX
Book C-21
Page 40
Chapter 1 na Commands
Book C
The modem_set parameter specifies the individual modem numbers,
separated by commas, or a range of numbers separated by a hyphen. The
valid modem number range is 1 to 24, inclusive.
Table C-9. Keywords for the reset Command
KeywordDefinition
allResets all serial ports and virtual CLI connections.
annex allResets the message-of-the-day, the security, name server,
LAT, and syslog subsystems, and customized user
interface macros.
annex dialoutResets all dial-out route information: it deletes all filters
entered via dial-out routes, deletes all routes and chat
scripts from the dial-out database, and resets all ports that
have an active dial-out route. Then it re-loads the dial-out
routes and chat scripts from the dialout section of the
Annex configuration file.
annex latResets the LAT-specific Annex parameters so that any
future LAT circuits (connections) will use the new values;
existing circuits will continue to use the old values. This
keyword will not terminate existing LAT circuits.
annex macrosResets the customized user interface macros.
annex modemResets attached modem(s).
annex motdResets the message-of-the-day.
annex
nameserver
Resets the name server parameters and flushes the
Annex’s host table.
annex securityResets the security parameters.
(continued on next page)
Book C-22
Remote Annex Administrator’s Guide for UNIX
Page 41
Book C
Chapter 1 na Commands
Table C-9. Keywords for the reset Command (continued)
KeywordDefinition
annex syslogResets thesyslog subsystem. The syslog subsystem does not
use any changes made to the syslog_port parameter.
interfaceResets the interface parameters. The syntax is:
reset interface [interface_set | keyword.
printerResets the parallel printer port. The syntax is:
reset printer [printer_set | keyword]
serialResets all serial ports.
virtualResets all virtual CLI connections.
Table C-10. Keywords for the reset t1 Command
KeywordDefinition
softThis setting reconfigures the software parameters and will only
disrupt the service on the DS0 channels that are changed.
hardThis setting resets the T1 engine causing the T1 Drop/Insert
interface and modem sessions to terminate.
If modem sessions and/or equipment are attached to
the Drop and Insert Interface, their service will be
interrupted for a short period of time (usually a few
esfThis setting resets all the statistics in the T1 engine.
Remote Annex Administrator’s Guide for UNIX
Book C-23
Page 42
Chapter 1 na Commands
Book C
set
The set command requires superuser privileges.
The set command modifies Annex configuration parameters:
set annexModifies Annex parameters.
set interfaceModifies interface parameters.
set printerModifies parallel printer port parameters.
set [port | asynchronous]Modifies asynchronous port parameters.
set t1Modifies T1 parameters.
The syntax is:
set annex [=annex_list] annex_parameters
set interface [=interface_list] interface_parameters
set printer [=printer_list] printer_parameters
set [port | asynchronous] [=port_list] port_parameters
set t1 t1_parameters
The annex_parameters, interface_parameters, printer_parameters,
port_parameters, and t1_parameters arguments require a name and a
value separated by a space. A space is required between each parameter
argument. You can enter more than one parameter argument with each
command. If you are entering multiple parameter arguments that require
a new line, precede the new line with the ‘‘\’’ character. Changes made
to parameters take effect after booting or resetting the Annex or the
port(s).
Book C-24
Remote Annex Administrator’s Guide for UNIX
Page 43
Book C
Chapter 1 na Commands
Sample command lines for setting port parameters are:
command: set port speed 9600
command: set port data_bits 7
command: set port stop_bits 1
command: set port parity odd
command: set port control_lines none
command: set port type hardwired
command: set port mode cli
command: set port inactivity_timer 120
show
The show command displays current Annex, interface, printer, or port
parameters:
show annexDisplays Annex parameters.
show interfaceDisplays interface parameters.
show printerDisplays parallel printer port parameters.
show [port | asynchronous]Displays asynchronous port parameters.
show t1Displays t1 parameters.
The syntax is:
show annex [=annex_list] [keyword | annex_parameters]
show interface [=interface_list] [keyword | interface_parameters]
show printer [=printer_list] [keyword | printer_parameters]
show [port | asynchronous] [=port_list] [keyword | port_parameters]
show t1 t1_parameter
Remote Annex Administrator’s Guide for UNIX
Book C-25
Page 44
Chapter 1 na Commands
Book C
Each keyword displays a subset of parameters:
•Table C-11 lists the keywords and associated parameters for the
show annex command.
•Table C-12 lists the keywords and associated parameters for the
show interface command.
•Table C-13 lists the keywords and associated parameters for the
show [port |asynchronous] command.
•Table C-14 lists the keywords and associated parameters for the
show t1 command.
Table C-11. Keywords for the show annex Command
KeywordParameters
allDisplays all Annex parameters.
appletalka_router, default_zone_list, node_id, zone
genericinet_addr, subnet_mask, pref_load_addr, pref_dump_addr,
slip_ppp_security, net_inactivity, phone_number,
do_compression, allow_compression from the serial group and
subnet_mask, slip_load_dump_host, slip_allow_dump,
slip_mtu_size, slip_no_icmp, slip_tos
alarmsyslogDisplays parameter setting as yes or no. These values
enable or disable the alarm event syslogs.
bypassDisplays parameter setting as yes or no. A setting of
yes removes the T1 engine from the network.
mapDisplays mappings for the DS0 channels.
ringDisplays parameter setting as yes or no. A setting of
yes means that an audible ring is sent to the service
provider for incoming calls.
sigprotoDisplays the inbound and outbound signaling protocol
settings for each DS0 channel.
t1_infoDisplays a character string (128 bytes maximum) of
printable ASCII characters that describe installation
information from the service provider.
(continued on next page)
Remote Annex Administrator’s Guide for UNIX
Book C-29
Page 48
Chapter 1 na Commands
Book C
Table C-14. Keywords for the show t1 Command (continued)
KeywordDescription
tdi_distanceDisplays an integer from 0 to 655 that represents the
length of the cable from the T1 Drop/Insert Interface to
the PBX or other equipment.
tdi_framingDisplays the super frame format used on the T1 Drop/
Insert Interface as d4 (super frame) or esf (extended
super frame). The default is esf.
tdi_line_codeDisplays the T1 Drop/Insert Interface line code setting
as either ami or b8zs. The default is b8zs.
tni_circuit_idDisplays the T1 circuit identifier string (128 charcters
maximum) required by the service provider for
customer service calls.
tni_clockDisplays parameter setting as loop, local, or external.
These values represent the source for the T1 clock.
tni_esf_fdlDisplays parameter setting as ansi or att. These v alues
represent the Facilities Data Link standard.
tni_framingDisplays parameter setting as d4 or esf. These values
represent the superframe format setting on the T1
Network Interface
tni_line_buildoutDisplays parameter setting as 0, 7.5, 15, or 22.5. These
values represent the cable loss measurement between
the last line generator and the customer location.
tni_line_codeDisplays parameter setting as ami or b8zs. These
values represent the line code used on the T1 Network
Interface.
tni_ones_densityDisplays the T1 Network Interface ones density setting
as on or off.
Book C-30
Remote Annex Administrator’s Guide for UNIX
Page 49
Book C
Chapter 1 na Commands
write
The write command creates a script file from the configuration data for
a specific Annex. You can modify this script file using any text editor.
Use the write command either to back up the current Annex’s
configuration or copy it to multiple Annexes. Once you write a script file,
issuing the read command activates the Annex parameter settings
contained in the file (for more details, seeread on page A-19).The syntax
for write is:
write annex_identifier filename
For security reasons, the following basic Annex and port parameters
are written to the script file as comments: acp_key, lat_key,
option_key, password, port_password, ppp_password_remote,
rip_auth, and vcli_password.
Since the inet_addr parameter uniquely identifies the Annex’s
location in the network, it is not written to the script file and it is not
restored during a read. You must set this parameter manually.
You can remove the pound sign (#) from the parameters written as
comments in the script file, enter valid data for their settings, and
issue a read command to copy or restore these parameters to another
Annex.
Entering passwords as plain text in the script file poses a possible
security breach for your system. Take appropriate precautions against
unauthorized access of this file.
The write command writes set annex, set printer, set port, and setinterface commands into the script file for each basic Annex, printer,
port, and interface parameter. The write command also includes echo
commands in the script file. When the script is executed using the read
command, the arguments to theechocommand are written to the standard
output, indicating the progress of the read.
Remote Annex Administrator’s Guide for UNIX
Book C-31
Page 50
Chapter 1 na Commands
Book C
The following is an example of the write command:
command: write 132.245.6.101 fronthall.script
The following example uses the write and read commands to install a
new Annex and to create a back-up copy of an Annex. The first line writes
configuration data for the Annex thirdfloor to a file named
thirdfloor.prm. The data from thirdfloor is copied to the new Annex
specified in the annex_list defined using the annex command.
set annex pref_load_addr 132.245.6.75
set annex pref_dump_addr 132.245.6.75
set annex load_broadcast Y
set annex image_name “”
set annex subnet_mask 255.255.255.0
set annex authoritative_agent Y
:
echo setting serial port parameters for port 1
set port=1 speed 19200
set port=1 data_bits 8
set port=1 stop_bits 1
set port=1 parity none
set port=64 slip_allow_dump Y
set port=64 do_compression N
set port=64 slip_allow_compression Y
set port=64 slip_no_icmp Y
set port=64 slip_tos Y
Book C-32
Remote Annex Administrator’s Guide for UNIX
:
Page 51
Book C
Chapter 2
Configuration Parameters
The configuration parameters define the operating characteristics for
a given Annex. There are three ways in which you can configure and
manage these parameters:
•The host-based na utility sends requests to the Annex to read,
set, reset, show, or copy configuration parameters (for more
details, see na Commands on page Book C-1).
•The CLI admin command is a counterpart of na that runs
locally on the Annex.
•The SNMP agent included in the Annex software provides MIB
objects that can be read and set by a standard SNMP
management station; these MIB objects correspond to the
configuration parameters (for more details, see Simple NetworkManagement Protocol (SNMP) on page Book B-41).
This chapter includes the following sections:
•Parameter Conventions.
•Parameter Descriptions.
Parameter Conventions
This section describes the conventions for entering parameter v alues and
returning those values to the supplied defaults.
Book C-33Remote Annex Administrator’s Guide for UNIX
Page 52
Chapter 2 Configuration Parameters
Entering Parameter Values
The conventions for entering parameter values depend on the type of
information the parameter defines.
•For parameters requiring an IP address, specify the address in
•For parameters requiring a yes/no input, use either Y or N.
•For parameters that define passwords, the na/admin command
Book C
dot notation as a decimal number (from 0 to255), a hexadecimal
number, or a combination of both: 192.9.200.100,
0xC0.0x9.0xC8.0x64, or 192.9.200.0x64.
These parameters are not case sensitive.
show displays only “<set>” or “<unset>”; it never displays the
values entered for the parameters. If you forget a password after
setting it, you can reset it only by using the ROM monitor erase
command to erase all of the Annex’s non-volatile memory.
Saving the configuration to a file (using the write
command) prevents having to reconfigure the Annex if
non-volatile memory is erased.
•Parameters that require a string for input allow a maximum of 16
characters, unless otherwise specified.
Book C-34
Remote Annex Administrator’s Guide for UNIX
Page 53
Book C
Chapter 2 Configuration Parameters
Setting Parameters to Supplied Defaults
Each configuration parameter, except the Annex’s IP address, has a
default value. Using the na command set, you can return any parameter
to its default setting (for more details, see set on page Book C-24).
Depending on the parameter type, the syntax options are:
Setting Annex
Parameters
Setting Interface
Parameters
1.set annex
The set annex
require a numeric value. For example, to set pref
default, 0.0.0.0, enter:
command: set annex pref_dump_addr 0
2.set annex
The set annex
that require a string value; these parameters default to either a null
string ("") or “<unset>”. For example, to set image
default, a null string (""), enter:
command: set annex image_name ""
3.set annex
The set annex
parameters. These parameters are set by choosing either an option
from a known list or a yes/no response. For example, to set
enable_security to its default, N, enter:
command: set annex enable_security default
annex_parameter
annex_parameter
annex_parameter
annex_parameter
annex_parameter
annex_parameter
0
0 command sets parameters that
_
dump_addr to its
""
"" command sets all parameters
_
name to its
default
default command sets all other
To set an interface parameter to its default value, use the set interface
command:
The set [port | asynchronous] [=port_set] port_parameter ^@ command
sets parameters that have single-character default values. Enter the
default value as a two-character sequence consisting of the circumflex
character (^) followed by the at sign (@). For example, to seterase_word
to its default value, ^W, enter:
command: set port erase_word ^@
Book C-36
The set [port | asynchronous] [=port_set] port_parameter "" command
sets parameters that require a string; these parameters default to either a
null string ("") or “<unset>”. For example, to set user_name to its
default, the null string, enter:
command: set port user_name ""
The set [port | asynchronous] [=port_set] port_parameter default
command sets all other parameters. These parameters are set by choosing
either an option from a known list or a yes/no response. The keyword
default sets these parameters to their default values. For example, to set
speed to its default, 9600, enter:
command: set port speed default
Remote Annex Administrator’s Guide for UNIX
Page 55
Book C
Chapter 2 Configuration Parameters
Setting All
Parameters
T o set all of the Annex’s parameters to the supplied def aults, use the ROM
monitor erase command (see the appropriate Remote Annex Hardware
Installation Guide). This command erases all parameters, including the
Annex’s IP address. After issuing erase, you must re-enter the Annex’s
IP address and re-configure the Annex.
Parameter Descriptions
The Annex configuration parameters are grouped by type, e.g., Annex,
interface, etc. Parameters within these groups are further divided by
relative function. Each function has an associated keyword (e.g.,
nameserver, security, time, etc.). The set and show commands accept
these keywords as arguments.
•Table C-15 lists the keywords and the associated parameters that
display with the show annex command.
•T able C-16 lists the keywords and the associated parameters that
display with the show interface command.
•Table C-17 lists the keyword and the associated parameters that
display with the show printer command.
•T able C-18 lists the keywords and the associated parameters that
display with the show [port | asynchronous] command.
•T able C-19 lists the keywords and the associated parameters that
display with the show t1 command.
The LAT-related parameters are visible only when the lat_key
parameter contains the correct key value (for more details, see
Configuring LAT Services
Remote Annex Administrator’s Guide for UNIX
on page A-409).
Book C-37
Page 56
Chapter 2 Configuration Parameters
Table C-15. Keywords for the show annex Command
KeywordParameters
allDisplays all Annex parameters
genericinet_addr, subnet_mask, pref_load_addr, pref_dump_addr,
Book C
The AppleTalk, tn3270 , and dynamic-dialout parameters are visible
only when the option_key parameter contains the correct key value
(for more details, see AppleTalk on page A-301, tn3270 on page
A-214, and IP Routing on page A-169).
Table C-18. Keywords for the show [port | asynchronous] Command (cont’d)
KeywordParameters
pppppp_acm, ppp_mru, ppp_security_protocol,
ppp_ipx_network, ppp_ipx_node, ppp_username_remote,
ppp_password_remote, ppp_ncp, as well as the serial
parameters local_address, remote_address, address_origin,
metric, slip_ppp_security, net_inactivity, phone_number,
alarmsyslogDisplays parameter setting as yes or no. These values
enable or disable the alarm event syslogs.
bypassDisplays parameter setting as yes or no. A setting of yes
removes the T1 engine from the network.
mapDisplays mappings for the DS0 channels.
ringDisplays parameter setting as yes or no. A setting of yes
means that an audible ring is sent to the service provider
for incoming calls.
sigprotoDisplays the inbound and outbound signaling protocol
settings for each DS0 channel.
t1_infoDisplays a character string (120 bytes maximum) of
printable ASCII characters that describe installation
information from the service provider.
(continued on next page)
Remote Annex Administrator’s Guide for UNIX
Book C-41
Page 60
Chapter 2 Configuration Parameters
Table C-19. Keywords for the show t1 Command (continued)
KeywordDescription
tdi_distanceDisplays an integer from 0 to 655 that represents the
tdi_framingDisplays the super frame format used on the T1 Drop/
tdi_line_codeDisplays the T1 Drop/Insert Interface line code setting
tni_circuit_idDisplays the T1 circuit identifier string (120 charcters
tni_clockDisplays parameter setting as loop, local, or external.
Book C
length of the cable from the T1 Drop/Insert Interface
to the PBX or other equipment.
Insert Interface as d4 (super frame) or esf (extended
super frame). The default is esf.
as either ami or b8zs. The default is b8zs.
maximum) required by the service provider for
customer service calls.
These values represent the source for the T1 clock.
tni_esf_fdlDisplays parameter setting as ansi or att. These values
represent the Facilities Data Link standard.
tni_framingDisplays parameter setting as d4 or esf. These values
represent the superframe format setting on the T1
Network Interface
tni_line_buildoutDisplays parameter setting as 0, 7.5, 15, or 22.5. These
values represent the cable loss measurement between
the last line generator and the customer location.
tni_line_codeDisplays parameter setting as ami or b8zs. These
values represent the line code used on the T1 Network
Interface.
tni_ones_densityDisplays the T1 Network Interface ones density setting
as on or off.
The parameter descriptions that follow are in alphabetical order. The
Software Refer ence Guide on page C-269provides a series of tables that
list the parameters in functional groupings.
Book C-42
Remote Annex Administrator’s Guide for UNIX
Page 61
Book C
Chapter 2 Configuration Parameters
a_router
The Ethernet address of the network’s A_Router. The Annex uses this
value as a hint at start-up. When a Routing Table Maintenance Protocol
(RTMP) message arrives from this Ethernet address, the Annex gleans
the AppleTalk DDP address from the packet and tries to talk to the
AppleTalk router. The address is a hexadecimal Ethernet address, e.g.,
00-7F-12-33-44-55. The default is 00-00-00-00-00-00.
acp_key
This Annex parameter defines the encryption key used to exchange
messages between the Annex and the security server. This parameter
works only when theenable_securityparameter is set toYand a security
server is defined. The security server maintains the encryption key for
each Annex in theacp_keys file. The default for this string is“<unset>. ”
The Annex and the security server can communicate only when this
parameter’s value matches the Annex’s value in the security server’s
acp_keys file.
address_origin
This asynchronous port parameter determines where the Remote Annex
looks to find the local and remote IP addresses to use for the endpoints
of a PPP/IPCP link. T able C-20 describes the options. The default islocal.
Remote Annex Administrator’s Guide for UNIX
Book C-43
Page 62
Chapter 2 Configuration Parameters
Table C-20. Valid Options for address_origin Parameter
OptionDescription
acpThe Remote Annex passes its own address, and the user name
localThe Remote Annex uses values set by the local_address and
dhcpThe Remote Annex contacts a DHCP server to obtain a remote
Book C
and port, to the ACP host. The host then determines the local
and remote addresses for the link by searching for entries in the
acp_dialup file.
remote_address parameters. It does not search acp_dialup.
address dynamically on behalf of the remote client. See
Dynamic Allocation of Network Addresses on page A-479 for a
complete explanation. This value is valid only when the
port is effectiv ely in PPP mode (e.g., the mode w as set to
ppp or the ppp command was issued when the port was
in CLI mode). DHCP is not supported with SLIP.
When address_origin is set to acp, the local and remote field settings
in the acp_dialup file supersede the values set in the local_address
and remote_address port parameters (for more details, seeDetermining Dial-up Addresses using the acp_dialup File on page
A-482).
This parameter replaces the dialup_addresses parameter for Release
13.2 and later. Earlier releases do not recognize address_origin and
require the use of dialup_addresses instead.
alarmsyslog
This T1 parameter enables or disables the T1 alarm event syslogs. A Y
enables alarm syslogs, an N disables it. The default is Y.
allow_broadcast
This asynchronous port parameter allows an asynchronous port to receiv e
administrative broadcast messages generated by theboot andbroadcast
commands. A Y enables this parameter, anN disables it. The default is Y .
Book C-44
Remote Annex Administrator’s Guide for UNIX
Page 63
Book C
Chapter 2 Configuration Parameters
allow_compression
This asynchronous port parameter allows the Annex to use TCP header
compression on a SLIP or PPP line. Header compression occurs only if
the other side of the serial link initiates compression. A Y enables this
parameter, an N disables it. The default is N.
allow_snmp_sets
This Annex parameter enables the Annex to accept and process SNMP
set commands. When disabled, the Annex rejects all SNMP set
commands; the Annex SNMP agent returns the error no such name for
the first object in the set command. A Y enables this parameter, an N
disables it. The default is N.
arap_v42bis
This asynchronous port parameter enables V.42bis compression during
an AppleTalk session. A Y enables this parameter, an N disables it. The
default is Y.
at_guest
This asynchronous port parameter allows guests to log into an AppleT alk
session. When at_guest is enabled, if a client requests guest access, the
Annex asks ACP for username guest privileges. A Y enables this
parameter, an N disables it. The default is N.
Remote Annex Administrator’s Guide for UNIX
Book C-45
Page 64
Chapter 2 Configuration Parameters
at_nodeid
This asynchronous port parameter defines the node ID hint used for an
ARA client during connection establishment. This parameter value is an
AppleTalk address in the form net.node. The valid net values are 0 to
65534. The valid node values are 0 to 254. The default is 0.0.
at_security
This asynchronous port parameter turns on ACP service for an AppleT alk
session on this port. When both at_security and enable_security are
enabled, the Annex uses ACP to get security information about the client,
including authentication, logging, and zone access. If at_security is not
enabled, the Annex uses only local security . AY enables this parameter,
an N disables it. The default is N.
Book C
attn_string
This asynchronous port parameter defines a control character sequence
that returns users to the CLI prompt. Users can define a temporary control
character sequence using the CLI stty attn command; stty attn ""
disables the sequence. The default is no control character sequence,
displayed as ""
If you are running a stats [–sm [ports] | [time]] command with a
defined time interval, the Annex ignores an attention string with
multiple characters.
; the default for virtual CLI connections is CTRL-A (^A).
Book C-46
Remote Annex Administrator’s Guide for UNIX
Page 65
Book C
Chapter 2 Configuration Parameters
authoritative_agent
This Annex parameter enables the Annex to send an ICMP Address Mask
reply to a host that broadcasts a subnet mask request. A Y enables this
parameter, an N disables it. The default is Y.
authorized_groups
This asynchronous port parameter specifies the LAT protocol remote
group codes that are accessible to users on a given Annex port. You can
enter all, none, a series of numbers between 0 and 255 separated by
commas (e.g., 1, 5,7) or a range of numbers between 0 and 255separated
by dashes (e.g., 1–5,200–255) followed by enabled or disabled. The
default is all disabled.
autobaud
This asynchronous port parameter determines whether or not the Annex
automatically detects line speed when a connection is opened and whether
or not it sets matching terminal port characteristics on the next login. This
parameter works only when the Annex is configured as a VMS interface
(i.e., when the cli_interface parameter is set to vci)
information, see the Annex Interface for VMS EnvironmentsAdministrator’ s Guide.AY enables this parameter, an N disables it. The
default is N.
To disable the autobaud feature, enter a value in the speed parameter
before setting autobaud to N.
. For more
Remote Annex Administrator’s Guide for UNIX
Book C-47
Page 66
Chapter 2 Configuration Parameters
autodetect_timeout
This Annex parameter specifies the maximum amount of time the Annex
should wait for auto_detect mode to identify an incoming call as PPP . If
the specified number of seconds is exceeded, or if the user enters a carriage
return before the call is detected as PPP , the Anne x places the user in CLI
mode. Valid values for the parameter are 1 - 60; the default value is 30.
backward_key
This asynchronous port parameter specifies a character or string that
reopens the next lower numbered session (already established at your
port) from within the current session without returning to local mode.
When defining this value, use a unique, unused character (such as Control
B) or a string of characters. T o clear an existing setting, enter a null string
(""). The default is no control character sequence.
Book C
On virtual (telnet) ports, the backward_key value is limited to one
printable or Control character. If the user tries to set this value to more
than one character, i.e., a string, the setting is ignored and the previous
value is restored.
On non-virtual ports, a backward_key string can range from 1 to 16
characters.
banner
This asynchronous port parameter controls whether or not the Annex
banner and message-of-the-day display on CLI ports. A Y enables this
parameter, an N disables it. The default is Y.
This parameter has effect only at the CLI level.
Book C-48
Remote Annex Administrator’s Guide for UNIX
Page 67
Book C
Chapter 2 Configuration Parameters
broadcast_addr
This Annex parameter defines the IP address for Annex broadcasts. It is
recommended that you set a subnet broadcast address, if possible. In this
case, you set the subnet portion of the broadcast address to match the
Annex subnet address, as determined by the Annex subnet mask, and you
set the host portion of the broadcast address to all one-bits. For example,
if the Annex subnet address is 132.254.9.0, and the Annex subnet mask
is 255.255.255.252, you should set the broadcast address to 132.254.9.3.
T o calculate this, subtract the subnet mask from 255.255.255.255. Thus,
in the previous example, you subtract 255.255.255.252 from
255.255.255.255 to arrive at 0.0.0.3.
If your network is not subnetted, you can specify a network broadcast
address. In this case, you set the network portion of the broadcast address
to match the Annex network address, as determined by the intrinsic mask
for the network class. And you set the host portion of the broadcast
address to all 1-bits.
Finally , you can set a limited broadcast address of 255.255.255.255 that
reaches all nodes on the subnet. However, if you have more than one
subnet on the same physical cable, the Annex will broadcast to all nodes
on all of the subnets. This can be troublesome if some of the subnets or
nodes do not recognize the broadcast.
The default for broadcast _addr is 0.0.0.0, which Annex RIP routing
does not support (because most hosts do not recognize it).
Remote Annex Administrator’s Guide for UNIX
Book C-49
Page 68
Chapter 2 Configuration Parameters
broadcast_direction
This asynchronous port parameter defines the direction in which an
administrative broadcast message is sent on a port. The options are
network or port; the default is port. This parameter is valid only for a
slave port (defined by the mode parameter).
If you specify network, the Annex sends administrative broadcast
messages out the network side of the connection to the initiator. If you
specify port, the Annex sends broadcast messages out the port side of
the connection.
bypass
Book C
This T1 parameter is used to remove the T1 engine from the network.
When bypass is set to Y, the T1 engine is off-line and the T1 Network
Interface (T1NI) and the T1 Drop and Insert Interface (T1DII) are
physically isolated from the T1 engine. When bypass is set to Y, the T1
engine has no effect on the T1 circuit. When bypass is set to N, the T1
engine is attached to both the T1NI and the T1DII. The default is Y.
chap_auth_name
This Annex parameter defines the character string that is used as theName
field entry when issuing a CHAPchallenge o ver a PPP link. The minimum
string length is one character and the maximum string length is 16
characters; the default is chap.
Change the default value:
•If you want the remote end of the PPP link to pick a secret
token that depends on the received name.
•If you want to achieve the highest level of security.
Book C-50
Remote Annex Administrator’s Guide for UNIX
Page 69
Book C
Chapter 2 Configuration Parameters
char_erase
When this asynchronous port parameter is enabled, the Annex echoes
both the character erase and the word erase characters for a video
terminal; i.e., the previous character (or word) looks as if it has been
erased. A Y enables this parameter, an N disables it. The default is Y.
When char_erase is disabled, the Annex echoes the erase characters for
a hard-copy terminal. It echoes the first erase character as a “\” followed
by the deleted character. Each additional use of the erase character deletes
and displays another character. The first character typed (other than the
erase character) echoes a “/” and the character, e.g., typing
“asdf<Delete><Delete>
This parameter has effect only at the CLI level.
g” echoes as “asdf\fd/g.”
circuit_timer
This Annex parameter defines the time interval in tens of milliseconds
between the transmission of LAT packets (e.g., if you enter
9, the time
interval will be 90 milliseconds). Allowable values range from 1 to 25.
The default value is 8 (80 milliseconds).
cli_imask7
When this asynchronous port parameter is enabled, the Annex masks CLI
input to seven bits. The Annex masks input only at the CLI. When
cli_imask7 is disabled, the Annex expects eight-bit ASCII input. A Y
enables this parameter, an N disables it. The default is Y.
Remote Annex Administrator’s Guide for UNIX
Book C-51
Page 70
Chapter 2 Configuration Parameters
cli_inactivity
This asynchronous port parameter specifies the amount of time in minutes
that the Annex remains idle before disconnecting a CLI session from a
port. Unlike the inactivity_timer, this timer does not disconnect a CLI
session with active jobs. Allowable values range from 0 (or off)to255
minutes or immediate. The default is 0.
Entering0 disables the timer; entering255 causes the Annex to disconnect
as soon as it exits from its last job. Enteringimmediate causes the Annex
to hang up the port immediately after exiting the last job.
cli_interface
Book C
This asynchronous port parameter allows you to control the prompt that
appears for VMS or UNIX environments. Allowable values are vci and
uci. The default is uci.
When set to vci, the Local> prompt is displayed followed by the
Username> prompt; the uci setting pro vides a standard UNIX interface
(with prompts defined by the cli_prompt and prompt parameters).
cli_prompt
This Annex parameter defines the Annex prompt for all CLI users. This
parameter uses formatting codes consisting of the percent character (%)
and a single lowercase letter. You can combine up to 16 of these codes
(e.g., %a%c). You can also enter text that will appear in the prompt as
long as the entry as a whole does not exceed 32 characters. The default
prompt is %a%c (the string annex:). Table C-21 lists the formatting
codes.
Book C-52
Remote Annex Administrator’s Guide for UNIX
Page 71
Book C
Chapter 2 Configuration Parameters
Table C-21. Formatting Codes for Annex Prompts
CodeExpansion
%aThe string annex.
%cA colon followed by a space.
%dThe current date and time in the following format:
Mon Mar 14 13:59:42 1991.
%iThe Annex’s IP address.
%jA new line character, skip to the beginning of the next line.
%lThe location defined for the port; if none, the string port nn,
where nn is the number of the serial line.
%nThe Annex’s name, if known, or the IP address.
%pThe port number, or the virtual CLI connection number in vn
form, where n is the virtual CLI connection number.
%rThe string port.
%sA space.
%tThe current time in 24-hour format.
%uThe user name defined for the port; if none, a null string.
cli_security
This asynchronous port parameter enables user authentication by the
host-based ACP server for all CLI connections. When disabled, you
cannot use any Annex security mechanism other than the administrativ e
password for CLI ports. AY enables this parameter, anN disables it. The
default is N.
When cli_security is enabled, the Annex logs PPP/SLIP logins/
logouts to the ACP log file.
Remote Annex Administrator’s Guide for UNIX
Book C-53
Page 72
Chapter 2 Configuration Parameters
config_file
This Annex parameter defines the file name for the configuration file
maintained on the load host. This file contains information about
gateways, rotaries, macros, and services; it must reside in the directory /usr/spool/erpcd/bfs. The default file name is config.annex.
connect_security
This asynchronous port parameter enables the host-based security policy
for access from the CLI to the network (using telnet and rlogin only). If
connect_security is enabled, the user must receive authorization to
connect to a host on the network. The supplied security policy scans the
file /install-directory/acp_r estrict to authorize a connection to a host
from the Annex. If authorization is not granted, the connection is not
made. A Y enables this parameter, an N disables it. The default is N.
Book C
control_lines
This asynchronous port parameter defines the type of hardware control
lines used on this port. T able C-22 describes the valid options; the default
is none.
Table C-22. Valid Options for the control_lines Parameter
OptionDescription
bothAllows both flow control and modem control.
flow_controlConfigures the control lines for flow control (RTS/
CTS), but does not activate hardware flow control.
modem_controlConfigures the control line for modem control using
DTR/DCD/DSR hand-shaking.
noneDoes not implement hardware control lines.
Book C-54
Remote Annex Administrator’s Guide for UNIX
Page 73
Book C
Chapter 2 Configuration Parameters
data_bits
This asynchronous port parameter defines the number of data bits in a
character. This value does not include the start, stop, or parity bits.
Allowable values are 5 through 8. The default is 8.
daylight_savings
This Annex parameter defines the daylight savings time for your
geographic location. The Annex uses this parameter to adjust the time
display for daylight savings time. Valid options are us, australian,
british, canadian, east_european, mid_european, west_european,
and none; the default is us.
dedicated_address
This asynchronous port parameter, along with the dedicated_port
parameter, defines one host and one TCP port to which this port can
connect. T o use this parameter, set themodeparameter to dedicated. The
dedicated_address is the host’s IP address. The default is 0.0.0.0.
This parameter is obsolete; it has been replaced with
dedicated_arguments (see dedicated_arguments on page A-55).
dedicated_arguments
This asynchronous port parameter defines the command line arguments
used for dedicated ports. The parameter accepts a 100-character string.
Use this parameter in conjunction with themode (seemode on page A-75)
and dedicated_port parameters. The default is a null string ("").
Remote Annex Administrator’s Guide for UNIX
Book C-55
Page 74
Chapter 2 Configuration Parameters
dedicated_port
This asynchronous port parameter selects the application name or TCP
port number to which this port can connect. The options aretelnet,rlogin,
call, or a TCP port number. The default is telnet.
For more details on configuring the Annex for use with dedicated ports,
see Dedicated Ports on page A-62.
default_zone_list
Book C
If port 5B (rlogin) is selected, the Annex uses BSD rlogin. If a port in
the 7000 to 7999 range is selected, the Annex uses TCP. Otherwise,
the Annex uses telnet.
This Annex parameter contains the zone list that is sent to AppleTalk
clients in case of an ACP failure. The string size ranges from 1 to 100
characters. You must use spaces to separate zone names (e.g., generalengineering lab). To escape embedded spaces within a zone name, use
the backslash (\) character. If you do not set this parameter, the Annex
provides the network zone list. The default is a null string ("").
default_session_mode
This asynchronous port parameter defines the default session mode when
the VMS interface is configured (i.e., when cli_interface is set to vci).
Valid options are interactive, passthru, passall, or transparent. The
default is interactive.
Book C-56
Remote Annex Administrator’s Guide for UNIX
Page 75
Book C
Chapter 2 Configuration Parameters
dhcp_broadcast
This Annex parameter enables and disables the use of DHCP broadcast
messages; a DHCP proxy client will use it to determine if it can generate
DHCP broadcast messages as a means of “discovering” a DHCP server.
The options for the parameter are Y or N, N being the default (i.e., the
broadcast of DHCP messages is disabled). dhcp_broadcast functions
consistently with all other broadcast parameters defined in the system.
disabled_modules
This Annex parameter allows you to disable indi vidual software modules
to free memory space. If you enter more than one module, separate
module names using commas. Valid options are admin, atalk, dialout,
edit,fingerd, ftpd, ipx,lat, nameserver, ppp,slip,snmp,tn3270,tstty ,
vci, all, ornone. The default is vci (disables the Annex VMS interface).
You should exercise extreme caution when disabling modules:
•Entering a null string ("") sets this parameter to its default
value.
•Ifdisabled_modules is set to a value other than none andserver_capability includes the operational image, no
modules are disabled; a syslog message announces this
override.
•The vci option disables the Annex interface for VMS
environments along with the following commands:
•Iflat_key is inv alid andserver_capability is set tonone, the
LAT code is freed for use by the system.
Remote Annex Administrator’s Guide for UNIX
Book C-57
Page 76
Chapter 2 Configuration Parameters
do_compression
This asynchronous port parameter starts TCP/IP header compression on
a SLIP link. When enabled, the Annex negotiates for TCP/IP compression
for both sides of the connection. AY enables this parameter, an N disables
it. The default is N.
Book C
•Disabling LAT also disables the CLI commands services,
connect, and queue.
•Disablingadminandsnmp can cause problems if host-based
na is not available. To change parameters in this case, return
to monitor mode, erase the parameters in non-volatile
memory, and reconfigure the Annex.
•Disabling dialout also disables filtering.
echo
This asynchronous port parameter directs an Annex to echo all characters
as a user types. This echo occurs only at the CLI level. A Y enables this
parameter, an N disables it. The default is Y.
enable_security
This Annex parameter activates the security system. To enable any
security features, set this parameter to Y. A Y enables this parameter , anN disables it. The default is N.
erase_char
This asynchronous port parameter defines a control character sequence
for the CLI erase character. The def ault is the Delete key (displayed as
^?).
Book C-58
Remote Annex Administrator’s Guide for UNIX
Page 77
Book C
Chapter 2 Configuration Parameters
erase_line
This asynchronous port parameter defines a control character sequence
for the CLI line erase character. The default is
CTRL-U (^U).
erase_word
This asynchronous port parameter defines a control character sequence
for the CLI word erase character. The default is
CTRL-W (^W).
facility_num
This Annex parameter identifies a LA T host by number . Allowable values
range from 0 to 32767. The default value is 0.
forward_key
This asynchronous port parameter specifies a character or string that
reopens the next av ailable, higher numbered session already established
at your port. When defining this value, use a unique, unused character
(such as Control F) or a string of characters. T o clear an e xisting setting,
enter a null string (""). The default is no control character sequence.
On virtual (telnet) ports, theforward_keyvalue is limited to one printable
or Control character. If the user tries to set this value to more than one
character, i.e., a string, the setting is ignored and the previous value is
restored.
On non-virtual ports, a forward_key string can range from 1 to 16
characters.
Remote Annex Administrator’s Guide for UNIX
Book C-59
Page 78
Chapter 2 Configuration Parameters
forwarding_count
This asynchronous port parameter controls Annex port behavior for
received characters. When set to a number other than zero, the port does
not forward characters until it receives the specified number of characters.
When set to zero, the port uses the value in the forwarding_timer
parameter. Allowable values range from 0 to 255. The default is 0.
forwarding_timer
Book C
If you use both forwarding_count and forwarding_timer, the
Annex uses the value that occurs first.
Setting forwarding_count to one or forwarding_timer to zero may
have a severe effect on the network when heavy serial input occurs.
This asynchronous port parameter sets the amount of time in ten
millisecond (ms) intervals that can elapse before an Annex forwards
received data. If new data arrives before the timer expires, the Annex
resets the timer. Allo wable values range from0to255 or off. The default
is 5 (50 ms); if you set the value to 0, the Annex uses 5.
If you use both forwarding_count and forwarding_timer, the
Annex uses the value that occurs first.
Setting forwarding_count to one or forwarding_timer to zero may
have a severe effect on the network when heavy serial input occurs.
Book C-60
Remote Annex Administrator’s Guide for UNIX
Page 79
Book C
Chapter 2 Configuration Parameters
group_value
This Annex parameter specifies the LAT protocol remote group codes
that can access local services offered by an Annex. To access these
services, the Annex must have at least one enabled group code that
matches the service’s group codes. Valid options are all,none, a series of
numbers between 0 and 255 separated by commas, or a range of numbers
between 0 and 255 separated by dashes, followed byenabled or disabled.
The default is all disabled.
hardware_tabs (asynchronous)
This asynchronous port parameter allows the Annex to con vert ASCII tab
characters to the correct number of spaces when a terminal does not
support hardware tabs. This occurs only at the CLI level. A Y enables
this parameter, an N disables it. The default is Y.
hardware_tabs (parallel)
This parallel printer port parameter enables the printer to use hardware
tab stops. When disabled, the Annex converts a tab character to the
number of spaces necessary to reach the next tab stop. Y enables this
parameter, an N disables it. The default is N.
host_table_size
This Annex parameter defines the number of entries allowed in the host
table. Allowable values range from 0 to 255. Entering 255 allows an
unlimited number of entries; entering 254 indicates that there is no host
table. In this case, the Annex requires a name server to resolve e very host
name. The default is 64.
Remote Annex Administrator’s Guide for UNIX
Book C-61
Page 80
Chapter 2 Configuration Parameters
image_name
This Annex parameter defines the file name containing the operational
code that loads by default when you boot an Annex. The string size ranges
from 0 to 100 characters. The default is a null string ("").
imask_7bits
This asynchronous port parameter enables an Annex to mask input to
seven bits. When disabled, the Annex e xpects eight-bit ASCII input. This
parameter has no effect on transmitted characters. A Y enables this
parameter, an N disables it. The default is N.
Book C
SLIP and PPP will not work if this parameter is enabled.
inactivity_timer
This asynchronous port parameter specifies the number of minutes that
a port can remain inactive. If the timer expires, the Anne x terminates all
sessions and resets the port.
You can use the input_is_activity andoutput_is_activityparametersto
define activity as input to the port or output from the port. Setting these
parameters toN causes the timer to run independent ofactivity. Allo wable
values range from 0 to 255. The default is 0 (timer disabled).
If you want a port to reset after a given number of minutes, re gardless of
any activity, you must also set the following parameters:
These setting are required because the timer does not start until one of
the following events occur:
1.Input occurs and input_is_activity is set to Y.
2.Output occurs and output_is_activity is set to Y.
3.A port with type set to dial_in starts (regardless of the value of
the control_lines parameter).
inet_addr
This Annex parameter defines the Annex’ s IP address. This 32-bit address
contains four 8-bit fields separated by periods. Each field contains a
number ranging from 0 to 255 or a hexadecimal number . The IP address
always displays in decimal notation. This parameter has no default.
input_flow_control
This asynchronous port parameter specifies the method of flow control
for input received from a device connected to an asynchronous port.
Table C-23 describes the valid options; the default is bell.
Table C-23. Valid Options for the input_flow_control Parameter
OptionDescription
bellThe Annex rings the terminal bell (sends ^G) when its input
buffer is full.
eiaFlow control is delegated to a lower level (e.g., a parallel port).
The control_lines parameter must be set to flow control or
both, and the device must be wired appropriately.
start/stopDesignates flow control by recognizing xon and xoff
characters. This action is independent of the control_lines
parameter setting.
noneDisables flow control; characters are lost if the buffers
overflow.
Remote Annex Administrator’s Guide for UNIX
Book C-63
Page 82
Chapter 2 Configuration Parameters
input_is_activity
This asynchronous port parameter defines activity as input. When
enabled, the Annex sets the inactivity timer when it recei ves input at the
port. A Y enables this parameter, an N disables it. The default is Y.
input_start_char
This asynchronous port parameter defines the control character sequence
that restarts input if the input_flow_control parameter is set to start/stop. The default is
input_stop_char
Book C
CTRL-Q (^Q).
This asynchronous port parameter defines the control character sequence
that stops input if the input_flow_control parameter is set to start/stop.
The default is
CTRL-S (^S).
ipencap_type
This Annex parameter specifies whether the Annex LAN interface
encapsulates IP packets in the Ethernet Version 2 format or the IEEE
802.3 Data Link Layer format. The values for this parameter areethernet
or ieee802. The default is ethernet.
Book C-64
Remote Annex Administrator’s Guide for UNIX
Page 83
Book C
Chapter 2 Configuration Parameters
ip_forward_broadcast
This Annex parameter allows an Annex to broadcast a pack et to the SLIP
or PPP interfaces. When the Annex receiv es a packet sent to a broadcast
address (except 0.0.0.0 and 255.255.255.255), it scans the list of installed
interfaces and matches the broadcast address against the interface’s
remote address using a subnet or net mask. If these addresses match, the
Annex copies the packet to that interface. When disabled, the Annex does
not scan the interface list and does not copy broadcast packets. A Y
enables this parameter, an N disables it. The default is N.
ipso_class
This asynchronous port parameter specifies the U.S. Department of
Defense basic IP Security Option (IPSO) classification level included in
TCP packets generated locally on Annex CLI, dedicated, or adaptive
asynchronous ports.
The option is not added to locally generated ICMP messages, RIP
updates, or other system packets. The Annex does not check incoming
packets for the presence of the IPSO. Valid options for the classification
level are topsecret, secret, confidential, unclassified, and none. If you
specify none, no IPSO classification is added. The default is none.
ipx_do_checksum
This Annex parameter controls whether or not the Annex enables an IPX
checksum. A Y enables this parameter, an N disables it. The default is N.
Remote Annex Administrator’s Guide for UNIX
Book C-65
Page 84
Chapter 2 Configuration Parameters
ipx_dump_password
This Annex parameter contains a user password for logging on to the
Novell file server before the Annex sends a dump file to the server. The
string size ranges from 0 to 16 characters. The default is “<unset>”.
ipx_dump_path
This Annex parameter specifies the full pathname that stores the uploaded
Annex dump image on the Novell file serv er . The string size ranges from
0 to 100 characters. This parameter has no default value.
ipx_dump_username
Book C
This Annex parameter provides a user name for logging on to the Novell
file server before the Annex sends a dump file to the server. The string
size ranges from 0 to 48 characters. This parameter has no default value.
ipx_file_server
This Annex parameter contains the name of the Novell file server from
which the Annex boots. The string size ranges from 0 to 48 characters.
This parameter has no default value.
ipx_frame_type
This Annex parameter defines the framing used for IPX packets on the
Ethernet interface. Valid options are ethernetII, raw802_3, 802_2, or802_2snap. The default is raw802_3.
Book C-66
Remote Annex Administrator’s Guide for UNIX
Page 85
Book C
Chapter 2 Configuration Parameters
ipx_security
This asynchronous port parameter controls whether or not IPX security
is enabled on the port. A Y enables this parameter, an N disables it. The
default is N.
ixany_flow_control
This asynchronous port parameter treats any input character as a start
(XON) character, if output has been suspended by a stop (XOFF)
character. AY enables this parameter, an N disables it. The default is N.
keep_alive_timer
This Annex parameter defines the number of seconds between the
transmission of identification packets during times of network inactivity .
This parameter works only for the LAT protocol. The packets serve only
as notices to remote nodes that the host’s services are a vailable. Allowable
values range from 10 to 255 (seconds). The default is 20 (seconds).
lat_key
This Annex parameter restricts access to LAT -related Annex commands,
parameters, functions, and the LAT protocol within the Annex. Each
Annex requires a unique key v alue (contact your supplier to obtain a LA T
key). After setting the key, your system administrator must reboot the
Annex.
Remote Annex Administrator’s Guide for UNIX
Book C-67
Page 86
Chapter 2 Configuration Parameters
lat_queue_max
This Annex parameter limits the number of HIC requests that the Annex
can queue. This parameter affects only the operation of HIC requests
received after changing the parameter’ s value and setting LA T . Allowable
values range from1 to 255 ornone (enteringnone sets the value to 255).
The default value is 4.
latb_enable
This asynchronous port parameter enables the Annex to decode a LAT
hosts’ s data-b packet. Data-b packets change certain asynchronous port
parameters (see your LAT host’s documentation for more details). A Y
enables this parameter, an N disables it. The default is N.
Book C
If latb_enable is set to Y and the LAT host sends a data-b slot
message requesting that flow control (XON/XOFF) be turned off, the
Annex turns off flo w control and passes XON/XOFF characters to the
host. This scenario can adversely affect both XON/XOFF and the
cursor keys on the terminal.
line_erase
This asynchronous port parameter allows an Annex to echo line erase for
a video terminal. When enabled, the Annex erases all characters on the
line and moves the cursor back to the beginning of the line. When
disabled, the Annex echoes the line erase character for hard-copy
terminals, making the deleted line visible and positioning the print head
at the beginning of the next line. The line erase occurs only at the CLI
level. A Y enables this parameter, an N disables it. The default is Y.
Book C-68
Remote Annex Administrator’s Guide for UNIX
Page 87
Book C
Chapter 2 Configuration Parameters
load_broadcast
This Annex parameter defines, during a boot, whether or not the Annex
requests the configuration or message-of-the-day files from other hosts
on the network if any or all of the files are not av ailable on the preferred
load host. A Y enables this parameter, an N disables it. The default is Y.
load_dump_gateway
This Annex parameter specifies the gateway’s IP address. A gateway is
required if the preferred load or dump host is on a different network or
subnet than the Annex. The default is 0.0.0.0 (no gateway).
load_dump_sequence
This Annex parameter specifies available network interfaces (Ethernet,
SLIP, or self) and the order in which they are used for a down-line load
or an up-line dump. Y ou can list more than one interface by using commas
to separate interface names. Table C-24 describes the valid options.
Table C-24. Valid Options for the load_dump_sequence Parameter
Option Description
netFor use with a local area network. This is the default value.
slnnFor use with a SLIP line, where nn is the number of the serial port.
selfInstructs the Annex to boot its image from the Flash ROMs. Since
the Annex cannot dump back to itself, when booting via self, always
have a secondary load/dump interface by setting
load_dump_sequence to self,net or self,slnn.
Remote Annex Administrator’s Guide for UNIX
Book C-69
Page 88
Chapter 2 Configuration Parameters
local_address
This asynchronous port parameter defines the IP address for the
asynchronous port on the Annex side of a link. This IP address is used
whenever SLIP or PPP is in ef fect for the port (for example, because the
mode parameter is set to slip or ppp, or because the mode is set to
auto_detect and SLIP or PPP is detected). The default is 0.0.0.0.
location
This asynchronous port parameter defines an asynchronous port location
or description that displays with the CLI who command. The string size
ranges from 0 to 16 characters. The default is a null string ("").
Book C
lock_enable
This Annex parameter enables any port to use the Annex Interface for
VMS Environment’s lock command. A Y enables this parameter, an N
disables it. The default is N.
login_password
This Annex parameter specifies the password for all ports using a VMS
interface. The string size ranges from 0 to 16 characters. For security
reasons, the Annex displays this value as “<set>” or “<unset>.” The
default is “<unset>.”
This parameter works only when cli_interface is set to vci and
login_port_password is set to Y.
Book C-70
Remote Annex Administrator’s Guide for UNIX
Page 89
Book C
Chapter 2 Configuration Parameters
login_port_password
This asynchronous port parameter enables the port password when the
VMS command interface is configured (i.e., when cli_interface is set to
vci). A Y enables this parameter, an N disables it. The default is N.
login_prompt
This Annex parameter defines the prompt that appears for all ports using
a VMS interface. The string size ranges from 0 to 16 characters. The
default is the # symbol.
This parameter works only when cli_interface is set to vci.
login_timer
This Annex parameter specifies the number of minutes a port using a
VMS interface can remain inactive. Valid values are 0 through 60
(minutes). Entering 0 sets the timer to 30 minutes. The default is 30.
This parameter works only when cli_interface is set to vci.
login_timeout
This asynchronous port parameter enables a login timer when the VMS
command interface is configured (i.e., when cli_interface is set to
A Y enables this parameter, an N disables it. The default is N.
vci).
Remote Annex Administrator’s Guide for UNIX
Book C-71
Page 90
Chapter 2 Configuration Parameters
long_break
This asynchronous port parameter enables an Annex to return a user to
the CLI prompt after receiving a break signal of more than two seconds.
When disabled, the Annex passes the break to the local application. A Y
enables this parameter, an N disables it. The default is Y.
loose_source_route
This Annex parameter controls the Loose Source Routing protocol which
defines a sequence of IP addresses that a datagram must follow. A Y
enables this parameter, an N disables it. The default is Y.
When enabled, The Annex forwards all IP packets that have the LooseSource Routing and Recor doption set. The Annex forwards all IP packets
that have the Strict Sour ce Routing and Recordoption set only if the next
routing address is directly reachable by the Annex. Otherwise, the Annex
drops these packets and sends an ICMP type Destination Unreachable
message with a code of Source Route Failed.
Book C
Book C-72
When disabled, the Annex will not forward any IP packets that ha ve the
Strict Source Routing and Record or Loose Source Routing and Record
options set. The Annex accepts these packets only if the Annex itself is
the ultimate destination. If the packets are not addressed to the Annex,
they are dropped and the Annex sends an ICMP type DestinationUnreachable message with a code of Source Route Failed will to the
originator.
Loose source routing can pose a security risk if you use filters on your
network router. If you are concerned with security, set this parameter
to N.
Remote Annex Administrator’s Guide for UNIX
Page 91
Book C
Chapter 2 Configuration Parameters
map
This T1 parameter controls the mapping of the modems to the T1 Drop
and Insert Interface (T1DII) and the T1 Network Interface (T1NI) DS0
channels. The modems can be mapped to any unoccupied slot on the T1NI
or the T1DII. The T1NI and the T1DII can be mapped to each other on
channels that are not occupied by modems. Table C-25 lists the options
that are used with the map parameter.
Table C-25. Options for the map Parameter
OptionDescription
map_val modem_numberThese options map an interface channel to a
modem. The map_val option defines the
interface as:
ds1_modem for the T1 Network Interface (the
DS0 channel).
di_modem for the Drop/Insert Interface.
The modem_number option must be specified.
The modem_number value ranges from 1 to 24.
map_valThe map_val option by itself maps the T1
Network Interface to the Drop/Insert Interface.
The map_val defines the type of channel as
data, voice, or unused.
map_to_lower
This asynchronous port parameter enables an Annex to conv ert uppercase
characters sent from a terminal into lowercase characters. This conv ersion
occurs only at the CLI level. Enable this parameter for older terminals
that do not support lower case characters. AY enables this parameter, an
N disables it. The default is N.
Remote Annex Administrator’s Guide for UNIX
Book C-73
Page 92
Chapter 2 Configuration Parameters
map_to_upper (asynchronous)
This asynchronous port parameter enables an Annex to conv ert lowercase
characters sent to a terminal into uppercase characters. This conversion
occurs only at the CLI level. Enable this parameter for older terminals
that do not support upper case characters. A Y enables this parameter, an
N disables it. The default is N.
map_to_upper (parallel)
This parallel port parameter enables an Annex to convert lowercase
characters sent to a terminal using the CLI into uppercase characters.
Enable this parameter for older terminals that do not support upper case
characters. A Y enables this parameter, an N disables it. The default is N.
Book C
max_chap_chall_int
This Annex security parameter enables the RA 6300 to re-issue a CHAP
challenge to a remote node at random times during the course of a PPP
connection. The parameter itself specifies the maximum number of
seconds in the interval from which the RA 6300 randomly chooses the
times to re-issue the challenge. V alid values are0 to65535(approximately
18.2 hours). For example, a value of 60 specifies an interv al ranging from
one to 60 seconds. The default is 0, which disables the re-issuing of
challenges.
max_session_count
This asynchronous port parameter specifies the number of active sessions
(jobs) allowed per port. The allowable values range from 1 to 16. The
default is 3.
Book C-74
Remote Annex Administrator’s Guide for UNIX
Page 93
Book C
Chapter 2 Configuration Parameters
max_vcli
This Annex parameter determines the maximum number of virtual CLI
connections the Annex can create at a time. Allowable values are the
stringunlimited or a decimal number from0 to254. A value of0 prevents
any virtual CLI connections. The default is unlimited.
metric
This asynchronous port parameter defines the hop count to the remote
end of the asynchronous line when the mode parameter is set to slip or
ppp. Modify this parameter only if you want the Annex to use a route
other than the SLIP or PPP interfaces to the remote end. Allowable v alues
are 1 to 15. The default is 1.
min_unique_hostnames
This Annex parameter determines whether or not you can identify a host
in the host table by entering a minimal string rather than the full host
name. A Y enables minimum uniqueness, an N disables it. The default
is Y.
mode
This asynchronous port parameter sets the mode for access to an
asynchronous port. It determines whether access is initiated by a device
connected to the Annex or from the network through the Annex to the
device. Table C-26 describes the valid options; the default is cli.
Remote Annex Administrator’s Guide for UNIX
Book C-75
Page 94
Chapter 2 Configuration Parameters
Table C-26. Valid Options for the mode Parameter
OptionDescription
adaptiveAllows a port to have both slave and cli capabilities. If a
arapAllows a port to perform as a network interface
auto_adaptAllows a port to detect whether packets are incoming or
auto_detectAllows a port to identify an incoming packet’s protocol and
Book C
connection is initiated on the serial side, the port enters cli
mode; if a connection is initiated via a port server, the port
enters slave mode.
using ARAP.
outgoing. For incoming packets, the port behaves as if it
were in auto_detect mode. For outgoing packets, it
operates in slave mode.
to convert to IPX, PPP, ARAP or CLI.
cliAllows a port connected to a terminal or incoming modem
access to the CLI. The CLI provides access to the network
and connections to other hosts via the telnet, connect,
rlogin and tn3270 commands.
The tn3270 command is available only if the option_key
parameter is set to the correct value for the Annex.
connectAllows a port to communicate with a LAT host via the
connect command. This option works with the
dedicated_arguments parameter.
dedicatedAllows a port to communicate only with one specific host
defined using the dedicated_address and dedicated_port
parameters. Communication can be via telnet or rlogin,
but not via tn3270 or connect.
ipxAllows dial-in Novell access.
ndpAllows Novell dial-in, dial-out, and routing.
pppAllows a port to perform as a network interface using PPP.
IP packets are encapsulated by PPP.
(continued on next page)
Book C-76
Remote Annex Administrator’s Guide for UNIX
Page 95
Book C
Chapter 2 Configuration Parameters
Table C-26. Valid Options for the mode Parameter (continued)
OptionDescription
rloginAllows a port to communicate via the rlogin command.Use
this option in conjunction with the asynchronous port
parameter dedicated_arguments.
slaveAllows port access through the port server. This mode
provides Annex login lines for hosts that have no Ethernet
interface and/or that require access to modems and serial line
printers attached to the Annex. It does not provide access to
the CLI.
slipAllows a port to perform as a network interf ace using SLIP. IP
packets are encapsulated by SLIP.
telnetAllows a port to communicate via the telnet command.Use
this option in conjunction with the asynchronous port
parameter dedicated_arguments.
tn3270Allows a port to communicate via the tn3270 command. Use
this option in conjunction with the asynchronous port
parameter dedicated_arguments.
unusedThe port has no connection; the Annex ignores it.
You should mark a port as unused if it is not connected to
a device.
mop_password
This Annex parameter contains the MOP maintenance password. In this
8-byte password, each byte consists of two hexadecimal digits. The string
size ranges from 0 to 16 characters. For security reasons, the Annex
displays values as “<set>” or “<unset>.” The default is “<unset>.”
Remote Annex Administrator’s Guide for UNIX
Book C-77
Page 96
Chapter 2 Configuration Parameters
motd_file
This Annex parameter defines the file name for the message-of-the-day
file maintained on the load host. The string size ranges from 0 to 16
characters. The default file name is motd; the file resides in the directory
chosen during the host installation process (typically
/usr/spool/erpcd/bfs).
multicast_timer
This Annex parameter defines the number of seconds that can elapse
between service announcement transmissions for the LAT protocol.
Allowable values range from 10 to 180 (seconds). The default is 30.
Book C
multisessions_enable (Annex)
This Annex parameter allows multisessions to be managed on a terminal
server basis. When enabled, terminals that support DEC’s Terminal
Device/Session Management Protocol (TD/SMP) can display two activ e
windows simultaneously over one communication line. AY enables this
parameter, an N disables it. The default is N.
multisessions_enable (asynchronous port)
This asynchronous port parameter allows multisessions to be managed
on a per port basis. A Y enables this parameter, an N disables it. The
default is N.
Book C-78
Remote Annex Administrator’s Guide for UNIX
Page 97
Book C
Chapter 2 Configuration Parameters
name_server_1
This Annex parameter defines the type of name service used with the
primary name server . When using this parameter, you must specify a host
using thepref_name1_addr . The options aredns, ien_116, ornone. The
default is none.
name_server_2
This Annex parameter defines the type of name service used with the
secondary name server . The service type specified with this parameter is
queried if the type specified with name_server_1 is not available. When
using this parameter, you must specify a host using pref_name2_addr.
The options are dns, ien_116, or none. The default is none.
nameserver_broadcast
This Annex parameter defines whether or not the Annex broadcasts a
name server request if the preferred name servers do not respond. A Y
enables this parameter, an N disables it. The default is N.
need_dsr
This asynchronous port parameter allows an Annex to use the DSR (Data
Set Ready) signal to determine whether a device is attached to the
corresponding asynchronous line. The Annex will not allow connection
to a slave port and will not acti vate the CLI until the DSR signal is active.
If DSR is deactivated, the connection to a sla ve line is terminated and the
CLI is deactivated.
Remote Annex Administrator’s Guide for UNIX
Book C-79
Page 98
Chapter 2 Configuration Parameters
When disabled, the DSR signal is not required to connect to a slave line,
and DSR is not required to activate a CLI line (see Modem Signals on
page A-99 for details on using need_dsr in conjunction with modem
control). DSR is always considered active on ports that do not ha ve a DSR
signal (ports with partial modem control lines). A Y enables this
parameter, an N disables it. The default is N.
net_inactivity
This asynchronous port parameter defines the amount of time that
network protocols (e.g., SLIP, PPP , ARAP) running on the serial line can
remain inactive before the port is reset. Valid options are 0 to255; a zero
value indicates off. The default is 0 (off).
Book C
Use this parameter in conjunction with net_inactivity_units.
Since the accuracy of the inactivity timer is within five seconds, if
net_inactivity_units is set to seconds, we recommend using a value
for net_inactivity that is a multiple of five.
net_inactivity_units
This asynchronous port parameter defines the units of time used for the
port’ s inactivity timer . V alid options areminutes orseconds. The default
is minutes.
Use this parameter in conjunction with net_inactivity.
If you are using an ISDN line, it is important to set net_inactivity to a
small value, such as 30, and net_inactivity_units to seconds;
otherwise, you may incur high costs from your ISDN service
provider.
Book C-80
Remote Annex Administrator’s Guide for UNIX
Page 99
Book C
Chapter 2 Configuration Parameters
To set an inactivity timer of two minutes, set:
net_inactivity_units=minutes
net_inactivity=2
To set an inactivity timer of 30 seconds, set:
net_inactivity_units=seconds
net_inactivity=30
An inactivity timer can be set to the following combinations:
0 to 4 minutes 15 seconds (= 255 seconds) in 1 second intervals
0 to 4 hours 15 minutes (= 255 minutes) in 1 minute intervals
network_turnaround
This Annex parameter defines the approximate number of seconds that
an Annex waits for a response from a security server (an algorithm defines
the actual time which typically is longer than the defined value). This
parameter works only when the enable_security parameter is set to Y.
Allowable values range from 1 to 255. The default is 2.
Setting this parameter to a high number is not recommended unless a
large timeout value is required for contacting (for security) slo w hosts or
waiting for a slow host’s response to a security request.
newline_terminal
This asynchronous port parameter interprets carriage returns and line
feeds at the CLI level. When enabled, a line feed terminates both the input
and the output lines. When disabled, a carriage return or a line feed
terminates the input line and a carriage return followed by a line feed
terminates output lines. A Y enables this parameter, anN disables it. The
default is N.
Remote Annex Administrator’s Guide for UNIX
Book C-81
Page 100
Chapter 2 Configuration Parameters
node_id
This Annex parameter specifies the address the Annex tries to acquire at
start-up. If this address is in use, the Annex must acquire a new node ID.
The node_id is an AppleTalk address in the form net.node. Valid net
values are 0 to 65534; valid node values are 0 to 254. The default is 0.0.
option_key
This Annex parameter enables the following features:
•The AppleTalk-specific functions and parameters.
•The CLI tn3270 command.
•dial-out routing and filtering.
Book C
•IPX.
These features are available separately or in any combination. Each
Annex requires a unique key v alue for the feature(s) you choose; contact
your supplier to obtain an option_key value.
output_flow_control
This asynchronous port parameter defines the method that a device uses
to stop output from an Annex. T able C-27 describes the v alid options; the
default is start/stop.
Book C-82
Remote Annex Administrator’s Guide for UNIX
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.