Get-WdsMulticastClient

Windows Server 2012 R2 and Windows 8.1

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[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。


エイリアス

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>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-TransmissionName<String>

Specifies a name for the multicast transmission.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByValue, ByPropertyName)

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

  • 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"

関連トピック

コミュニティの追加

追加
表示: