Document revision date: 30 March 2001

## OpenVMS System Management Utilities Reference Manual

Previous | Contents | Index

## SET TIMEOUT

> Establishes the amount of time SYSMAN waits for a node to respond. Once the time limit expires, SYSMAN proceeds to execute the command on the next node in the environment.

### Format

> SET TIMEOUT time

### Parameter

> #### time

> Specifies a delta time value, which has the following format:

> `hh:mm:ss[.cc.]`

> This is the amount of time that SYSMAN waits for a node to respond. SYSMAN waits indefinitely---by default it has no timeout period. Refer to the OpenVMS User's Manual for a description of delta time values.

### Qualifiers

> None.

### Example

    SYSMAN> SET TIMEOUT 00:00:30
    %SYSMAN-I-TIMEVAL, timeout value is 00:00:30
    SYSMAN> CONFIGURATION SHOW TIME
    System time on node NODE21: 19-JUN-2000  14:22:33
    %SYSMAN-I-NODERR, error returned from node NODE22
    %SMI-E-TIMEOUT, remote operation has timed out
    System time on node NODE23: 19-JUN-2000  14:23:15

> This command establishes a timeout period of 30 seconds. Because NODE22 did not respond within 30 seconds, SYSMAN displays an error message and proceeds to execute the command on the next node in the environment.

## SHOW ENVIRONMENT

> Displays the target nodes or cluster where SYSMAN is executing commands.

### Format

> SHOW ENVIRONMENT

### Parameters

> None.

### Qualifiers

> None.

### Description

> The SHOW ENVIRONMENT command displays the current management environment. It can be the local cluster, local or remote nodes, or a nonlocal cluster. SYSMAN indicates if the environment is limited to individual nodes or if it is clusterwide. It also shows the current user name.

> The environment exists until you exit from SYSMAN or enter another SET ENVIRONMENT command.

### Examples

#1
    SYSMAN> SHOW ENVIRONMENT
    %SYSMAN-I-ENV, Current command environment:
            Clusterwide on local cluster
            Username ALEXIS   will be used on nonlocal nodes

> This command shows the current environment is the local cluster. User name ALEXIS will be used on other nodes in the cluster.

#2
    SYSMAN> SHOW ENVIRONMENT
    %SYSMAN-I-ENV, Current command environment:
            Clusterwide on remote cluster NODE21
            Username ALEXIS   will be used on nonlocal nodes

> This command shows that the command environment is a nonlocal cluster where NODE21 is a member.

#3
    SYSMAN> SHOW ENVIRONMENT
    %SYSMAN-I-ENV, Current command environment:
            Individual nodes: NODE22,NODE23
            At least one node is not in local cluster
            Username ALEXIS   will be used on nonlocal nodes

> This command shows that the command environment consists of two nodes.

## SHOW KEY

> Displays key definitions created with the DEFINE/KEY command.

### Format

> SHOW KEY [key-name]

### Parameter

> #### key-name

> Specifies the name of the key whose definition you want displayed. See the DEFINE/KEY command for a list of valid key names.

### Qualifiers

> #### /ALL

> Displays all the key definitions in the specified state or states. Specifying a key name is not necessary.

> #### /BRIEF

> Displays only the key definition. By default, the system displays all the qualifiers associated with the key definition, including any specified state, unless you use the /BRIEF qualifier.

> #### /DIRECTORY

> Displays the names of all the states for which you have defined keys. If you have not defined keys, the SHOW KEY/DIRECTORY command displays the DEFAULT and GOLD states (which is the default SYSMAN keypad).

> #### /STATE=(state, state...)

> Specifies the name of a state for which the specified key definitions are to be displayed. If you select more than one state name, separate them with commas and enclose the list in parentheses.

### Description

> Specifies the name of the key whose definition you want displayed. See the DEFINE/KEY command for a list of valid key names.

### Example

    SYSMAN> SHOW KEY/ALL
    DEFAULT keypad definitions:
      KP0 = "SHOW ENVIRONMENT" (echo)
      KP1 = "SHOW PROFILE" (echo)
    SYSMAN>

> This command displays all the key definitions currently in effect.

## SHOW PROFILE

> Displays the privileges and the default device and directory being used in the current environment.

### Format

> SHOW PROFILE

### Parameters

> None.

### Qualifiers

> #### /DEFAULT

> Displays the default disk device and directory name that the system uses in this environment to locate and catalog files.

> #### /PRIVILEGES

> Displays only the privileges in effect for the current environment.

### Description

> The SHOW PROFILE command displays the privileges and the default device and directory that is being used in the current environment. You can modify these attributes with the SET PROFILE command.

> These values remain in effect until you change environments or enter another SET PROFILE command.

### Example

    SYSMAN> SHOW PROFILE
    %SYSMAN-I-DEFDIR, Default directory on node NODE21  -- WORK1:[BERGERON]
    %SYSMAN-I-DEFPRIV, Process privileges on node NODE21 --
            TMPMGX
            OPER
            NETMBX
            SYSPRV

> This command shows the default device and directory as well as current privileges.

## SHOW TIMEOUT

> Displays the amount of time SYSMAN waits for a node to respond. By default, there is no timeout period.

### Format

> SHOW TIMEOUT

### Parameter

> None.

### Qualifiers

> None.

### Example

    SYSMAN> SHOW TIMEOUT
    %SYSMAN-I-TIMEVAL, timeout value is 00:00:04.00

> This command displays the current timeout value, which is 4 seconds.

## SHUTDOWN NODE

> Shuts down one or more nodes in an OpenVMS Cluster.

> The SHUTDOWN NODE command invokes SYS$SYSTEM:SHUTDOWN to shut down one node or multiple nodes, as you specify, in the current management environment. You can enter the shutdown command in one command line, instead of executing the SHUTDOWN.COM procedure on each node individually.

> Requires SETPRV privilege or all of the following privileges: CMKRNL, EXQUOTA, LOG_IO, OPER, SYSNAM, SYSPRV, TMPMBX, WORLD.

### Format

> SHUTDOWN NODE

### Parameters

> None.

### Qualifiers

> #### /AUTOMATIC_REBOOT

> #### /NOAUTOMATIC_REBOOT (default)

> Reboots the system automatically when the shutdown is complete.

> #### /CLUSTER_SHUTDOWN

> #### /NOCLUSTER_SHUTDOWN (default)

> Shuts down the entire cluster.

> When you use the /CLUSTER_SHUTDOWN qualifier, each node suspends activity just short of shutting down completely, until all other nodes in the cluster have reached the same point in the shutdown procedure.

> You must specify this option on every cluster node. If any one node is not shut down completely, the clusterwide shutdown cannot occur.

> You should use the SET ENVIRONMENT/CLUSTER command before you issue a SHUTDOWN NODE/CLUSTER_SHUTDOWN command to ensure that all nodes in the cluster are shutting down.

> #### /DISABLE_AUTOSTART

> Specifies the number of minutes before shutdown when autostart queues running on the node are marked stop pending and are subject to failover to another node.

> Using this qualifier gives you control over when the autostart failover process begins. By default, the value equals that of the /MINUTES_TO_SHUTDOWN qualifier.

> Determine the appropriate number of minutes for your configuration by weighing a smoother transition against completing a maximum number of jobs before shutdown. The larger the value, the smoother the transition will be. The smaller the value, the more jobs will execute on the node.

> #### /INVOKE_SYSHUTDOWN (default)

> #### /NOINVOKE_SYSHUTDOWN

> Invokes a site-specific shutdown procedure.

> #### /MINUTES_TO_SHUTDOWN=number

> The number of minutes until shutdown occurs. If the system logical name SHUTDOWN$MINIMUM_MINUTES is defined, its integer value is the minimum value that you can enter. Therefore, if the logical name is defined as 10, you must specify at least 10 minutes to final shutdown or an error message displays. If the logical name is not defined, and you do not enter a value, 0 minutes is the default.

> #### /POWER_OFF

> Specifies that the system is to power off after shutdown is complete.

> #### /REASON=text

> The reason for the shutdown (one line).

> #### /REBOOT_CHECK

> #### /NOREBOOT_CHECK (default)

> Checks for basic operating system files and notifies you if any are missing. Be sure to replace missing files before rebooting.

> #### /REBOOT_TIME=time

> The time when you expect to reboot the system such as IMMEDIATELY, IN 10 MINUTES, 2 P.M., or 14:00:00. Shutdown displays this time in a shutdown message to users.

> #### /REMOVE_NODE

> #### /NOREMOVE_NODE (default)

> Removes a node from the active cluster quorum. Use this qualifier when you do not expect the shut-down node to rejoin the cluster for an extended period.

> When you use the /REMOVE_NODE qualifier, active quorum in the remainder of the cluster is adjusted downward to reflect the fact that the removed node's votes no longer contribute to the quorum value. The shutdown procedure readjusts the quorum by issuing the SET CLUSTER/EXPECTED_VOTES command.

> You can reset options by using the following command:

>     SYSMAN> STARTUP SET OPTIONS/NOVERIFY/NOCHECKPOINTING

> For more information about cluster management, refer to OpenVMS Cluster Systems.

> #### /SAVE_FEEDBACK

> #### /NOSAVE_FEEDBACK (default)

> Records feedback data collected from the system since it was last booted and creates a new version of the AUTOGEN feedback data file, which you can use the next time you run AUTOGEN.

> #### /SPIN_DOWN_DISKS

> #### /NOSPIN_DOWN_DISKS (default)

> Spins down disks. You cannot spin down the system disk.

### Description

> Because SYSMAN enables you to define the target environment, you can perform a shutdown on your local node, your own cluster, or a subset of nodes on your cluster. If you are shutting down a local node, SYSMAN does not require you to remain logged in to the system during the shutdown, as long as you set the environment to the local node. See the SHUTDOWN NODE command examples and the SET ENVIRONMENT command for more information.

> In shutting down the system, the shutdown procedure:

> 1. At decreasing time intervals, broadcasts a message to users to log out.
> 2. Defines the system logical SHUTDOWN$TIME to reflect the value entered with the /MINUTES_TO_SHUTDOWN qualifier. For example, if you entered /MINUTES_TO_SHUTDOWN=10 at 12:00, the shutdown time would be 12:10.
>    To see if a shutdown is in progress or determine the actual time for shutdown, use the command SHOW LOGICAL SHUTDOWN$TIME.
> 3. At six minutes or less before shutdown, disables all nonoperator logins. If DECnet is running, it is shut down.
> 4. At one minute before shutdown, stops batch and device queues and the system job queue manager.
> 5. At zero minutes before shutdown, invokes the site-specific command procedure SYS$MANAGER:SHUTDWN.COM.
> 6. Stops all user processes; however, system processes continue. Ancillary control processes (ACPs) may delete themselves when their mounted volumes are finally dismounted.
> 7. Stops the secondary processor on dual-processor systems.
> 8. Removes all installed images.
> 9. Dismounts volumes and spins down disks, if you requested it. Does not spin down the system disk and the quorum disk, if a quorum disk is present.
> 10. Closes the operator's log file.
> 11. Invokes SYS$SYSTEM:OPCRASH to shut down the system.
> 12. Displays the following message if you did not request an automatic reboot:

>         SYSTEM SHUTDOWN COMPLETE - USE CONSOLE TO HALT SYSTEM

>     If you requested an automatic reboot, the system reboots, provided the necessary controls are set.

### Examples

#1
    SYSMAN> SET ENVIRONMENT/CLUSTER
    SYSMAN> SHUTDOWN NODE/MINUTES_TO_SHUTDOWN=15/REBOOT_TIME="later"-
    _SYSMAN>  /REASON="SOFTWARE UPGRADE"/REBOOT_CHECK/CLUSTER_SHUTDOWN

> The first command in this example ensures that all nodes in the cluster will shut down. The second command requests a shutdown for the entire cluster and a reboot check for any missing operating system files. The following messages are displayed to users on the cluster:

>     SHUTDOWN message on NODE21, from user SYSTEM at NODE21$0PA0: 12:00:00:20
>     NODE21 will shut down in 15 minutes; back up later. Please log off NODE21.
>     SOFTWARE UPGRADE

>     SHUTDOWN message on NODE22, from user SYSTEM at NODE22$0PA0: 12:00:00:22
>     NODE22 will shut down in 15 minutes; back up later. Please log off NODE22.
>     SOFTWARE UPGRADE

>     SHUTDOWN message on NODE23, from user SYSTEM at NODE23$0PA0: 12:00:00:24
>     NODE23 will shut down in 15 minutes; back up later. Please log off NODE23.
>     SOFTWARE UPGRADE

#2
    SYSMAN> SET ENVIRONMENT/NODE=0
    Password:
    SYSMAN> SHUTDOWN NODE/MINUTES=120
    %SYSMAN-I-SHUTDOWN, SHUTDOWN request sent to node
    SYSMAN> EXIT
    $ LOGOUT

> This example shuts down the local node in 2 hours. As long as you set the environment to the local node, a subprocess of the SMISERVER system detached process runs shutdown, and remaining logged into the system during the shutdown is not necessary. If you do not set the environment to the local node, the shutdown runs via a subprocess of the current process, requiring that you remain logged in during the shutdown cycle.

## SPAWN

> Creates a subprocess of the current process. The context of the subprocess is copied from the current process. You can use the SPAWN command to leave SYSMAN temporarily, perform other tasks (such as displaying a directory listing or printing a file), and return to SYSMAN.

> Note that SPAWN performs actions on the local node only. If you want to execute DCL commands or command procedures throughout your environment, use the DO command.

> Requires TMPMBX or PRMMBX user privilege. The SPAWN command does not manage terminal characteristics. You cannot use the SPAWN and ATTACH commands if your terminal has an associated mailbox.

### Format

> SPAWN [command-string]

### Parameter

> #### command-string

> Specifies a command string of fewer than 132 characters that you want executed in the context of the created subprocess. When the command completes execution, the subprocess terminates and control returns to the parent process. If you specify both a command string and the /INPUT qualifier, the command string executes before additional commands are obtained from the /INPUT qualifier.

### Qualifiers

> #### /INPUT=filespec

> Specifies an input file containing one or more DCL command strings that you want executed by the spawned subprocess. If you specify a command string along with an input file, the command string gets processed before the commands in the input file. When processing is complete, the subprocess terminates.

> #### /LOGICAL_NAMES (default)

> #### /NOLOGICAL_NAMES

> Specifies that the logical names of the parent process are copied to the subprocess. When you do not want the subprocess to use the logical names of the parent process, enter the /NOLOGICAL_NAMES qualifier.

> #### /OUTPUT=filespec

> Identifies the output file to which the results of the operation are written. Specify an output other than SYS$OUTPUT whenever you use the /NOWAIT qualifier. This prevents output from being displayed while you are specifying new commands. If you omit the /OUTPUT qualifier, output gets written to the current SYS$OUTPUT device.

> #### /PROCESS=subprocess-name

> Specifies the name of the subprocess that you want to create. The default subprocess name is in the format USERNAME_n.

> #### /SYMBOLS (default)

> #### /NOSYMBOLS

> Determines whether the system passes DCL global and local symbols to the subprocess.

> #### /WAIT (default)

> #### /NOWAIT

> Controls whether the system waits until the subprocess completes before you can specify more commands. The /NOWAIT qualifier enables you to specify new commands while the specified subprocess is running. If you specify the /NOWAIT qualifier, use the /OUTPUT qualifier to direct the output to a file instead of displaying it on the screen. Doing this prevents your terminal from being used by more than one process simultaneously.

### Description

> The SPAWN command creates a subprocess of your current process with the following attributes copied from the parent process:
> - All symbols except $RESTART, $SEVERITY, and $STATUS
> - Key definitions
> - The current keypad state
> - The current prompt string
> - All process logical names and logical name tables except those explicitly marked CONFINE or those created in executive or kernel mode
> - Default disk and directory
> - Current SET MESSAGE settings
> - Current process privileges
> - Control and verification states

> Note that some attributes, such as the process's current command tables, are not copied.

> When the subprocess is created, the process-permanent open files and any image or procedure context are not copied from the parent process. The subprocess is set to command level 0 (DCL level with the current prompt).

> If you do not specify the /PROCESS qualifier, the name of this subprocess is composed of the same base name as the parent process and a unique number. For example, if the parent process name is SMITH, the subprocess name can be SMITH_1, SMITH_2, and so on.

> The LOGIN.COM file of the parent process is not executed for the subprocess because the context is copied separately, allowing quicker initialization of the subprocess. When the /WAIT qualifier is in effect, the parent process remains in hibernation until the subprocess terminates or returns control to the parent by way of the ATTACH command.

> More than one process simultaneously attempts to use the same input or output stream when several processes share that stream and you perform one of the following actions:

> - Terminate a subprocess to which you are not currently attached.
> - Terminate a process that is not spawned from the process to which you are currently attached.

> Use the LOGOUT command to terminate the subprocess and return to the parent process. You can also use the ATTACH command (see ATTACH) to transfer control of the terminal to another process in the subprocess tree, including the parent process. (The SHOW PROCESS/SUBPROCESSES command displays the processes in the subprocess tree and points to the current process.)

> Note Because a tree of subprocesses can be established using the SPAWN command, you must be careful when terminating any process in the tree. When a process is terminated, all subprocesses below that point in the tree are automatically terminated.

> Qualifiers used with the SPAWN command must directly follow the command verb. The command string parameter begins after the last qualifier and continues to the end of the command line.

### Examples

#1
    SYSMAN> SPAWN DIR SYS$MANAGER:SITE*.*

    Directory CLU$COMMON:[SYSMGR]

    SITE$STARTUP.COM;5

    Total of 1 file.

    SYSMAN>

> This command enables you to enter the DIRECTORY command in DCL to see if a site-specific startup file is in the directory. After the DIRECTORY command executes, control returns to the parent process.

#2
    SYSMAN> SPAWN
    $ EDIT SITE$STARTUP.COM
       .
       .
       .
    $ LOGOUT
    Process SYSTEM_1 logged out at 28-JUN-2000 10:05:17.24
    SYSMAN>

> This example shows how you can use the SPAWN command to leave SYSMAN and edit a file. The LOGOUT command returns you to SYSMAN.

#3

    SYSMAN> SPAWN /NOLOGICAL_NAMES SET HOST
    _Node: NODE21
       .
       .
       .
    $ LOGOUT
    %REM-S-END, control returned to node _NODE22::

    SPAWN>

> This example shows how you can use the SPAWN command to create a subprocess in which you can use the SET HOST command. When you want to leave NODE21, enter the LOGOUT command. The /NOLOGICAL_NAMES qualifier prevents the logical names of the parent process from being copied to the subprocess.

Previous | Next | Contents | Index

| privacy and legal statement |
6048PRO_072.HTML