Copy-WdsInstallImage
Copy-WdsInstallImage
Copies install images within an image group.
Syntax
Parameter Set: SingleImage
Copy-WdsInstallImage -ImageName <String> -NewFileName <String> -NewImageName <String> [-AsJob] [-CimSession <CimSession[]> ] [-FileName <String> ] [-ImageGroup <String> ] [-NewDescription <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: SingleImageAutoStart
Copy-WdsInstallImage -ImageName <String> -Multicast -NewFileName <String> -NewImageName <String> [-AsJob] [-CimSession <CimSession[]> ] [-ClientCount <UInt32> ] [-FileName <String> ] [-ImageGroup <String> ] [-NewDescription <String> ] [-StartTime <DateTime> ] [-ThrottleLimit <Int32> ] [-TransmissionName <String> ] [ <CommonParameters>]
Parameter Set: SingleImageManualStart
Copy-WdsInstallImage -ImageName <String> -ManualStart -Multicast -NewFileName <String> -NewImageName <String> [-AsJob] [-CimSession <CimSession[]> ] [-FileName <String> ] [-ImageGroup <String> ] [-NewDescription <String> ] [-ThrottleLimit <Int32> ] [-TransmissionName <String> ] [ <CommonParameters>]
Detailed Description
The Copy-WdsInstallImage cmdlet copies install images within an image group. You can only copy images that are within the same image group. To copy images between image groups, use the Export-WdsInstallImage and Import-WdsInstallImage cmdlets.
When you work with multicast transmissions that use an install image as content you can do the following:
-- Create and name an AutoCast transmission.
-- Create and name a ScheduledCast transmission which begins when a preset number of clients are ready to start, at a specific time, or both.
-- Create a ScheduledCast transmission that must be manually started.
An AutoCast transmission is a multicast transmission. When a client requests an install image, the multicast transmission begins. Clients that request the same image are joined to the multicast transmission.
A ScheduledCast transmission is a multicast transmission. When a specified number of clients request an image, or a specified time of day is reached, the multicast transmission begins. If you do not specify either of these conditions, you must manually start the transmission.
When you copy an image, specify the install image by the image name and image group name. You must specify the file name if the image name and image group name do not uniquely identify the install image.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ClientCount<UInt32>
Specifies the number of clients that must connect to a transmission. If you also specify MulticastTransmission, this parameter specifies the number of clients that must connect to the ScheduledCast transmission in order for it to begin. The StartScheduledCast parameter can start a transmission before reaching the client count. If you specify the ClientCount parameter with the StartTime parameter, the transmission begins when either a sufficient number of clients connect, or at the time specified by the StartTime parameter.
You may not use this parameter together with the ManualStart parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FileName<String>
Specifies a file name. This is the file name of the install image. Use this parameter to specify the file name for the install image if the install image name does not uniquely identify the image.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ImageGroup<String>
Specifies the name of an image group. This image group contains the image to copy. If you do not specify an image group, and only one image group exists on the server, that image group will be used by default. If more than one image group exists on the server, then you must specify an image group.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ImageName<String>
Specifies the name of an image. This is the name of the image to copy. You must provide a new image name.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ManualStart
Indicates that the transmission uses a manual start. If you also specify the MulticastTransmission parameter with this parameter, the cmdlet creates a ScheduledCast transmission that does not begin until a StartScheduledCast command is given.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Multicast
Indicates that the cmdlet enables an AutoCast transmission on the image. If you do not specify a name by using the TransmissionName parameter, the multicast transmission uses the image name.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NewDescription<String>
Specifies a new description for the install image to create in the copy operation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NewFileName<String>
Specifies a new name for the image file to create in the copy operation.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NewImageName<String>
Specifies a new name for the image to create in the copy operation.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StartTime<DateTime>
Specifies a day and time, in MM/DD/YYYY.hh:mm:ss format, that denotes the start time. When you specify the MulticastTransmission parameter, this parameter denotes the time the ScheduledCast transmission begins. The StartScheduledCast command can start a transmission before reaching the client count. If you specify both the StartTime parameter and the ClientCount parameter, the transmission begins when either a sufficient number of clients connect, or the time specified in this parameter is reached. Do not specify this parameter together with the ManualStart parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TransmissionName<String>
Specifies a name for the multicast transmission.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsInstallImage
Examples
Example 1: Copy an install image
This command copies an install image.
PS C:\> Copy-WdsInstallImage -ImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -FileName install-3.wim -NewImageName "Fabrikam Latest with LOB v2.0 apps" -NewDescription "This Fabrikam Latest image contains the second wave of our line of business applications." -NewFileName install-4.wim
Example 2: Copy an install image as a multicast transmission
PS C:\> Copy-WdsInstallImage -ImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -FileName install-3.wim -NewImageName "Fabrikam Latest with LOB v2.0 apps" -Multicast -TransmissionName "Fabrikam Latest AutoCast"
Example 3:Copy an install image as a multicast transmission with a client count and start time
PS C:\> Copy-WdsInstallImage -ImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -FileName install-3.wim -NewImageName "Fabrikam Latest with LOB v2.0 apps" -Multicast -ClientCount 50 -StartTime 2014/12/01:11:00 -TransmissionName "Fabrikam Latest ScheduledCast with automatic start"
Example 4: Copy an install image as a multicast transmission with a manual start
PS C:\> Copy-WdsInstallImage -ImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -FileName install-3.wim -NewImageName "Fabrikam Latest with LOB v2.0 apps" -Multicast -ManualStart -TransmissionName "Fabrikam Latest ScheduledCast with manual start"