ReadMe_TcXaeMgmt.txt
|
3.1.1120.0
========== Fix: Enhancements in TwinCAT.Ads.dll 4.2.169.0 Further Support of Jagged arrays in SymbolLoader Versions (1 + 2) (ArgumentException in ArrayIndexConverter.TryCheckIndices fixed) Support of ArrayTypes with Size of 0 (e.g. ARRAY [-1..0] OF INT as special case for a unspecified ARRAY reference of length 0) Support of PlcOpen DataTypes also with Read/Write-Any Access Support of PlcOpen DataType LTIME. 3.1.1119.0 ========== Fix: Correction of reading / writing (Read-TcValue, Write-TcValue Cmdlets) Enum typed values Fix: Correction of reading / writing (Read-TcValue, Write-TcValue Cmdlets) PlcOpen typed values (DATE,TIME,TOD,DATETIME) Fix: SessionID parameter on Read-TcValue and Write-TcValue functional again Enh: Better Error messages on Read-TcValue and Write-TcValue when symbol not found. 3.1.1114.0 ========== Feature: Timeout parameter for Get-AdsRoute and Add-AdsRoute Feature: Broadcast search HostName over SubNetworks 3.1.1103 ======== Feature: Get-TcLicense Cmdlet 3.1.1102 ======== Enh: Better Cmdlet Error Messages on invalid parameters. 3.1.1097 ======== Enh: Force flags for Set and Read Cmdlets to bypass FailFastInterceptor 3.1.1097 ======== Fix: Finding Devices with 'Get-AdsRoute IPADDRESS -all' also behind network segments. 3.1.1091 ======== Enh: Finished first version of Cmdlet Documentation Enh: IndexGroupArgumentCompleter and AdsPortArgumentCompleter implemented. 3.1.1090 ======== Fix: Copy-AdsFile Cmdlet fixes Enh: Powershell Help for Copy-AdsFile created. 3.1.1089 ======== Enh: ArgumentCompleters for Address Parameters (Cmdlets); Enh: PSTypes and PSTypeConverters added; Feature: New Copy-AdsFile Cmdlet 3.1.1083 ======== Enh: Mdp Support for TwinCAT.Management and TcXaeMgmt Enh: Mdp Session Provider implementation 3.1.1076 ======== Enh: Add-AdsSubRoute enhancements (Parameternames, Documentation) 3.1.1075 ======== First Release Version of the TcXaeMgmt Cmdlets (TwinCAT.Management) The Contained Cmdlets are: CommandType Name Version Source ----------- ---- ------- ------ Cmdlet Add-AdsRoute 3.1.1075.0 TcXaeMgmt Cmdlet Add-AdsSubRoute 3.1.1075.0 TcXaeMgmt Cmdlet Close-TcSession 3.1.1075.0 TcXaeMgmt Cmdlet Get-AdsRoute 3.1.1075.0 TcXaeMgmt Cmdlet Get-AdsState 3.1.1075.0 TcXaeMgmt Cmdlet Get-TcDataType 3.1.1075.0 TcXaeMgmt Cmdlet Get-TcSession 3.1.1075.0 TcXaeMgmt Cmdlet Get-TcSymbol 3.1.1075.0 TcXaeMgmt Cmdlet Get-TcTargetInfo 3.1.1075.0 TcXaeMgmt Cmdlet Get-TcVersion 3.1.1075.0 TcXaeMgmt Cmdlet New-TcSession 3.1.1075.0 TcXaeMgmt Cmdlet Read-TcValue 3.1.1075.0 TcXaeMgmt Cmdlet Remove-AdsRoute 3.1.1075.0 TcXaeMgmt Cmdlet Set-AdsState 3.1.1075.0 TcXaeMgmt Cmdlet Test-AdsRoute 3.1.1075.0 TcXaeMgmt Cmdlet Write-TcValue 3.1.1075.0 TcXaeMgmt - Enh: Supporting Sessions and SessionProviders. Installation of the TwinCAT Management Console (TcXaeMgmt) ========================================================== 1. Installation Requirements: ============================== Windows 7 SP1 and newer Windows Powershell 4.0 and newer .NET Framework 4.0 and newr 2. Installation ================ 2a. Via TwinCAT 3 Setup (RECOMMENDED) ------------------------------------- Installation and Activation [Not released] Check Installed Powershell Module The TwinCAT Installation includes the setup for the Powershell TcXaeMgmt Module. It should already be existing under the folder TWINCATINSTALL]/AdsApi/Powershell/TcXaeMgmt where [TWINCATINSTALL] indicates the TwinCAT root folder (c:\TwinCAT by default). Check the Powershell Cmdlet Execution policy What is left actually to the user is to activate that module in the Powershell environment. PS> get-executionPolicy Restricted If the policy is not set to ‘Unrestricted’ or ‘RemoteSigned’, Powershell doesn’t allow to process scripts or Cmdlets. For more information please see PS> get-help about_Execution_Policies If the execution policy is restricted, it has to be set to ‘RemoteSigned’ by a Powershell console with administrative rights: PS C:\tfs> Set-ExecutionPolicy RemoteSigned Execution Policy Change The execution policy helps protect you from scripts that you do not trust. Changing the execution policy might expose you to the security risks described in the about_Execution_Policies help topic at http://go.microsoft.com/fwlink/?LinkID=135170. Do you want to change the execution policy? [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "N"): y Extend Powershell Module Search Path (PSModulePath) As next step, the Powershell Search path for Powershell Modules must be extended, so that Powershell can find the TcXaeMgmt Cmdlets in the [TWINCATINSTALL]/AdsApi/Powershell/ folder. Please check the Enviroment variable ‘PSModulePath’: PS> $env:PSModulePath D:\Users\User\Documents\WindowsPowerShell\Modules\;C:\Program Files\WindowsPowerShell\Modules;C:\Windows\system32\WindowsPowerShell\v1.0\Modules\; If the TwinCAT AdsApi path is not contained in the PSModulePath Variable, it should be set via the Windows Control Panel → System Properties → Advanced → Environment Variables Dialog. Please add [TWINCATINSTALLDIR]\AdsApi\Powershell\ e.g with C:\TwinCAT\AdsApi\Powershell to the System wide ‘PSModulePath’ Variable. After a Powershell Console restart, the new setting should be available: PS C:\tfs> $env:PSModulePath D:\Users\User\Documents\WindowsPowerShell\Modules\;C:\Program Files\WindowsPowerShell\Modules;C:\Windows\system32\WindowsPowerShell\v1.0\Modules;c:\TwinCAT\AdsApi\Powershell\ Check succeeded activation To check that the TcXaeMgmt Module can be loaded successfully and is operational: PS> get-command -module TcXaeMgmt CommandType Name ----------- ---- Cmdlet Add-AdsRoute Cmdlet Close-TcSession Cmdlet Copy-AdsFile Cmdlet Get-AdsRoute Cmdlet Get-AdsState Cmdlet Get-TcDataType Cmdlet Get-TcSession Cmdlet Get-TcSymbol Cmdlet Get-TcTargetInfo Cmdlet Get-TcVersion Cmdlet New-TcSession Cmdlet Read-TcValue Cmdlet Remove-AdsRoute Cmdlet Set-AdsState Cmdlet Test-AdsRoute Cmdlet Write-TcValue PS> get-adsstate Name State OK Time (ms) Address --------- ----- -- --------- ------- CX_000001 Run True 2 14.5.137.176.1.1 2b. Via Beckhoff internal Nuget Server (ONLY FOR INTERNAL USE) -------------------------------------------------------------- BECKHOFF-INTERNAL: From inside Beckhoff Domain, access to the Beckhoff Gallery Server is given: For Powershell 5 and later: ----------------- From Powershell Version 5(.1) and later Powershell supports PackageManagement without installing 3-rd party software. This Support is build in the "PackageManagement" Powershell Module (a.k.a 'OneGet'). see PS> get-help about_PackageManagement or https://www.red-gate.com/simple-talk/sysadmin/powershell/managing-packages-using-windows-powershell/ The most easy way is to use this Module to install the 'TcXaeMgmt' package. But before it can be used, the appropriate package Source (here the Beckhoff internal Nuget Server) and the package provider must be registered. This has to be done one time on the system: PS> register-packageSource -name PSBeckhoffInternal -location http://nuget.beckhoff.com/NuGet/api/v2/ -provider PowerShellGet -trusted Afterwards, 'Find-Package' browses for available Packages: PS> Find-Package TcXaeMgmt Name Version Source Summary ---- ------- ------ ------- TcXaeMgmt 3.1.1119 PSBeckhoffInternal Powershell Commandlets for TwinCAT ADS Communication and TwinCAT Ads Management tasks Version To Install the latest version of this package simply use 'Install-Package' PS> Install-package TcXaeMgmt To update the package with the newest version use the follwing sequence: PS> Uninstall-Package TcXaeMgmt PS> Install-Package TcXaeMgmt To check, if the installation was successfull call: PS> Get-Package TcXaeMgmt For Powershell 4: ----------------- It is recommended to use Powershell 5 because the installation process of the 'TcXaeMgmt' module will be simplified via PackageManagement (see Powershell 5 above). To update Powershell 4 to Version 5.1 please consult: https://www.microsoft.com/en-us/download/details.aspx?id=54616 (Microsoft Management Framework 5.1 download) https://docs.microsoft.com/en-us/powershell/scripting/setup/installing-windows-powershell?view=powershell-6 (Microsoft docs) Follow the next steps in case it is a necessity to remain on Powershell 4: Because the PowershellGet/OneGet functionality is not given in Powershell 4, a Helper Module is needed for Package management ('PSGet') Link: https://github.com/psget/psget/ To install this: From Administrator console do the following steps: 1. Install the PsGet Powershell package management module PS> (new-object Net.WebClient).DownloadString("http://psget.net/GetPsGet.ps1") | iex 2. Register the Beckhoff internal NuGet Server as Package source (Beckhoff internal only) PS> register-psrepository -name BeckhoffInternal -SourceLocation http://nuget.beckhoff.com/NuGet/api/v2/ -installationpolicy Trusted 3. Install the TcXaeMgmt Module PS> Install-Module TcXaeMgmt Later on, if new Versions are released the new Version can be installed via PS> Update-Module TcXaeMgmt 2c. XCopy Deployment (ONLY FOR INTERNAL USE) -------------------------------------------- If the Internal Beckhoff Nuget server is not available XCopy deployment is also possible. To enable automatic module load the following steps should be executed: 1. Find out the Module Load Path of Powershell. Within the Powershell console type PS> $env:PSModulePath This path shows the load paths for Powershell Modules e.g: C:\Users\UserName\Documents\WindowsPowerShell\Modules\;C:\Program Files\WindowsPowerShell\Modules;C:\Windows\system32\WindowsPowerShell\v1.0\modules\ A good spot for the Module will be the C:\Windows\system32\WindowsPowerShell\v1.0\modules\ folder or alternatively add a path to the $env:PSModulePath environment variable. 3. Usage of the Cmdlets ======================= The contained commandlets can be determined as follows: > get-command -module TcXaeMgmt CommandType Name Version Source ----------- ---- ------- ------ Cmdlet Add-AdsRoute 3.1.1075.0 TcXaeMgmt Cmdlet Add-AdsSubRoute 3.1.1075.0 TcXaeMgmt Cmdlet Close-TcSession 3.1.1075.0 TcXaeMgmt Cmdlet Get-AdsRoute 3.1.1075.0 TcXaeMgmt Cmdlet Get-AdsState 3.1.1075.0 TcXaeMgmt Cmdlet Get-TcDataType 3.1.1075.0 TcXaeMgmt Cmdlet Get-TcSession 3.1.1075.0 TcXaeMgmt Cmdlet Get-TcSymbol 3.1.1075.0 TcXaeMgmt Cmdlet Get-TcTargetInfo 3.1.1075.0 TcXaeMgmt Cmdlet Get-TcVersion 3.1.1075.0 TcXaeMgmt Cmdlet New-TcSession 3.1.1075.0 TcXaeMgmt Cmdlet Read-TcValue 3.1.1075.0 TcXaeMgmt Cmdlet Remove-AdsRoute 3.1.1075.0 TcXaeMgmt Cmdlet Set-AdsState 3.1.1075.0 TcXaeMgmt Cmdlet Test-AdsRoute 3.1.1075.0 TcXaeMgmt Cmdlet Write-TcValue 3.1.1075.0 TcXaeMgmt The Cmdlets are integrated into the Powershell help system. To get detailed documentation for the Cmdlets please type: > get-help [CmdletName] e.g. PS> get-help New-TcSession PS> get-help New-TcSession -detailed PS> get-help New-TcSession -full or to get just examples PS> PS> get-help New-TcSession -examples 4. Usage of the Providers (Unsupported yet) ============================================ THE ADS PROVIDER FOR POWERSHELL IS PRELIMINARY AND NOT SUPPORTED YET. The TwinCAT System Snapin adds the following Powershell Provider: * AdsSymbolProvider Naming Syntax for automatically addes Powershell Drives: [RouteName]@[AdsPort] e.g: > cd CX_0130C7@801: Known Issues: - Array Types are not correctly handled by the AdsSymbolProvider: For further information about Powershell providers please use the Powershell about topics: > get-help about_TcXaeMgmt > get-help about_providers Supported CmdLets: ================== NAME Add-AdsRoute SYNOPSIS Cmdlet for adding TwinCAT Routes. SYNTAX Add-AdsRoute [-Address] <string[]> -Credential <PSCredential> [-Destination <string>] [-DestinationCredentials <PSCredential>] [-Force <SwitchParameter>] [-HostName <SwitchParameter>] [-Temporary <SwitchParameter>] [<CommonParameters>] Add-AdsRoute [-NetId] <AmsNetId> -Credential <PSCredential> [-Destination <string>] [-DestinationCredentials <PSCredential>] [-Force <SwitchParameter>] [-HostName <SwitchParameter>] [-Temporary <SwitchParameter>] [<CommonParameters>] Add-AdsRoute [-InputObject] <RouteTargetCollection> -Credential <PSCredential> [-Destination <string>] [-DestinationCredentials <PSCredential>] [-Force <SwitchParameter>] [-HostName <SwitchParameter>] [-Temporary <SwitchParameter>] [<CommonParameters>] DESCRIPTION Adds a Route to the destination target System (Temporary or static). RELATED LINKS REMARKS To see the examples, type: "get-help Add-AdsRoute -examples". For more information, type: "get-help Add-AdsRoute -detailed". For technical information, type: "get-help Add-AdsRoute -full". NAME Add-AdsSubRoute SYNOPSIS Adds a SubRoute to a target via a Gateway system. SYNTAX Add-AdsSubRoute [-Source] <string> [-Gateway] <string> [-Target] <string> -CredGateway <PSCredential> -CredSource <PSCredential> -CredTarget <PSCredential> [<CommonParameters>] Add-AdsSubRoute [-SourceNetID] <AmsNetId> [-GatewayNetId] <AmsNetId> [-TargetNetId] <AmsNetId> -CredGateway <PSCredential> -CredSource <PSCredential> -CredTarget <PSCredential> [<CommonParameters>] Add-AdsSubRoute [-SourceRoute] <RouteTarget> [-GatewayRoute] <RouteTarget> [-TargetRoute] <RouteTarget> -CredGateway <PSCredential> -CredSource <PSCredential> -CredTarget <PSCredential> [<CommonParameters>] DESCRIPTION RELATED LINKS REMARKS To see the examples, type: "get-help Add-AdsSubRoute -examples". For more information, type: "get-help Add-AdsSubRoute -detailed". For technical information, type: "get-help Add-AdsSubRoute -full". NAME Close-TcSession SYNOPSIS Closes the specified session object. SYNTAX Close-TcSession -Id <int> [<CommonParameters>] Close-TcSession -InputObject <ISession> [<CommonParameters>] DESCRIPTION This Cmdlet closes the specified Point-To-Point Connection to the TwinCAT Target that is represented by the returned session object. All registered SessionProvider types of Sessions can be used here (e.g. ADS, MQTT, OPC). RELATED LINKS REMARKS To see the examples, type: "get-help Close-TcSession -examples". For more information, type: "get-help Close-TcSession -detailed". For technical information, type: "get-help Close-TcSession -full". NAME Get-AdsRoute SYNOPSIS List routes on a TwinCAT System / Broadcast search. SYNTAX Get-AdsRoute [[-Address] <string[]>] [-All <SwitchParameter>] [-InputObject <string>] [-StaticRoutes <SwitchParameter>] [<CommonParameters>] Get-AdsRoute -Local <SwitchParameter> [-InputObject <string>] [<CommonParameters>] DESCRIPTION This Cmdlet can list the routes configured on a TwinCAT local/remote system, or start determining all TwinCAT Systems within the current subnet. RELATED LINKS REMARKS To see the examples, type: "get-help Get-AdsRoute -examples". For more information, type: "get-help Get-AdsRoute -detailed". For technical information, type: "get-help Get-AdsRoute -full". NAME Get-AdsState SYNOPSIS Gets the Ads State of a TwinCAT Target. SYNTAX Get-AdsState [[-NetId] <AmsNetId>] [[-Port] <int>] [-Quiet <SwitchParameter>] [<CommonParameters>] Get-AdsState [[-Address] <string[]>] [[-Port] <int>] [-Quiet <SwitchParameter>] [<CommonParameters>] Get-AdsState [[-InputObject] <RouteTargetCollection>] [[-Port] <int>] [-Quiet <SwitchParameter>] [<CommonParameters>] DESCRIPTION This command let gets the ADS state of a TwinCAT target. RELATED LINKS REMARKS To see the examples, type: "get-help Get-AdsState -examples". For more information, type: "get-help Get-AdsState -detailed". For technical information, type: "get-help Get-AdsState -full". NAME Get-TcDataType SYNOPSIS Get the DataTypes from a TwinCAT target system / Device. SYNTAX Get-TcDataType [[-Name] <string[]>] -Port <int> [-NetId <AmsNetId>] [<CommonParameters>] Get-TcDataType [[-Name] <string[]>] -Port <int> -Route <RouteTarget> [<CommonParameters>] Get-TcDataType [[-Name] <string[]>] -Address <string> -Port <int> [<CommonParameters>] Get-TcDataType [[-Name] <string[]>] -InputObject <ISession> [<CommonParameters>] Get-TcDataType [[-Name] <string[]>] -SessionId <int> [<CommonParameters>] DESCRIPTION This Cmdlet get the DataTypes from a target system if symbolic information is provided by the device (Symbol Server running). The DataTypes can be determined via different Providers (e.g. ADS, MQTT, OPC, see the '-Provider' parameter.) RELATED LINKS REMARKS To see the examples, type: "get-help Get-TcDataType -examples". For more information, type: "get-help Get-TcDataType -detailed". For technical information, type: "get-help Get-TcDataType -full". NAME Get-TcSession SYNOPSIS List the currently established Sessions. SYNTAX Get-TcSession -Id <int> [<CommonParameters>] DESCRIPTION This Cmdlet lists all actually Point-To-Point connections to TwinCAT Targets in form of their session representation. Different types of Sessions can be accessed via the registered types of SessionProviders (e.g. ADS, MQTT, OPC). RELATED LINKS REMARKS To see the examples, type: "get-help Get-TcSession -examples". For more information, type: "get-help Get-TcSession -detailed". For technical information, type: "get-help Get-TcSession -full". NAME Get-TcSymbol SYNOPSIS Get the symbols from a TwinCAT target system / Device. SYNTAX Get-TcSymbol [[-Path] <string[]>] -Port <int> [-Force <SwitchParameter>] [-NetId <AmsNetId>] [-Recurse <SwitchParameter>] [<CommonParameters>] Get-TcSymbol [[-Path] <string[]>] -Port <int> -Route <RouteTarget> [-Force <SwitchParameter>] [-Recurse <SwitchParameter>] [<CommonParameters>] Get-TcSymbol [[-Path] <string[]>] -Address <string> -Port <int> [-Force <SwitchParameter>] [-Recurse <SwitchParameter>] [<CommonParameters>] Get-TcSymbol [[-Path] <string[]>] -InputObject <ISession> [-Force <SwitchParameter>] [-Recurse <SwitchParameter>] [<CommonParameters>] Get-TcSymbol [[-Path] <string[]>] -SessionId <int> [-Force <SwitchParameter>] [-Recurse <SwitchParameter>] [<CommonParameters>] DESCRIPTION This Cmdlet get the symbolic information from a target system if symbols are provided. The information can be determined via different Providers (e.g. ADS, MQTT, OPC). RELATED LINKS REMARKS To see the examples, type: "get-help Get-TcSymbol -examples". For more information, type: "get-help Get-TcSymbol -detailed". For technical information, type: "get-help Get-TcSymbol -full". NAME Get-TcTargetInfo SYNOPSIS Get TwinCAT Device Target information. SYNTAX Get-TcTargetInfo [[-NetId] <AmsNetId[]>] [<CommonParameters>] Get-TcTargetInfo [-InputObject] <RouteTargetCollection> [<CommonParameters>] Get-TcTargetInfo [-Address] <string[]> [<CommonParameters>] Get-TcTargetInfo -Session <ISession[]> [<CommonParameters>] Get-TcTargetInfo -SessionId <int[]> [<CommonParameters>] DESCRIPTION This Cmdlet gets information from the specified target system. To contact the target system, it must be available as actual route. The information contains the TargetName, TwinCAT Version, Running Operating system, CPU Architecture and Image Information. RELATED LINKS REMARKS To see the examples, type: "get-help Get-TcTargetInfo -examples". For more information, type: "get-help Get-TcTargetInfo -detailed". For technical information, type: "get-help Get-TcTargetInfo -full". NAME Get-TcVersion SYNOPSIS Get the TwinCAT Version of a target system. SYNTAX Get-TcVersion [[-NetId] <AmsNetId[]>] [<CommonParameters>] Get-TcVersion [-InputObject] <RouteTargetCollection> [<CommonParameters>] Get-TcVersion [-Address] <string[]> [<CommonParameters>] Get-TcVersion -Session <ISession[]> [<CommonParameters>] Get-TcVersion -SessionId <int[]> [<CommonParameters>] DESCRIPTION This Cmdlet gets the TwinCAT version of the specified target version and returns the version object. RELATED LINKS REMARKS To see the examples, type: "get-help Get-TcVersion -examples". For more information, type: "get-help Get-TcVersion -detailed". For technical information, type: "get-help Get-TcVersion -full". NAME New-TcSession SYNOPSIS Create a new session to a TwinCAT Target. SYNTAX New-TcSession [[-NetId] <AmsNetId>] [-Port] <int> [<CommonParameters>] New-TcSession [-InputObject] <RouteTarget> [-Port] <int> [<CommonParameters>] New-TcSession [-Address] <string> [[-Provider] <string>] [[-Port] <int>] [<CommonParameters>] DESCRIPTION Creates a new Point-To-Point Connection to a TwinCAT Target that is represented by the returned session object. Different types of Sessions can be accessed by the registered types of SessionProviders (e.g. ADS, MQTT, OPC). RELATED LINKS REMARKS To see the examples, type: "get-help New-TcSession -examples". For more information, type: "get-help New-TcSession -detailed". For technical information, type: "get-help New-TcSession -full". NAME Read-TcValue SYNOPSIS Reads values from TwinCAT devices. SYNTAX Read-TcValue [-IndexGroup] <uint> [-IndexOffset] <uint> [-Size] <int> [-Async <SwitchParameter>] [-NetId <AmsNetId[]>] [-Port <int>] [<CommonParameters>] Read-TcValue [-IndexGroup] <uint> [-IndexOffset] <uint> [-ValueType] <Type> [-Async <SwitchParameter>] [-NetId <AmsNetId[]>] [-Port <int>] [<CommonParameters>] Read-TcValue [-Path] <string> [-Async <SwitchParameter>] [-Extended <SwitchParameter>] [-NetId <AmsNetId[]>] [-Port <int>] [<CommonParameters>] Read-TcValue [-IndexGroup] <uint> [-IndexOffset] <uint> [-Size] <int> -Route <RouteTargetCollection> [-Async <SwitchParameter>] [-Port <int>] [<CommonParameters>] Read-TcValue [-IndexGroup] <uint> [-IndexOffset] <uint> [-ValueType] <Type> -Route <RouteTargetCollection> [-Async <SwitchParameter>] [-Port <int>] [<CommonParameters>] Read-TcValue [-Path] <string> -Route <RouteTargetCollection> [-Async <SwitchParameter>] [-Extended <SwitchParameter>] [-Port <int>] [<CommonParameters>] Read-TcValue [-IndexGroup] <uint> [-IndexOffset] <uint> [-Size] <int> -Address <string[]> [-Async <SwitchParameter>] [-Port <int>] [<CommonParameters>] Read-TcValue [-IndexGroup] <uint> [-IndexOffset] <uint> [-ValueType] <Type> -Address <string[]> [-Async <SwitchParameter>] [-Port <int>] [<CommonParameters>] Read-TcValue [-Path] <string> -Address <string[]> [-Async <SwitchParameter>] [-Extended <SwitchParameter>] [-Port <int>] [<CommonParameters>] Read-TcValue [-IndexGroup] <uint> [-IndexOffset] <uint> [-Size] <int> -Session <ISession[]> [-Async <SwitchParameter>] [<CommonParameters>] Read-TcValue [-IndexGroup] <uint> [-IndexOffset] <uint> [-ValueType] <Type> -Session <ISession[]> [-Async <SwitchParameter>] [<CommonParameters>] Read-TcValue [-Path] <string> -Session <ISession[]> [-Async <SwitchParameter>] [-Extended <SwitchParameter>] [<CommonParameters>] Read-TcValue [-IndexGroup] <uint> [-IndexOffset] <uint> [-Size] <int> -SessionId <int[]> [-Async <SwitchParameter>] [<CommonParameters>] Read-TcValue [-IndexGroup] <uint> [-IndexOffset] <uint> [-ValueType] <Type> -SessionId <int[]> [-Async <SwitchParameter>] [<CommonParameters>] Read-TcValue [-Path] <string> -SessionId <int[]> [-Async <SwitchParameter>] [-Extended <SwitchParameter>] [<CommonParameters>] Read-TcValue [-InputObject] <ISymbol> [-Async <SwitchParameter>] [<CommonParameters>] DESCRIPTION This Cmdlet read values from TwinCAT Devices. The devices can be accessed via different ValueProviders. RELATED LINKS REMARKS To see the examples, type: "get-help Read-TcValue -examples". For more information, type: "get-help Read-TcValue -detailed". For technical information, type: "get-help Read-TcValue -full". NAME Remove-AdsRoute SYNOPSIS Remove an ADS Route. SYNTAX Remove-AdsRoute [-Address] <string[]> [-Credentials <PSCredential>] [-Destination <RouteTarget>] [-Temporary <bool>] [<CommonParameters>] Remove-AdsRoute [-NetId] <AmsNetId> [-Credentials <PSCredential>] [-Destination <RouteTarget>] [-Temporary <bool>] [<CommonParameters>] Remove-AdsRoute [-InputObject] <RouteTargetCollection> [-Credentials <PSCredential>] [-Destination <RouteTarget>] [-Temporary <bool>] [<CommonParameters>] DESCRIPTION Removes static or temporary routes from the local system or from remote systems. If access is available, the route is removed on both endpoints of the Route. RELATED LINKS REMARKS To see the examples, type: "get-help Remove-AdsRoute -examples". For more information, type: "get-help Remove-AdsRoute -detailed". For technical information, type: "get-help Remove-AdsRoute -full". NAME Set-AdsState SYNOPSIS Set the ADS State of a TwinCAT Target. SYNTAX Set-AdsState [-State] <AdsState> {Invalid | Idle | Reset | Init | Start | Run | Stop | SaveConfig | LoadConfig | PowerFailure | PowerGood | Error | Shutdown | Suspend | Resume | Config | Reconfig | Stopping | Incompatible | Exception | Maxstates} [[-NetId] <AmsNetId>] [[-Port] <int>] [-Force <SwitchParameter>] [-Quiet <SwitchParameter>] [-Reinitialize <SwitchParameter>] [<CommonParameters>] Set-AdsState [-State] <AdsState> {Invalid | Idle | Reset | Init | Start | Run | Stop | SaveConfig | LoadConfig | PowerFailure | PowerGood | Error | Shutdown | Suspend | Resume | Config | Reconfig | Stopping | Incompatible | Exception | Maxstates} [-InputObject] <RouteTargetCollection> [-Force <SwitchParameter>] [-Quiet <SwitchParameter>] [-Reinitialize <SwitchParameter>] [<CommonParameters>] Set-AdsState [-State] <AdsState> {Invalid | Idle | Reset | Init | Start | Run | Stop | SaveConfig | LoadConfig | PowerFailure | PowerGood | Error | Shutdown | Suspend | Resume | Config | Reconfig | Stopping | Incompatible | Exception | Maxstates} [-Address] <string[]> [-Force <SwitchParameter>] [-Quiet <SwitchParameter>] [-Reinitialize <SwitchParameter>] [<CommonParameters>] DESCRIPTION This Cmdlet sets the ADS State of the specified TwinCAT Targets (E.g. Start / Stop / Config / Reconfig) RELATED LINKS REMARKS To see the examples, type: "get-help Set-AdsState -examples". For more information, type: "get-help Set-AdsState -detailed". For technical information, type: "get-help Set-AdsState -full". NAME Test-AdsRoute SYNOPSIS Test the specified route connection. SYNTAX Test-AdsRoute [-Address] <string[]> [[-Port] <int[]>] [-DefaultPorts <SwitchParameter>] [-Mode <PingStrategy> {IP | HostName | IPOrHostName | Ads}] [-Quiet <SwitchParameter>] [-TimeToLive <int>] [<CommonParameters>] Test-AdsRoute [[-NetId] <AmsNetId[]>] [[-Port] <int[]>] [-DefaultPorts <SwitchParameter>] [-Mode <PingStrategy> {IP | HostName | IPOrHostName | Ads}] [-Quiet <SwitchParameter>] [-TimeToLive <int>] [<CommonParameters>] Test-AdsRoute [-InputObject] <RouteTargetCollection> [[-Port] <int[]>] [-DefaultPorts <SwitchParameter>] [-Mode <PingStrategy> {IP | HostName | IPOrHostName | Ads}] [-Quiet <SwitchParameter>] [-TimeToLive <int>] [<CommonParameters>] DESCRIPTION This Cmdlet establishes a connection to the specified target system and tests if the connection is working. A Port scan can be executed. RELATED LINKS REMARKS To see the examples, type: "get-help Test-AdsRoute -examples". For more information, type: "get-help Test-AdsRoute -detailed". For technical information, type: "get-help Test-AdsRoute -full". NAME Write-TcValue SYNOPSIS Write values to TwinCAT devices. SYNTAX Write-TcValue [-IndexGroup] <uint> [[-Length] <int>] [-IndexOffset] <uint> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [-NetId <AmsNetId[]>] [-Offset <int>] [-Port <int>] [<CommonParameters>] Write-TcValue [-Path] <string> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [-NetId <AmsNetId[]>] [-Port <int>] [<CommonParameters>] Write-TcValue [-IndexGroup] <uint> [[-Length] <int>] [-IndexOffset] <uint> -Route <RouteTargetCollection> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [-Offset <int>] [-Port <int>] [<CommonParameters>] Write-TcValue [-Path] <string> -Route <RouteTargetCollection> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [-Port <int>] [<CommonParameters>] Write-TcValue [-IndexGroup] <uint> [[-Length] <int>] [-IndexOffset] <uint> -Address <string[]> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [-Offset <int>] [-Port <int>] [<CommonParameters>] Write-TcValue [-Path] <string> -Address <string[]> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [-Port <int>] [<CommonParameters>] Write-TcValue [-IndexGroup] <uint> [[-Length] <int>] [-IndexOffset] <uint> -Session <ISession[]> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [-Offset <int>] [<CommonParameters>] Write-TcValue [-Path] <string> -Session <ISession[]> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [<CommonParameters>] Write-TcValue [-IndexGroup] <uint> [[-Length] <int>] [-IndexOffset] <uint> -SessionId <int[]> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [-Offset <int>] [<CommonParameters>] Write-TcValue [-Path] <string> -SessionId <int[]> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [<CommonParameters>] Write-TcValue [-InputObject] <ISymbol> -Value <object> [-Async <SwitchParameter>] [-Force <SwitchParameter>] [<CommonParameters>] DESCRIPTION This Cmdlet writes values to TwinCAT Devices. The devices can be accessed via different ValueProviders. IMPORTANT: Please be aware, that writing data via IndexGroup/IndexOffset simply overwrites data in the ProcessImage and can destabilize the system. No validity check is done for the symbol alignment and therefore this should be done with highest care! If applicable writing data via symbolic information should be preferred! RELATED LINKS REMARKS To see the examples, type: "get-help Write-TcValue -examples". For more information, type: "get-help Write-TcValue -detailed". For technical information, type: "get-help Write-TcValue -full". |