Get-TcSymbolStatistics
SYNOPSIS
Get the Symbol statistics from a TwinCAT target system / Device.
SYNTAX
NetIdPort (Default)
Get-TcSymbolStatistics [-NetId <AmsNetId>] [-Port <Int32>] [-Force] [-Reset]
[<CommonParameters>]
Route
Get-TcSymbolStatistics -Route <IRoute> [-Port <Int32>] [-Force] [-Reset]
[<CommonParameters>]
AddressStr
Get-TcSymbolStatistics -Address <String> [-Port <Int32>] [-Force] [-Reset]
[<CommonParameters>]
Session
Get-TcSymbolStatistics -Session <ISession> [-Force] [-Reset]
[<CommonParameters>]
SessionId
Get-TcSymbolStatistics -SessionId <Int32> [-Force] [-Reset]
[<CommonParameters>]
DESCRIPTION
This Cmdlet gets the Symbol statistics from a target system if symbolic information is provided by the device (Symbol Server available). The Statistic information include information about the amount of available Symbols and Datatypes, how they are configured and the actual caching information.
PARAMETERS
-NetId
The NetID address of the target system where get the statistic information. Tab completion: Completes AmsNetId values from currently reachable routes on the local TwinCAT system. The net id.
Type: AmsNetId
Parameter Sets: NetIdPort
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Route
The Route target where the the statistic information to load (RouteTarget.Local by default). Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The input object.
Type: IRoute
Parameter Sets: Route
Aliases: Destination
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Address
The address where to load the statistic information. This can be the RouteName, NetId, the HostName or the IPAddress. Wildcards are permitted. Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The address.
Type: String
Parameter Sets: AddressStr
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Port
The Port where to load the datatype descriptions (Default Port 851) Tab completion: Completes well-known ADS port numbers and names (e.g., 851/Plc1, 10000/SystemService). The port.
Type: Int32
Parameter Sets: NetIdPort, Route, AddressStr
Aliases:
Required: False
Position: Named
Default value: 851
Accept pipeline input: False
Accept wildcard characters: False
-Session
The session object to use for the statistic information upload. The port.
Type: ISession
Parameter Sets: Session
Aliases: InputObject
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-SessionId
The unique session Identifier that represents the session to use for statistic information upload. Tab completion: Completes IDs of active TwinCAT sessions (created with New-TcSession). The port.
Type: Int32
Parameter Sets: SessionId
Aliases: Id
Required: True
Position: Named
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False
-Force
Forces to load the statistic information. The force switch
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Reset
Resets and reloads all cached symbolic information. The force switch
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.