Set-WdsBootImage

Set-WdsBootImage

Modifies settings of a boot image.

语法

Parameter Set: AutoStart
Set-WdsBootImage -Architecture <Architecture> -ImageName <String> -Multicast [-AsJob] [-CimSession <CimSession[]> ] [-DisplayOrder <UInt32> ] [-FileName <String> ] [-NewDescription <String> ] [-NewImageName <String> ] [-ThrottleLimit <Int32> ] [-TransmissionName <String> ] [ <CommonParameters>]

Parameter Set: BootImageName
Set-WdsBootImage -Architecture <Architecture> -ImageName <String> [-AsJob] [-CimSession <CimSession[]> ] [-DisplayOrder <UInt32> ] [-FileName <String> ] [-NewDescription <String> ] [-NewImageName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: StopMulticastTransmission
Set-WdsBootImage -Architecture <Architecture> -ImageName <String> -StopMulticastTransmission [-AsJob] [-CimSession <CimSession[]> ] [-DisplayOrder <UInt32> ] [-FileName <String> ] [-Force] [-NewDescription <String> ] [-NewImageName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

详细说明

The Set-WdsBootImage cmdlet modifies information associated with a boot image in the Windows Deployment Services image store. You can use the cmdlet to change the name and description of the boot image, set the display order in the boot menu, and enable the boot image for multicast transmissions.

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.

参数

-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 modify the correct image. 此参数可接受的值如下:

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

别名

是否为必需?

true

位置?

named

默认值

是否接受管道输入?

True (ByPropertyName)

是否接受通配符?

false

-AsJob

别名

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-CimSession<CimSession[]>

在远程会话中或在远程计算机上运行 cmdlet。输入计算机名称或会话对象,例如 New-CimSessionGet-CimSession cmdlet 的输出。默认为本地计算机上的当前会话。

别名

Session

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-DisplayOrder<UInt32>

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.

If two boot images have the same display order, the imported images appear in alphabetical order of file name. If you do not specify this parameter, the imported images appear in the middle of the list.

别名

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

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.

别名

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

True (ByPropertyName)

是否接受通配符?

false

-Force

在不请求用户确认的情况下,强制该命令运行。

If you specify this parameter, the cmdlet disconnects any clients connected to the multicast transmission. If you do not specify this parameter, and you specified the Multicast parameter to enable an autocast transmission of the image, existing clients finish receiving the content, but no additional clients can join the multicast transmission.

别名

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-ImageName<String>

Specifies the name of an image. This is the name of the image to modify.

别名

是否为必需?

true

位置?

named

默认值

是否接受管道输入?

True (ByPropertyName)

是否接受通配符?

false

-Multicast

Indicates that the cmdlet enables an autocast transmission of the image. If you do not specify the TransmissionName parameter, Windows Deployment Services uses the image name of the imported image for the multicast.

别名

是否为必需?

true

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-NewDescription<String>

Specifies a new description.

别名

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-NewImageName<String>

Specifies a name for the image.

别名

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-StopMulticastTransmission

Indicates that the cmdlet stops 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.

别名

是否为必需?

true

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-ThrottleLimit<Int32>

指定可建立的用于运行此 cmdlet 的并发操作的最大数目。如果省略了此参数或输入了值 0,那么 Windows PowerShell® 将基于正在计算机上运行的 CIM cmdlet 的数目,计算 cmdlet 的最佳中止值。中止值仅适用于当前 cmdlet,而不适用于会话或计算机。

别名

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

-TransmissionName<String>

Specifies a name for the multicast transmission.

别名

是否为必需?

false

位置?

named

默认值

是否接受管道输入?

false

是否接受通配符?

false

<CommonParameters>

此 cmdlet 支持通用参数:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息,请参阅 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

输入

输入类型是指可通过管道传送给 cmdlet 的对象的类型。

输出

输出类型是 cmdlet 所发出对象的类型。

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsBootImage

示例

Example 1: Change boot image settings

This command changes the settings of the boot image named Fabrikam LOB setup (x86) for the x86 architecture. The command sets the display order of the boot image on the boot menu on PXE clients, and specifies a new name and description for the boot image.

PS C:\> Set-WdsBootImage -Architecture x86 -ImageName " Fabrikam LOB setup (x86)" -DisplayOrder 2 -NewImageName " Fabrikam LOB setup with re-partitioning (x86)" -NewDescription "Choose this image to re-partition the disk, and install Fabrikam LOB on computers with x86 processors."

Example 2: Start a multicast transmission of a boot image

This command starts a multicast transmission of the boot image named Fabrikam LOB setup (x86) for the x86 architecture. The command specifies that the multicast transmission is named Custom WinPE multicast.

PS C:\> Set-WdsBootImage -Architecture x86 -ImageName " Fabrikam LOB setup (x86)" -Multicast -TransmissionName "Custom WinPE multicast"

Example 3: Stop a multicast transmission of a boot image

This command stops a multicast transmission of the boot image named Fabrikam LOB setup (x86) for the x86 architecture. The Force parameter specifies that the cmdlet disconnects any clients connected to the multicast transmission.

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

相关主题

Get-WdsBootImage

Enable-WdsBootImage

Disable-WdsBootImage

Remove-WdsBootImage

Import-WdsBootImage

Export-WdsBootImage