Previous Topic: ExampleNext Topic: Example


renewJob—Renew Job

This command renews a failed job of the specified job container. The job options for the renewed job are modified according to the parameters and their coded values. The options belonging to parameters that are not coded remain unchanged.

This action has the following format:

jobcontainer action=renewJob 
name=job_container_name
jobName=job_name
[newName=new_container_name] 
[newJobName=new_job_name]
[deliveryTime="YYYY-MM-DD hh:mm"] 
[atTime="YYYY-MM-DD hh:mm"]
[after={exacttime|boottime}] 
[calendarname=delivery_calendar]
[preaction={none|reboot|logoff}]
[postaction={none|reboot|logoff|rebootAtEnd|logoffAtEnd|shutdownAtEnd}]
[promptUser[={y|n}]] 
[allowCancel[={y|n}]] 
[execTimedOut[={y|n}]] 
[prompt=days.hours] 
[offline[={y|n}]] 
[runAtShutdown[={y|n}]] 
[preventLogon[={y|n}]] 
[globalTime[={y|n}]] 
[nocalendar[={y|n}]]
[resolveQuery[={y|n}]] 
[parameters=user_parameters]
[jobTimeout=d.h]
[userJobMessage]
[userMessage]
after

Start time of the procedure at the target system.

The following values are valid:

exacttime

The procedure is started immediately after reaching atTime.

boottime

The start of the procedure is delayed until the first boot after atTime has been passed.

allowCancel

If "allowCancel" or "allowCancel=y" is coded, the user will be granted to cancel the job's execution.
If "allowCancel=n" is coded, the user will not be granted.

This parameter should only be coded, if "promptUser" is already enabled or will be enabled with this call, otherwise this setting will be ignored. No warning is given.

atTime

Specifies the Specifies the date and time when the action will be started.

The date has the ISO format "YYYY-MM-DD hh:mm".

If the parameter is not coded, the actual date and time are used.

calendarname

Specifies the name of the calendar that controls the time when the evaluation can take place.

deliveryname

Specifies the start time of delivery from the domain manager.
The date has the ISO format "YYYY-MM-DD hh:mm".

If the parameter is not coded, the actual date and time are used.

execTimedOut

If "execTimedOut " or "execTimedOut=y" is coded, the job's execution will be automatically started when the user prompt times out.
If "execTimedOut=n", the job will not automatically be started.

This parameter should only be coded, if "promptUser" is already enabled or will be enabled with this call, otherwise this setting will be ignored. No warning is given.

globalTime

If "globalTime" or "globalTime=y" is coded, then the time specifications are based on the enterprise manager time.

If "globalTime=n" is coded, it is based on domain manager time.

jobName

Specifies the name of the job to be renewed.

jobTimeout

Specifies the jobTimeout expiration period of a job in the form “d.h” where d specifies the number of days and h the number of hours. The range of the parameter is configurable at the manager’s site. When the specified value exceeds the configured upper limit then the value is set to the upper limit, if the specified value goes below the lower limit then the lower limit is taken. No warning is given in any case.
jobTimeout should not be coded with the timeout parameter otherwise an error is reported. If none of the parameters is coded the default is given by 7.0.

name

Specifies the name of the job container of which a failed job is renewed.

newJobName

Specifies the new job name. If not coded the job name of the job to be renewed is used.

newName

Specifies the new name of the job container that will contain the renewed job. If this parameter is not coded a default container name of the form

<job name> [<timestamp>] 

is generated.

noCalendar

If "noCalendar" is coded, a possible calendar at the target computer will be ignored for this job's execution.

offline

If "offline" or "offline=y" is coded, the connection between the target computer and the server will be released for the job's execution and reestablished thereafter.
If "offline=n" the connection will not be released.

parameters

Specifies the user parameters for the procedure.
Multiple user parameters must be separated by spaces inside double quotes.
If an empty string is coded, then no parameters are assumed.

postaction

Specifies the necessary actions that must take place after completion of the specified procedure. The following values are valid:

none

Performs no post-action.

reboot

Restarts the system after completion of the procedure.

logoff

Logs off the user after completion of the procedure.

rebootAtEnd

Restarts the system after completion of all the jobs of this container.

logoffAtEnd

Logs off the user after completion of all the jobs of this container.

shutdownAtEnd

Shuts down the target computer after completion of the jobs.

If the parameter is not coded, the default is given by the related procedure's job option value.

preaction

Specifies that necessary actions must take place before the specified procedure starts. The following values are valid:

none

Performs no pre-action.

reboot

Restarts the system before the start of the procedure.

logoff

Logs off the user before the start of the procedure.

If the parameter is not coded, the default is given by the related procedure's job option value.

preventLogon

If "preventLogon" or "preventLogon=y" is coded, then the user logon will be rejected during the job's runtime. If a user is already logged on, the execution of the job is delayed until the user logs off.
If "preventLogon=n" the user logon will not be rejected.

prompt=d.h

Specifies the time period in which the user will be prompted for the job's start.

The period’s format is "d.h" where d means days and h means hours.

The range of this parameter is from three hours to seven days (from 0.3 to 7.0). If the specified value falls below the valid minimum, the value is replaced by the minimum. If the specified value exceeds the valid maximum, then the value is replaced by the maximum. No warning is given.

This parameter should only be coded, if "promptUser" is already enabled or will be enabled with this call, otherwise this setting will be ignored. No warning is given.

promptUser

If "promptUser" or "promptUser=y" is coded, the user will be prompted for the job's execution.

If "promptUser=n", the user will not be prompted.

If the parameter is not coded, the default is given by the related procedure's job option value.

resolveQuery

Evaluate a possibly related query group before the job is generated.

runAtShutdown

If "runAtShutdown" or "runAtShutdown=y" is coded, the job's execution will start at shutdown only.
If "runAtShutdown=n", the job will start at any other time too.
If the parameter is not coded, the default is given by the related procedure's job option value.
This parameter is for Unix targets only.

userJobMessage

Specifies the custom administrator message for a renewed job in a job container.

userMessage

Specifies the custom administrator message for a job container.

Note: Only jobs of a job container of type "noLinkage" can be renewed as single jobs. For any other type of job container only renewal of the container is possible.