Page History

...

The following job explains how to use different output channels for PowerShell such as:

<?xml version="1.0" encoding="ISO-8859-1"?>
<job  process_class="my_Agent" stop_on_error="no">
    <settings >
        <log_level ><![CDATA[debug1]]></log_level>
    </settings>

    <script  language="powershell">
        <![CDATA[
# Use Write-Output or Echo cmdlets to write to the JobScheduler log
Write-Output "job: this is some output"
echo "job: this is some output"

# This does not work: Use of Write-Host cmdlet is not applicable
# Write-Host "job: this is some output"


# Standard PowerShell verbose setting is considered for log output:
$VerbosePreference = "continueContinue"
Write-Verbose "job: this is some verbose output"

# Standard PowerShell debug setting is considered for log output:
$DebugPreference = "continue"
# In addition the current log level of the job has to be set, e.g. log level "debug1" logs debug messages
Write-Debug "job: this is some debug output"

# creates a warning for the job
Write-Warning "job: this is a warning"

# can be used to throw an error
# Write-Error "job: this is an error"
        ]]>

    </script>

    <run_time />
</job>

...

JobScheduler PowerShell CLI for

...

Jobs

...

Info
The feature is only available in case your Agent is running on a machine with PowerShell available For more information about how to install and to use the PowerShell CLI module for an Agent see PowerShell Command Line Interface - Introduction

 

The JobScheduler PowerShell CLI is available for PowerShell jobsThe integration of the PowerShell CLI into PowerShell jobs is available as well. A basic job using the PowerShell CLI might look like this:

info

Code Block
<job<?xml version="1.0" encoding="ISO-8859-1"?> <job process_class="my_Agent"> <script language="powershell"> <![CDATA[ Import-Module JobScheduler show-status   # display summary information Show-Status   # retrieve the number of available job chains ( Get-JobChain ).count ]]> </script> <run_time /> </job>

Explanations

• The

...

• PowerShell CLI is activated by the Import-Module JobScheduler command.
• For a complete list of cmdlets available from the PowerShell CLI see PowerShell CLI - Cmdlets

...

Anchor
powershell-as-a-shell powershell-as-a-shell

Compatibility between PowerShell and Shell

As mentioned before, PowerShell Jobs should be seen PowerShell jobs can be considered as a migration path for shell jobs. That means, This suggests that every shell job should can possibly be converted (with a few changes) to a PowerShell job. 

...

Returning a parameter and its value to an Order

Setting a parameter in for an order (for instance parameter name1 with the initial value value1) and modifying the value to value2 and returning the parameter to the order so that the next job chain node uses the new value. For PowerShell this works using the API methods for method available from $spooler_task.order():

# Example Shell: 
echo name1 = value2 >> %SCHEDULER_RETURN_VALUES%

# Example PowerShell: 
$spooler_task.order().params().set_value( "name1", "value2" )

...

References

Reference Documentation

...