Install-File

PackageDeployment Module Help	Package Deployment Module
Install-File Cmdlet	Version 4.0.0.5

Install-File

Synopsis

Install Single File

Syntax

Install-File [-File] <String> [-TargetDir] <String> [[-Replace] <String>] [-BreakLock] [-ContinueOnError] [-CreateBackup] [-Wow64] [[-Context] <String>] [<CommonParameters>]

Description

Use this command to install a single file in a target directory. This command works in the same way as the Copy command.

Parameters

-BreakLock <SwitchParameter>

Break file lock, if file is locked by the server service is used in order to update files locked by the Server Service during Windows runtime without causing a reboot. This option is valid for the selected object and can be specified in the configuration table in the General Package Properties > Server Service File Lock Settings.
Please note that by using this option, the managed computer's system may crash when server applications are active!

Required	False
Position	Named
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	3
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

-CreateBackup <SwitchParameter>

Creates backup files of all files updated by a copying process.

Required	False
Position	Named
Accepts pipeline input	False

-File <String>

The source file to be installed are specified in the form of a list. Wildcards (? *) and variables can be used.

Required	True
Position	0
Accepts pipeline input	False

-Replace <String>

Always: Files with identical names in the target directory will always be replaced.
Note: If you select the options "Always replace" or "Replace older versions only", you additionally switch to the unattended mode. In this mode, the DSM automatically checks whether the files to be installed are currently in use (and therefore cannot be installed while Windows is running). The respective files are listed; Windows is automatically restarted and the files are installed. Use the Unregister-SystemRestart command to avoid the automatic restart.
Older: This option allows you to compare file versions (of existing files). First, the Installer compares the internal versions of the files (if maintained). If the internal versions have not been maintained, the Installer compares the date and time of files having identical names. If an older file version exists it will be replaced with the newer version.
Note: If you select the options "Always replace" or "Replace older versions only", you additionally switch to the unattended mode. In this mode, the DSM automatically checks whether the files to be installed are currently in use (and therefore cannot be installed while Windows is running). The respective files are listed; Windows is automatically restarted and the files are installed. Use the Unregister-SystemRestart command to avoid the automatic restart.
Never: Files with identical names in the target directory will not be replaced.
Confirm: Files with identical names in the target directory will replaced only if the user confirms.

Required	False
Position	2
Accepts pipeline input	False

-TargetDir <String>

The specified source files are installed in the common target path. An installation in subdirectories is not possible.

Required	True
Position	1
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".