Web Services Reference › Sequences › SoftwareJobProperties3

SoftwareJobProperties3

The SoftwareJobProperties3 sequence defines the properties that you can set for a software job.

xsd:string softwareJobId

Specifies the UUID identifying the software job.

xsd:string softwareJobName

Specifies the display name of the software job.

xsd:string softwarePackageId

Specifies the UUID identifying the software package with which this job is associated.

xsd:string softwarePackageName

Specifies the name of the software package with which this job is associated.

xsd:string softwarePackageVersion

Specifies the version of the software package with which this job is associated.

SoftwarePackageType softwarePackageType

Specifies the type of the software package with which this job is associated.

xsd:string softwarePackageProcedureId

Specifies the UUID identifying the software package procedure with which this job is associated.

xsd:string softwarePackageProcedureName

Specifies the name of the software package procedure with which this job is associated.

DateTime executionDate

Specifies the date and time when you want to run the job.

DateTime createdDate

Specifies the date and time at which the job was created.

xsd:long timeoutHours

Specifies the time in hours after which, if the job has been unable to complete, the job will cease attempts to complete.

SoftwareJobType softwareJobType

Specifies the type of the software job.

SoftwareJobState softwareJobState

Specifies the current state of the software job.

SoftwareJobStartupTime startWhen

Specifies the time to start the software job. The range for this parameter is by default 3-168 hours. For example, if you select the value as 1 hour, the system immediately replaces the value with 3 hours. The default value is 7 days (168 hours).

SoftwareJobPermissionMask permissionMask

Specifies the permissions applicable to this software job.

SoftwareJobBootMask3 bootBeforeMask

Specifies the restart options requested for the software job before executing the job.

SoftwareJobBootMask3 bootAfterMask

Specifies the restart options requested for the software job after executing the job.

SoftwareJobOperationMask2 operationMask2

Specifies the properties for the operation of the software job.

xsd:string userParameters

Specifies the user-defined parameters for the job.

SoftwareJobStatusCounters jobStatusCounters

Specifies the summary of the status counts for the targets of this software job.

xsd:long internalMask

Specifies the internal mask for the software job properties.

xsd:long orderNumber

Specifies the order number of a software job within its job container if the software job is part of that job container.

xsd:long promptTimeoutHours

Specifies the number of hours for which you want to display a user prompt before a forced execution of the job starts. The default value is 1 day. You must set this parameter to a value that does not exceed the timeout value for the job.

SoftwareJobTask softwareJobTask

Specifies the type of the task that the software job is supposed to complete.

xsd:string deliveryCalendar

Specifies the name of a delivery calendar to use for scheduling the job. The calendar works as an ordinary calendar to control the days, dates, and times when the delivery is permitted. The time cells that are not set in the calendar define the exclusion intervals. You cannot create the job if you try to define a calendar with the name unknown to SD.

DateTime deliveryDate

Specifies the date and time at which the job was delivered.

xsd:long cause

Indicates the job error or status cause, that is, indicates a return code or identifier.

xsd:string causeParam

Specifies the message ID of the message that explains the error (if any) associated with this software job.

SoftwareJobRenewState renewState

Specifies the current state of the job, if it has been renewed.

xsd:string userMessage

Specifies the custom administrator message.

Remarks

None