Get-TcVersion

SYNOPSIS

Get the TwinCAT Version of a target system.

SYNTAX

NetIdPort (Default)

Get-TcVersion [[-NetId] <AmsNetId[]>] [-Timeout <Int32>] [-Force] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Route

Get-TcVersion [-Timeout <Int32>] [-InputObject] <IRoute[]> [-Force] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

AddressStr

Get-TcVersion [-Timeout <Int32>] [-Address] <String[]> [-Force] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Session

Get-TcVersion [-Timeout <Int32>] -Session <ISession[]> [-Force] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

SessionId

Get-TcVersion [-Timeout <Int32>] -SessionId <Int32[]> [-Force] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

This Cmdlet gets the TwinCAT version of the specified target version and returns the version object.

EXAMPLES

EXAMPLE 1

PS> Get-TcVersion

Major  Minor  Build  Revision
-----  -----  -----  --------
3      1      4021   50

Get the TwinCAT version of the local system.

EXAMPLE 2

PS> Get-AdsRoute | Get-TcVersion

Major  Minor  Build  Revision
-----  -----  -----  --------
3      1      4021   50
3      1      4021   54

Get the TwinCAT version actual routes.

PARAMETERS

-NetId

The target address.

Type: AmsNetId[]
Parameter Sets: NetIdPort
Aliases:

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

-Timeout

The communication ADS timeout in milliseconds.

A value of 0 disables the timeout.

A value \<= 0 sets the Default (5000 ms).

Type: Int32
Parameter Sets: (All)
Aliases:

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

-InputObject

The target routes where to determine the Version information.

Type: IRoute[]
Parameter Sets: Route
Aliases: Destination, Route

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Address

Addresses where to determine the Version information.

The Addresses can consist of NetId, IPAddress or HostName.

Wildcards are permitted.

Type: String[]
Parameter Sets: AddressStr
Aliases: Name

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

-Session

The Session to use for the Cmdlet.

Type: ISession[]
Parameter Sets: Session
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SessionId

Specifies the Session (with unique ID) to use for the Cmdlet.

Type: Int32[]
Parameter Sets: SessionId
Aliases:

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

-Force

Forces reading the version.

This flag bypasses the FailFastInterceptor to retry communication in every case.

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

TwinCAT.IRoute[]

The target routes where to determine the Version information.

TwinCAT.ISession[]

The Session to use for the Cmdlet.

OUTPUTS

NOTES