Disable-WdsBootImage

Disable-WdsBootImage

Disables a boot image.

Syntax

Parameter Set: BootImageName
Disable-WdsBootImage -Architecture <Architecture> -ImageName <String> [-AsJob] [-CimSession <CimSession[]> ] [-FileName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Disable-WdsBootImage cmdlet disables a boot image in the Windows Deployment Services Image Store. When you disable a boot image, Windows Deployment Services does not offer the boot image to clients that use Pre-Boot Execution Environment (PXE) to boot to the Windows Deployment Services server. You can add driver packages to a boot image while it is disabled.

Specify the boot image by using the ImageName and Architecture parameters. If the image name and architecture do not uniquely identify the image, also specify the FileName parameter.

Parameters

-Architecture<Architecture>

Specifies an architecture. This is the architecture of the boot image. Because you can use the same image name for boot images in different architectures, specify this this parameter to ensure that you disable the correct image. The acceptable values for this parameter are:

-- ARM
-- ia64
-- x64
-- x86

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-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 boot image. Use this parameter to specify the file name for the boot image if the boot 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

-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_WdsBootImage

Examples

Example 1: Disable a boot image for the x86 architecture

This command disables the boot image named Fabrikam LOB setup (x86) for the x86 architecture.

PS C:\> Disable-WdsBootImage -Architecture x86 -ImageName "Fabrikam LOB setup (x86)"

Get-WdsBootImage

Set-WdsBootImage

Enable-WdsBootImage

Remove-WdsBootImage

Import-WdsBootImage

Export-WdsBootImage