Get-TcSession

SYNOPSIS

List the currently established Sessions.

SYNTAX

Default (Default)

Get-TcSession [-Force] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Id

Get-TcSession -Id <Int32> [-Force] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This Cmdlet lists all actually Point-To-Point connections to TwinCAT Targets in form of their session representation.

Different types of Sessions can be accessed via the registered types of SessionProviders (e.g.

ADS, MQTT, OPC).

EXAMPLES

EXAMPLE 1

PS> Get-TcSession

Lists all actual initiated sessions.

PARAMETERS

-Id

Specifies the ID of the session to get.

Type: Int32
Parameter Sets: Id
Aliases: SessionID

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

-Force

Forces the Cmdlet to determine also the internal used sessions.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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