PowerShell CLI 1.2 - Cmdlets - Start-JobSchedulerJob

Name

Start-JobSchedulerJob

SYNOPSIS

Starts jobs in the JobScheduler Master.

SYNTAX

Start-JobSchedulerJob [-Job] <String> [[-Directory] <String>] [[-Parameters] <Hashtable>] [[-Environment] <Hashtable>] [[-At] <String>] [[-Timezone] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<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.

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.

Parameters

-Parameters <Hashtable>
Specifies the parameters for the job. Parameters are created from a hashmap,
i.e. a list of names and values.

Environment

-Environment <Hashtable>

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.

Timezone

-Timezone <String>
Specifies the time zone to be considered for the start time that is indicated with the -At parameter.
Without this parameter the time zone of the JobScheduler Master is assumed.

This parameter should be used if the JobScheduler Master runs in a time zone different to the environment
that makes use of this cmdlet.

Find the list of time zone names from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

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.

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.

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.

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

RELATED LINKS

about_JobScheduler

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > Start-JobSchedulerJob -Job /sos/dailyschedule/CheckDaysSchedule

Starts the indicated job.

-------------------------- EXAMPLE 2 --------------------------

PS > Start-JobSchedulerJob -Job /sos/dailyschedule/CheckDaysSchedule -At "2038-01-01 00:00:00" -Timezone "Europe/Berlin"

Starts the indicated job for a later date that is specified for the "Europe/Berlin" time zone.

-------------------------- EXAMPLE 3 --------------------------

PS > Get-JobSchedulerJob -Directory /some_path -Recursive | Start-JobSchedulerJob

Starts all jobs from the specified directory and sub-folders.

-------------------------- EXAMPLE 4 --------------------------

PS > Start-JobSchedulerJob -Job /some_path/some_job -Parameters @{'par1' = 'val1'; 'par2' = 'val2'}

Starts the job with parameter 'par1' and 'par2' and respective values.