Share via


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