Page History

Scope

The script adds adds an order to a job chain in a JobScheduler Master instance.
PowerShell script is operational for command line execution with Windows, Linux, MacOS.
The script is a wrapper that demonstrates use of the PowerShell CLI.

...

The script is executable from the command line
- for Windows by use of the pwsh.exe PowerShell interpreter like this:
  - pwsh.exe -f ./Add-JobSchedulerOrder.ps1 -JobChain /bjb/shell_chain -Order sample_order
- for Linux, MacOS by directly calling the script and implictly using the shebang (#!/usr/bin/pwsh) to reference the interpreter like this:
  - ./Add-JobSchedulerOrder.ps1 -JobChain /bjb/shell_chain -Order sample_order

Coding

Code Block

language	powershell
title	Add-JobSchedulerOrder.ps1
collapse	true

#!/usr/bin/pwsh
 
param
(
    [Parameter(Mandatory=$True,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
    [string] $JobChain,
    [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
    [string] $Order,
    [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
    [String] $Parameters = '',
    [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
    [string] $At = 'now',
    [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
    [string] $State,
    [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
    [string] $EndState,
    [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
    [string] $Id = $global:JobSchedulerId,
    [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
    [Uri] $Url = $global:JobSchedulerUrl,
    [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
    [PSCredential] $Credentials = $global:JobSchedulerCredentials,
    [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
    [string] $Separator = ';'
)

if ( !$Id )
{
    throw "missing value for parameter -Id"
}

if ( !$Url )
{
    throw "missing value for parameter -Url"
}

if ( !$Credentials -and !$Url.UserInfo )
{
    throw "missing value for parameter -Credentials"
}

Import-Module JobScheduler
if ( $Url.UserInfo )
{
    $ws = Use-JobSchedulerWebService -Url $Url -Id $Id
} else {
    $ws = Use-JobSchedulerWebService -Url $Url -Id $Id -Credentials $Credentials
}
try
{
    $order = Add-JobSchedulerOrder -JobChain $JobChain -Order $Order -At $At -State $State -EndState $EndState -Parameters ( ConvertFrom-StringData -StringData $Parameters.Replace($Separator, "`n") )
} catch {
    throw $_.Exception
} finally {
    $ws = Use-JobSchedulerWebService -Url $Url -Id $Id -Disconnect
}

Explanations

...

- - ddd

Examples

To display examples execute the following commands:

...

Space shortcuts

Page tree

Versions Compared

Old Version 3

New Version 4

Key

Table of Contents

Scope

Examples