Web Services Reference › Methods › Software › Software Jobs › CreateActivateSoftwareJob3

CreateActivateSoftwareJob3

The CreateActivateSoftwareJob3 method creates a new software job of type Activate.

Additionally, this method provides the functionality to shut down a target computer after completion of the jobs. The method takes the sequence CreateSoftwareJobOrderProperties3, which includes another sequence SoftwareJobBootMask3. The SoftwareJobBootMask3sequence 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 CreateSoftwareJobOrderProperties3 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 softwarePackageProcedureId (^m)

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

xsd:string softwarePackageInstallProcedureId (^m)

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

CreateSoftwareJobOrderProperties3 softwareJobOrderProperties3 (^m)

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

xsd:string softwareJobContainerId (^m)

Specifies the UUID identifying the job container associated with this new software job.

ArrayOfstring softwarePackageInstallationIds

Specifies an array of UUIDs identifying the installation jobs on which this activation job must be based. The targets from the given installation jobs are used, so do not supply the unitGroupIds and unitIds parameters.

ArrayOfstring unitGroupIds

Specifies an array of UUIDs identifying the unit groups to which the job must be applied.

ArrayOfstring unitIds

Specifies an array of UUIDs identifying the units to which the job must be applied.

Return Values

xsd:string CreateActivateSoftwareJobReturn

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

Remarks

None

More information:

CreateSoftwareJobOrderProperties3