Set-RTimeCpuSettings

SYNOPSIS

Sets the Windows (Shared) CPU cores and Isolated cores for TwinCAT.

SYNTAX

NetIdPortShared (Default)

Set-RTimeCpuSettings [[-NetId] <AmsNetId>] -SharedCores <Int32> [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

NetIdPortIsolated

Set-RTimeCpuSettings [[-NetId] <AmsNetId>] -IsolatedCores <Int32> [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

NetIdPortReset

Set-RTimeCpuSettings [[-NetId] <AmsNetId>] [-Reset] [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

RouteShared

Set-RTimeCpuSettings [-InputObject] <IRoute> -SharedCores <Int32> [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

RouteIsolated

Set-RTimeCpuSettings [-InputObject] <IRoute> -IsolatedCores <Int32> [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

RouteReset

Set-RTimeCpuSettings [-InputObject] <IRoute> [-Reset] [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

AddressStrShared

Set-RTimeCpuSettings [-Address] <String> -SharedCores <Int32> [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

AddressStrIsolated

Set-RTimeCpuSettings [-Address] <String> -IsolatedCores <Int32> [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

AddressStrReset

Set-RTimeCpuSettings [-Address] <String> [-Reset] [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SessionShared

Set-RTimeCpuSettings -Session <ISession> -SharedCores <Int32> [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SessionIsolated

Set-RTimeCpuSettings -Session <ISession> -IsolatedCores <Int32> [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SessionReset

Set-RTimeCpuSettings -Session <ISession> [-Reset] [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SessionIdShared

Set-RTimeCpuSettings -SessionId <Int32> -SharedCores <Int32> [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SessionIdIsolated

Set-RTimeCpuSettings -SessionId <Int32> -IsolatedCores <Int32> [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SessionIdReset

Set-RTimeCpuSettings -SessionId <Int32> [-Reset] [-Timeout <Int32>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This Cmdlet configurates the CPU settings. A reboot is necessary after configuration.

EXAMPLES

Example 1

PS> Set-RTimeCpuSettings -SharedCores 6

Setting CPU cores
Setting WindowsCores: 6, IsolatedCores: 6 to device '172.17.62.146.1.1'?
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): y
Number of processors successfully set to '6'. A reboot is necessary to activate settings!

Sets the CPU Core Settings to 6 Shared and 6 Isolated on a 12 Core System

PARAMETERS

-NetId

NetId 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: NetIdPortShared, NetIdPortIsolated, NetIdPortReset
Aliases:

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

-InputObject

The route object where to set the CPUs. This parameter support pipelining. Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The input object.

Type: IRoute
Parameter Sets: RouteShared, RouteIsolated, RouteReset
Aliases: Destination, Route

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Address

Target names/addresses where to configure the CPU. Wildcards are permitted. Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The address.

Type: String
Parameter Sets: AddressStrShared, AddressStrIsolated, AddressStrReset
Aliases: Name

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

-Session

The Session where to configure the CPU (supports pipeline) The address.

Type: ISession
Parameter Sets: SessionShared, SessionIsolated, SessionReset
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SessionId

Specifies the Session (with unique ID) where to configure the CPU Core settings. Tab completion: Completes IDs of active TwinCAT sessions (created with New-TcSession). The Session ID.

Type: Int32
Parameter Sets: SessionIdShared, SessionIdIsolated, SessionIdReset
Aliases:

Required: True
Position: Named
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False

-SharedCores

The number of shared windows cores (Isolated cores will be: isolatedCores = allCores - sharedCores. Number of shared (windows) cores.

Type: Int32
Parameter Sets: NetIdPortShared, RouteShared, AddressStrShared, SessionShared, SessionIdShared
Aliases:

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

-IsolatedCores

Number of Isolated cores. Shared cores will be: sharedCores = allCores - isolatedCores. Number of isolated cores.

Type: Int32
Parameter Sets: NetIdPortIsolated, RouteIsolated, AddressStrIsolated, SessionIsolated, SessionIdIsolated
Aliases:

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

-Reset

Resets the number of shared cores. After reboot all Cores are dedicated to windows (shared). true if reset

Type: SwitchParameter
Parameter Sets: NetIdPortReset, RouteReset, AddressStrReset, SessionReset, SessionIdReset
Aliases:

Required: True
Position: Named
Default value: False
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: -1
Accept pipeline input: False
Accept wildcard characters: False

-Force

Forces this command. It suppresses the ShouldContinue settings and bypasses the FailFastInterceptor to retry communication in every case. Force flag.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

TwinCAT.ISession

OUTPUTS

NOTES