Skip to content

Disconnect-PodeWebSocket

SYNOPSIS

Disconnect from a WebSocket connection.

SYNTAX

Disconnect-PodeWebSocket [[-Name] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Disconnect from a WebSocket connection. These connections can be reconnected later using Reset-PodeWebSocket

EXAMPLES

EXAMPLE 1

Disconnect-PodeWebSocket -Name 'Example'

PARAMETERS

-Name

The Name of the WebSocket connection (optional if in the scope where $WsEvent is available).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES