Previous Topic: ExampleNext Topic: Example


recover—Recovering Failed Installations

The recover command recovers the failed installations. The command also cleans up the failed installations.

The recover command is valid only on the domain managers.

This command has the two following formats:

recover {item=item_name version=version_name 
installedwith=install_procedure 
procedure=un_install_procedure_name	
[{computer=computer_name}] 
[after={exacttime|boottime}]
[nocalendar[={y|n}] 
[offline[={y|n}]] 
[deliverytime="YYYY-MM-DD hh:mm" ] 
[attime="YYYY-MM-DD hh:mm" ] 
[promptUser[={y|n}]] 
[bootbefore[={y|n}]
[bootafte[={y|n}] 
[timeout=hours]
[calendarname=delivery_exclusion_calendar]
[runAtShutdown[={y|n}]
[userJobMessage]
[userMessage]

recover cname=name 
[item=item_name 
version=version_name
installedwith=install_procedure 
procedure=un_install_procedure_name	
[after={exacttime|boottime}]
[globalTime[={y|n}]] 
[nocalendar[={y|n}] 
[offline[={y|n}]] 
[deliverytime="YYYY-MM-DD hh:mm" ] 
[attime="YYYY-MM-DD hh:mm" ] 
[promptUser[={y|n}]] 
[bootbefore[={y|n}]
[bootafte[={y|n}] 
[timeout=hours]
[calendarname=delivery_exclusion_calendar]
[nopurge]
[runAtShutdown[={y|n}]
[userJobMessage]
[userMessage]
after={exacttime | boottime }

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.

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".

bootafter

Indicates that the target computer is to be rebooted before the procedure starts.

bootbefore

Indicates that the target computer has to be rebooted after the procedure has completed.

calendarname

Specifies the name of a calendar, which specifies the periods where deliveries are excluded.

cname

Specifies the name of the job container from where the jobs to be recovered will be taken.

computer

Specifies the name of the computer.

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 will be used.

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.

installedWith

Specifies the name of the install procedure.

This parameter should be coded together with the parameter item only.

item

Specifies the name of the item being recovered.

This parameter should be coded with the parameters version, installedWith and procedure only.

If the parameter item is not coded, then all recoverable jobs of the specified container will be recovered using the first uninstall procedure related to an item to be recovered.

noCalendar

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

nopurge

The job container coded in cname is kept if the parameter is coded, otherwise the container will be deleted.

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.

procedure

Specifies the name of the "uninstall" procedure to be performed.

This parameter should be coded with the parameter item only.

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.

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.

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

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 being recovered.

This parameter should be coded with the parameter item only.

userJobMessage

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

userMessage

Specifies the custom administrator message for a job container.

Note: If the cname variant of the command is coded then the block with the parameters item version installed is optional. If these parameters are not coded, all recoverable jobs of the container will be recovered and the uninstall procedure used is the first one in the list of the uninstall procedures found which are assigned to the related products.