Web Services Reference › Methods › Software › Software Jobs › CreateRecoverSoftwareJob3

CreateRecoverSoftwareJob3

The CreateRecoverSoftwareJob3 method creates a new software job of type Recover to clean up and recover a failed job.

Additionally, this method provides the functionality to shut down a target computer after completion of the jobs. The method takes the sequence SoftwareJobOrderProperties3, which includes another sequence SoftwareJobBootMask3. The SoftwareJobBootMask3 sequence contains the option ShutdownAfterLast that lets you shut down the target computer after completion of the jobs.

This method also includes the functionality that helps you manage the custom administrator message. For the custom administrator message, the sequence SoftwareJobOrderProperties3 includes two parameters: userMessage, which takes the message input from the user, and userMessageSupplied, which checks the presence of the userMessage field for the custom administrator message in SD.

Parameters

xsd:string sessionId (^m)

Specifies the session ID obtained from the login to the web service.

xsd:string softwareJobId (^m)

Specifies the UUID identifying the software job to be recovered.

xsd:string softwareJobContainerId (^m)

Specifies the UUID identifying the software job container to be recovered.

xsd:string softwarePackageProcedureId (^m)

Specifies the UUID identifying the software package procedure that the job must use.

SoftwareJobOrderProperties3 softwareJobOrderProperties3 (^m)

Specifies the properties required to create and order a software job.

Return Values

xsd:string CreateRecoverSoftwareJobReturn

Returns the UUID of the new job if a software Recover job is successfully created.

Remarks

None

More information:

SoftwareJobOrderProperties3