Revision Information: This is a revised manual.
Operating Systems: OpenVMS Alpha Versions 6.2, 7.0, 7.1 OpenVMS VAX Versions 6.2, 7.0, 7.1
Software Version:
DIGITAL TCP/IP Services
for OpenVMS Version 4.2
Digital Equipment Corporation Maynard, Massachusetts
Digital Equipment Corporation makes no representations that the use of its products in the manner described in this publication will not infringe on existing or future patent rights, nor do the descriptions contained in this publication imply the granting of licenses to make, use, or sell equipment or software in accordance with the description.
Possession, use, or copying of the software described in this publication is authorized only pursuant to a valid written license from DIGITAL or an authorized sublicensor.
DIGITAL conducts its business in a manner that conserves the environment and protects the safety and health of its employees, customers, and the community.
© Digital Equipment Corporation 1997. All rights reserved.
The following are trademarks of Digital Equipment Corporation: ACMS, DECdtm, DDCMP, DEC, DECnet, DECNIS, DECserver, DECsystem, DECwindows, DIGITAL, DNA, InfoServer, LAT, OpenVMS, PATHWORKS, POLYCENTER, VAX, VAXstation, VMS, VMScluster, and the DIGITAL logo.
The following are third-party trademarks:
HP and Hewlett-Packard are registered trademarks of Hewlett Packard Company.
IBM and OS/2 are registered trademarks of International Business Machines Corporation
MS-DOS is a registered trademark of Microsoft Corporation.
OSF/1 is a registered trademark of Open Software Foundation, Inc.
PostScript is a registered trademark of Adobe Systems, Inc.
Sun, NFS, and PC-NFS are registered trademarks of Sun Microsystems, Inc.
UNIX is a registered trademark of UNIX System Laboratories, Inc., a wholly-owned subsidiary of Novell, Inc.
All other trademarks and registered trademarks are the property of their respective holders.
zk6527
This manual describes the DIGITAL TCP/IP Services for OpenVMS (UCX) management commands. Use it in conjunction with the DIGITAL TCP/IP Services for OpenVMS Management manual, which describes the management tasks.
This manual is for experienced OpenVMS and/or UNIX system managers and assumes a working knowledge of TCP/IP networking, TCP/IP terminology, and some familiarity with the DIGITAL TCP/IP Services for OpenVMS product.
If you are not familiar with the DIGITAL TCP/IP Services for OpenVMS product, please review the DIGITAL TCP/IP Services for OpenVMS Concepts and Planning before using this manual to configure and manage UCX components.
This manual contains two chapters.
This manual uses the following terminology:
For a complete list of acronyms used throughout this and other manuals in the DIGITAL TCP/IP Services for OpenVMS documentation set, see DIGITAL TCP/IP Services for OpenVMS Concepts and Planning.
All IP addresses in this book represent fictitious addresses. The following conventions apply to this book.
| Convention | Meaning |
|---|---|
| UPPERCASE SPECIAL TYPE | Indicates OpenVMS system output or user input. |
| lowercase special type | Indicates UNIX system output or user input, commands, options, files, directories, utilities, hosts, and users. |
| italic | Indicates a variable. |
| bold | Indicates a new term defined in the text. |
| [Return] | Indicates that you press the Return key. |
| [Ctrl/] x | Indicates that you press the Control key while you press the key noted by x. |
| [ ] | In command format descriptions, indicates optional elements. You can enter as many as you want. |
| { } | In command format descriptions, indicates you must enter at least one listed element. The elements are separated by bars (|). |
DIGITAL welcomes your comments on this manual or any of the DIGITAL TCP/IP Services for OpenVMS documents. Send us your comments through any of the following channels:
| Internet | openvmsdoc@zko.mts.dec.com |
| Fax | 603 884-0120, Attention: OSSG Documentation, ZKO3-4/U08 |
|
OSSG Documentation Group, ZKO3-4/U08
110 Spit Brook Rd. Nashua, NH 03062-2698 |
Use the following table to order additional documentation or information. If you need help deciding which documentation best meets your needs, call 800-DIGITAL (800-344-4825).
| Location | Call | Fax | Write |
|---|---|---|---|
| U.S.A. |
DECdirect
800-DIGITAL 800-344-4825 |
Fax: 800-234-2298 |
Digital Equipment Corporation
Mailstop: TAY2-2/11D 153 Taylor Street Littleton, MA 01460 |
| Puerto Rico | 787-781-0505 | Fax: 787-749-8300 | Local DIGITAL subsidiary |
| Canada |
DTN: 621-6005
800-DIGITAL |
Fax: 613-592-1946 |
Digital Equipment of Canada, Ltd.
Box 13000 Kanata, Ontario, Canada K2K2A6 Attn: CICC |
| International | --- | --- |
Local DIGITAL subsidiary or
approved distributor |
| Internal Orders |
DTN: 261-2010
603-791-2010 |
Fax: 800-741-6970 |
U.S. Software Supply Business
Digital Equipment Corporation 8 Cotton Road Nashua, NH 03063-1260 |
DIGITAL TCP/IP Services for OpenVMS (UCX) software provides a management command interface you use to configure or reconfigure and manage the UCX software. These commands let you
Issue the management commands at the OpenVMS prompt or from within the UCX management control program.
$ UCX SHOW CONFIGURATION BIND
UCX> SHOW CONFIGURATION BIND
To start the UCX control program, type UCX at the OpenVMS prompt.
$ UCX
At the UCX> prompt you can enter commands described in this manual or display online help. Type EXIT to exit the management control program or Ctrl/C to abort a command. Help is also available at the OpenVMS prompt by typing HELP UCX.
Note
The word "command" refers to UCX commands. DCL commands and UNIX commands are so identified when needed.
This manual uses the following conventions in syntax specifications:
When you type a command line for a UCX management command, use the syntax rules described in the following sections for:
You can abbreviate command keywords to the fewest number of characters, usually four, that identify the command. The following two command lines, for example, have identical meanings.
UCX> SET COMM /LARG=(MI=10, MA=30)
UCX> SET COMMUNICATION /LARGE_BUFFERS=(MINIMUM=10, MAXIMUM=30)
On command lines, enclose the following in quotation marks ( " " ):
The following command lines show some required quotation marks:
UCX> MAP "/usr/songbirds/canary" CANARY$DUA2:
UCX> ADD PROXY COUSINS /GID=10 /UID=40 /NFS=OUTGOING -
_UCX> /HOST=("raven","crow","rook","daw","magpie")
UCX> SET HOST "eaglet" /ADDRESS = 128.33.22.1
UCX> SHOW HOST EAGLET
To specify a host or network on a command line, you can type either its
name or IP address.
1.3.4 File and Directory Names
When you specify OpenVMS files, follow all OpenVMS file specification
rules. Likewise, when you specify UNIX files, follow all UNIX file
specification rules.
1.3.5 Multiple Values
To specify multiple host names, addresses, or options for parameters and qualifiers, use the following guidelines:
Examples:
/qualifier=(option_a:value1,option_b:value2,value3)
is the same as
/qualifier=(option_a=value1),(option_b=value2,value3)
PARROT> UCX UCX> SET NAME_SERVICE /SERVER=(SORA,JACANA,PARROT)
.../ACCEPT=(HOSTS:JACANA,JAEGER,JAY,JUNCO,999.20.40.3)
Unless otherwise stated, all shown values are decimal.
1.3.7 Address Formats
Some commands require that you specify one of the following kinds of addresses:
To specify Ethernet, FDDI, Token Ring, and hardware addresses, type a 12-digit hexadecimal number (hh-hh-hh-hh-hh-hh) as shown below:
UCX> SET HOST CROW /ADDRESS=1.2.3.4 UCX> SET BOOTP MACAW /HARDWARE=ADDRESS=08-dd-ff-2a-23-21 UCX> SET ARP AA-BB-04-05-06-07 CONDOR
If you specify a wildcard on a command line, by default, every command that deletes records asks for your confirmation before it executes a deletion. You can change the default with the /NOCONFIRM qualifier.
UCX> REMOVE PROXY GRACKLE /GID=* /UID=130 VMS User_name Type User_ID Group_ID Host_name GRACKLE N 269 48 MAPLE Remove? [N]:
Most SHOW commands default values to *.
DELETE commands require that you supply a parameter.
1.3.9 Valid Values
Most UCX management commands accept any number value you might enter.
Specify values appropriate to your environment.
1.4 Program Design
The design of the UCX management program provides commands in the
following functional categories.
1.4.1 SET Commands
For some UCX components, you can enter information only in a permanent UCX database and, for others, only in volatile memory. In addition, UCX can store parameter settings and other configuration information for some of the software in both locations. Table 1-1 shows the SET commands that affect only one or the other.
| Modify Permanent Database Files | Modify Volatile Memory |
|---|---|
| SET BOOTP | SET ARP |
| SET CONFIGURATION | SET COMMUNICATION |
| SET HOST | SET INTERFACE |
| SET MX_RECORDS | SET NAME_SERVICE |
| SET NETWORK | SET NFS_SERVER |
| SET CONTAINER | SET PROTOCOL |
| SET SERVICE |
The SET ROUTE command works on both the permanent and dynamic routing
databases.
1.4.2 Commands that Modify the Configuration Database
Unlike the other UCX databases, which have similar objects, the configuration database holds diverse initialization information for various UCX objects.
All the initialization information is node-specific except for TIME and SNMP. This information is identified by the SYSGEN parameter SCSNODE. If you change your node's name after you configure UCX, the startup information, by default, will not be seen by the UCX startup procedure or by the management software.
To see the configuration that is paired to the original node name, use the /ON qualifier, which is available with all the configuration commands. To copy node-specific startup information from one node to another, use the COPY CONFIGURATION command.
The following commands modify the configuration database:
The CREATE commands create the following kinds of files:
The CREATE commands create database files with the default protections shown in Table 1-2.
| Database | Default Protection | |
|---|---|---|
| Proxy database | System | RWED |
| Owner | RWED | |
| Group | RE | |
| All other databases | System | RWED |
| Owner | RWED | |
| Group | RE | |
| World | RE | |
To add and delete records from the UCX databases, use the CONVERT, ADD, and REMOVE management commands.
UCX has two kinds of CONVERT management commands:
The following commands add records to and delete records from the proxy and export databases:
You cannot modify information that you enter into databases with ADD
commands. Instead, delete the record with REMOVE and then issue a new
ADD.
1.4.5 Commands that Start and Stop Software
You can interactively start and stop software components with the following commands:
For example:
UCX> START ROUTING /SUPPLY
For the server components that are started by the auxiliary server upon an incoming client request, the ENABLE SERVICE command tells the the auxiliary server to listen for requests and act upon them.
The DISABLE SERVICE command tells the auxiliary server to stop listening for incoming requests.
The following commands set components to start upon UCX startup. The permanent configuration is stored in the configuration database.
The following commands verify the integrity of UCX files:
The NFS server requires the following management commands:
The UCX software includes commands for using NFS. By issuing the following commands, users can view container file systems and copy files to and from them:
For using NFS client (working with files that reside on remote hosts), UCX offers:
The SHOW and LIST commands display configuration, status, and performance information.
The ZERO commands reset the performance counters.
1.4.10 The /LOCAL Qualifier
The /LOCAL qualifier redefines the method for lookups. It limits lookups to the local hosts database. The default for lookups is a search of the hosts database and then, if the local lookup fails, a BIND lookup.
/LOCAL applies to commands that control name-to-address lookups and commands that control Ethernet-address-to-IP-address lookups.
Example 1:
This command displays hosts in the local hosts database.
UCX> SHOW HOST /LOCAL
Example 2:
With this command, addresses not found in the local hosts database are obtained through the BIND resolver.
UCX> SHOW DEVICE-SOCKET /NOLOCAL
This chapter contains command descriptions, in alphabetical order, for the DIGITAL TCP/IP Services for OpenVMS (UCX) management commands.
For information about how to type the commands, see Chapter 1.
Adds an entry to the export database for one of the following:
- An OpenVMS disk
- A subset of an OpenVMS disk
- A UNIX-style container file system
Related commands: REMOVE EXPORT, SHOW EXPORT, SHOW HOST
Applies to: NFS server
ADD EXPORT "/path/name" /HOST=host [/OPTIONS= {[NO]DATA_CONVERSION | [NO]NAME_CONVERSION | [NO]PURGE_VERSIONS | [NO]TYPELESS_DIRECTORIES}]
- No wildcards within the UNIX-style directory specification.
- Requires read and write access to the export database.
- For each host, define both its host name and alias name.
- For each entry, use uppercase and lowercase consistently.
- If you remove an export entry then replace the entry using different options, each client must dismount and remount for the new options to take effect.
"/path/name"
Required.File system to add to the export database.
Separate multiple names with slashes.
/HOST=host
Required.The NFS client that will have access to the specified NFS file system.
You may use wildcards.
/OPTIONS= {[NO]DATA_CONVERSION | [NO]NAME_CONVERSION | [NO]PURGE_VERSIONS | [NO]TYPELESS_DIRECTORIES}
Optional.
Note
For clients operating in VMS-to-VMS mode, the server ignores the options in the export record and uses the settings required for VMS-to-VMS mode.
Options for the specified directory:
- DATA_CONVERSION, NODATA_CONVERSION
- DATA_CONVERSION (default)
Converts the following kinds of sequential files:
- Variable
- Variable with fixed-length control (VFC)
- Fixed record formats
Converts sequential files according to the rules applied by the following record attributes:
- Carriage return/carriage control (CR)
- Fortran carriage control (FTN)
- Print file format control (PRN)
Stream formats are returned unconverted.
The data in files with nonstream records cannot be written back to the file.- NODATA_CONVERSION
File data is considered "raw" and is returned without conversion. Nonstream records are returned with their record control information mixed with the record data. Files can be rewritten randomly.- NAME_CONVERSION, NONAME_CONVERSION
- NAME_CONVERSION
A non-OpenVMS client can create files with mixed-case names and names containing characters that are invalid for OpenVMS file names. The server converts such names to valid OpenVMS file names, and reverses the conversion when displaying the file names back to a non-OpenVMS client.- NONAME_CONVERSION (default)
Clients can only create files with valid OpenVMS names. The server does case-insensitive lookups, and displays directories in lowercase.- PURGE_VERSIONS, NOPURGE_VERSIONS
Default: NOPURGE_VERSIONS
Deletes multiple versions of files when created or detected. (The NFS CREATE and RENAME calls can create multiple versions. The NFS READDIR call can sense multiple versions.)- TYPELESS_DIRECTORIES, NOTYPELESS_DIRECTORIES
- TYPELESS_DIRECTORIES
Removes .dir.1 from the name of directories. A naming conflict could arise, for example, if two files exist in the parent directory. For example:
DOVE.;1 (regular file)
DOVE.DIR;1 (directory file)
The name is returned as dove., rather than dove, if a file and a "conflicting" directory exist.- NOTYPELESS_DIRECTORIES (default)
Returns names as file.ext and file.dir.
#1
UCX> ADD EXPORT "/gold/finch" /HOST=GOLD
Next | Contents