The STOP/QUEUE command causes the specified execution queue to
pause. All jobs currently executing in the queue are suspended
(until the queue is restarted with the START/QUEUE command), and
no new jobs are initiated. The /QUEUE qualifier is required.
Requires manage (M) access to the queue.
The STOP/QUEUE command performs different functions when used
with certain qualifiers as follows:
STOP Qualifier(s) Function
/QUEUE/ABORT Aborts a job that is printing or
processing on an output queue, deletes
it from the queue, and begins processing
the first pending job in the queue.
/QUEUE/ENTRY Aborts one or more jobs that are executing
on a batch queue or printing on an output
queue, deletes them from the queue, and
begins processing the first pending job in
the queue.
/QUEUE/MANAGER/CLUSTER Stops the queue manager throughout the
OpenVMS Cluster.
/QUEUE/NEXT Stops the specified queue after all
executing jobs have completed processing.
/QUEUE/REQUEUE Stops the current jobs on the specified
queue and requeues them for later
processing.
/QUEUE/RESET Abruptly stops the queue and returns
control to the system.
/QUEUES/ON_NODE Stops all queues on the specified node.
Format
STOP/QUEUE queue-name[:]
1 – Parameter
queue-name[:]
Specifies the name of the queue that you want to pause.
2 – Examples
1.$ STOP/QUEUE LPA0
The STOP/QUEUE command in this example suspends the current
print job in the queue LPA0 and places that queue in the paused
state.
2.$ STOP/QUEUE JADE_PRINT
$ START/QUEUE/TOP_OF_FILE JADE_PRINT
The STOP/QUEUE command in this example suspends the job that
is currently printing on the printer queue JADE_PRINT and
places that queue in the paused state. The START/QUEUE command
releases the queue from the paused state. The /TOP_OF_FILE
qualifier causes the job that was suspended to resume printing
at the beginning of the file rather than at where it was
interrupted.
3 /ABORT
Aborts a job that is printing or processing on an output queue,
deletes it from the queue, and begins processing the first
pending job in the queue. The /QUEUE qualifier is optional, but
the /ABORT qualifier is required.
Requires delete (D) access to the current job.
Format
STOP/QUEUE/ABORT queue-name[:]
3.1 – Parameter
queue-name[:]
Specifies the name of the queue containing the job you want to
abort.
3.2 – Example
$ STOP/QUEUE/ABORT LPA0
This example aborts the current print job on the queue LPA0.
The print symbiont begins to process the first pending job in
the queue. Assuming there is no problem with the printer, the
current page of the file completes printing. If the printer
queue has been set up to put trailer pages at the end of jobs,
a trailer page is printed after the current page is completed.
For batch queues an entry number must be provided. To abort a
batch job, use the STOP/QUEUE/ENTRY command.
4 /ENTRY
Aborts one or more jobs that are executing on a batch queue or
printing on an output queue, deletes them from the queue, and
begins processing the first pending job in the queue. The /QUEUE
qualifier is optional, but the /ENTRY qualifier is required.
Requires delete (D) access to the specified job.
Format
STOP/QUEUE/ENTRY=(entry-number[,...]) [queue-name[:]]
4.1 – Parameters
entry-number[,...]
Specifies the entry number (or a list of entry numbers) of jobs
to be deleted. If you specify only one entry number, you can
omit the parentheses. If you do not specify a queue name, you can
delete entries from multiple queues.
The system assigns a unique entry number to each queued print
or batch job in the system. By default, the PRINT and SUBMIT
commands display the entry number when they successfully queue
a job for processing. These commands also create or update the
local symbol $ENTRY to reflect the entry number of the most
recently queued job. To find a job's entry number, enter the
SHOW ENTRY or the SHOW QUEUE command.
queue-name[:]
Specifies the name of the queue that contains the jobs that you
want to abort. The queue name can refer either to the queue
to which the job was submitted or to the queue where the job
is executing. The queue-name parameter is optional syntax;
however, when you specify a queue name, the OpenVMS system uses
it to verify an entry in the specific queue before stopping and
deleting the entry.
4.2 – Example
$ STOP/QUEUE/ENTRY=365 SYS$BATCH
The STOP/QUEUE/ENTRY command in this example aborts batch
job number 365 currently executing on the SYS$BATCH queue and
begins the first pending job in the queue.
5 /MANAGER
5.1 /CLUSTER
Shuts down the queue manager on a standalone node or an OpenVMS
Cluster. The /QUEUE qualifier is optional, but the /MANAGER
and /CLUSTER qualifiers are required on both standalone and
clustered systems. By default, the command affects the default
queue manager, SYS$QUEUE_MANAGER. Specify the /NAME_OF_MANAGER
qualifier to shut down a queue manager other than the default.
Requires OPER (operator) and SYSNAM (system logical name)
privileges.
The STOP/QUEUE/MANAGER/CLUSTER command notifies the queue manager
to perform the following on the standalone node or on all nodes
in the cluster:
o Aborts all current jobs that cannot be restarted, and requeues
all current restartable jobs.
o Stops all execution queues.
o Disables autostart on all nodes.
o Closes all queue database files.
Once the STOP/QUEUE/MANAGER/CLUSTER command is entered, the queue
manager process remains stopped, and requests to the queuing
system are denied until the DCL command START/QUEUE/MANAGER is
entered.
Format
STOP/QUEUE/MANAGER/CLUSTER
5.1.1 – Qualifier
5.1.1.1 /NAME_OF_MANAGER
/NAME_OF_MANAGER=name
Specifies the name of the queue manager process to be stopped.
If the /NAME_OF_MANAGER qualifier is omitted, the default queue
manager name SYS$QUEUE_MANAGER is used. For more information,
see the chapter about the queue manager in the VSI OpenVMS System
Manager's Manual.
5.1.2 – Example
$ STOP/QUEUE/MANAGER/CLUSTER
The STOP/QUEUE/MANAGER/CLUSTER command in this example stops
the queue manager process, SYS$QUEUE_MANAGER. The process
remains stopped and requests to SYS$QUEUE_MANAGER will be
denied until the START/QUEUE/MANAGER command is entered.
This command stops the default queue manager SYS$QUEUE_MANAGER
because the /NAME_OF_MANAGER qualifier is not specified.
6 /NEXT
Stops the specified queue after all executing jobs have completed
processing. No new jobs are initiated. For autostart queues, also
marks the queue as inactive for autostart.
The /QUEUE qualifier is optional, but you must specify the /NEXT
qualifier.
Requires manage (M) access to the queue.
Format
STOP/QUEUE/NEXT queue-name[:]
6.1 – Parameter
queue-name[:]
Specifies the name of the queue that you want to stop.
6.2 – Examples
1.$ STOP/QUEUE/NEXT LASER_PRINT
In this example, the STOP/QUEUE/NEXT command prepares to stop
the queue LASER_PRINT. The currently printing job is allowed
to complete, but no new job is allowed to initiate. Once the
current job has finished, the queue is stopped.
If LASER_PRINT is an autostart queue, it will not be
automatically started until you enter the START/QUEUE command.
2.$ STOP/QUEUE/NEXT BATCH_1
$ SHOW QUEUE/ALL BATCH_1
Batch queue BATCH_1, stopped, on JADE::
$ DELETE/QUEUE BATCH_1
This example shows how to delete the batch queue BATCH_
1. First, the STOP/QUEUE/NEXT command is entered, which
stops the queue after jobs currently executing on the
queue are completed. Second, the SHOW QUEUE/ALL command is
entered to ensure that no jobs are pending in the queue. The
screen display shows that no jobs are pending. Finally, the
DELETE/QUEUE command is entered to delete the queue BATCH_1.
7 /REQUEUE
Stops the current jobs on the specified queue and requeues them
for later processing. The queue does not stop; processing of
the first pending job in the queue begins. The /QUEUE qualifier
is optional, but the /REQUEUE qualifier is required. The /ENTRY
qualifier is required to requeue batch jobs.
Requires delete (D) access to the current or specified job.
Format
STOP/QUEUE/REQUEUE[=queue-name] queue-name[:]
STOP/QUEUE/REQUEUE[=queue-name] /ENTRY=(entry-number[,...])
queue-name[:]
7.1 – Parameters
queue-name[:]
Specifies the name of the queue that contains the jobs that you
want to stop. When you specify a queue name as a parameter for
the /REQUEUE qualifier, the jobs are requeued to that queue;
otherwise, the jobs are requeued in the current queue.
entry-number[,...]
Specifies the entry number (or a list of entry numbers) of the
jobs you want to requeue. If you specify only one entry number,
you can omit the parentheses.
The system assigns a unique entry number to each queued print
or batch job in the system. By default, the PRINT and SUBMIT
commands display the entry number when they successfully queue
a job for processing. These commands also create or update the
local symbol $ENTRY to reflect the entry number of the most
recently queued job. To find a job's entry number, enter the
SHOW ENTRY or SHOW QUEUE command.
7.2 – Qualifiers
7.2.1 /ENTRY
/ENTRY=(entry-number[,...])
Specifies the entry number of one or more jobs you want to
abort. If you specify only one entry number, you can omit the
parentheses.
The system assigns a unique entry number to each queued print
or batch job in the system. By default, the PRINT and SUBMIT
commands display the entry number when they successfully queue
a job for processing. These commands also create or update the
local symbol $ENTRY to reflect the entry number of the most
recently queued job. To find a job's entry number, enter the
SHOW ENTRY or the SHOW QUEUE command.
You must use the /ENTRY qualifier when you enter the
STOP/QUEUE/REQUEUE command for a batch queue. Entry numbers
specified must match entry numbers of executing jobs.
7.2.2 /HOLD
Places the aborted job or jobs in a hold state for later release
with the SET ENTRY/RELEASE or SET ENTRY/NOHOLD command.
7.2.3 /PRIORITY
/PRIORITY=n
Requires OPER (operator) or ALTPRI (alter privilege) privilege to
raise the priority value above the value of the system parameter
MAXQUEPRI.
Changes the priority of the requeued job or jobs. The parameter
n can be from 0 to 255; the default value of the n parameter is
the same as the priority value that the job or jobs had when they
were stopped.
Generally, the /PRIORITY qualifier is used to lower the priority
of a job or jobs, which ensures that the job or jobs runs when
the queue contains no other jobs. No privilege is needed to set
the priority lower than the MAXQUEPRI value.
7.2.4 /REQUEUE
/REQUEUE=[queue-name]
Specifies a queue where current jobs are to be requeued. If you
do not specify the queue-name parameter, the jobs are requeued in
the current queue.
7.3 – Examples
1.$ STOP/QUEUE/REQUEUE=LPB0 LPA0
In this example, the current print job on queue LPA0 is
stopped and requeued to queue LPB0. If the print symbiont
sent checkpoint information about the print job to the job
controller, printing resumes on LPB0 at the last checkpoint
recorded.
2.$ STOP/QUEUE/REQUEUE/HOLD LPA0
.
.
.
$ SET ENTRY 254/RELEASE
In this example, the current print job on LPA0 is suspended
and placed in the hold state. Later, when you enter the SET
ENTRY command with the /RELEASE qualifier, the job is released
from the hold state and is rescheduled to print on queue LPA0.
If the print symbiont sent checkpoint information about the
print job to the job controller, printing resumes at the last
checkpoint.
3.$ STOP/QUEUE/REQUEUE/ENTRY=758 SYS$BATCH
In this example, batch job number 758 is stopped and requeued
for later processing on SYS$BATCH. If the batch job has been
programmed with appropriate SET RESTART_VALUE commands, those
portions of the job that have completed successfully are not
rerun.
8 /RESET
Abruptly stops the queue and returns control to the system.
Any jobs that cannot be restarted are aborted immediately. For
autostart queues, also marks the queue as inactive for autostart.
The /QUEUE qualifier is optional, but you must specify the /RESET
qualifier.
Requires manage (M) access to the queue.
Format
STOP/QUEUE/RESET queue-name[:]
8.1 – Parameter
queue-name[:]
Specifies the name of the queue you want to reset.
8.2 – Examples
1.$ INITIALIZE/QUEUE/AUTOSTART_ON=MYNODE::LPAO/START LPA0
$ENABLE AUTOSTART/QUEUES/ON_NODE=MYNODE
.
.
.
$STOP/QUEUE/RESET LPA0
$START/QUEUE LPA0
THE INITIALIZE/QUEUE command in this example creates an
autostart output queue named LPA0. The /START qualifier
activates the queue for autostart, and the ENABLE
AUTOSTART/QUEUES command causes the queue to begin executing.
Suppose the printer LPA0:: runs out of paper. The
STOP/QUEUE/RESET command abruptly stops the queue LPA0. The
current print job stops immediately and is requeued. The
STOP/QUEUE/RESET command also makes the queue inactive for
autostart, so it will not be restarted while the printer's
paper is being resupplied.
After the printer is loaded with paper, the START/QUEUE command
makes the queue active for autostart and allows the queue
manager to automatically start it again.
2.$ STOP/QUEUE/RESET TEXBATCH
The STOP/QUEUE/RESET command in this example stops the batch
queue TEXBATCH. Any current jobs that were submitted with the
/RESTART qualifier are requeued for processing when the queue
is restarted. Users might want to resubmit current jobs that
were not originally submitted with the /RESTART qualifier.
9 /ON_NODE
Stops all queues on the specified node. This command is useful if
you want to stop a set of queues on a node with a single command
(for example, before shutting down a node), but do not want to
stop a queue manager throughout an OpenVMS Cluster.
The /QUEUES qualifier is optional, but the /ON_NODE qualifier is
required.
Requires OPER (operator) privilege.
Format
STOP/QUEUES/ON_NODE[=node]
9.1 – Description
The STOP/QUEUES/ON_NODE command notifies the queue manager to
perform the following tasks:
o Abort all current jobs that cannot be restarted (in all of
that queue manager's execution queues on the appropriate
node), and requeue all current restartable jobs.
o Stop all of that queue manager's execution queues on the
appropriate node. Force any of that queue manager's autostart
queues on the node to fail over to the next available node
in the queue's failover list (if any) on which autostart is
enabled.
o Prevent any of that queue manager's autostart queues from
failing over to the node.
By default, this command affects the node from which it is
entered. Specify a nodename with the /ON_NODE qualifier to stop
queues on a different node.
By default, the command affects autostart queues managed by the
default queue manager, SYS$QUEUE_MANAGER. Specify the /NAME_
OF_MANAGER qualifier to disable autostart of a different queue
manager's autostart queues (on the node).
The STOP/QUEUES/ON_NODE command affects all autostart and
nonautostart execution queues on the appropriate node that are
managed by the queue manager. Autostart queues stopped as a
result of this command remain active for autostart and will
be restarted when the ENABLE AUTOSTART command is entered for
the affected node or a node to which the queue can fail over.
Nonautostart queues stopped as a result of this command must each
be started with a START/QUEUE command specifying the queue name.
If you are using autostart queues, you might want to enter the
DISABLE AUTOSTART/QUEUES command. For more information on the
relationship between DISABLE AUTOSTART/QUEUES and STOP/QUEUES/ON_
NODE, see the section on stopping queues before shutting down
a system in the chapter about queues in the VSI OpenVMS System
Manager's Manual.
The STOP/QUEUES/ON_NODE command is included in the shutdown
command procedure SYS$SYSTEM:SHUTDOWN.COM. If you shut down a
node without using SHUTDOWN.COM, you might want to enter the
STOP/QUEUES/ON_NODE command first. For more information on
stopping queues before shutting down a node, see the chapter
about queues in the VSI OpenVMS System Manager's Manual.
9.2 – Qualifier
9.2.1 /NAME_OF_MANAGER
/NAME_OF_MANAGER=name
Specifies the name of the queue manager controlling the queues
you want to stop.
If the /NAME_OF_MANAGER qualifier is omitted, then the default
queue manager name SYS$QUEUE_MANAGER is used. For more
information on multiple queue managers, see the chapter about
the queue manager in the VSI OpenVMS System Manager's Manual.
9.3 – Examples
1.$ STOP/QUEUES/ON_NODE
The STOP/QUEUES/ON_NODE command in this example stops all
queues on the node from which it is entered. The autostart
feature is disabled on this node for all autostart queues.
However, the queue manager process continues to run and
schedules jobs as requested for execution on its unstopped
queues on other nodes in the OpenVMS Cluster.
This command only affects queues managed by the default
queue manager SYS$QUEUE_MANAGER because the /NAME_OF_MANAGER
qualifier is not specified.
2.$INITIALIZE/QUEUE-
_$/AUTOSTART_ON=(JADE::,RUBY::,OPAL::)/BATCH/START BATCH_1
$ENABLE AUTOSTART/QUEUES/ON_NODE=JADE
$ENABLE AUTOSTART/QUEUES/ON_NODE=RUBY
.
.
.
$ STOP/QUEUES/ON_NODE=JADE
$ SHOW QUEUE BATCH_1
Batch queue BATCH_1, idle, on RUBY::
The INITIALIZE/QUEUE command in this example creates the
autostart queue BATCH_1 capable of running on node JADE,
RUBY, or OPAL. The /START qualifier activates the queue for
autostart. The first ENABLE AUTOSTART/QUEUES command enables
autostart of all autostart queues on node JADE, causing the
queue BATCH_1 to begin processing on that node. The second
ENABLE AUTOSTART/QUEUES command enables autostart for all
autostart queues on node RUBY.
Later, suppose node JADE needs to be removed from the cluster.
The STOP/QUEUES/ON_NODE command in the example stops all queues
on node JADE without stopping the clusterwide queue manager,
and causes the autostart queue BATCH_1 to failover to node
RUBY, the next available node in its failover list. Because
the STOP QUEUES/ON_NODE command disables autostart, the ENABLE
AUTOSTART/QUEUES command must be executed on node JADE when it
reboots for autostart queues to run on that node in the future.
This command only affects queues managed by the default
queue manager SYS$QUEUE_MANAGER because the /NAME_OF_MANAGER
qualifier is not specified.