Disconnect-WdsMulticastClient

  • Reference
Module:
WDS

Disconnects a multicast client from a transmission or namespace.

Syntax

Disconnect-WdsMulticastClient
          -Id <UInt32>
          [-Force]
          [-CimSession <CimSession[]>]
          [-ThrottleLimit <Int32>]
          [-AsJob]
          [<CommonParameters>]

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.

Examples

Example 1: Disconnect a client

PS C:\> Disconnect-WdsMulticastClient -Id 34 -Force

This command disconnects a Windows Deployment Services multicast client identified by the ID 34.

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
Required:False
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
Required:False
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Specifies an ID. This is the ID of a multicast client to disconnect.

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