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"