PackageDeployment Module Help

Package Deployment Module (DSM eScript Commands)

Start-Program Cmdlet

Version 1.0.0.3

Start-Program

Synopsis

Execute program

Syntax

Start-Program [-Command] <String> [[-WorkingDirectory] <String>] [[-ExitCodeVariable] <String>] [-ContinueOnError] [-SecureParameters] [-Wait] [-Wow64] [[-MaxWaitMinutes] <String>] [[-Context] <String>] [<CommonParameters>]

Description

Use this command to run a DOS or Windows program. In contrast to the Execute command, the ExecuteEx command is used to execute server-sided and local programs.The result is returned to a variable and can be used as such.
The command starts the specified program; start parameters are supported. Please always include the file name extension EXE (this is important because NetInstall must be able to recognize the parameters in long file names). (Long file names may contain blanks.)
A user must have the respective permission to execute the command.

Parameters

-Command <String>

Enter the executable file (EXE) with a path. Click the Browser icon to find the executable file you want.

Required

True

Position

0

Accepts pipeline input

False

-Context <String>

User: Execution under user account; logging in HKEY_CURRENT_USER, i.e. for the user.
UserPerService: User-related command, execution with DSM Runtime Service.
Computer: Execution under user account; logging in HKEY_CURRENT_MACHINE, i.e. for the computer.
Computer: Execution with DSM Runtime Service; logging in HKEY_LOCAL_MACHINE, i.e. for the computer.

Required

False

Position

4

Accepts pipeline input

False

-ContinueOnError <SwitchParameter>

Continues script execution in spite of errors in the respective command

Required

False

Position

Named

Accepts pipeline input

False

-ExitCodeVariable <String>

#TODO#

Required

False

Position

2

Accepts pipeline input

False

-MaxWaitMinutes <String>

#TODO#

Required

False

Position

3

Accepts pipeline input

False

-SecureParameters <SwitchParameter>

The command or the variable are not written to log file. Use this option if you do not want the installation parameters or the password, for example, to be read out from the variable.

Required

False

Position

Named

Accepts pipeline input

False

-Wait <SwitchParameter>

Wait for completion of the program.

Required

False

Position

Named

Accepts pipeline input

False

-WorkingDirectory <String>

#TODO#

Required

False

Position

1

Accepts pipeline input

False

-Wow64 <SwitchParameter>

For reasons of compatibilty, Ivanti DSM maps file and registry access to the default storage location for 32 bit applications (provided that the storage location differs from that of 64-bit applications). File access: whenever a 32-bit application attempts to access %windir%\System32, the access is redirected to %windir%\SysWOW64. Registry commands: when accessing HKEY_LOCAL_MACHINE\SOFTWARE the calls are redirected to HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node. The x64-switch stops this redirection of file and registry accesses when running the script command on a x64 computer; the eScript command runs on the specified path. CallScript command: the script runs in a 64-bit process.

Required

False

Position

Named

Accepts pipeline input

False

<CommonParameters>

For more information about common parameters, type "Get-Help about_CommonParameters".