Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

DESCRIPTION

...

Required?true
Position?1
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

...

Order

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

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

...

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

Required?false
Position?4
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

Required?false
Position?5
Default value
Accept pipeline input?true (ByPropertyName)false
Accept wildcard characters?false

...

-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.

Default: now

Required?false
Position?6
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Timezone

...

RunTime

...

now
Accept pipeline input?false
Required?false
Position?8
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

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

Required?false
Position?97
Default value
Accept pipeline input?true (ByPropertyName)false
Accept wildcard characters?false

...

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

Required?false
Position?108
Default value
Accept pipeline input?true (ByPropertyName)false
Accept wildcard characters?false

...

Replace

-AuditComment <String>Replace <SwitchParameter>
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. the order should replace an existing order with the same order identification.

Required?false
Position?11named
Default valueFalse
Accept pipeline input?true (ByPropertyName)false
Accept wildcard characters?false

...

NoImmediate

-AuditTimeSpent <Int32>NoImmediate <SwitchParameter>
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 JobSchedulerthat the order is not immediately submitted and that no order identification is returned
with the order object. This parameter is intended for a situation when no order identification
is required when executing the cmdlet.

Required?false
Position?12named
Default value0False
Accept pipeline input?true (ByPropertyName)Accept wildcard characters?false

...

...

Required?false
Position?13
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

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

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

...

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

Adds 10 orders to the indicated a job chain.

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

...

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

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

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

Adds the specified order. Should the indicated order for a start time 30 minutes (1800 seconds) from noworder exist then it will be replaced.

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

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

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