Get-TcRouterInfo
SYNOPSIS
Gets the router status information of the specified target system.
SYNTAX
NetIdPort (Default)
Get-TcRouterInfo [[-NetId] <AmsNetId[]>] [-Timeout <Int32>] [-Count <Int32>] [-Delay <Int32>]
[<CommonParameters>]
Route
Get-TcRouterInfo [-InputObject] <IRoute[]> [-Timeout <Int32>] [-Count <Int32>] [-Delay <Int32>]
[<CommonParameters>]
AddressStr
Get-TcRouterInfo [-Address] <String[]> [-Timeout <Int32>] [-Count <Int32>] [-Delay <Int32>]
[<CommonParameters>]
Session
Get-TcRouterInfo -Session <ISession[]> [-Timeout <Int32>] [-Count <Int32>] [-Delay <Int32>]
[<CommonParameters>]
SessionId
Get-TcRouterInfo -SessionId <Int32[]> [-Timeout <Int32>] [-Count <Int32>] [-Delay <Int32>]
[<CommonParameters>]
DESCRIPTION
This Cmdlet gets status information from the specified target system. To contact the target system, it must be available as actual route or must be the local system. The status information contains the amout of overall router memory and the used memory. Furthermore the number of active connections and the size of the actual router mailbox will be shown.
EXAMPLES
Example 1
PS> Get-TcRouterInfo
Target Result TotalMem(kb) AvailMem(kb) Ports Drivers Transports Mailbox Size(kb) Mailbox Queue
------ ------ ------------- ------------- ----- ------- ---------- ----------------- -------------
CX_1234 Ok 32768 32759 31 4 11 0 0
Get router information from the local system.
PARAMETERS
-NetId
NetId(s) of the target system. 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: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputObject
The route object where to get the Target information from.. 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, 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. Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The address.
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. The address.
Type: ISession[]
Parameter Sets: Session
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SessionId
Specifies the Session (with unique ID) to use for the value read. Tab completion: Completes IDs of active TwinCAT sessions (created with New-TcSession). The Session ID.
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). The ADS communication timeout in milliseconds.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 2500
Accept pipeline input: False
Accept wildcard characters: False
-Count
Specifies the number of repeats for this Cmdlet (Default is 1). Communication Timeout
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False
-Delay
The Delay in Seconds between repeated requests in Seconds (Default is 1s). A delay of 0 Seconds means as fast as possible. Delay in Seconds
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 1
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.