PS_ExecuteScript

Description

Executes a PowerShell script with Windows PowerShell
The output of the script is written to PSOut.log in gsTempDir (for computer jobs <gsWorkstationPath>Logs\Temp\PSOut.log)
If the script returns an exit code other than 0, the function fails the job

Tip

PS_ExecuteScript and PS_ExecuteCommand both write their output to the same PSOut.log file in gsTempDir, so each run overwrites the previous one. If you need to keep a history of the output, create a folder such as <gsWorkstationPath>\Logs\PowerShell and copy PSOut.log there under a more descriptive name after each run. Alternatively, consider building the logic as a PowerPack instead, which can handle logging on its own.

Syntax

PS_ExecuteScript(sScript, sScriptArguments, bSigned, bRunUnrestricted) As Boolean

Parameters

sScript (String)

Full path to and name of Powershell script that should be executed

sScriptArguments (String)

Script arguments

bSigned (Boolean)

Is the script signed. Set it to TRUE if the script is signed and the execution policy is AllSigned.

bRunUnrestricted (Boolean)

Should the script be executed even though the execution policy prevents it. If TRUE, the script runs with -ExecutionPolicy Unrestricted.

If the execution policy is AllSigned and both bSigned and bRunUnrestricted are FALSE, the script isn’t run and the function fails the job.

Return value

Boolean, TRUE if the script ran and returned exit code 0.

Example

• VBScript

If bStatus Then bStatus = PS_ExecuteScript(gsPackageRoot & "\Kit\CapaInstaller.ps1", "", False, True)

Scripting Guidelines

Related functions

Constants Package Property Variables