Get-WdsMulticastClient

Get-WdsMulticastClient

Gets a list of clients connected to a multicast transmission or namespace.

Syntax

Parameter Set: BootImageName
Get-WdsMulticastClient -Architecture <BootImageArchitecture> -BootImageName <String> [-AsJob] [-CimSession <CimSession[]> ] [-FileName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: BootImageObject
Get-WdsMulticastClient -BootImageObject <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: InstallImageName
Get-WdsMulticastClient -InstallImageName <String> [-AsJob] [-CimSession <CimSession[]> ] [-FileName <String> ] [-ImageGroup <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: InstallImageObject
Get-WdsMulticastClient -InstallImageObject <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: MulticastTransmissionName
Get-WdsMulticastClient [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-TransmissionName <String> ] [ <CommonParameters>]

Detaillierte Beschreibung

The Get-WdsMulticastClient cmdlet gets a list of clients connected to a multicast transmission or namespace. Use this cmdlet to return a list of multicast client IDs to use with the Disconnect-WdsMulticastClient cmdlet. You can specify the transmission by any of the following:

-- The transmission name.

-- The name and architecture of the boot image, with the filename if necessary to identify the image uniquely, if the transmission is based on a boot image in the Windows Deployment Services image store.

-- The boot image object directly, if the transmission is based on a boot image in the Windows Deployment Services image store.

-- The filename, if necessary to identify the image uniquely, and, if the transmission is based on an install image in the Windows Deployment Services image store, the name and group name of the install image the transmission is based on.

-- The install image object directly, if the transmission is based on an install image in the Windows Deployment Store image store.

Parameter

-Architecture<BootImageArchitecture>

Specifies an architecture. This is the architecture of the image with the multicast transmission from which to return the client. Since it is possible to have the same image name for boot images in different architectures, you should specify the architecture to ensure the correct image is used.

-AsJob

-BootImageName<String>

Specifies the name of the boot image with the multicast transmission to return.

-BootImageObject<CimInstance>

Specifies the boot image object with the multicast transmission to return.

-CimSession<CimSession[]>

Führt das Cmdlet in einer Remotesitzung oder auf einem Remotecomputer aus. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, z. B. die Ausgabe eines Cmdlets New-CimSession oder Get-CimSession. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.

-FileName<String>

Specifies a file name. Use this parameter to specify the file name for the image if the boot image or install image name does not uniquely identify the image.

-ImageGroup<String>

Specifies the image group that contains the image from which to return the client. If you do not specify an image group, and only one image group exists on the server, that image group will be used by default. If more than one image group exists on the server, then you must specify an image group.

-InstallImageName<String>

Specifies the name of the install image with the multicast transmission to return.

-InstallImageObject<CimInstance>

Specifies the install image object with the multicast transmission to return.

-ThrottleLimit<Int32>

Gibt die maximale Anzahl von gleichzeitigen Vorgängen an, die zum Ausführen dieses Cmdlets eingerichtet werden können. Wenn dieser Parameter ausgelassen oder der Wert 0 eingegeben wird, berechnet Windows PowerShell® einen optimalen Drosselungsgrenzwert für das Cmdlet basierend auf der Anzahl der CIM-Cmdlets, die auf dem Computer ausgeführt werden. Die Drosselungsgrenze gilt nur für das aktuelle Cmdlet und nicht für die Sitzung oder den Computer.

-TransmissionName<String>

Specifies a name for the multicast transmission.

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Eingaben

Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

• Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsMulticastClient

Beispiele

Example 1: Return a list of multicast clients by boot image name

This command returns a list of multicast clients by using the boot image name.

PS C:\> Get-WdsMulticastClient -Architecture x86 -BootImageName "Fabrikam Latest setup (x86)"

Example 2: Return a list of multicast clients by boot image object

This example returns a list of multicast clients by using a boot image object.

The first command uses the Get-WdsBootImage cmdlet to obtain a boot image object, and stores the object in the variable named $BootImageObject.

The second command returns a list of client for the boot image object.

PS C:\> $BootImageObject = Get-WdsBootImage -Architecture x86 -ImageName "Fabrikam Latest setup (x86)"
PS C:\> Get-WdsMulticastClient -BootImageObject $BootImageObject

Example 3: Return a list of multicast clients by file name

This command uses the FileName parameter to identify the clients for an install image.

PS C:\> Get-WdsMulticastClient -InstallImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -FileName install-3.wim

Example 4: Return a list of multicast clients by file name and object

This example returns a list of multicast clients by using a file name to obtain an object, and then using that object to return a list of clients.

The first command uses the Get-WdsInstallImage cmdlet to obtain an object for an install image, and stores the object in the variable named $InstallImageObject.

The second command returns a list of clients for the object.

PS C:\> $InstallImageObject = Get-WdsInstallImage -ImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -FileName install-3.wim
PS C:\> Get-WdsMulticastClient -InstallImageObject $InstallImageObject

Example 5: Return a list of multicast clients by transmission name

This command returns a list of multicast clients for a transmission named Custom WinPE multicast.

PS C:\> Get-WdsMulticastClient -TransmissionName "Custom WinPE multicast"

Verwandte Themen

Disconnect-WdsMulticastClient