Disconnect-WdsMulticastClient
Disconnect-WdsMulticastClient
Disconnects a multicast client from a transmission or namespace.
Syntax
Parameter Set: ClientID
Disconnect-WdsMulticastClient -Id <UInt32> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Disconnect-WdsMulticastClient cmdlet disconnects a multicast client from a transmission or namespace. To obtain an ID for a multicast client, use the Get-WdsMulticastClient cmdlet. You can allow the client to restart deployment using a unicast transmission, or just disconnect the client from the Windows Deployment Services server.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Indicates that the cmdlet disconnects any clients currently connected to the multicast transmission. If you do not specify this parameter, the client will be able to restart the transmission and download the content using a unicast transmission.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Id<UInt32>
Specifies an ID. This is the ID of a multicast client to disconnect.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Disconnect a client
This command disconnects a Windows Deployment Services multicast client identified by the ID 34.
PS C:\> Disconnect-WdsMulticastClient -Id 34 -Force