Control services

The following commands can be sent to the server by the role “OPERATOR”, except for “shutdown” which requires the role “ADMIN”:

Command

Description

Start a job (limited to jobs in the status “Waiting” and “Pause”)

start

Removes the stop flag

Sets the status to “Waiting”

Sets the start time to “Immediately”

start  <name>

Limited to jobs with spool name <name>, otherwise same as “start” (see above)

start  <name> <gen>

Limited to jobs with spool name <name> and generation <gen>, otherwise same as “start” (see above)

Starts the job even when restricted in Aktion.ini by min/max time

Pause a job (limited to jobs in the status “Waiting” and “Running” or “Disabled”)

pause

Sets the stop flag for active jobs

Sets status to “Pause” for the jobs in status “Waiting”

A job with the status “Disabled” is also set to “Pause” by the command “Enable” (supported since coldscheduler assembly 9.11.1.1).

pause <name>

Limited to jobs with spool name <name>, otherwise same as “pause” (see above)

pause <name> <gen>

Limited to jobs with spool name <name> and generation <gen>, otherwise same as “pause” (see above)

Reset a job (limited to jobs in the status “Error”)

reset

Removes the stop flag

Sets the attempts to “1”

Sets the status to “Waiting”

Sets the start time to “Immediately”

reset  <name>

Limited to jobs with spool name <name>, otherwise same as “reset” (see above)

reset  <name> <gen>

Limited to jobs with spool name <name> and generation <gen>, otherwise same as “reset” (see above)

Add a new job

add <name> <state>

Adds a new job called <name>

The state <state> must exist in Aktion.ini.

Sets the status “Pause”

Sets the attempts to “1”

Sets the start time to “Immediately”

add <name> <state> <DateTime or Time>

Sets the start time as scheduled

Schedule a job run

schedule <DateTime or Time>

Schedules job's start time

Sets the status to “Waiting”

schedule <name> <DateTime or Time>

Limited to jobs with spool name <name>, otherwise same as “schedule” (see above)

schedule <name> <gen> <DateTime or Time>

Limited to jobs with spool name <name> and generation <gen>, otherwise same as “schedule” (see above)

Next (manually advance a job to the next step, i.e. simulate a successful execution)

next  <name> <gen>

Operates on the job with spool name <name> and Generation <gen>

Only works with jobs with a status of: “Error”, “Waiting”, or “Pause”

The job is advanced to the next step in Aktion.ini (if it exists).

If the last step has been reached, the job is set to status “OK”.

Jobs with status “Pause” keep their status “Pause”.

Jobs with status “Waiting” or “Error” switch to status “Waiting” with a start time in 5 minutes.

Sets the attempts to ”1”

If there is a “new” command in Aktion.ini, a new generation will be created.

Last (manually set a job one step back)

last <name> <gen>

Operates on the job with spool name <name> and Generation <gen>

Only works with jobs with a status of “Error”, “Waiting”, or “Pause”

The job is set one step back in Aktion.ini.

Jobs with status “Pause” keep their status.

Jobs with status “Waiting” or “Error” switch to status “Waiting” with a start time in 5 minutes.

Sets the attempts to “1”

The job must have exactly one preceding step in Aktion.ini.

The preceding step must not create a new generation (command “new” in Aktion.ini).

Disable (supported since coldscheduler assembly 9.11.1.1)

disable

Disables the spool

Sets the status to “Disabled”

disable <name>

Limited to jobs with spool name <name>, otherwise same as “disable ” (see above)

disable <name> <gen>

Limited to jobs with spool name <name> and generation <gen>, otherwise same as “disable ” (see above)

Enable (supported since coldscheduler assembly 9.11.1.1)

enable

Enables the spool

Sets the status to “Pause”

Sets the start time to “Immediately”

enable <name>

Limited to jobs with spool name <name>, otherwise same as “enable” (see above)

enable <name> <gen>

Limited to jobs with spool name <name> and generation <gen>, otherwise same as “enable” (see above)

Comment

comment <"comment">

Adds comment to all jobs

comment <name> <"comment">

Limited to jobs with spool name <name>, otherwise same as “comment” (see above)

comment <name> <gen> <"comment">

Limited to jobs with spool name <name> and generation <gen>, otherwise same as “comment ” (see above)

comment

Removes comment for all jobs

comment <name>

Limited to jobs with spool name <name>, otherwise same as “comment” with no <"comment"> parameter (see above)

comment <name> <gen>

Limited to jobs with spool name <name> and generation <gen>, otherwise same as “comment” with no <"comment"> parameter (see above)

Shutdown (requires role “ADMIN”)

shutdown

Starts the shutdown of the server

No new jobs are started.

The system waits for executing jobs to complete.

The Monitor is stopped and the shutdown is complete when there is no more connection to the server.

shutdown force

Like shutdown but running jobs are terminated immediately

Reload actions (reload Aktion.ini)

reload actions

Reloads the initialization file “Aktion.ini” to enforce changes when this file was edited

Table 87: Command Line Monitor – commands for role “Operator”