Get-TcTargetInfo
SYNOPSIS
Get TwinCAT Device Target information.
SYNTAX
NetIdPort (Default)
Get-TcTargetInfo [[-NetId] <AmsNetId[]>] [-Timeout <Int32>] [-Force] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Route
Get-TcTargetInfo [-InputObject] <IRoute[]> [-Timeout <Int32>] [-Force] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
AddressStr
Get-TcTargetInfo [-Address] <String[]> [-Timeout <Int32>] [-Force] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Session
Get-TcTargetInfo -Session <ISession[]> [-Timeout <Int32>] [-Force] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
SessionId
Get-TcTargetInfo -SessionId <Int32[]> [-Timeout <Int32>] [-Force] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
This Cmdlet gets information from the specified target system.
To contact the target system, it must be available as actual route.
The information contains the TargetName, TwinCAT Version, Running Operating system, CPU Architecture and Image Information.
EXAMPLES
EXAMPLE 1
PS> Get-TcTargetInfo
Target Version Level OS Image Device CPUArch
------ ------- ----- -- ----- ------ -------
TC3TESTA1-CP67X 3.1.4021.54 CP Win7 IntelX86
Get the target information of th localSystem system.
EXAMPLE 2
PS> get-adsRoute | Get-TcTargetInfo
Target Version Level OS Image Device CPUArch
------ ------- ----- -- ----- ------ -------
CP-15ECA0 3.1.4021.50 CP Win7 IntelX86
TC3TESTA1-CP67X 3.1.4021.54 CP Win7 IntelX86
Get the target information of the actual connected routes.
PARAMETERS
-NetId
NetId(s) of the target system.
Type: AmsNetId[]
Parameter Sets: NetIdPort
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputObject
The route object where to get the Target information from..
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
Target names/addresses.
These can consist of RouteName, NetID, HostName or IPAddress.
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 value read.
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 value read.
Type: Int32[]
Parameter Sets: SessionId
Aliases:
Required: True
Position: Named
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
-Force
Force reading value.
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 route object where to get the Target information from..
TwinCAT.ISession[]
The Session to use for the value read.