Compaq Advanced Server for OpenVMS

Document revision date: 30 March 2001

Commands Reference Manual

Order Number: AA--R6G5C--TE

March 2001

This manual provides command syntax descriptions for all ADMINISTER commands available with the Advanced Server for OpenVMS.

Revision/Update Information: This manual supersedes the Commands Reference Manual, AA--R6G5B--TE.

Operating System Version: OpenVMS Alpha Version 7.2-1, 7.1-2, 6.2
OpenVMS VAX Version 7.2, 7.1, 6.2

Software Versions: Advanced Server V7.3 for OpenVMS
PATHWORKS V6.0C for OpenVMS (Advanced Server)

Compaq Computer Corporation
Houston, Texas

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

AlphaStation, DEC, DECnet, DECwindows, PATHWORKS, OpenVMS, and POLYCENTER are trademarks of Compaq Information Technologies Group, L.P. in the United States and other countries.

Microsoft, MS-DOS, Windows, and Windows NT are trademarks of Microsoft Corporation in the United States and other countries.
Intel is a trademark of Intel Corporation in the United States and other countries.
UNIX is a trademark of The Open Group 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.

ZK6544

The Compaq Advanced Server for OpenVMS documentation set is available on CD-ROM.

Contents Index

Preface

Welcome to the Compaq Advanced Server for OpenVMS Commands Reference Manual. For the purposes of this text, the product is referred to as the Advanced Server. The information presented in this guide is equally applicable to:

Advanced Server V7.3 for OpenVMS
PATHWORKS V6.0C for OpenVMS (Advanced Server)

Usage of the term "Advanced Server" in this manual refers to either version of the file and print server, except when the text explicitly specifies a version number.

The Advanced Server and its associated OpenVMS system platform provide a powerful, reliable, and open operating environment that meets the demands of client/server computing. This manual provides reference material to help you manage and maintain your network using the Advanced Server ADMINISTER command-line interface.

Intended Audience

This manual is for the Advanced Server for OpenVMS server administrator. As the administrator, you must be familiar with the Compaq OpenVMS operating system to support the server and with other operating systems to support clients. It is also expected that you have experience doing network administration, and that you are familiar with OpenVMS DCL command language syntax and the specific network configuration being managed. You are assumed to have read the other documents in the Advanced Server for OpenVMS set and to have access to documentation for any clients running other operating systems.

Document Structure

This document contains the following chapters:

Chapter Description

Chapter 1, Overview Provides an overview of this guide

Chapter 2, ADMINISTER Commands Describes the function and syntax of all ADMINISTER commands for managing the Advanced Server

Chapter 3, Net Commands and ADMINISTER Command Equivalents Lists PATHWORKS V5 for OpenVMS (LAN Manager) Net commands and their ADMINISTER command equivalents

Chapter	Description
Chapter 1, Overview	Provides an overview of this guide
Chapter 2, ADMINISTER Commands	Describes the function and syntax of all ADMINISTER commands for managing the Advanced Server
Chapter 3, Net Commands and ADMINISTER Command Equivalents	Lists PATHWORKS V5 for OpenVMS (LAN Manager) Net commands and their ADMINISTER command equivalents

Document	Description
Compaq Advanced Server for OpenVMS Server Installation and Configuration Guide	Explains how to install and configure Advanced Server software
Compaq Advanced Server for OpenVMS Concepts and Planning Guide	Provides an overview of and introduction to the Advanced Server software and associated networking concepts for system administrators and operators
Compaq Advanced Server for OpenVMS Server Administrator's Guide	Explains how to manage and customize the Advanced Server software
Compaq Advanced Server for OpenVMS Guide to Managing Advanced Server Licenses	Describes the License Server software and how to manage Advanced Server licenses

Document	Description
Compaq PATHWORKS for OpenVMS (Advanced Server) Server Migration Guide	Explains how to upgrade a PATHWORKS V5 for OpenVMS (LAN Manager) server to PATHWORKS V6 for OpenVMS (Advanced Server)
Compaq PATHWORKS for OpenVMS (Advanced Server) Server Installation and Configuration Guide	Explains how to install and configure PATHWORKS for OpenVMS (Advanced Server) software
Compaq Advanced Server for OpenVMS Concepts and Planning Guide	Provides an overview of and introduction to the PATHWORKS for OpenVMS (Advanced Server) software and associated networking concepts for system administrators and operators
Compaq PATHWORKS for OpenVMS (Advanced Server) Server Administrator's Guide	Explains how to manage and customize the PATHWORKS for OpenVMS (Advanced Server) software
Compaq Advanced Server for OpenVMS Guide to Managing Advanced Server Licenses	Describes the License Server software and how to manage PATHWORKS for OpenVMS (Advanced Server) licenses

OpenVMS Document	Description
OpenVMS Alpha Version 7.1 Upgrade and Installation Manual	Describes how to install the OpenVMS Alpha V7.1 system software
OpenVMS Alpha Version 7.2 Upgrade and Installation Manual	Describes how to install the OpenVMS Alpha V7.2 system software
OpenVMS VAX Version 7.1 Upgrade and Installation Manual	Describes how to install the OpenVMS VAX V7.1 system software
OpenVMS VAX Version 7.2 Upgrade and Installation Manual	Describes how to install the OpenVMS VAX V7.2 system software
OpenVMS System Manager's Manual	A task-oriented guide (in two volumes) to managing an OpenVMS system; describes how to set up the required system services
OpenVMS System Management Utilities Reference Manual	A reference guide (in two volumes) to the utilities and tools used in managing an OpenVMS system
OpenVMS License Management Utility Manual	Explains how to load and manage license Product Authorization Keys (PAKs)
OpenVMS Guide to Extended File Specifications	Describes Extended File Specifications on OpenVMS, including how to set up and enable the ODS-5 file system
OpenVMS DCL Dictionary: A--M, OpenVMS DCL Dictionary: N--Z	Provide detailed reference information and examples for OpenVMS DCL commands and lexical functions
Compaq C Run-Time Library Utilities Reference Manual	Describes utilities that help you manage localization and time zone data for international software applications
OpenVMS Connectivity Developer's Guide	Contains COM for OpenVMS, OpenVMS Registry, and OpenVMS Events information

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

Use the following World Wide Web address 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 following conventions are used in the Advanced Server documentation set:

Convention Meaning

Advanced Server Advanced Server refers to PATHWORKS Advanced Server as well as Advanced Server for OpenVMS file server.

italic text Italic text indicates a place holder for information or parameters that you must provide. For example, if the procedure asks you to type file-name, you must type the actual name of a file.
Italic text also indicates path names, new terms, and the titles of other documents referenced.

monospace text Monospace text indicates the actual commands, words, or characters that you type in a dialog box or at a command prompt or system output.

UPPERCASE TEXT Uppercase text indicates names of OpenVMS and Advanced Server for OpenVMS commands and qualifiers. You can enter commands and qualifiers in any combination of uppercase and lowercase letters, unless otherwise noted.

/ A forward slash in command descriptions indicates that a command qualifier follows.

= An equal sign (=) in command descriptions indicates you must provide information.

[ ] In command format descriptions, brackets indicate optional elements. Multiple elements are separated by vertical bars (|). You can enter as many as you want.

{ } In command format descriptions, braces indicate you must enter at least one listed element. The elements are separated by bars (|).

... A horizontal ellipsis following an entry in a command line indicates that the entry or a similar entry can be repeated any number of times. An ellipsis following a file name indicates that additional parameters, values, or information can be entered.

.
.
. A vertical ellipsis in an example indicates that not all the data is shown.

Note The use of Note indicates information of special importance.

Ctrl/ x While you hold down the Ctrl key, press another key or a pointing device button.

Return or Enter In text, Return or Enter indicates where you should press the Return or Enter key to execute a command or terminate a sequence. This key is labeled Return or Enter, depending on your keyboard.

[Tab] 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.

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.

Convention	Meaning
Advanced Server	Advanced Server refers to PATHWORKS Advanced Server as well as Advanced Server for OpenVMS file server.
italic text	Italic text indicates a place holder for information or parameters that you must provide. For example, if the procedure asks you to type file-name, you must type the actual name of a file. Italic text also indicates path names, new terms, and the titles of other documents referenced.
`monospace text`	Monospace text indicates the actual commands, words, or characters that you type in a dialog box or at a command prompt or system output.
UPPERCASE TEXT	Uppercase text indicates names of OpenVMS and Advanced Server for OpenVMS commands and qualifiers. You can enter commands and qualifiers in any combination of uppercase and lowercase letters, unless otherwise noted.
/	A forward slash in command descriptions indicates that a command qualifier follows.
=	An equal sign (=) in command descriptions indicates you must provide information.
[ ]	In command format descriptions, brackets indicate optional elements. Multiple elements are separated by vertical bars (\|). You can enter as many as you want.
{ }	In command format descriptions, braces indicate you must enter at least one listed element. The elements are separated by bars (\|).
...	A horizontal ellipsis following an entry in a command line indicates that the entry or a similar entry can be repeated any number of times. An ellipsis following a file name indicates that additional parameters, values, or information can be entered.
. . .	A vertical ellipsis in an example indicates that not all the data is shown.
Note	The use of Note indicates information of special importance.
Ctrl/ x	While you hold down the Ctrl key, press another key or a pointing device button.
Return or Enter	In text, Return or Enter indicates where you should press the Return or Enter key to execute a command or terminate a sequence. This key is labeled Return or Enter, depending on your keyboard.
`[Tab]`	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.
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.

Chapter 1
Overview

The Advanced Server for OpenVMS software provides a flexible system for managing wide area networks (WANs) and local area networks (LANs). The Advanced Server enables you to use Compaq computers as servers to share network resources with supported clients and is fully compatible with Windows NT servers running in the same network.

The Advanced Server is an OpenVMS-based network operating system (NOS) fully compatible with Microsoft networking technology.

1.1 ADMINISTER Commands

You use the Advanced Server command-line interface (ADMINISTER commands) to manage your network from an Advanced Server. This manual provides full descriptions of the ADMINISTER commands with examples; commands are presented in alphabetical order. Task-oriented procedures using these commands are described in your Server Administrator's Guide.

1.2 Net Commands

PATHWORKS V5 for OpenVMS (LAN Manager) uses the Net command-line interface (Net commands) to perform some functions for managing your network. With the Advanced Server, Net commands are obsolete. Their functions are now available using ADMINISTER commands. The ADMINISTER command-line interface provides a subset of the Net commands for backward compatibility. This feature enables users to migrate to the new command syntax.

Chapter 3, Net Commands and ADMINISTER Command Equivalents, in this manual provides a list of the Net commands and the ADMINISTER commands that provide the same functions. Use the ADMINISTER commands in place of Net commands to manage your network.

Chapter 2
ADMINISTER Commands

You manage the Advanced Server from your OpenVMS system using the ADMINISTER command with its command-line interface. Some commands require privileges (group membership), described in your Server Administrator's Guide.

You can also use programs available through Windows NT server administration tools to manage the Advanced Server. In the context of this manual, as administrator you are an OpenVMS system manager.

This chapter lists commands that are available in the Advanced Server and also summarizes syntax and usage conventions. You can also use the ADMINISTER Help file for information on these commands. To access ADMINISTER Help, enter ADMINISTER HELP at the DCL system prompt:

$ ADMINISTER HELP

2.1 Invoking the ADMINISTER User Interface

You control many aspects of the Advanced Server with the ADMINISTER command-line interface. You can invoke the ADMINISTER user interface in one of two ways:

You invoke the command-line interface by typing ADMINISTER at the OpenVMS system prompt. The command-line interface prompts you with the name of the domain and the name of the server you are managing. For example:
$ ADMINISTER LANDOFOZ\\TINMAN>
In this example, you are managing a domain called LANDOFOZ, and a server called TINMAN.

You can also execute ADMINISTER commands on the DCL command line in the following form:

$ ADMINISTER SHOW SHARES Shared resources on server "TINMAN": Name Type Description ------------ --------- ----------------------------- NETLOGON Directory Logon Scripts Directory HANKP Printer Hank's print share PLOUGH Printer Scarecrow's print share PWLIC Directory PATHWORKS Client License Software PWLICENSE Directory PATHWORKS Client License Software PWUTIL Directory PATHWORKS Client-based Utilities USERS Directory Users Directory Total of 7 shares

When invoked as shown in this example, the command-line interface executes a single command and returns you to the OpenVMS system prompt.

Once you have invoked the command-line interface, you can enter any number of commands. This way of using the command-line interface provides for better system response than entering commands from the OpenVMS prompt.

You can enter commands with parameters and qualifiers on a single line as shown in this example:

$ ADMINISTER ADD COMPUTER DOROTHY/DOMAIN=LANDOFOZ/ROLE=BACKUP

In some cases, you will be prompted for parameters that you did not enter. For example, if you did not enter the user name with the LOGON command, you will be prompted for it:

LANDOFOZ\\TINMAN> LOGON Username:

Although the software may prompt for required parameters, do not rely on the software to prompt you for all required information. Be sure to enter all required information, except for passwords, on the command line. For information about entering passwords, see Section 2.1.6, Using Passwords with Commands.

2.1.1 Local and Remote Administration

You can use the ADMINISTER command-line interface to administer the local computer, as well as any other compatible servers on the network to which you have access. By default, you are set up to administer the local server and the domain to which it belongs. You can administer a remote server and domain in one of three ways:

Change the default domain or server using the SET ADMINISTRATION command. This command causes all further commands to be directed to the new default domain or server.
You can also change the default domain by using the LOGON command to log into the specific domain. Again, all subsequent commands affect the specified domain. The server name is set to the local server if the local server is a member of the logged on domain. It is set to the name of the primary domain controller of the specified domain if the local server is not a member of the specified domain.
The default domain remains in effect for the duration of the current OpenVMS login session, or until you log off the domain or change the default domain.
Direct an individual command to a specified domain or server using the /DOMAIN or /SERVER command qualifiers. Refer to the command descriptions in this manual to determine which commands support the /DOMAIN and /SERVER qualifiers.
If the server you wish to administer is a downlevel server (a server such as the PATHWORKS LAN Manager server, which runs an earlier network operating system than that of the Advanced Server), use the TELL command. The TELL command sends an entire command line to a specified server to be executed at the server.

2.1.2 Member Server Local Database Administration

Using ADMINISTER commands on a member server (or directing them to a member server), you can manage the domain-wide security accounts database as you would from any domain controller. Although a member server does not store or maintain the domain-wide database, it still has access to the benefits of the centralized, domain-wide database.

You can also manage a member server's local security accounts database. You can do so by logging directly into the server's local database, or setting the default to that database, as explained in Section 2.1.2.1, Administering the Member Server's Local Database. However, certain ADMINISTER commands will be restricted. Certain objects, such as global groups and trusts, are manageable only when logged into a domain controller's domain. Section 2.1.2.2, ADMINISTER Command Variances on Member Servers, lists the ADMINISTER commands that are not allowed, or that provide restricted capabilities. The information in both of these sections applies to workstations as well as member servers.

2.1.2.1 Administering the Member Server's Local Database

Unless you have changed the default to the member server's local database, ADMINISTER commands normally operate domain-wide --- that is, on the domain to which the member server belongs. For example, if you enter the ADMINISTER command on member server WIZARD in domain LANDOFOZ, the ADMINISTER prompt displays domain LANDOFOZ and server WIZARD, as shown:

$ ADMINISTER LANDOFOZ\\WIZARD>

To manage a member server's local database, you must log in, or change the default domain to the local database. To do so, specify for the domain name the member server's name preceded by two backslashes (\\). The following example shows how to specify the SET ADMINISTRATION command to administer member server WIZARD's local domain database:

LANDOFOZ\\TINMAN> SET ADMINISTRATION/DOMAIN=\\WIZARD %PWRK-S-ADMSET, now administering domain "\\WIZARD", server "WIZARD" \\WIZARD\\WIZARD>

As shown, when you administer the member server's local domain database, the ADMINISTER prompt displays the domain name preceded by two backslashes, and the domain name is the same as the name of the member server.

In an OpenVMS Cluster in which the Advanced Servers are member servers, you can optionally specify for the domain name the Advanced Server cluster alias name, preceded by two backslashes. When administering a clustered member server's local database, the ADMINISTER prompt displays the cluster alias name as the domain (preceded by two backslashes). For the server name, unless you specified a specific server name, the prompt displays the name of the cluster member that responded first to the ADMINISTER interface.

2.1.2.2 ADMINISTER Command Variances on Member Servers

As mentioned previously, member servers do not maintain or manage the domain-wide security accounts database and cannot manage or display certain objects, such as global groups, primary groups, and trusts. Table 2-1, Disallowed or Restricted Commands When Administering a Member Server's Local Database, lists the commands that are not allowed, or are restricted when, administering the member server's local domain database. If you attempt to use these commands in such circumstances, the following error message will be displayed:

%PWRK-E-DCONLY, operation is only valid to a Domain Controller

The affected commands are categorized by each of the following management objects: COMPUTER, GROUP, TRUST, and USER.

Table 2-1 Disallowed or Restricted Commands When Administering a Member Server's Local Database
Object Command Restriction

COMPUTER ADD Not allowed

REMOVE Not allowed

SET Not allowed with the /ACCOUNT_SYNCHRONIZE or /ROLE= qualifiers

SHOW When you do not specify a computer name with the command, it displays information about the member server only (the computer you are managing) rather than about all the computers in the domain; note that the display symbol for a member server is [SV]

GROUP ADD, COPY, MODIFY, REMOVE, SHOW Do not use for global groups, or with the /GLOBAL or /PRIMARY_GROUP qualifiers; GROUP commands manage local groups only

TRUST ADD, REMOVE, SHOW Not allowed

USER ADD, COPY, MODIFY Do not use with the /PRIMARY_GROUP qualifier; the ADD USER command adds the user to the Users local group; these commands manage memberships in local groups only

REMOVE, SHOW These commands manage memberships in local groups only; the SHOW USERS command does not display the primary group or memberships in global groups

**Table 2-1 Disallowed or Restricted Commands When Administering a Member Server's Local Database**
Object	Command	Restriction
COMPUTER	ADD	Not allowed
	REMOVE	Not allowed
	SET	Not allowed with the /ACCOUNT_SYNCHRONIZE or /ROLE= qualifiers
	SHOW	When you do not specify a computer name with the command, it displays information about the member server only (the computer you are managing) rather than about all the computers in the domain; note that the display symbol for a member server is [SV]
GROUP	ADD, COPY, MODIFY, REMOVE, SHOW	Do not use for global groups, or with the /GLOBAL or /PRIMARY_GROUP qualifiers; GROUP commands manage local groups only
TRUST	ADD, REMOVE, SHOW	Not allowed
USER	ADD, COPY, MODIFY	Do not use with the /PRIMARY_GROUP qualifier; the ADD USER command adds the user to the Users local group; these commands manage memberships in local groups only
	REMOVE, SHOW	These commands manage memberships in local groups only; the SHOW USERS command does not display the primary group or memberships in global groups

2.1.3 Privileges Required

Some of your network users may be designated as Account Operators, Print Operators, or Server Operators. These users have limited administrative or operator privileges that enable them to perform specific tasks. If you have different operators responsible for parts of your network and you do not want to assign them full administrative privileges, then make them members of groups only at the server being administered.

Required privileges are included in the command descriptions in this manual.

2.1.4 Understanding Command Syntax

In this manual, command syntax for ADMINISTER commands is denoted as follows:

An option enclosed in braces ({ }) is required. For example, {YES | NO} indicates that you must specify either YES or NO when using the command.
An option enclosed in brackets ([ ]) is optional. For example, [password] indicates that a password can be used with the command if desired, but it is not required.
When a vertical bar (|) separates items within braces or brackets, select only one option. For example, the following list indicates that you must select only one of the options:
{/HOLD | /RELEASE | /DELETE}
When an ellipsis (...) appears in a syntax statement, you can repeat the previous item. For example, /FLAGS=(option, ...) indicates that you can specify more than one option, with a comma between the flag options.
Be sure to type slashes (/), backslashes (\), commas (,), double quotes ("), equal signs (=), colons (:), parentheses ( ), semicolons (;), spaces ( ), and asterisks (*) as they are shown.
When you finish typing a command, press Return or Enter.
If you are typing a long command string, do not press Return when your cursor gets to the edge of your screen; the cursor wraps around and continues on the next line of your screen. Press Return only after you finish typing the entire command string. Or, enter multiple line command strings; use a hyphen (-) at the end of the line as the continuation character.

In general, the ADMINISTER command syntax conforms to the OpenVMS DCL command conventions. Refer to the OpenVMS DCL Dictionary for more information.

2.1.5 Case Sensitivity

Due to the behavior of OpenVMS, all parameters and qualifier values entered on the command line are converted to uppercase characters when they are processed by the user interface. If you wish to preserve case, or you wish to enter any value that contains blanks (spaces) or any nonalphanumeric characters, you must enclose the value in quotation marks. This is not necessary, however, if you are prompted for additional information after entering a command.

For further information, refer to your Server Administrator's Guide.

2.1.6 Using Passwords with Commands

Some commands require you to enter a password. You can provide a password with a command by typing the password on the same line as the command. For example, to log on as the user named JIM using the password KAHUNA, you type:

$ ADMINISTER LANDOFOZ\\TINMAN> LOGON JIM KAHUNA The server \\TINMAN successfully logged you on as JIM. Your privilege level on domain LANDOFOZ is ADMIN. The last time you logged on was 10/08/00 07:48 PM LANDOFOZ\\TINMAN>

Because passwords are case sensitive in most cases, pay careful attention when entering them on a command line. If they are to contain any lowercase letters, blanks (spaces), or nonalphanumeric characters, be sure to enclose them in quotation marks.

You can also have the user interface prompt you for the password. For example, to log on to the network, type:

$ ADMINISTER LANDOFOZ\\TINMAN> LOGON JIM Password: The server \\TINMAN successfully logged you on as JIM. Your privilege level on domain LANDOFOZ is ADMIN. The last time you logged on was 10/08/00 07:48 PM LANDOFOZ\\TINMAN>

When you enter a password when prompted, as in the second example, the password does not appear on the screen as you type. This helps you keep your password confidential, providing added security. In addition, you need not use quotation marks if the password contains lowercase letters, blanks (spaces), or nonalphanumeric characters (as you do when entering the password on the command line).

If you forget to enter a password for a command that requires one, the software prompts you for it. Depending on the command that you type, the software may also prompt you for other required information, such as your user name.

Contents

Index

privacy and legal statement

6544PRO.HTML

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