Get-RTimePerformance
SYNOPSIS
Gets the Realtime Performance of the specified system.
SYNTAX
NetIdPort (Default)
Get-RTimePerformance [-NetId <AmsNetId>] [-Core <Int32>] [-Count <Int32>] [-Delay <Int32>] [-Timeout <Int32>]
[-NoReset] [-ProgressAction <ActionPreference>] [<CommonParameters>]
AddressStr
Get-RTimePerformance [-Address] <String> [-Core <Int32>] [-Count <Int32>] [-Delay <Int32>] [-Timeout <Int32>]
[-NoReset] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Session
Get-RTimePerformance -Session <ISession> [-Core <Int32>] [-Count <Int32>] [-Delay <Int32>] [-Timeout <Int32>]
[-NoReset] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Gets the Realtime Performance of the specified TwinCAT Target systems.
The output can be filtered for specified Realtime CPUs and contains the actual CPU Latency and CPU Load.
This Cmdlet is preliminary and subject of change.
Performance Data is not supported before TwinCAT Build 4026.
EXAMPLES
EXAMPLE 1
PS> Get-RTimePerformance
NetId CoreId LastDelay MaxDelay DelayLimit Load (%) MaxLoad
(us) (us) (us) (%)
----- ------ ---------- ---------- ---------- -------- --------
192.168.0.2.1.1 1 0 109 0 0 80
192.168.0.2.1.1 2 0 109 0 0 80
Getting the Performance Data from all Realtime CPUs on the local target system.
EXAMPLE 2
PS> Get-RTimePerformance -core 1 -count 5 -Delay 0 -noReset
NetId CoreId LastDelay MaxDelay DelayLimit Load (%) MaxLoad
(us) (us) (us) (%)
----- ------ ---------- ---------- ---------- -------- --------
192.168.0.2.1.1 1 0 1659 0 0 80
192.168.0.2.1.1 1 0 1659 0 0 80
192.168.0.2.1.1 1 0 1659 0 0 80
192.168.0.2.1.1 1 0 1659 0 0 80
192.168.0.2.1.1 1 0 1659 0 0 80
Getting the Performance Data from the local System (Core 1) 5 times as fast as possible.
The MaxDelay will not be reset on each call.
PARAMETERS
-NetId
The AmsNetId of the target system.
Uses the Local system if empty.
Type: AmsNetId
Parameter Sets: NetIdPort
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Address
The address(es) where to get the performance data.
This can be the RouteName, NetId, the HostName or the IPAddress.
Multiple addresses and wildcards are permitted.
Type: String
Parameter Sets: AddressStr
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Session
The Session to use for the Cmdlet, must be connected to port 300, R0_IO
Type: ISession
Parameter Sets: Session
Aliases: InputObject
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Core
Specifies the ID of the Core where to determine the performance data.
If not specified, all Realtime CPUs will be returned.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False
-Count
Specifies the number of performance requests (Default is 1) per target and CPU.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False
-Delay
Delay in Milliseconds between performance requests (Default is 1000ms)
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 1000
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
-NoReset
By default, the Maximum Delay of the PerformanceData before getting new data is reset.
Switching to -NoReset remains the maximum Delay between calls.
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.