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.
Syntax
1 | $job.Name |
The following properties are always added :
Type |
Name |
Description |
---|---|---|
long |
Id |
A unique identifier for the job. |
string |
Name |
The name of the job. |
string |
Description |
A description of the job. |
int |
Priority |
The priority of the job. |
string |
CreateUserName |
The name of the user who created the job. |
DateTime |
CreationDate |
The date the job was created. |
bool |
Reserved |
Indicates whether the job was reserved or not. |
string |
ReserveDate |
The date that the job was reserved. |
DateTime |
ReservedMachine |
The computer name of the client that the job is reserved to. |
string |
Status |
The status of the job. Possible values: Pending,Running,Success,Failed |
string |
ErrorMessage |
The error message for failed jobs. |
Remarks
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.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 | 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 |