PowerShell CLI 1.2 - Cmdlets - Add-JobSchedulerOrder

Name

Add-JobSchedulerOrder

SYNOPSIS

Adds an order to a job chain in the JobScheduler Master.

SYNTAX

Add-JobSchedulerOrder [-JobChain] <String> [[-OrderId] <String>] [[-Directory] <String>] [[-Parameters] <Hashtable>] [[-Title] <String>] [[-At] <String>] [[-Timezone] <String>] [[-RunTime] <String>] [[-State] <String>] [[-EndState] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

Creates a temporary ad hoc order for execution with the specified job chain

PARAMETERS

JobChain

-JobChain <String>
Specifies the path and name of a job chain for which orders should be added.

OrderId

-OrderId <String>
Optionally specifies the identifier of an order.

If no order identifier is specified then JobScheduler assigns a unique identifier.

Directory

-Directory <String>
Optionally specifies the folder where the job chain is located. The directory is determined
from the root folder, i.e. the "live" directory.

If the -JobChain parameter specifies the name of job chain then the location specified from the
-Directory parameter is added to the job chain location.

Parameters

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

Example:
$orderParams = @{ 'param1' = 'value1'; 'param2' = 'value2' }

Title

-Title <String>
Specifies the title of the order.

At

-At <String>
Specifies the point in time when the order should start. Values are added like this:

* now
** specifies that the order should start immediately
* now+1800
** specifies that the order should start with a delay of 1800 seconds, i.e. 30 minutes later.
* yyyy-mm-dd HH:MM[:SS]
** specifies that the order 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

RunTime

-RunTime <String>
Optionally specifies an XML configuration for the <run_time> of an order.
This makes sense should the order be scheduled based on some rule, e.g. to start on a specific day of week.

For details of the run-time configuration see https://www.sos-berlin.com/doc/en/scheduler.doc/xml/run_time.xml

State

-State <String>
Specifies that the order should enter the job chain at the job chain node that
is assigend the specified state.

EndState

-EndState <String>
Specifies that the order should leave the job chain at the job chain node that
is assigend the specified state.

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.

RELATED LINKS

about_JobScheduler

EXAMPLES

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

PS > Add-JobSchedulerOrder -JobChain /sos/reporting/Reporting

Adds an order to the indicated job chain. The order identification is generated by the JobScheduler Master.

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

PS > 1..10 | Add-JobSchedulerOrder -JobChain /sos/reporting/Reporting

Adds 10 orders to the indicated job chain.

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

PS > Add-JobSchedulerOrder -Order 123 -JobChain /sos/reporting/Reporting

Adds the order "123" to the indicated job chain.

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

PS > Add-JobSchedulerOrder -Order 123 -JobChain /sos/reporting/Reporting -At "now+1800"

Adds the indicated order for a start time 30 minutes (1800 seconds) from now.

-------------------------- EXAMPLE 5 --------------------------

PS > Add-JobSchedulerOrder -Order 123 -JobChain /sos/reporting/Reporting -At "2038-01-01 00:00:00" -Timezone "Europe/Berlin"

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

-------------------------- EXAMPLE 6 --------------------------

PS > Add-JobSchedulerOrder -JobChain /sos/reporting/Reporting -At "now+3600" -Parameters @{'param1' = 'value1'; 'param2' = 'value2'}

Adds an order to the indicated job chain. The order will start one hour later and will use the parameters from the indicated parameters.