Add-VaultJob

Adds a Job to the Vault JobQueue.

Syntax

Add-VaultJob -Name <String> [-Parameters <Hashtable>] [-Description <String>] [-Priority <int>] [<CommonParameters>]

Parameters

Type	Name	Description	Default value	Optional
String	Name	The name of job to add		no
Hashtable	Parameters	A hashtable of parameters for the job		yes
String	Description	A description of the job	“powerVault: added job”	yes
Integer	Priority	The priority of the job. Possible values are interger numbers or: High, Medium and Low	Medium	yes

Return type

Job ← on success
empty ← on failure

Remarks

The Priority argument can be specified by passing either a number or passing one of the following values: High, Medium, Low.
Passing a lower number means a higher priority. 1 is the lowest possible number.
High is equal to priority 1, Medium is equal to priority 10 and Low is equal to priority 20.

Examples

Adds a Job to the Vault JobQueue:

$job = Add-VaultJob -Name "Sample.CreatePDF" -Parameters @{"EntityId"=88;"EntityClassId"="FILE"} -Description "Job for creating PDF"

Adds a Job with High Priority:

$job = Add-VaultJob -Name "TransferBOMToERP" -Parameters @{"EntityId"=$entity.Id;"EntityClassId"=$entity._EntityTypeID} -Priority High