Document revision date: 30 March 2001

## OpenVMS System Management Utilities Reference Manual

Previous | Contents | Index

## Chapter 21
System Management Utility

## 21.1 SYSMAN Description

The System Management utility (SYSMAN) centralizes the management of nodes and cluster environments. Rather than logging in to individual nodes and repeating a set of management tasks, SYSMAN enables you to define your management environment to be a particular node, a group of nodes, or a cluster environment. With a management environment defined, you can perform system management tasks from your local node. SYSMAN executes these tasks on all nodes in the target environment.

Managing a system with SYSMAN is similar to the traditional management of an individual system because SYSMAN uses many of the same software tools. It can process most DCL commands, such as MOUNT, DEFINE, INITIALIZE, SET, and SHOW. It can also execute many OpenVMS system management utilities and command procedures, such as AUTHORIZE, AUTOGEN, and INSTALL.

SYSMAN also contains system management tools that let you perform the following tasks:

- Set disk quotas using DISKQUOTA commands.
- Load and unload licenses using LICENSE commands.
- Associate a terminal or port with a user name using the automatic login facility (ALF) commands.
- Modify or display System Generation utility (SYSGEN) parameters using PARAMETERS commands.
- Build site-specific startup procedures using STARTUP commands, which display or modify startup components of the OpenVMS operating system, site-specific programs, and layered products.
- Modify or display OpenVMS Cluster parameters using CONFIGURATION commands.
- Load system services using SYS_LOADABLE commands, which add and remove executive loaded images from the set of images loaded at boot time.
- Create and modify scheduling classes, which allow you to limit the amount of CPU time alloted to users on a system.
- On Alpha systems, detect all previously undiscovered tapes and medium changers.
- On Alpha systems, connect devices, load device drivers, and display configuration information using IO commands.
- Shut down systems using SHUTDOWN NODE command.

### 21.1.1 Defining Keys to Execute SYSMAN Commands

Instead of having to type lengthy command lines, SYSMAN enables you to define keys to execute SYSMAN commands. For example, you can define a key to execute a SET ENVIRONMENT command as follows:

    SYSMAN> DEFINE/KEY/TERMINATE
    _Key name: KP0
    _Translation: "SET ENVIRONMENT/NODE=(NODE21,NODE22,NODE23)"

Once the key is defined, you can press keypad 0, and SYSMAN executes the SET ENVIRONMENT command. Note that key definitions are lost each time that you exit from SYSMAN, unless you define them in the SYSMAN initialization file. (See Section 21.1.2 for more information about executing commands from an initialization file.)

### 21.1.2 Executing Commands from an Initialization File

You can create an initialization file that SYSMAN will use each time you invoke the utility. In the SYSMAN initialization file, you can perform tasks such as defining keys and setting the SYSMAN environment.

The default file specification for the SYSMAN initialization file is SYS$LOGIN:SYSMANINI.INI. If you want your SYSMAN initialization file to have a different file specification, you must define the logical name SYSMANINI to point to the location of the file.

The following example is a sample initialization file in which several keys are defined:

    $ TYPE SYSMANINI.INI
    DEFINE/KEY/TERMINATE KP0 "SET ENVIRONMENT/CLUSTER/NODE=(NODE21,NODE22,NODE23,NODE24)"
    DEFINE/KEY/TERMINATE KP1 "CONFIGURATION SHOW TIME"
    DEFINE/KEY/TERMINATE KP2 "SHOW PROFILE"
       .
       .
       .

## 21.2 SYSMAN Usage Summary

> The System Management utility (SYSMAN) centralizes system management, enabling you to manage nodes or clusters from one location.

### Format

> RUN SYS$SYSTEM:SYSMAN

### Parameters

> None.

Usage Summary To invoke SYSMAN, enter the following command at the DCL prompt:

    $ RUN SYS$SYSTEM:SYSMAN

SYSMAN displays the following prompt at which you can enter SYSMAN commands using the standard rules of DCL syntax:

    SYSMAN>

As an alternative, you can enter the RSX command MCR, which expands to RUN SYS$SYSTEM:

    $ MCR SYSMAN

With the MCR command, you can invoke SYSMAN and supply a command in one command string. With any SYSMAN command invoked in this way (except SET ENVIRONMENT), SYSMAN executes the command string and exits. After executing a SET ENVIRONMENT command, the utility returns the SYSMAN> prompt.

To exit from SYSMAN and return to the DCL command level, enter the EXIT command at the SYSMAN> prompt or press Ctrl/Z.

- Note SYSMAN has the following restrictions: You must have the OPER privilege on the local node and authorization for the OPER or SETPRV privilege on any remote nodes in the management environment. You must also have the privileges required by individual commands, as each command in this chapter describes. To determine which privileges are required for DCL commands or for system management utilities, refer to the OpenVMS DCL Dictionary or the appropriate utility reference part of this manual. You cannot run SYSMAN from a batch job in any environment that requires a password. Some DCL commands, such as SHOW SYSTEM/CLUSTER, SET CLUSTER/QUORUM, MOUNT/CLUSTER, and some forms of the REPLY command, operate clusterwide by design. These commands should not be run using SYSMAN, unless the environment has been set to a single node. Similarly, operations on clusterwide logical names and tables operate clusterwide by design. If a SYSMAN user running with more than 125 total rights attempts to issue a SYSMAN command to a remote node within a cluster, the following error message is displayed:
      SMI-E-RIGHTSLIM, Rights limit exceeded.
Note that this rights limitation includes a minimum of three identifiers that are granted during login when the process rights list is created: A UIC identifier A system identifier Depending upon the environment in which the process is operating, at least one environmental identifier Users who want to run SYSMAN must have either one of the following items: A separate account with no more than 125 rights Enough identifiers removed from their current account so that the total number of rights falls within the appropriate range

## 21.3 SYSMAN Commands

This section describes the SYSMAN commands and demonstrates their use. Table 21-1 summarizes each command as follows.

Table 21-1 SYSMAN Commands
Command | Function
--- | ---
@ (Execute Procedure) | Requests that SYSMAN read subsequent command input from the specified file or device.
ALF ADD | Adds a record to the automatic login facility (ALF) database.
ALF REMOVE | Deletes one or more records from the automatic login facility (ALF) database.
ALF SHOW | Displays one or more records from the automatic login facility (ALF) database.
ATTACH | Transfers control from your current process to the specified process in your job.
CLASS_SCHEDULE ADD | Creates a new scheduling class.
CLASS_SCHEDULE DELETE | Deletes a scheduling class.
CLASS_SCHEDULE MODIFY | Modifies the characteristics of a scheduling class.
CLASS_SCHEDULE RESUME | Resumes a scheduling class that has been suspended.
CLASS_SCHEDULE SHOW | Displays the characteristics of a scheduling class.
CLASS_SCHEDULE SUSPEND | Temporarily suspends a scheduling class.
CONFIGURATION SET CLUSTER_AUTHORIZATION | Updates security data in a local area cluster.
CONFIGURATION SET TIME | Updates system time.
CONFIGURATION SHOW CLUSTER_AUTHORIZATION | Displays cluster security data.
CONFIGURATION SHOW TIME | Displays current system time.
DEFINE/KEY | Defines a key to execute a SYSMAN command
DISKQUOTA ADD | Adds an entry to a disk quota file.
DISKQUOTA CREATE | Creates and enables a disk quota file for a volume that does not contain one.
DISKQUOTA DELETE | Removes an entry from a quota file.
DISKQUOTA DISABLE | Suspends disk quota operations on a volume.
DISKQUOTA ENABLE | Resumes disk quota operations on a volume.
DISKQUOTA MODIFY | Changes an entry in the quota file or adjusts the default quota and overdraft values.
DISKQUOTA REBUILD | Reconstructs the disk usage counts for all entries.
DISKQUOTA REMOVE | Removes an entry from a disk quota file.
DISKQUOTA SHOW | Displays disk quotas and usage counts.
DO | Executes a DCL command or DCL command procedure.
EXIT | Terminates the SYSMAN session and returns control to the DCL command level.
HELP | Provides information about SYSMAN commands.
++ IO AUTOCONFIGURE | Automatically identifies and configures all hardware devices attached to a system.
++ IO CONNECT | Connects devices and loads device drivers.
++ IO FIND_WWID | Detects all previously undiscovered tapes and medium changers.
++ IO LOAD | Loads an I/O driver.
++ IO REBUILD | Rebuilds all device configuration tables.
++ IO REPLACE_WWID | Replaces one worldwide identifier (WWID) with another.
++ IO SCSI_PATH_VERIFY | Checks each SCSI and FC path in the system to determine whether the attached device has been changed; if it has, the SCSI or FC path in the IO database is disconnected.
++ IO SET EXCLUDE | Sets the permanent exclusion list to be used when configuring devices automatically.
++ IO SET PREFIX | Sets the prefix used to build the IOGEN Configuration Building Module (ICBM) names.
++ IO SHOW BUS | Lists the system's buses, node numbers, bus names, TR numbers, and base CSR addresses on the system.
++ IO SHOW DEVICE | Displays information about devices, their drivers, and their I/O databases.
++ IO SHOW EXCLUDE | Displays the permanent exclusion list used in the autoconfiguration of devices.
++ IO SHOW PREFIX | Displays the current prefix list used to produce the IOGEN Configuration Building Module (ICBM) names.
LICENSE LOAD | Activates a license that is registered in the LICENSE database.
LICENSE UNLOAD | Deactivates a license that is registered in the LICENSE database.
PARAMETERS DISABLE CHECKS | Inhibits range checks on system parameter values specified in subsequent PARAMETERS SET commands.
PARAMETERS ENABLE CHECKS | Ensures that range checks are in effect. Enables range checks after a PARAMETERS DISABLE CHECKS command.
PARAMETERS SET | Modifies the value of a system parameter in the work area.
PARAMETERS SHOW | Displays the values of system parameters in the work area, plus the default, minimum, and maximum values of the parameters and their units of measure.
PARAMETERS USE | Initializes the current work area with system parameter values and the name of the site-independent command procedure.
PARAMETERS WRITE | Writes the system parameter values and the name of the site-independent command procedure from the work area to a parameter file, the current system parameter file, or the active system in memory.
RESERVED_MEMORY ADD | On Alpha systems, adds an entry to the Reserved Memory Registry data file.
RESERVED_MEMORY FREE | On running Alpha systems, frees reserved memory.
RESERVED_MEMORY MODIFY | On Alpha systems, allows you to modify an existing entry in the Reserved Memory Registry data file.
RESERVED_MEMORY REMOVE | On Alpha systems, removes a reserved memory entry from the Reserved Memory Registry data file.
RESERVED_MEMORY SHOW | On Alpha systems, displays the memory reservations on the running system.
SET ENVIRONMENT | Establishes a management context for subsequent SYSMAN commands.
SET PROFILE | Modifies the default device and directory and the current privileges for the current management environment, and allows you to set DCL verification for future DO commands.
SET TIMEOUT | Establishes the amount of time that SYSMAN waits for a node to respond.
SHOW ENVIRONMENT | Displays the current command context.
SHOW KEY | Displays key definitions.
SHOW PROFILE | Displays the default device and directory and the current privileges.
SHOW TIMEOUT | Displays the current timeout period.
SHUTDOWN NODE | Shuts down one or more nodes simultaneously with a single command line.
SPAWN | Creates a subprocess of the current process, where the context of the subprocess is copied from the current process.
STARTUP ADD | Adds an executable file or command procedure to the startup database.
STARTUP DISABLE | Prevents a component of the startup database from executing on one or more nodes in the environment.
STARTUP ENABLE | Allows a component of the startup database to execute.
STARTUP MODIFY | Edits a record in the startup database describing how a startup component executes.
STARTUP REMOVE | Removes one or more components from the startup database.
STARTUP SET DATABASE | Determines the default database.
STARTUP SET OPTIONS | Displays startup status.
STARTUP SHOW | Displays the name of the current startup database or its contents.
SYS_LOADABLE ADD | Adds an executive loaded image to the set of images loaded at boot time.
SYS_LOADABLE REMOVE | Removes an executive loaded image from the set of images loaded at boot time.

++Alpha specific

## @ (Execute Procedure)

> Requests that SYSMAN read subsequent command input from the specific file or device.

### Format

> @ filespec

### Parameter

> #### filespec

> Specifies either the input device or the command procedure you want to execute. The default file type is .COM. You cannot use wildcard characters in the file specification.

### Description

> Use the execute procedure command to execute a command procedure containing SYSMAN commands. To execute the command procedure, invoke SYSMAN, place the at sign (@) command at the beginning of a command line, then specify the file name of the command procedure.

> The command procedure can contain any valid SYSMAN command.

### Examples

#1
    $ CREATE ENV.COM
    SET ENVIRONMENT
    SHOW PROFILE[Ctrl/Z]
    $ MCR SYSMAN
    SYSMAN> @ENV.COM

    %SYSMAN-I-DEFDIR, default directory on node -- SYS$SYSROOT:[SYSMGR]
    %SYSMAN-I-DEFPRIV, default process privileges on node --
            CMKRNL
            CMEXEC
            SYSNAM
            .
            .
            .
            GRPPRV
            READALL
            SECURITY
    SYSMAN>

> This example shows how to create a command procedure that sets the SYSMAN environment to the local node, and displays the current profile. These commands execute when you enter the @ENV.COM command.

#2
    $ CREATE TIME.COM
    SET ENVIRONMENT/CLUSTER
    CONFIGURATION SHOW TIME[Ctrl/Z]
    $ MCR SYSMAN
    SYSMAN> @TIME

    System time on node NODE23: 19-JUN-2000 13:32:19.45
    System time on node NODE24: 19-JUN-2000 13:32:27.79
    System time on node NODE25: 19-JUN-2000 13:32:58.66

> This example shows how to create and execute a command procedure that shows the current date and time for all the nodes in the cluster.

## ALF ADD

> Adds a new record to the automatic login facility (ALF) database. You can also create records for proxy accounts.

> Requires read (R) and write (W) access to the SYSALF database (SYS$SYSTEM:SYSALF.DAT by default).

### Format

> ALF ADD device user

### Parameters

> #### device

> Specifies the terminal name or port name that you want to assign to a user name. The parameter device must be a terminal name if you do not specify qualifiers on the command line, and can be either a logical name or an abbreviated device name. This parameter accepts a maximum of 63 characters, including devices for proxy accounts.

> #### user

> Specifies the user name of the account that you want to assign to a particular terminal or port.

### Qualifiers

> #### /TERMINAL (default)

> Checks whether the device name you specified is a terminal on the target system. The parameter device can be a logical name or an abbreviated device name, which SYSMAN translates to a full device name.

> #### /PORT

> Checks whether the device name you specified is a valid port. If the port name contains special characters, such as a slash (/), or if it contains lowercase letters that you want to preserve, you must enclose the port name within quotation marks (" ").

> Be aware that anything within quotation marks is written literally to the ALF database file. For example, if the actual port name contains uppercase letters as well as special characters, be sure to specify uppercase letters within the quotation marks. Otherwise, a mismatch will occur between the actual port name and what is specified in the SYSALF.DAT file.

> #### /PROXY

> Checks that the device name is in the NODE::USERNAME format.

> #### /LOG

> Displays the device names and user names as they are added to the ALF database.

### Description

> You can use the ALF ADD command to associate a terminal or port with a particular user name. This will enable certain users to log in to certain terminals or ports without specifying a user name.

> The ALF ADD command adds a new record to the ALF database.

### Examples

#1
    SYSMAN> ALF ADD TTA3 JBERGERON
    SYSMAN> ALF ADD "MN34C3/LC-1-2" FMARTIN /PORT

> In this example, the first command assigns terminal TTA3 to user JBERGERON. The second command assigns port MN34C3/LC-1-2 to user FMARTIN.

#2
    SYSMAN> ALF ADD VMS:.ZKO.VMSORG.SYSMAN.CLIENT1::SYSTEM FOOBAR

> In this example, VMS:.ZKO.VMSORG.SYSMAN.CLIENT1::SYSTEM is the value for the device parameter, which is assigned to FOOBAR.

Previous | Next | Contents | Index

| privacy and legal statement |
6048PRO_064.HTML