Previous Topic: ExampleNext Topic: Example


configureItem—Assign a Configure Job to a Software Template

This command assigns a configure job to the software template.

This command has the following format:

templategroup action=configureItem
name=template_group_name
[swTemplate=software_template_name]
item=item_name 
version=item_version
procedure=procedure_name 
installedWith=install_procedure_name
[repeat] 
after={exacttime|boottime} 
[calendarname=delivery_calendar]
[{preaction={none|reboot|logoff}|bootbefore}]
[{postaction=
{none|reboot|logoff|rebootAtEnd|logoffAtEnd|shutdownAtEnd}
|bootafter}]
[promptUser[={y|n}]] 
[allowCancel[={y|n}]] 
[execTimedOut[={y|n}]]
[prompt=days.hours] 
[offline[={y|n}]] 
[runAtShutdown[={y|n}]]
[preventLogon[={y|n}]] 
[globalTime] 
[nocalendar]
[resolveQuery] 
[parameters=user_parameters]
[{jobTimeout=d.h|timeout=hours}]
[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.

calendarname

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

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.

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

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.

(default)

installedWith

Specifies the name of the install procedure that has installed the item at the target system.

item

Specifies the name of the item to be configured.

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 template group name to which the configure order is added.

noCalendar

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

If "noCalendar=n" is coded, the calendar will not be ignored any longer.

(default)

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.

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

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.

If the parameter is not coded, then the default user parameters are given by the procedure definition.

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 users after completion of all the 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 of type configure to be run.

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.

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.

repeat

If coded the job is repeated every time an evaluation takes place.

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.

swTemplate

Specifies the name of the software template the order will be assigned to.

If not coded the order will be assigned to a software template of default name, that is, “<group name> [$date $time]”.

timeout

Specifies the timeout specifies the expiration period of a job in the form “h” where 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.
timeout should not be coded with the jobTimeout parameter otherwise an error is reported. If none of the parameters is coded the default is given by 168

version

Specifies the version of the item to be configured.

userJobMessage

Specifies the custom administrator message for a configure job in a template group.

The parameters "allowCancel," "execTimedOut" and "prompt" are valid, if the "promptUser" option is already set or is set by this command using the "promptUser" parameter.
If neither the "promptUser" option of a job nor the "promptUser" parameter of the command is set, these parameters will be ignored.
No warning is given.