Disable-WdsInstallImage
Disable-WdsInstallImage
Disables an install image.
Syntax
Parameter Set: InstallImageName
Disable-WdsInstallImage -ImageName <String> [-AsJob] [-CimSession <CimSession[]> ] [-FileName <String> ] [-ImageGroup <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Disable-WdsInstallImage cmdlet disables an install image in the Windows Deployment Services image store. When you disable an install image, the Windows Deployment Services server no longer makes the install image available to clients. Specify the install image with 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 |
-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 disable.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.
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 disable.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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 |
<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: Disable an install image
This command disables an install image named Fabrikam Latest with LOB apps.
PS C:\> Disable-WdsInstallImage -InstallImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -FileName install-3.wim