Skip to end of metadata
Go to start of metadata

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 (JCLI) can be used to control JobScheduler instances (start, stop, status) and job-related objects such as jobs, job chains, orders, tasks.

The JobScheduler CLI module supports Windows PowerShell 2.0 and newer.

Long Description

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

  • work as a replacement for 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 CLI - Cmdlets

  • The complete list of cmdlets is available with the command:
    • PS C:\> Get-Command -Module JobScheduler
  • Cmdlets come with a full name that includes the term JobScheduler:
    • PS C:\> Use-JobSchedulerMaster
  • The term JobScheduler can be abbreviated to JS:
    • PS C:\> Use-JSMaster
  • The term JobScheduler can further be omitted if the resulting alias does not conflict with existing cmdlets:
    • PS C:\> Use-Master
  • Should conflicts occur with existing cmdlets from other modules then no 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:\> . Use-JobSchedulerAlias

Cmdlets consider verbosity and debug settings.

  • This will cause verbose output to be created from cmdlets:
    • PS C:\> $VerbosePreference = "Continue"
  • The verbosity level is reset with:
    • PS C:\> $VerbosePreference = "SilentlyContinue"
  • This will cause debug output to be created from cmdlets:
    • PS C:\> $DebugPreference = "Continue"
  • The debug level is reset with:
    • PS C:\> $DebugPreference = "SilentlyContinue"

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.
The threshold for creating temporary files is 1000 byte by default.
Consider use of the Set-JobSchedulerOption -DebugMaxOutputSize cmdlet to change this value.

The JobScheduler CLI is provided with the following features:

  • JS-1630 - PowerShell Command Line Interface Released
  • JS-1339 - Conversion of all Windows start scripts and event script to PowerShell Resolved
  • JS-1620 - JobScheduler start script offers option for bulk removal of ad hoc orders Released

 

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 - 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-JobSchedulerWebService (starting from release 1.11) cmdlets.
    • PS C:\> Use-JobSchedulerMaster <Url>   or   PS C:\> Use-JobSchedulerMaster -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 GUI in your browser, e.g. http://localhost:4444. If you omit the protocol (HTTP/HTTPS) for the URL then HTTP will be used.
      • 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 to manage a JobScheduler Master running on a Linux box. 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-JobSchedulerMaster -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 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 the environment variable SCHEDULER_HOME that points to the installation path.
      • The JobScheduler CLI module on import checks availability of this environment variable.
    • 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
  • 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.

  • Makes the JobScheduler Master with the specified URL available for use with cmdlets.
    • PS C:\> Use-JobSchedulerMaster http://localhost:4444
  • Makes the JobScheduler Master with JobScheduler ID scheduler111 available for use with cmdlets that are executed via the REST Web Services from the specified URL.
  • Shows the summary information of a JobScheduler Master.
    • PS C:\> Show-JobSchedulerStatus
  • Shows the number of tasks that are currently running.
    • PS C:\> (Get-JobSchedulerTask).count
  • Stops all running tasks (emergency stop).
    • PS C:\> Get-JobSchedulerTask | Stop-JobSchedulerTask
  • Collects the list of orders from a directory and stores 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
    • 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-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 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

Job Management

Job Chain Management

Event Management

Master Managment

Agent Managment

Windows Service Management

Change Management References

Loading
T Key Linked Issues Fix Version/s Status P Summary Updated
Feature JS-1630 JS-1620 , JS-1339 1.9.12, 1.10.5, 1.11 Released Minor PowerShell Command Line Interface Jul 08, 2016
Feature JS-1620 JS-1630 1.10.5, 1.11 Released Minor JobScheduler start script offers option for bulk removal of ad hoc orders Jul 08, 2016
Feature JS-1339 JS-1630 1.10.5, 1.11 Resolved Minor Conversion of all Windows start scripts and event script to PowerShell Jul 08, 2016