Get-WdsMulticastClient
Get-WdsMulticastClient
Gets a list of clients connected to a multicast transmission or namespace.
语法
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>]
详细说明
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.
参数
-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.
别名 |
无 |
是否为必需？ |
true |
位置？ |
named |
默认值 |
无 |
是否接受管道输入？ |
True (ByValue, ByPropertyName) |
是否接受通配符？ |
false |
-AsJob
别名 |
无 |
是否为必需？ |
false |
位置？ |
named |
默认值 |
无 |
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-BootImageName<String>
Specifies the name of the boot image with the multicast transmission to return.
别名 |
无 |
是否为必需？ |
true |
位置？ |
named |
默认值 |
无 |
是否接受管道输入？ |
True (ByValue, ByPropertyName) |
是否接受通配符？ |
false |
-BootImageObject<CimInstance>
Specifies the boot image object with the multicast transmission to return.
别名 |
无 |
是否为必需？ |
true |
位置？ |
named |
默认值 |
无 |
是否接受管道输入？ |
True (ByValue, ByPropertyName) |
是否接受通配符？ |
false |
-CimSession<CimSession[]>
在远程会话中或在远程计算机上运行 cmdlet。输入计算机名称或会话对象，例如 New-CimSession 或 Get-CimSession cmdlet 的输出。默认为本地计算机上的当前会话。
别名 |
Session |
是否为必需？ |
false |
位置？ |
named |
默认值 |
无 |
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-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.
别名 |
无 |
是否为必需？ |
false |
位置？ |
named |
默认值 |
无 |
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-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.
别名 |
无 |
是否为必需？ |
false |
位置？ |
named |
默认值 |
无 |
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-InstallImageName<String>
Specifies the name of the install image with the multicast transmission to return.
别名 |
无 |
是否为必需？ |
true |
位置？ |
named |
默认值 |
无 |
是否接受管道输入？ |
True (ByValue, ByPropertyName) |
是否接受通配符？ |
false |
-InstallImageObject<CimInstance>
Specifies the install image object with the multicast transmission to return.
别名 |
无 |
是否为必需？ |
true |
位置？ |
named |
默认值 |
无 |
是否接受管道输入？ |
True (ByValue, ByPropertyName) |
是否接受通配符？ |
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 |
默认值 |
无 |
是否接受管道输入？ |
True (ByValue, ByPropertyName) |
是否接受通配符？ |
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_WdsMulticastClient
示例
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"