Compaq TCP/IP Services for OpenVMS

Management Command Reference

Order Number: AA--PQQGH--TE

January 2001

This manual describes the commands used for configuring and managing the Compaq TCP/IP Services for OpenVMS product.

Revision Information: This guide supersedes the Compaq TCP/IP Services for OpenVMS Management Command Reference, Version 5.0

Software Version: Compaq TCP/IP Services for OpenVMS Version 5.1

Operating Systems: OpenVMS Alpha Versions 7.1 and 7.2-1 OpenVMS VAX Versions 7.1 and 7.2

Compaq Computer Corporation Houston, Texas

COMPAQ, VAX, VMS, and the Compaq logo Registered in U.S. Patent and Trademark Office.

OpenVMS, PATHWORKS, and Tru64 are trademarks of Compaq Information Technologies Group, L.P. in the United States and other countries.

All other product names mentioned herein may be trademarks of their respective companies.

Confidential computer software. Valid license from Compaq required for possession, use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

Compaq shall not be liable for technical or editorial errors or omissions contained herein. The information in this document is provided "as is" without warranty of any kind and is subject to change without notice. The warranties for Compaq products are set forth in the express limited warranty statements accompanying such products. Nothing herein should be construed as constituting an additional warranty.

ZK6527

The document is available on CD-ROM.

Contents Index

Preface

The Compaq TCP/IP Services for OpenVMS product is Compaq's implementation of the TCP/IP networking protocol suite and internet services for OpenVMS Alpha and OpenVMS VAX systems.

A layered software product, TCP/IP Services provides a comprehensive suite of functions and applications that support industry-standard protocols for heterogeneous network communications and resource sharing.

This manual describes the TCP/IP Services management commands. Use it in conjunction with the Compaq TCP/IP Services for OpenVMS Management manual, which describes the management tasks.

Intended Audience

This manual is for experienced OpenVMS and UNIX system managers and assumes a working knowledge of TCP/IP networking, TCP/IP terminology, and some familiarity with the TCP/IP Services product.

If you are not familiar with the TCP/IP Services product, please review the DIGITAL TCP/IP Services for OpenVMS Concepts and Planning manual before using this manual to configure and manage TCP/IP components.

Document Structure

This manual contains the following chapters:

Chapter 1 introduces the management control program.
Chapter 2 provides command descriptions for each management command.

Related Documents

Table 1 lists the documents available with this version of TCP/IP Services.

Table 1 TCP/IP Services Documentation
Manual Contents

DIGITAL TCP/IP Services for OpenVMS Concepts and Planning This manual provides conceptual information about networking and the TCP/IP protocol including a description of the Compaq implementation of the Berkeley Internet Name Domain (BIND) service and the Network File System (NFS). It outlines general planning issues to consider before configuring your system to use the TCP/IP Services software.
This manual also describes the manuals in the documentation set, provides a glossary of terms and acronyms for the TCP/IP Services software product, and documents how to contact the InterNIC Registration Service to register domains and access Requests for Comments (RFCs).

Compaq TCP/IP Services for OpenVMS Release Notes This text file describes new features and changes to the software including installation, upgrade, configuration, and compatibility information. These notes also describe new and existing software problems and restrictions, and software and documentation corrections.
Print this text file at the beginning of the installation procedure and read it before you install TCP/IP Services.

Compaq TCP/IP Services for OpenVMS Installation and Configuration This manual explains how to install and configure the TCP/IP Services product.

DIGITAL TCP/IP Services for OpenVMS User's Guide This manual describes how to use the applications available with TCP/IP Services such as remote file operations, email, TELNET, TN3270, and network printing. This manual explains how to use these services to communicate with systems on private internets or on the worldwide Internet.

Compaq TCP/IP Services for OpenVMS Management This manual describes how to configure and manage the TCP/IP Services product.
Use this manual with the Compaq TCP/IP Services for OpenVMS Management Command Reference manual.

Compaq TCP/IP Services for OpenVMS Management Command Reference This manual describes the TCP/IP Services management commands.
Use this manual with the Compaq TCP/IP Services for OpenVMS Management manual.

Compaq TCP/IP Services for OpenVMS Management Command Quick Reference Card This reference card lists the TCP/IP management commands by component and describes the purpose of each command.

Compaq TCP/IP Services for OpenVMS UNIX Command Reference Card This reference card contains information about commonly performed network management tasks and their corresponding TCP/IP management and Compaq Tru64 UNIX command formats.

DIGITAL TCP/IP Services for OpenVMS ONC RPC Programming This manual presents an overview of high-level programming using open network computing remote procedure calls (ONC RPCs). This manual also describes the RPC programming interface and how to use the RPCGEN protocol compiler to create applications.

Compaq TCP/IP Services for OpenVMS Sockets API and System Services Programming This manual describes how to use the Sockets API and OpenVMS system services to develop network applications.

Compaq TCP/IP Services for OpenVMS SNMP Programming and Reference This manual describes the Simple Network Management Protocol (SNMP) and the SNMP application programming interface (eSNMP). It describes the subagents provided with TCP/IP Services, utilities provided for managing subagents, and how to build your own subagents.

Compaq TCP/IP Services for OpenVMS Tuning and Troubleshooting This manual provides information about how to isolate the causes of network problems and how to tune the TCP/IP Services software for the best performance.

Compaq TCP/IP Services for OpenVMS Guide to IPv6 This manual describes the IPv6 environment, the roles of systems in this environment, the types and function of the different IPv6 addresses, and how to configure TCP/IP Services to access the 6bone network.

**Table 1 TCP/IP Services Documentation**
Manual	Contents
DIGITAL TCP/IP Services for OpenVMS Concepts and Planning	This manual provides conceptual information about networking and the TCP/IP protocol including a description of the Compaq implementation of the Berkeley Internet Name Domain (BIND) service and the Network File System (NFS). It outlines general planning issues to consider before configuring your system to use the TCP/IP Services software. This manual also describes the manuals in the documentation set, provides a glossary of terms and acronyms for the TCP/IP Services software product, and documents how to contact the InterNIC Registration Service to register domains and access Requests for Comments (RFCs).
Compaq TCP/IP Services for OpenVMS Release Notes	This text file describes new features and changes to the software including installation, upgrade, configuration, and compatibility information. These notes also describe new and existing software problems and restrictions, and software and documentation corrections. Print this text file at the beginning of the installation procedure and read it before you install TCP/IP Services.
Compaq TCP/IP Services for OpenVMS Installation and Configuration	This manual explains how to install and configure the TCP/IP Services product.
DIGITAL TCP/IP Services for OpenVMS User's Guide	This manual describes how to use the applications available with TCP/IP Services such as remote file operations, email, TELNET, TN3270, and network printing. This manual explains how to use these services to communicate with systems on private internets or on the worldwide Internet.
Compaq TCP/IP Services for OpenVMS Management	This manual describes how to configure and manage the TCP/IP Services product. Use this manual with the Compaq TCP/IP Services for OpenVMS Management Command Reference manual.
Compaq TCP/IP Services for OpenVMS Management Command Reference	This manual describes the TCP/IP Services management commands. Use this manual with the Compaq TCP/IP Services for OpenVMS Management manual.
Compaq TCP/IP Services for OpenVMS Management Command Quick Reference Card	This reference card lists the TCP/IP management commands by component and describes the purpose of each command.
Compaq TCP/IP Services for OpenVMS UNIX Command Reference Card	This reference card contains information about commonly performed network management tasks and their corresponding TCP/IP management and Compaq Tru64 UNIX command formats.
DIGITAL TCP/IP Services for OpenVMS ONC RPC Programming	This manual presents an overview of high-level programming using open network computing remote procedure calls (ONC RPCs). This manual also describes the RPC programming interface and how to use the RPCGEN protocol compiler to create applications.
Compaq TCP/IP Services for OpenVMS Sockets API and System Services Programming	This manual describes how to use the Sockets API and OpenVMS system services to develop network applications.
Compaq TCP/IP Services for OpenVMS SNMP Programming and Reference	This manual describes the Simple Network Management Protocol (SNMP) and the SNMP application programming interface (eSNMP). It describes the subagents provided with TCP/IP Services, utilities provided for managing subagents, and how to build your own subagents.
Compaq TCP/IP Services for OpenVMS Tuning and Troubleshooting	This manual provides information about how to isolate the causes of network problems and how to tune the TCP/IP Services software for the best performance.
Compaq TCP/IP Services for OpenVMS Guide to IPv6	This manual describes the IPv6 environment, the roles of systems in this environment, the types and function of the different IPv6 addresses, and how to configure TCP/IP Services to access the 6bone network.

For additional information about Compaq OpenVMS products and services, access the Compaq website at the following location:

http://www.openvms.compaq.com/

For a comprehensive overview of the TCP/IP protocol suite, you might find the book Internetworking with TCP/IP: Principles, Protocols, and Architecture, by Douglas Comer, useful.

Reader's Comments

Compaq welcomes your comments on this manual. Please send comments to either of the following addresses:

Internet openvmsdoc@compaq.com

Mail Compaq Computer Corporation
OSSG Documentation Group, ZKO3-4/U08
110 Spit Brook Rd.
Nashua, NH 03062-2698

How to Order Additional Documentation

Visit the following World Wide Web address for information about how to order additional documentation:

http://www.openvms.compaq.com/

If you need help deciding which documentation best meets your needs, call 800-282-6672.

Conventions

The name TCP/IP Services means both:

Compaq TCP/IP Services for OpenVMS Alpha
Compaq TCP/IP Services for OpenVMS VAX

The name UNIX refers to the Compaq Tru64 UNIX operating system.

The following conventions are used in this manual. In addition, please note that all IP addresses are fictitious.

Ctrl/ x A sequence such as Ctrl/ x indicates that you must hold down the key labeled Ctrl while you press another key or a pointing device button.

PF1 x A sequence such as PF1 x indicates that you must first press and release the key labeled PF1 and then press and release another key or a pointing device button.

[Return] In examples, a key name enclosed in a box indicates that you press a key on the keyboard. (In text, a key name is not enclosed in a box.)
In the HTML version of this document, this convention appears as brackets, rather than a box.

... A horizontal ellipsis in examples indicates one of the following possibilities:

Additional optional arguments in a statement have been omitted.
The preceding item or items can be repeated one or more times.
Additional parameters, values, or other information can be entered.

.
.
. A vertical ellipsis indicates the omission of items from a code example or command format; the items are omitted because they are not important to the topic being discussed.

( ) In command format descriptions, parentheses indicate that you must enclose choices in parentheses if you specify more than one.

[ ] In command format descriptions, brackets indicate optional choices. You can choose one or more items or no items. Do not type the brackets on the command line. However, you must include the brackets in the syntax for OpenVMS directory specifications and for a substring specification in an assignment statement.

| In command format descriptions, vertical bars separate choices within brackets or braces. Within brackets, the choices are optional; within braces, at least one choice is required. Do not type the vertical bars on the command line.

{ } In command format descriptions, braces indicate required choices; you must choose at least one of the items listed. Do not type the braces on the command line.

bold text This typeface represents the introduction of a new term. It also represents the name of an argument, an attribute, or a reason.

italic text Italic text indicates important information, complete titles of manuals, or variables. Variables include information that varies in system output (Internal error number), in command lines (/PRODUCER= name), and in command parameters in text (where dd represents the predefined code for the device type).

UPPERCASE TEXT Uppercase text indicates a command, the name of a routine, the name of a file, or the abbreviation for a system privilege.

Monospace text Monospace type indicates code examples and interactive screen displays.
This typeface indicates UNIX system output or user input, commands, options, files, directories, utilities, hosts, and users.
In the C programming language, this typeface identifies the following elements: keywords, the names of independently compiled external functions and files, syntax summaries, and references to variables or identifiers introduced in an example.

- A hyphen at the end of a command format description, command line, or code line indicates that the command or statement continues on the following line.

numbers All numbers in text are assumed to be decimal unless otherwise noted. Nondecimal radixes---binary, octal, or hexadecimal---are explicitly indicated.

Chapter 1
Using TCP/IP Services Management Commands

The TCP/IP Services product provides a management command interface you use to configure and manage the software. These commands let you perform the following tasks:

Configure and reconfigure components
Modify parameters of components
Configure customer-developed services
Enable and disable running components
Monitor the running software

1.1 Entering Commands

To start the management control program, type TCPIP at the DCL prompt. For example:

$ TCPIP TCPIP>

At the TCPIP> prompt, you can enter commands described in this manual or display online help. Type EXIT to exit the management control program, or press Ctrl/C to abort a command.

Help is also available at the DCL prompt by typing HELP TCPIP_SERVICES.

$ HELP TCPIP_SERVICES

Note

The word command refers to commands for the TCP/IP Services software. DCL commands and UNIX commands are explicitly identified.

Table 1-1 provides guidelines for using management control program commands.

Table 1-1 Management Command Guidelines
Element Guideline

Address formats Some commands require that you specify one of the following kinds of addresses:

IP
Ethernet
FDDI
Token Ring
Hardware

Be sure to use the appropriate format. The following examples illustrate an IP address, an Ethernet address, and a hardware address, respectively.
TCPIP> SET HOST CROW /ADDRESS=1.2.3.4
TCPIP> SET ARP AA-BB-04-05-06-07 CONDOR
TCPIP> SET BOOTP MACAW /HARDWARE=ADDRESS=08-dd-ff-2a-23-21

Default Refers to the command's behavior if optional qualifiers are omitted.

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.

Host names and IP addresses To specify a host or network name on a command line, you can enter either the host's name or the host's IP address.

Keywords You can abbreviate commands to the fewest number of characters, usually four, that identify the command. The following command lines, for example, have identical meanings:
TCPIP> SH SE NFS/FU/PER

TCPIP> SHOW SERVICE NFS /FULL /PERMANENT

Command examples shown in this manual are expressed using full command and qualifier names for clarity.

Multiple values To specify multiple host names, addresses, or options for parameters and qualifiers, be sure to separate elements with commas and enclose the entire list in parentheses. Wildcards are valid unless otherwise stated. A space between multiple elements is optional unless otherwise stated. For example, the following qualifiers are the same:
/qualifier=(option_a:value1,option_b:value2,value3)
/qualifier=(option_a=value1),(option_b=value2,value3)

Wildcards are valid unless otherwise stated. A space between multiple elements is optional unless otherwise stated.

Numeric values Unless otherwise stated, all numeric values are decimal. Values are indicated by either a preceding equals sign (=) or a colon (:). For example:
TCPIP> SET NAME_SERVICE /SERVER:(SORA,JACANA,PARROT) -
_TCPIP> /ACCEPT:(HOSTS:JACANA,JAY,JUNCO,999.20.40.3)

Quotation marks On command lines, enclose the following in quotation marks when:

Lowercase and mixed-case names that are to be stored in a database with the exact case preserved.
Directory and file specifications that contain a slash (/).
UNIX commands entered on the DCL command line.

Consider these examples:

To specify a path, enclose it in quotation marks:
TCPIP> MAP "/usr/songbirds/canary" CANARY$DUA2:

To specify host names using lowercase letters when you create a proxy entry in the database:
TCPIP> ADD PROXY COUSINS /GID=10 /UID=40 -
_TCPIP> /HOST=("raven","crow","rook","daw")

Note the use of the DCL command-line continuation character ( - ) that allows you to continue a long command on the next line.
To specify a lowercase host name when adding the host to the hosts database, use these commands:
TCPIP> SET HOST "eaglet" /ADDRESS = 128.33.22.1
TCPIP> SHOW HOST EAGLET

Note that DCL interprets all input as uppercase unless you enclose it in quotation marks. Therefore, you must use quotation marks to enter the host name in lowercase in the hosts database. To display information about a host, you can enter either uppercase or lowercase characters.
Use quotes when entering a UNIX command at the DCL prompt. For example:
$ TCPIP "ifconfig -a"

UNIX commands Follow UNIX syntax and case rules when entering UNIX commands at the TCPIP> prompt. For example, enter the ifconfig command in lowercase letters:
TCPIP> ifconfig options

The following use of the ifconfig command is incorrect:
TCPIP> IFCONFIG options

Wildcards If you specify a wildcard on a command line, you are asked for confirmation before the command executes.
You can change this default behavior with the /NOCONFIRM qualifier. For example:
TCPIP> REMOVE PROXY GRACKLE/GID=*/UID=130
VMS User_name Type User_ID Group_ID Host_name
GRACKLE N 269 48 MAPLE
Remove? [N]:

**Table 1-1 Management Command Guidelines**
Element	Guideline
Address formats	Some commands require that you specify one of the following kinds of addresses: IP Ethernet FDDI Token Ring Hardware Be sure to use the appropriate format. The following examples illustrate an IP address, an Ethernet address, and a hardware address, respectively. TCPIP> SET HOST CROW /ADDRESS=1.2.3.4 TCPIP> SET ARP AA-BB-04-05-06-07 CONDOR TCPIP> SET BOOTP MACAW /HARDWARE=ADDRESS=08-dd-ff-2a-23-21
Default	Refers to the command's behavior if optional qualifiers are omitted.
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.
Host names and IP addresses	To specify a host or network name on a command line, you can enter either the host's name or the host's IP address.
Keywords	You can abbreviate commands to the fewest number of characters, usually four, that identify the command. The following command lines, for example, have identical meanings: TCPIP> SH SE NFS/FU/PER TCPIP> SHOW SERVICE NFS /FULL /PERMANENT Command examples shown in this manual are expressed using full command and qualifier names for clarity.
Multiple values	To specify multiple host names, addresses, or options for parameters and qualifiers, be sure to separate elements with commas and enclose the entire list in parentheses. Wildcards are valid unless otherwise stated. A space between multiple elements is optional unless otherwise stated. For example, the following qualifiers are the same: /qualifier=(option_a:value1,option_b:value2,value3) /qualifier=(option_a=value1),(option_b=value2,value3) Wildcards are valid unless otherwise stated. A space between multiple elements is optional unless otherwise stated.
Numeric values	Unless otherwise stated, all numeric values are decimal. Values are indicated by either a preceding equals sign (=) or a colon (:). For example: TCPIP> SET NAME_SERVICE /SERVER:(SORA,JACANA,PARROT) - _TCPIP> /ACCEPT:(HOSTS:JACANA,JAY,JUNCO,999.20.40.3)
Quotation marks	On command lines, enclose the following in quotation marks when: Lowercase and mixed-case names that are to be stored in a database with the exact case preserved. Directory and file specifications that contain a slash (/). UNIX commands entered on the DCL command line. Consider these examples: To specify a path, enclose it in quotation marks: TCPIP> MAP "/usr/songbirds/canary" CANARY$DUA2: To specify host names using lowercase letters when you create a proxy entry in the database: TCPIP> ADD PROXY COUSINS /GID=10 /UID=40 - _TCPIP> /HOST=("raven","crow","rook","daw") Note the use of the DCL command-line continuation character ( - ) that allows you to continue a long command on the next line. To specify a lowercase host name when adding the host to the hosts database, use these commands: TCPIP> SET HOST "eaglet" /ADDRESS = 128.33.22.1 TCPIP> SHOW HOST EAGLET Note that DCL interprets all input as uppercase unless you enclose it in quotation marks. Therefore, you must use quotation marks to enter the host name in lowercase in the hosts database. To display information about a host, you can enter either uppercase or lowercase characters. Use quotes when entering a UNIX command at the DCL prompt. For example: $ TCPIP "ifconfig -a"
UNIX commands	Follow UNIX syntax and case rules when entering UNIX commands at the TCPIP> prompt. For example, enter the `ifconfig` command in lowercase letters: TCPIP> ifconfig options The following use of the `ifconfig` command is incorrect: TCPIP> IFCONFIG options
Wildcards	If you specify a wildcard on a command line, you are asked for confirmation before the command executes. You can change this default behavior with the /NOCONFIRM qualifier. For example: TCPIP> REMOVE PROXY GRACKLE/GID=*/UID=130 VMS User_name Type User_ID Group_ID Host_name GRACKLE N 269 48 MAPLE Remove? [N]:

1.1.1 Setting Configuration Parameters

Some commands allow you to enter information in the database; others modify only the run-time parameters. Table 1-2 shows the SET commands that affect one or the other.

Table 1-2 SET Commands
Modify Permanent Database Files Modify Dynamic 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 ROUTE SET ROUTE

SET SERVICE

**Table 1-2 SET Commands**
Modify Permanent Database Files	Modify Dynamic 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 ROUTE	SET ROUTE
SET SERVICE

Note that the SET ROUTE command affects both the permanent and dynamic routing databases.

1.1.2 Modifying the Configuration Database

Unlike the other databases, which have similar objects, the configuration database holds diverse initialization information for various TCP/IP Services components.

The following commands modify the configuration database:

SET CONFIGURATION BIND
SET CONFIGURATION COMMUNICATION
SET CONFIGURATION ENABLE SERVICE
SET CONFIGURATION INTERFACE
SET CONFIGURATION NAME_SERVICE
SET CONFIGURATION PROTOCOL
SET CONFIGURATION SMTP
SET CONFIGURATION SNMP
SET CONFIGURATION START ROUTING
SET CONFIGURATION TIME

Contents

Index

Internet	openvmsdoc@compaq.com
Mail	Compaq Computer Corporation OSSG Documentation Group, ZKO3-4/U08 110 Spit Brook Rd. Nashua, NH 03062-2698

Ctrl/ x	A sequence such as Ctrl/ x indicates that you must hold down the key labeled Ctrl while you press another key or a pointing device button.
PF1 x	A sequence such as PF1 x indicates that you must first press and release the key labeled PF1 and then press and release another key or a pointing device button.
`[Return]`	In examples, a key name enclosed in a box indicates that you press a key on the keyboard. (In text, a key name is not enclosed in a box.) In the HTML version of this document, this convention appears as brackets, rather than a box.
...	A horizontal ellipsis in examples indicates one of the following possibilities: Additional optional arguments in a statement have been omitted. The preceding item or items can be repeated one or more times. Additional parameters, values, or other information can be entered.
. . .	A vertical ellipsis indicates the omission of items from a code example or command format; the items are omitted because they are not important to the topic being discussed.
( )	In command format descriptions, parentheses indicate that you must enclose choices in parentheses if you specify more than one.
[ ]	In command format descriptions, brackets indicate optional choices. You can choose one or more items or no items. Do not type the brackets on the command line. However, you must include the brackets in the syntax for OpenVMS directory specifications and for a substring specification in an assignment statement.
\|	In command format descriptions, vertical bars separate choices within brackets or braces. Within brackets, the choices are optional; within braces, at least one choice is required. Do not type the vertical bars on the command line.
{ }	In command format descriptions, braces indicate required choices; you must choose at least one of the items listed. Do not type the braces on the command line.
bold text	This typeface represents the introduction of a new term. It also represents the name of an argument, an attribute, or a reason.
italic text	Italic text indicates important information, complete titles of manuals, or variables. Variables include information that varies in system output (Internal error number), in command lines (/PRODUCER= name), and in command parameters in text (where dd represents the predefined code for the device type).
UPPERCASE TEXT	Uppercase text indicates a command, the name of a routine, the name of a file, or the abbreviation for a system privilege.
`Monospace text`	Monospace type indicates code examples and interactive screen displays. This typeface indicates UNIX system output or user input, commands, options, files, directories, utilities, hosts, and users. In the C programming language, this typeface identifies the following elements: keywords, the names of independently compiled external functions and files, syntax summaries, and references to variables or identifiers introduced in an example.
-	A hyphen at the end of a command format description, command line, or code line indicates that the command or statement continues on the following line.
numbers	All numbers in text are assumed to be decimal unless otherwise noted. Nondecimal radixes---binary, octal, or hexadecimal---are explicitly indicated.