powervault:code_reference:objects:job

Job

A Job object is of type PsObject and represents a queued VaultJob.

The $job object is dynamically generated based on the job Parameters. Therefore all job parameters are directly available on this object.
When accessing parameters containing whitespaces, you have to enclose such a property in single quotes.

$job.Name

The following properties are always added :

NameTypeDescription
longIdA unique identifier for the job.
stringNameThe name of the job.
stringDescription A description of the job.
intPriorityThe priority of the job.
stringCreateUserNameThe name of the user who created the job.
DateTimeCreationDateThe date the job was created.
boolReservedIndicates whether the job was reserved or not.
DateTimeReserveDateThe date that the job was reserved.
stringReservedMachineThe computer name of the client that the job is reserved to.
StatusThe status of the job. Possible values: Pending,Running,Success,Failed
stringErrorMessageThe error message for failed jobs.

The data types of the parameters on the object are all of type string.

When parameters with one of the following property names are set, they do not get overwritten.

Id              : 261026
Name            : Sample.CreatePDF
Description     : Job for creating PDF
Priority        : 10
CreateUserName  : Administrator
CreationDate    : 29.05.2019 13:08:29
Reserved        : False
ReserveDate     : 01.01.0001 00:00:00
ReservedMachine : 
Status          : Pending
ErrorMessage    : 
EntityId        : 88
EntityClassId   : FILE