PowerShell CLI 1.2 - Cmdlets - Resume-JobSchedulerOrder

Name

Resume-JobSchedulerOrder

SYNOPSIS

Resumes a number of orders in the JobScheduler Master.

SYNTAX

Resume-JobSchedulerOrder [-OrderId] <String> [-JobChain] <String> [[-Directory] <String>] [[-Parameters] <Hashtable>] [[-State] <String>] [[-EndState] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet is an alias for Update-JobSchedulerOrder -Action "resume"

PARAMETERS

OrderId

-OrderId <String>
Specifies the identifier of an order.

Both parameters -Order and -JobChain have to be specified if no pipelined order objects are used.

JobChain

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

Both parameters -Order and -JobChain have to be specified if no pipelined order objects are used.

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' }

State

-State <String>
Specifies that the order should resume 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.

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

RELATED LINKS

about_JobScheduler

EXAMPLES

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

PS > Resume-JobSchedulerOrder -Order Reporting -JobChain /sos/reporting/Reporting

Resumes the order "Reporting" from the specified job chain.

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

PS > Get-JobSchedulerOrder | Resume-JobSchedulerOrder

Resumes all orders for all job chains.

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

PS > Get-JobSchedulerOrder -Directory / -Nosub-folders | Resume-JobSchedulerOrder

Resumes orders that are configured with the root folder ("live" directory) without consideration of sub-folders.

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

PS > Get-JobSchedulerOrder -JobChain /test/globals/chain1 | Resume-JobSchedulerOrder

Resumes all orders for the specified job chain.