Set-WdsBootImage
Set-WdsBootImage
Modifies settings of a boot image.
Sintaxe
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>]
Descrição detalhada
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.
Parâmetros
-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. Os valores aceitáveis para este parâmetro são:
-- ARM
-- ia64
-- x64
-- x86
Aliases |
nenhuma |
Necessário? |
true |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
True (ByPropertyName) |
Aceitar caracteres curinga? |
false |
-AsJob
Aliases |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-CimSession<CimSession[]>
Executa o cmdlet em uma sessão remota ou em um computador remoto. Insira um nome do computador ou um objeto de sessão, como a saída de um cmdlet New-CimSession ou Get-CimSession. O padrão é a sessão atual do computador local.
Aliases |
Session |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
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.
Aliases |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
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 |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
True (ByPropertyName) |
Aceitar caracteres curinga? |
false |
-Force
Força o comando a ser executado sem solicitar a confirmação do usuário.
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.
Aliases |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-ImageName<String>
Specifies the name of an image. This is the name of the image to modify.
Aliases |
nenhuma |
Necessário? |
true |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
True (ByPropertyName) |
Aceitar caracteres curinga? |
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.
Aliases |
nenhuma |
Necessário? |
true |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-NewDescription<String>
Specifies a new description.
Aliases |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-NewImageName<String>
Specifies a name for the image.
Aliases |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
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.
Aliases |
nenhuma |
Necessário? |
true |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-ThrottleLimit<Int32>
Especifica o número máximo de operações simultâneas que podem ser estabelecidas para executar o cmdlet. Se esse parâmetro for omitido ou um valor de 0 for inserido, o Windows PowerShell® calculará o limite ideal de restrição para o cmdlet com base no número de cmdlets do CIM que estão em execução no computador. O limite de restrição se aplica somente ao cmdlet atual, e não à sessão ou ao computador.
Aliases |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-TransmissionName<String>
Specifies a name for the multicast transmission.
Aliases |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet dá suporte a parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entradas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet.
Saídas
O tipo de saída é o tipo de objeto emitido pelo cmdlet.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsBootImage
Exemplos
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