Name
Start-JobSchedulerJob
SYNOPSIS
Starts jobs in the JobScheduler Master.
SYNTAX
Start-JobSchedulerJob [-Job] <String> [[-Directory] <String>] [[-Parameters] <Hashtable>] [[-Environment] <Hashtable>] [[-At] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet starts standalone jobs with the JobScheduler Master.
Jobs are started independent from the fact if they are stopped
or if they will be started due to calendar events.
PARAMETERS
Job
-Job <String>
Specifies the full path and name of a job.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Directory
-Directory <String>
Optionally specifies the directory of a job should the -Job parameter
not be provided with the full path and name of the job.
| Required? | false |
| Position? | 2 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Parameters
-Parameters <Hashtable>
Specifies the parameters for the job. Parameters are created from a hashmap,
i.e. a list of names and values.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Environment
-Environment <Hashtable>
| Required? | false |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
At
-At <String>
Specifies the point in time when the job should start:
* now
** specifies that the job should start immediately
* now+1800
** specifies that the job should start with a delay of 1800 seconds, i.e. 30 minutes later.
* yyyy-mm-dd HH:MM[:SS]
** specifies that the job should start at the specified point in time.
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditComment
-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.
The Audit Comment is visible from the Audit Log view of JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforece Audit Log comments for any interventions.
| Required? | false |
| Position? | 6 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTimeSpent
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.
| Required? | false |
| Position? | 7 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTicketLink
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobScheduler.
This information is visible with the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobScheduler.
| Required? | false |
| Position? | 8 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Start-JobSchedulerJob -Job /sos/dailyschedule/CheckDaysSchedule
Starts the indicated job.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JobSchedulerJob -Directory /some_path -Recursive | Start-JobSchedulerJob
Starts all jobs from the specified directory and sub-folders.
-------------------------- EXAMPLE 3 --------------------------
PS > $params = ${ 'par1' = 'val1'; 'par2' = 'val2' }
Start-JobSchedulerJob -Job /some_path/some_job -Parameters $params
Starts the job with parameter 'par1' and 'par2' and respective values.