Previous Topic: Job Management CommandsNext Topic: Procedures File Format


addJob—Add Job to Job Container

This command adds a job to an existing job container. You must not seal the job container.

This command has the following format:

jobcontainer action=addjob
name=job_container_name
{item=item_name version=item_version  
procedure=procedure_name
{[task=install] 
|task={configure|activate|uninstall}
[installedWith=install_procedure]}
| group=group_name [procedures=file]}
{{{compgrp=computer_group_name | ccompgrp=(computer_group_name sep groupScope)} 
[sep=separator_sign]
|{computer=computer_name}}
[deliverytime="YYYY-MM-DD hh:mm" ] 
[attime="YYYY-MM-DD hh:mm" ]
[{preaction={none|reboot|logoff}|bootbefore}]
[{postaction={none|reboot|logoff|rebootAtEnd|logoffAtEnd|shutdownAtEnd}|bootafter}]
[promptUser[={y|n}]] 
[allowCancel[={y|n}]] 
[execTimedOut[={y|n}]]
[offline[={y|n}]] 
[runAtShutdown[={y|n}]]
[preventLogon[={y|n}]] 
after={exacttime|boottime}
[calendarname=delivery_calendar]
[globalTime=y|n] 
[nocalendar[={y|n}]]
[resolveQuery[={y|n}]] 
[stagingServer[={y|n}]]
[parameters=user_parameters]
[prompt=days.hours]] 
[jobTimeOut=days.hours]
[reinstall[={y|n}]]
[userJobMessage]
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.

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

atTime

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.

ccompgrp

Specifies the computer group to be addressed as a pair of group name and scope. By default, name and scope are separated by a dot ("."), but an alternate separator can be specified with the "sep" option. The separator should not be used as part of the names.

For the group scope only the following values are valid.

local

The group is created at the local domain manager,

global

The group has been created at the enterprise manager and may be replicated.

The "ccompgrp" can be coded with the "compgrp" in one call.

compgrp

Specifies the name of a computer group on which the specified product will be processed.

The parameter can be coded more than once to address more than one computer group.

The parameter must not be coded together with the computer parameter.

computer

Specifies the name of the computer on which the specified product will be processed.

The parameter can be coded more than once to address more than one computer.

The parameter must not be coded together with the compgrp parameter.

deliveryTime

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.

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.

group

Specifies the name of a software or procedure group the jobs will be generated for.

The parameter must not be coded together with the item parameter.

installedWith

Specifies the name of the install procedure.

This parameter is mandatory for the tasks configure, activate, and uninstall. Otherwise it is ignored.

item

Specifies the name of the item to be processed.

This parameter must not be coded together with the group parameter.

jobTimeOut

Specifies the expiration date of the job in form of a period.

The period is specified in the format "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.

name

Specifies the name of the job container to which the job will be added.

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 space separated inside double quotes.

If an empty string is coded, then no parameters are assumed any longer.

postaction

Specifies that necessary actions must take place after the specified procedure has terminated. 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 jobs of this container.

logoffAtEnd

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

shutdownAtEnd

Shuts down the target computer after completion of the jobs.

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.

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.

procedure

Specifies the name of a procedure

procedures

Specifies the name of the file defining the procedures to be used for the software group and / or to define individual job options for the procedures (software and procedure groups).

For the content of this procedures file, see Procedures File Format

prompt

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.

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.

reinstall

Optional. Default: “reinstall=n”

If “reinstall” or “reinstall=y” is coded then a possible installation record related to the order is removed before the job is evaluated by the domain manager.

If “reinstall=n” is coded then such records will remain.

Note: Option only applies to install jobs. In any other cases it is ignored.

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.

sep

Specifies an alternate separator used with the "ccompgroup" option. The separator should not be part of the group name code with the "ccompgroup" options.

stagingServer

Deliver the related product also to the staging libraries of the scalability servers of the target computers.

This parameter applies to procedures of task type "install" only!

task

Specifies the type of task to be performed by the item procedure.

The following types are valid:

activate

The procedure activates the item.

configure

The procedure configures the item.

install

The procedure installs the item.

uninstall

The procedure uninstalls the item.

If the parameter is not coded, install is assumed.

version

Specifies the version of the item to be processed.

userJobMessage

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

Note: You should be aware of the following: