Get-Wds Multicast Client

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

Syntax 

Get-WdsMulticastClient
   [-FileName <String>]
   [-ImageGroup <String>]
   -InstallImageName <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-WdsMulticastClient
   [-FileName <String>]
   -Architecture <BootImageArchitecture>
   -BootImageName <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-WdsMulticastClient
   -BootImageObject <CimInstance>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-WdsMulticastClient
   -InstallImageObject <CimInstance>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-WdsMulticastClient
   [-TransmissionName <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

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 file name if it is required 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 file name, if it is required 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.

Examples

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

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

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

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

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

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.

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

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

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

Example 4: Return a list of multicast clients by file name and 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

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.

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

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

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

Required Parameters

-Architecture

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.

Type: BootImageArchitecture
Parameter Sets: Unknown, X86, Ia64, X64, Arm
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-BootImageName

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

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-BootImageObject

Specifies the boot image object that has the multicast transmission to return.

Type: CimInstance
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-InstallImageName

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

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-InstallImageObject

Specifies the install image object that has the multicast transmission to return.

Type: CimInstance
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs .

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FileName

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.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ImageGroup

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 is used by default. If more than one image group exists on the server, you must specify an image group.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ThrottleLimit

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.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TransmissionName

Specifies a name for the multicast transmission.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

Outputs

Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsMulticastClient