Start-ProgramAs

PackageDeployment Module Help	Package Deployment Module
Start-ProgramAs Cmdlet	Version 4.0.0.5

Start-ProgramAs

Synopsis

Execute program under other logon as

Syntax

Start-ProgramAs [-FilePath] <String> [[-Arguments] <String>] [[-OnError] <String>] [[-Context] <String>] [[-WorkingDirectory] <String>] [-ContinueOnError] [-LeastPrivilege] [-PassThru] [-SecureParameters] [-SignedExitCode] [-Wait] [-Wow64] [[-ExitCodeVariable] <String>] [[-MaxWaitMinutes] <String>] [[-WindowStyle] <String>] [[-RunAs] <String>] [[-UserName] <String>] [[-Password] <String>] [[-Logon] <String>] [<CommonParameters>]

Description

Executes an application using an account other than the currently logged on user account. This ensures, for example, that an application can be executed with more permissions than the current logon allows. In contrast to RunAs the command RunAsEx additionally allows you to specify a return value which can be processed subsequently in the eScript.

Parameters

-Arguments <String>

These parameters are transferred to the application

Required	False
Position	1
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 in Service context.
Computer: Execution under user account; logging in HKEY_CURRENT_MACHINE, i.e. for the computer.
ComputerPerService: Execution in service context; logging in HKEY_LOCAL_MACHINE, i.e. for the computer.

Required	False
Position	11
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	3
Accepts pipeline input	False

-FilePath <String>

Name of the application to be executed.

Required	True
Position	0
Accepts pipeline input	False

-LeastPrivilege <SwitchParameter>

#TODO#

Required	False
Position	Named
Accepts pipeline input	False

-Logon <String>

NoProfile: The user profile is not loaded. No changes are written into the user profile after the application has been executed.
LoadProfile: The user profile is loaded. Changes are written into the user profile.
NetworkOnly: The application is executed using the current user account. The specified user account will only be used for access to the network, i.e. a logon session is opened under the specified user account.

Required	False
Position	9
Accepts pipeline input	False

-MaxWaitMinutes <String>

The package is resumed after the amount of time entered, even if the application has not yet been terminated.
The minimum wait time is one minute (even if "0" is specified).

Required	False
Position	4
Accepts pipeline input	False

-OnError <String>

Done: Package is resumed with the next command.
Undone: Package execution is canceled. If the package was launched as a component of a Software Set or with the command CallNIProc, the calling package will also be canceled.
Failed: Package execution is canceled. If the package was launched as a component of a Software Set or with the command CallNIProc, these packages will be continued.
Failed: Package execution is canceled. The compliance status of the associated policy instance turns red.

Required	False
Position	10
Accepts pipeline input	False

-PassThru <SwitchParameter>

#TODO#

Required	False
Position	Named
Accepts pipeline input	False

-Password <String>

The password for the selected user account

Required	False
Position	8
Accepts pipeline input	False

-RunAs <String>

UserName: The application is executed using the account information entered.
LocalSystem: The application is executed using one of the configured DSM accounts. The account will be automatically determined according to the following rules:
If the option Log on for network only is selected (see below), the User Account for Depot Access will be used. If this account is not configured, the logged-in user's account is used instead.
In all other cases, the user account for the DSM Runtime Service will be used. If this account is not configured, the account is used instead under which the ServiceInstaller is running..

Required	False
Position	6
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

-SignedExitCode <SwitchParameter>

#TODO#

Required	False
Position	Named
Accepts pipeline input	False

-UserName <String>

The user account under which the application is to be executed.
Data can be input as follows: <Username> , <Domain>\<Username>

Required	False
Position	7
Accepts pipeline input	False

-Wait <SwitchParameter>

The package is only resumed when the application has been terminated.

Required	False
Position	Named
Accepts pipeline input	False

-WindowStyle <String>

Normal: The application window of the executed program is displayed (Normal mode)
Minimized: The application window of the executed program is visible only in the task bar (Minimized).
Hidden: The application window of the executed program is not visible at all (Hidden).

Required	False
Position	5
Accepts pipeline input	False

-WorkingDirectory <String>

#TODO#

Required	False
Position	2
Accepts pipeline input	False

-Wow64 <SwitchParameter>

By default, the PackageDeployment module assumes to run in a 64-bit PowerShell process on 64-bit systems, and therefore defaults to the 64-bit application location (if different from the 32-bit application location) for file and registry accesses. If you want to access the 32-bit counterparts (in the file system %WinDir%\SysWOW64 instead of %WinDir%\System32, in the registry HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node instead of HKEY_LOCAL_MACHINE\SOFTWARE), use the -Wow64 switch.

Required	False
Position	Named
Accepts pipeline input	False

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