Get-RTimeCpuSettings

SYNOPSIS

Getting the Cpu Settings of the TwinCAT System

SYNTAX

NetIdPort (Default)

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

AddressStr

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

Session

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

DESCRIPTION

This command lists the actually configured Relatime, Windows and Realtime cores of the TwinCAT System.

EXAMPLES

EXAMPLE 1

PS> Get-RTimeCpuSettings

NetId                Windows    NonWin     RealTime  Cpu Type  Cpu      CpuFrequency
                     Cores      Cores      Cores               Family   (GHz)
-----                ---------- ---------- ---------- -------- -------- ------------
172.17.60.167.1.1    22         2          1          0        4        3793

Getting the CPU Settings of the local system.

PARAMETERS

-NetId

The AmsNetId of the Target system.

Type: AmsNetId
Parameter Sets: NetIdPort
Aliases:

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

-Address

The target address(es) where to get the CPU Settings.

This can be the RouteName, NetId, the HostName or the IPAddress.

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

-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

-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.ISession

The Session to use for the Cmdlet, must be connected to port 300, R0_IO

OUTPUTS

NOTES