Page History

...

Download

DOWNLOAD

The PowerShell Command Line Interface is available from GitHub at https://github.com/sos-berlin/scheduler-cli-powershell

...

Short Description

The JobScheduler Command Line Interface (JCLICLI) can be used to control
JobScheduler control JobScheduler instances (start, stop, status) and job-related objects
such objects such as jobs, job chains, orders, tasks.

The JobScheduler CLI module supports Windows PowerShell 23.0 and newer.

...

Long Description

The JobScheduler Command Line Interface (JCLICLI) is used for the following
areas of operation:

• work as a replacement for the command scripts
  • JobScheduler start script .\bin\jobscheduler.cmd:
    • provide operations for installing and removing the JobScheduler Windows service
    • starting and stopping JobScheduler instances including active and passive clusters
  • Job Editor (JOE) start script .\bin\jobeditor.cmd
  • JobScheduler Dashboard (JID) start script .\bin\dashboard.cmd
  • JobScheduler Event script .\bin\jobscheduler_event.cmd
• provide bulk operations:
  • select jobs, job chains, orders and tasks
  • manage orders with operations for start, stop and removal
  • suspend and resume jobs, job chains and orders
  • terminate tasks
• schedule jobs and orders:
  • add orders to job chains
  • start jobs and orders
• manage Agents
  • retrieve Agent clusters
  • check Agent status

The JobScheduler CLI provides a number of cmdlets, see PowerShell Command Line Interface CLI 1.1 - Cmdlets

• The complete list of cmdlets is available with the command:
  • PS C:\> Get-Command -Module JobScheduler
• Cmdlets come with a full name and a short alias:The full name includes the term "JobScheduler" such as inthat includes the term JobScheduler:
  • PS C:\> Use-JobSchedulerWebService
• The term JobScheduler can be abbreviated to JS:

  • PS C:\> Use-JobSchedulerMasterJSWebService
• The term JobScheduler can further be omitted if the resulting alias does not conflict with existing cmdlets:

  • PS C:\> Use-MasterWebService
• Should conflicts occur with existing cmdlets from other modules then the aliases can be removedno conflicting aliases are created. This includes aliases for cmdlets from the PowerShell Core as e.g. Get-Job, Start-Job, Stop-Job.
  It is recommended to use the abbreviated form Get-JSJob, Start-JSJob etc. Aliases can be forced by use of the cmdlet:
  • PS C:\> Remove-Item alias:> . Use-MasterJobSchedulerAlias

Cmdlets consider verbosity and debug settings.

...

The responses from a JobScheduler Master can include large XML answers.
Such answers are stored in temporary files, the debug message indicates the location of the file name.
The threshold for creating temporary files is 1000 bye byte by default.
Consider use of the Set-Option JobSchedulerOption -DebugMaxOutputSize cmdlet to change this value.

The PowerShell JobScheduler CLI is proviced with provided with the following features:

• Jira
  server SOS JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-1630

...

• Jira
  server SOS JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-1339

• Jira
  server SOS JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-1620

• Jira
  server SOS JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-1762

How to get started with the JobScheduler CLI

The JobScheduler CLI is used for JobScheduler instances that are installed
locally or on remote computers and is initialized by the following commands:

• Import Module
  • PS C:\> Import-Module JobScheduler
    • loads the module from a location that is available with the PowerShell module path,
    • see $env:PSModulePath for predefined module locations.
  • PS C:\> Import-Module C:\some_module_location\JobScheduler
    • loads the module from a specific location, absolute and relative paths can be used.
  • Hints
    The JCLI module will automatically connect to a Master on import of the module if one of the following environment variables is present:
    • SCHEDULER_URL specifies the URL for which the Master is operated.
    • SCHEDULER_ID specifies the unique identification of a Master.
    SCHEDULER_HOME specifies the installation path of a locally available Master.
    • You can add the command Import-Module JobScheduler to your PowerShell profile to have the module loaded on start of a PowerShell session, see PowerShell CLI 1.1 - Use Cases - Credentials Management
• Use JobScheduler Master Instance
  • As a first operation after importing the module it is required to execute the Use-JobSchedulerMaster or Use-Master cmdletJobSchedulerWebService (starting from release 1.11) cmdlets.

  • PS C:\> Use-JobSchedulerMaster <Url>   or   PS C:\> Use-JobSchedulerMaster -Url <Url>  <Url>   or   PS C:\> Use-JobSchedulerWebService -Url <Url> -Id <JobSchedulerId>
    • specifies the URL for which the JobScheduler Master or REST Web Service is available. This is the same URL that you would use when opening the JOC Cockpit GUI in your browser, e.g. http://localhost:44444446. Do not If you omit the protocol (httpHTTP/httpsHTTPS) for the URL then HTTP will be used. The -Id parameter specifies the JobScheduler ID of the Master that you intend to connect to.
    • allows to execute cmdlets for the specified Master independently from the server and operating system that the JobScheduler Master is operated for, i.e. you can use PowerShell cmdlets on Windows to manage a JobScheduler Master running on a Linux box and vice versa. As an exception to this rule you cannot start a remote JobScheduler Master and you cannot start a remote JobScheduler Windows service, however, you can restart, terminate, abort and suspend any JobScheduler Master on any platform.
    • specifying the URL is not sufficient to manage the Windows Service of the respective Master, see below.
  • PS C:\> PS C:\> Use-Master Use-JobSchedulerWebService -Url <Url> -Id <JobSchedulerID>
    
    • references the JobScheduler ID that has been assigned during installation of a Master.
    • adds the JobScheduler ID to the assumed installation base path.
      
      • A typical base bath would be C:\Program Files\sos-berlin.com\jobscheduler
      • The path is added the subdirectory with the name value of the JobScheduler ID
  • PS C:\> Use-JobSchedulerMaster -InstallPath <InstallationPath>
    • specifies the full installation path, e.g. C:\Program Files\sos-berlin.com\jobscheduler\scheduler1.10, for a locally available JobScheduler Master.
  • PS C:\> Use-JobSchedulerMaster -InstallPath $env:SCHEDULER_HOME
    • You can use an the environment variable SCHEDULER_HOME that points to the installation path.
    • The JobScheduler CLI module on import checks availability of this environment variableThe Use-Master cmdlet is executed automatically if SCHEDULER_HOME is present.
  • PS C:\> Use-JobSchedulerMaster -Url <Url> -Id <JobSchedulerID>
    
    • specify both URL and JobScheduler ID (recommended).
    • determines if the Master with the specified JobSchedulerID is locally available.
  • Hints
    • If your JobScheduler Master is configured to require HTTP authentication then please consider that
      • by default the Windows credentials of the current user are forwarded for web requests.
      • individual credentials can be added by use of the following command:cmdlet Set-Credentials -AskForCredentials prompts for user input of an account and password.
      • Set-Credentials -Credentials $credentials accepts a predefined credentials object that can be created e.g. by
        • $credentials = ( New-Object -typename System.Management.Automation.PSCredential -ArgumentList 'account', ( 'password' | ConvertTo-SecureString -AsPlainText -Force) )
        • Technically this allows to store the account and password in a script which is not recommended for compliance reasons.
      • Set-Credentials without parameters removes an existing credentials object from being forwarded for web requests.
      You can add the command Set-Credentials to your PowerShell profile to have credentials applied on start of a PowerShell session.JobSchedulerCredentials.
      • For details and examples see PowerShell CLI 1.1 - Use Cases - Credentials Management
• Manage JobScheduler Objects
  • PS C:\> Show-JobSchedulerStatus
    • shows the summary information for a JobScheduler Master
  • PS C:\> Get-JobSchedulerOrder
PS C:\> Get-JobSchedulerJobChain
PS C:\> Get-JobSchedulerJob
PS C:\> Get-JobSchedulerTask
    • retrieves the list of avaiable objects
  • see the complete list of cmdlets with the cmdlet: Get-Command -Module JobScheduler

...

How to run JobScheduler commands

JobScheduler commands are Windows PowerShell scripts (.ps1 files), so you can run
them at the command line, or in any editor.

• Import the JobScheduler CLI module (assuming that the module is available in one of the directories that are indicated with the $env:PSModulePath.

...

• • PS C:\> Import-Module JobScheduler
• Make Makes the JobScheduler Master with the specified Url available JobScheduler ID scheduler111 available for use with cmdlets that are executed via the REST Web Services from the specified URL.
  
  • PS C:\> Use-Master JobSchedulerWebService -Url http://localhost:44444446 -Id scheduler111
• Display Shows the summary information of a JobScheduler Master.
  • PS C:\> Show-JobSchedulerStatus
• Shows Display the number of tasks that are currently running.
  • PS C:\> (Get-JobSchedulerTask).count
• Stops Display all running tasks (emergency stop).
  • PS C:\> Get-JobSchedulerTask | Stop-JobSchedulerTask
• Collects Collect the list of orders from a directory and stores store it in a variable.
  • PS C:\> $orders = Get-JobSchedulerOrder /sos

For more information about individual JobScheduler cmdlets, type:

• Get-Help Use-JobSchedulerMaster -detailed

...

• Get-Help Show-JobSchedulerStatus -detailed
• etc.

...

Examples

Find some typical use cases for the JobScheduler CLI.

• Perform an emergency stop:
  • Get-JobSchedulerTask | Stop-JobSchedulerTask -Action kill
  • This will terminate all running and enqueued tasks immediately.
• Find enqueued tasks, i.e. tasks that are scheduled for a later start:
  • Get-JobSchedulerTask -NoRunningTasks
  • Retrieves the list of scheduled tasks.
• Suspend any temporary orders that are e.g. created by job scripts:
  • $orders = ( Get-JobSchedulerOrder /my_jobs -NoPermanent | Suspend-JobSchedulerOrder )
  • This will retrieve temporary ad hoc orders from the /my_jobs directory and any subfolders.
  • All temporary orders are suspended and the list of order objects is stored in a variable.
• Remove orders based on a list that has previously been retrieved:
  • $orders | Remove-JobSchedulerOrder
  • This will remove the orders available from the list.

...

Managing the JobScheduler

...

Master

Find some use cases for JobScheduler Master management.

• Start the JobScheduler Master:
  • Start-JobSchedulerMaster -Service
  • Starts the Windows service of a JobScheduler Master
• Start the JobScheduler Master in paused mode:
  • Start-JobSchedulerMaster -Service -Pause
  • The Windows service is started and is immediately paused to prevent any tasks from starting.
• Restart the JobScheduler Master:
  • Restart-JobSchedulerMaster -Timeout 120
  • Restarts the Master having left any running tasks up to 120 seconds to complete.
• Stop the JobScheduler Master immediately:
  • Stop-JobSchedulerMaster -Action kill
  • This will kill all running tasks immediately and terminate the JobScheduler Master.
• Stop the JobScheduler Master cluster:
  • Stop-JobSchedulerMaster -Cluster -Action abort
• Install the JobScheduler Master Windows service:
  • Install-Service JobSchedulerService -Start -PauseAfterFailure
  • Installs and starts the Windows service. Should a previous JobScheduler run have been terminated with failure then the JobScheduler Master will switch to pause paused mode.
  • This allows e.g. to check for enqueued tasks before starting operations.
  • A previously installed Windows service with the same name will be removed.
• Install the JobScheduler Master Windows service for a specific account:
  • Install-JobSchedulerService -Start -UseCredentials
  • This will install the Windows service and ask for the name of the account and password that the service is operated for. The account name typically includes the domain and user, e.g. .\some_user for some_user in the current domain.
• Remove the JobScheduler Master Windows service:
  • Remove-JobSchedulerService
  • This will remove the Windows service. Should any tasks be running with the JobScheduler Master then the removal will be delayed. 
  • Consider to use Stop-JobSchedulerMaster -Action abort if immediate removal of the Windows service is required.

...

PowerShell CLI in Detail

• For typical areas of operation see PowerShell CLI 1.1 - Use Cases
• Full list of JobScheduler cmdlets: PowerShell Command Line Interface CLI 1.1 - Cmdlets
• Below See the below list of aliases for JobScheduler cmdlets.

...

Job Management

• Get-CalendarJobSchedulerJob
• Get-StatusJobSchedulerJobHistory
• Get-Version

• Restart-Master
• Resume-Master

• Send-Command
• Set-Credentials 
• Set-Option

• Show-Calendar

• Show-Status
• Start-Master

• Stop-Master
  
• Suspend-Master
• Use-Master

Job Chain Management

• Add-Order
• Get-JobChain
• Get-Order
• Get-SingleOrder
• Remove-Order
• Reset-Order
• Resume-Order

• Start-Order
• Suspend-Order
• Update-Order

Job Management

• -JobSchedulerTask
• Start-JobSchedulerExecutableFile
• Start-JobSchedulerJob
• Stop-JobSchedulerJob
• Stop-JobSchedulerTask
• Update-JobSchedulerJob

Job Chain Management

• Add-JobSchedulerOrder
• Get-JobSchedulerJobChain
• Get-JobSchedulerOrder
• Get-JobSchedulerOrderHistory
• Remove-JobSchedulerOrder
• Reset-JobSchedulerOrder
• Resume-JobSchedulerOrder

• Start-JobSchedulerOrder
• Suspend-JobSchedulerJobChain
• Suspend-JobSchedulerOrder
• Update-JobSchedulerJobChain
• Update-JobSchedulerOrder

Event Management

• Add-JobSchedulerEvent
• Get-JobSchedulerEvent
• Remove-JobSchedulerEvent

Master Managment

• Get-JobSchedulerCalendar
• Get-JobSchedulerInventory
• Get-JobSchedulerStatus
• Get-JobSchedulerSystemCredentials
• Get-JobSchedulerVersion

• New-JobSchedulerHolidays
• Restart-JobSchedulerMaster
• Resume-JobSchedulerMaster

• Send-JobSchedulerCommand
• Set-JobSchedulerCredentials 
• Set-JobSchedulerOption

• Show-JobSchedulerCalendar

• Show-JobSchedulerStatus
• Start-JobSchedulerDashboard
• Start-JobSchedulerJobEditor
• Start-JobSchedulerMaster

• Stop-JobSchedulerMaster
  
• Suspend-JobSchedulerMaster
• Use-JobSchedulerAlias

• Use-JobSchedulerMaster
• Use-JobSchedulerWebService


Agent Managment

• Get-JobSchedulerAgentCluster
• Get-JobSchedulerAgentStatus
• Show-JobSchedulerAgentStatus
• Get-Job
• Get-Task
• Start-Job
• Stop-Job
• Stop-Task
• Update-Job

Windows Service Management

• Install-ServiceJobSchedulerService

• Remove-ServiceJobSchedulerService

Change Management References