PowerShell Command Line Interface 2.0 - Introduction

Download

The PowerShell Command Line Interface is available

• from GitHub at https://github.com/sos-berlin/js7-cli-powershell

• from PowerShell Gallery at https://www.powershellgallery.com/packages/JobScheduler/2.0.0

  PowerShell Gallery

  Find-Module -Name JS7
  Install-Module -Name JS7

Description

The JS7 JobScheduler Command Line Interface (CLI) can be used to control JS7 instances and workflow-related objects.

The CLI module supports Windows PowerShell FullCLR 5.1 and PowerShell CoreCLR 6.x and 7.x for Windows, Linux and MacOS environments. It can be used with JS7 releases 2.0. The CLI module is used for the following areas of operation:

• provide bulk operations:
  • select orders and workflows
  • manage orders with operations to start, stop, suspend
  • deploy workflows
• run orders and workflows
  • add orders to workflows
• manage Agents
  • add Agents to Controllers
  • check Agent status
  • retrieve Agent job execution reports

Getting Started

Prerequisites

Check Execution Policy

• PS > Get-ExecutionPolicy
• shows the current execution policy, see e.g. Microsoft Technet about_Execution_Policies
• The required PowerShell execution policy for the JobScheduler CLI module is RemoteSigned or Unrestricted
• PS > Set-ExecutionPolicy RemoteSigned
• Modifying the execution policy might require administrative privileges

Check Module Location

• PowerShell provides a number of locations for modules, see $env:PSModulePath for predefined module locations.
• Download/unzip the JobScheduler CLI module
  • either to a user's module location, e.g. for Windows C:\Users\<user-name>\Documents\WindowsPowerShell\Modules\ or /home/<user-name>/.local/share/powershell/Modules for a Linux environment
  • or to a location that is available for all users, e.g. C:\Windows\system32\WindowsPowerShell\v1.0\Modules\
  • or to an arbitrary location that later on is specified when importing the module.
• Directory names might differ according to PowerShell versions.
• The required JobScheduler CLI module folder name is JobScheduler. If you download the module it is wrapped in a folder that specifies the current branch, e.g. scheduler-cli-powershell-1.2.0. Manually create the JobScheduler folder in the module location and add the contents of the scheduler-cli-powershell-1.2.0 folder from the archive.

Import Module

• PS > Import-Module JS7
  • loads the module from a location that is available with the PowerShell module path,
  • see $env:PSModulePath for predefined module locations.
• PS > Import-Module C:\some_module_location\JS7
  • loads the module from a specific location, absolute and relative paths can be used on all platforms.

Hint: You can add the command Import-Module JS7 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 Web Service

As a first operation after importing the module it is required to execute the  Connect-JS cmdlet.


• PS > Connect-JS7 -Url <Url> -AskForCredentials
  • specifies the URL for which the JOC Cockpit REST Web Service is available and asks interactively for credentials. The default account is root with the password root.
• PS > Connect-JS7 <Url> <Credentials> <JobSchedulerId> or PS > Connect-JS7 -Url <Url> -Credentials <Credentials> -Id <ControllerId>
  • specifies the URL of JOC Cockpit which is the same URL that you use when opening the JOC Cockpit GUI in your browser, e.g. http://localhost:4446. When omitting the protocol (HTTP/HTTPS) for the URL then HTTP is used.
  • specifies the credentials (user account and password) that are used to connect to the Web Service.
    • A credential object can be created by keyboard input like this:
      • Set-JSCredentials -AskForCredentials
    • A credential object can be created like this:
      • $credentials = ( New-Object -typename System.Management.Automation.PSCredential -ArgumentList 'root', ( 'root' | ConvertTo-SecureString -AsPlainText -Force) )
      • The example makes use of the default account root and password root.
      • A possible location for the above code is a user's PowerShell Profile that would be executed for a PowerShell session.
    • Credentials can be forwarded with the Url parameter like this:
      • Connect-JS7 -Url http://root:root@localhost:4446
      • Specifying account and password with a URL is considered insecure.
  • specifies the Controller ID that the Controller has been installed with. As JOC Cockpit can manage a number of Controller instances the -Id parameter can be used to select the respective Controller.
  • allows to execute cmdlets for the specified Controller independently from the server and operating system that the JS7 Controller is operated for, i.e. you can use PowerShell cmdlets on Windows to manage a JS7 Controller running on a Linux box and vice versa. As an exception to this rule you cannot start a remote JS7 Controller instance and you cannot start a remote JS7 Windows service, however, you can restart, terminate, abort, suspend and resume any JS7 Controller instance on any platform.

Run Commands

The JS7 CLI provides a number of cmdlets, see PowerShell CLI - Cmdlets. Return values of cmdlets generally correspond to the JOC Cockpit REST Web Service.

• The complete list of cmdlets is available with the command:
  • PS > Get-Command -Module JS7
• Cmdlets come with a full name that includes the term JS7:
  • PS > Get-JS7Status
• The term JS7 can be abbreviated to JS:

  • PS > Get-JSStatus
• The term JS7 can further be omitted if the resulting alias does not conflict with existing cmdlets:

  • PS > Get-Status
• Should conflicts occur with existing cmdlets from other modules then no conflicting aliases will be 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 form Get-JS7Job, Start-JS7Job etc.
• Help information for a given cmdlet is available with:
  • PS > Get-Help Get-JS7Status -detailed

Examples

Find some typical use cases for the JobScheduler CLI.

• PS > Get-JS7Status -Display
  • shows the summary information for a JS7 Controller.
• PS > (Get-JS7Workflow).count
  • shows the number of workflows that are available.
• PS > (Get-JS7AgentInstance).count
  • shows the number of Agents that are available.
• PS > $orders = (Get-JS7Order -Directory /my_orders -Recursive | Suspend-JS7Order)
  • retrieves orders from the my_orders directory and any sub-folders with orders found that will be suspended. The list of affected orders is returned.
• PS > $orders | Cancel-JS7Order
  • cancels orders based on a list that has previously been retrieved.

Manage Log Output

JobScheduler Cmdlets consider verbosity and debug settings.

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

Change Management References

JS7 Cmdlets in Detail