COMMAND EVERYTHING.
Modifies the properties of an install image.
Microsoft WDS reference: Modifies the properties of an install image. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Set-WdsInstallImage. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Windows / WDS · Windows Server 2025 documentation; feature/module prerequisites apply
-AsJob- Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.
-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.
-ClientCount- Specifies the number of clients that must connect to a transmission. If you also specify the *MulticastTransmission* parameter, the client count specifies the number of clients that must connect to the ScheduledCast transmission for it to begin. Use the *StartScheduledCast* parameter to begin a transmission before reaching the client count. If you specify the *ClientCount* parameter and the *StartTime* parameter, the transmission starts when either a sufficient number of clients have connected or at the time specified by the *StartTime* parameter. You may not specify this parameter together with the *ManualStart* parameter.
-DisplayOrder- Specifies the order in which images appear in the boot menu on Pre-Boot Execution Environment (PXE) clients. The menu lists the boot images in ascending order, smallest number to largest number.
-FileName- 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.
-Force- Indicates that the cmdlet disconnects any clients currently connected to the multicast transmission. If you do not specify this parameter for an AutoCast transmission, existing clients finish receiving the content, but no new clients join.
-ImageGroup- Specifies the name of an image group. This image group contains the image to modify. If you do not specify an image group, and only one image group exists on the server, the cmdlet uses that image group by default. If more than one image group exists on the server, you must specify the image group.
-ImageName (required)- Specifies the name of an image. This is the name of the image to modify.
-ManualStart (required)- Indicates that the transmission uses a manual start. If you also specify the *MulticastTransmission* parameter, the cmdlet creates a ScheduledCast transmission that does not begin until a StartScheduledCast command is given.
-Multicast (required)- 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
-NewDescription- Specifies a new description for the install image to create in the set operation.
-NewImageName- Specifies a new name for the image file to create in the set operation.
-OverwriteUnattend- Indicates that the cmdlet can overwrite an existing answer file. If you specify the UnattendFile parameter, the cmdlet overwrites an existing answer file associated with the image.
-StartScheduledCast (required)- Indicates that the cmdlet enables and starts a ScheduledCast transmission on the image. If there are no clients connected to the transmission, the transmission does not start.
-StartTime- Specifies a day and time, in MM/DD/YYYY.hh:mm:ss format, that denotes the start time. If you specify the *MulticastTransmission* parameter, this parameter denotes the time the ScheduledCast transmission starts. 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 starts 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.
-StopMulticastTransmission (required)- Indicates that Windows Deployment Services stop the multicast transmission of the image. If you specify the *Force* parameter, the cmdlet disconnects any clients connected to the multicast transmission. If you do not specify the *Force* parameter, and the transmission is autocast, current clients finish receiving the content, but no additional clients can join the transmission.
-ThrottleLimit- 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.
-TransmissionName- Specifies a name for the multicast transmission.
-UnattendFile- Specifies the full path for the answer file associated with the image.
-UserFilter- Specifies the access controls on the image, in Security Descriptor Definition Language (SDDL) format. To restrict access to the file resources, and access to all images in an image group, set access controls on the image group itself.
Windows with the WDS module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.