QSYSTEM

The QSYSTEM.EXE command allows the System Administrators to control the queue system settings.

Most of the functions of this command are, by default, available only to members of the Administrators or Domain Admin Group on the Argent Queue Engine server.

Syntax


QSYSTEM.EXE 

		/SHOW

		/START 

		/STOP 

		/PAUSE 

		/CONTINUE 

		/DEFAULT_QUEUE=QueueName

		/NO_DEFAULT_QUEUE 

		/LOG_SIZE_LIMIT=KBytes 

		/KEY=LicenseKey

		/NOSTART

		/MAX_EXEC_JOBS

		/MAX_JOB_PROCESSES

		/LICENSE

		/SERVER=ServerName

		/JOB_NUMBER_WRAPS_AFTER=Value

		/ARCHIVE_JOB_LOGS=Value

		/PORT=port_number

		/FORCE_ROLLOVER

		/RESET_ROLLOVER

		/DEBUG

		/NODEBUG

		/QUEUES_CLOSE

		/QUEUES_OPEN

		/QUEUES_STOP

		/QUEUES_START

Qualifiers

/SHOW
This displays information about the Argent Queue Engine service. This information includes the current state of the service, the filenames of the system log file and the system settings file. This is the default if no qualifiers are specified.

/START
This starts the Argent Queue Engine service. The service must be started in order for any other Argent Queue Engine commands to work. When the product is first installed, the Argent Queue Engine service is configured to start automatically at system startup, so it is not necessary to manually start it every time the server boots.

/STOP
This stops the Argent Queue Engine service. When the service is stopped, no other Argent Queue Engine commands will work. Stopping the Argent Queue Engine service is a dangerous operation, because all jobs that are executing when the service is stopped are terminated. If you need to halt the service for any reason, it is much safer to pause it using the /PAUSE qualifier.

/PAUSE
This pauses the Argent Queue Engine service. When the service is paused, all jobs that are executing will continue to execute, but no new jobs will be started. Also, if any user tries to use Argent Queue Engine commands, it will display a message saying that the Argent Queue Engine service is paused.

/CONTINUE
This continues, or “un-pauses”, the Argent Queue Engine service, allowing it to resume normal operation.

/LICENSE
This displays installation and license information about an Argent Queue Engine server.

/MAX_EXEC_JOBS
This sets the maximum executing jobs value for the Argent Queue Engine server. When this number of jobs are executing on the server in all queues combined, then no new jobs will be started. This value may be increased or decreased depending on the amount of memory and other system resources available to the server.

/MAX_JOB_PROCESSES
This sets the maximum number of processes among all executing jobs for the Argent Queue Engine server. When this number of processes exists among all executing jobs, then no new jobs will be started. This value may be increased or decreased depending on the amount of memory and other system resources available to the server. Note that the actual number of job processes on an Argent Queue Engine server may temporarily exceed this limit, because although no new jobs are started, jobs which are already executing may create more processes.

/DEFAULT_QUEUE
This sets the default queue for the product. The default queue is the queue that jobs are submitted to if no queue name is specified in the QSUBMIT command. Usually, you will want to set the default queue to a “middle of the road” queue, one with a moderate priority and executing jobs limit.

/NO_DEFAULT_QUEUE
This clears the default queue. When no default queue is set, a queue name must be specified in order to submit a job.

/LOG_SIZE_LIMIT
This changes the size limit of the Argent Queue Engine system log file. This value determines the maximum size, in kilobytes, that the system log file is allowed to reach. When the file reaches the size limit, the old one is renamed and a new one is started. By default, the Argent Queue Engine system log file size limit is set to 512K, or one-half megabyte.

/KEY
This installs a new product license key. This qualifier should only be used when you have received a license key from Argent Software, Inc.

/NOSTART
This when used with /KEY prevents the service from being started.

/SERVER
This specifies the name of an Argent Queue Engine server. If this qualifier is absent, then the command uses the value of the XS_SERVER environment variable, if defined. If this environment variable is also absent, then the command assumes the local server.

/JOB_NUMBER_WRAPS_AFTER
This sets the value after which the job number begins at 1 again. The default value is 100,000.

/ARCHIVE_JOB_LOGS
This set the number of hours that job logs are retained. The default value is 168. This causes job logs to be retained by the Argent Queue Engine for 7 days.

/PORT
This specifies the TCP port number for the Argent Queue Engine to listen on. The default port number is 3135.

NOTE: Changes made to the port number of the Argent Queue Engine will immediately cause the Argent Queue Engine service to restart.

/FORCE_ROLLOVER
This initiates a manual rollover on the Argent Queue Engine server.

This will cause any job template, handled by the Argent Queue Engine, to be resubmitted from the current time to the next rollover time.

/RESET_ROLLOVER
This causes the rollover time to be reset to midnight daily, 00:00.

/DEBUG
This raises the debug level of the Argent Queue Engine service log.

/NODEBUG
This lowers the debug level of the Argent Queue Engine service log.

/QUEUES_CLOSE
This closes all queues on the specified server. The Argent Queue Engine will accept no new jobs once the queues are closed

/QUEUES_OPEN
This opens all queues on the specified Argent Queue Engine server. This allows the Argent Queue Engine to accept new jobs

/QUEUES_STOP
This stops all queues on the specified server. Once stopped no new jobs will begin executing within the queues

/QUEUES_START
This starts all queues on the specified server. Jobs with the queues can begin executing once the queues are started.

Example A

QSYSTEM.EXE /SHOW

This example displays information about the queue system.

Example B

QSYSTEM.EXE /PAUSE

This example will cause the Argent Queue Engine service to pause. When the service is paused, queues will not start any pending jobs, and the Argent Queue Engine commands and the Argent Queue Engine client GUI functions will not work.

Example C

QSYSTEM.EXE /CONTINUE

This example continues the Argent Queue Engine service.

Example D

QSYSTEM.EXE /START /SERVER=ARIES

This example starts the Argent Queue Engine service on the Argent Queue Engine server named ARIES.

Example E

QSYSTEM.EXE /DEFAULT_QUEUE=HIGH_PRI

This example sets the default queue to HIGH_PRI.