PS_ExecuteCommand

Description

Executes PowerShell command with Windows PowerShell
The output of the command is written to PSOut.log in gsTempDir (for computer jobs <gsWorkstationPath>Logs\Temp\PSOut.log)
If the command returns an exit code other than 0, the function fails the job
If execution policy has been set to “Restricted”, single Powershell commands can still be executed
If it is required to perform more than one command, it is recommended to insert the commands into a script and execute them with the function PS_ExecuteScript

Caution

For some commands, it may be necessary to add extra formatting to sCommand parameter. In the code block, you can see examples of these formats

Tip

PS_ExecuteCommand and PS_ExecuteScript 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_ExecuteCommand(sCommand) As Boolean

Parameters

sCommand (String)

Powershell command that should be executed

Example

• VBScript

If bStatus Then bStatus = PS_ExecuteCommand("Stop-process -processname notepad")

If bStatus Then bStatus = PS_ExecuteCommand("& {Stop-process -processname notepad}")

Scripting Guidelines

Related functions

Constants Package Property Variables