TcXaeMgmt.psd1
|
# # Module manifest for module 'TcXaeMgmt' # # Generated by: Beckhoff # # Generated on: 7/23/2025 # @{ # Script module or binary module file associated with this manifest. RootModule = 'TcXaeMgmt.psm1' # Version number of this module. ModuleVersion = '7.0.4' # Supported PSEditions CompatiblePSEditions = 'Core', 'Desktop' # ID used to uniquely identify this module GUID = '2ff0b895-60af-486d-ab1c-781ab019ea47' # Author of this module Author = 'Beckhoff' # Company or vendor of this module CompanyName = 'Beckhoff Automation GmbH & Co. KG' # Copyright statement for this module Copyright = 'Beckhoff Automation GmbH 2025' # Description of the functionality provided by this module Description = 'Cmdlets for Twincat ADS and device management for Powershell Core and Windows Powershell' # Minimum version of the Windows PowerShell engine required by this module PowerShellVersion = '5.1' # Name of the Windows PowerShell host required by this module # PowerShellHostName = '' # Minimum version of the Windows PowerShell host required by this module # PowerShellHostVersion = '' # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # DotNetFrameworkVersion = '' # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # CLRVersion = '' # Processor architecture (None, X86, Amd64) required by this module # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module # RequiredModules = @() # Assemblies that must be loaded prior to importing this module # RequiredAssemblies = @() # Script files (.ps1) that are run in the caller's environment prior to importing this module. # ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module TypesToProcess = 'TcXaeMgmt.types.ps1xml' # Format files (.ps1xml) to be loaded when importing this module FormatsToProcess = 'TcXaeMgmt.format.ps1xml' # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. FunctionsToExport = @() # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = 'Add-AdsRoute', 'Close-TcSession', 'Copy-AdsFile', 'Get-AdsRoute', 'Get-AdsState', 'Get-TcDataType', 'Get-TcSession', 'Get-TcSymbol', 'Get-TcTargetInfo', 'Get-TcVersion', 'New-TcSession', 'Read-TcValue', 'Remove-AdsRoute', 'Set-AdsState', 'Test-AdsRoute', 'Write-TcValue', 'Get-TcLicense', 'Send-TcReadWrite', 'Register-AdsHandle', 'Unregister-AdsHandle', 'Add-MqttRoute', 'Remove-MqttRoute', 'Get-MqttRoute', 'Register-AdsNatRoute', 'Restart-AdsComputer', 'Stop-AdsComputer', 'Get-TcRouterInfo', 'Get-AmsRouterEndpoint', 'Set-AmsRouterEndpoint', 'Get-TcEvent', 'Get-IODevice', 'Get-EcMaster', 'Get-EcBoxes', 'Get-EcFrameStatistics', 'Get-IoFreeRun', 'Set-IoFreeRun', 'Reset-IoFreeRun', 'Get-RTimeLatency', 'Get-RTimePerformance', 'Get-RTimeCpuSettings', 'Set-RTimeCpuSettings', 'Start-AdsProcess', 'Set-AmsNetId', 'Restart-TwinCAT', 'Get-AmsNetId', 'Get-TcSymbolStatistics', 'Set-AdsRouteProperty', 'Get-AdsRemoteConnections', 'Get-TComObject' # Variables to export from this module VariablesToExport = '*' # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. AliasesToExport = '*' # DSC resources to export from this module # DscResourcesToExport = @() # List of all modules packaged with this module # ModuleList = @() # List of all files packaged with this module FileList = '.\about_TcXaeMgmt.help.txt', '.\License.txt', '.\TcXaeMgmt-Help.xml', '.\TcXaeMgmt.format.ps1xml', '.\TcXaeMgmt.psd1', '.\TcXaeMgmt.psm1', '.\TcXaeMgmt.types.ps1xml', '.\net6.0\EtherCAT.Description.dll', '.\net6.0\Microsoft.Extensions.Configuration.Abstractions.dll', '.\net6.0\Microsoft.Extensions.Configuration.Binder.dll', '.\net6.0\Microsoft.Extensions.Configuration.CommandLine.dll', '.\net6.0\Microsoft.Extensions.Configuration.dll', '.\net6.0\Microsoft.Extensions.Configuration.EnvironmentVariables.dll', '.\net6.0\Microsoft.Extensions.Configuration.FileExtensions.dll', '.\net6.0\Microsoft.Extensions.Configuration.Json.dll', '.\net6.0\Microsoft.Extensions.Configuration.UserSecrets.dll', '.\net6.0\Microsoft.Extensions.Configuration.Xml.dll', '.\net6.0\Microsoft.Extensions.DependencyInjection.Abstractions.dll', '.\net6.0\Microsoft.Extensions.DependencyInjection.dll', '.\net6.0\Microsoft.Extensions.FileProviders.Abstractions.dll', '.\net6.0\Microsoft.Extensions.FileProviders.Physical.dll', '.\net6.0\Microsoft.Extensions.FileSystemGlobbing.dll', '.\net6.0\Microsoft.Extensions.Hosting.Abstractions.dll', '.\net6.0\Microsoft.Extensions.Hosting.dll', '.\net6.0\Microsoft.Extensions.Logging.Abstractions.dll', '.\net6.0\Microsoft.Extensions.Logging.Configuration.dll', '.\net6.0\Microsoft.Extensions.Logging.Console.dll', '.\net6.0\Microsoft.Extensions.Logging.Debug.dll', '.\net6.0\Microsoft.Extensions.Logging.dll', '.\net6.0\Microsoft.Extensions.Logging.EventLog.dll', '.\net6.0\Microsoft.Extensions.Logging.EventSource.dll', '.\net6.0\Microsoft.Extensions.Options.ConfigurationExtensions.dll', '.\net6.0\Microsoft.Extensions.Options.dll', '.\net6.0\Microsoft.Extensions.Primitives.dll', '.\net6.0\Microsoft.Win32.SystemEvents.dll', '.\net6.0\MQTTnet.dll', '.\net6.0\MQTTnet.Extensions.ManagedClient.dll', '.\net6.0\System.CodeDom.dll', '.\net6.0\System.ComponentModel.Composition.dll', '.\net6.0\System.Configuration.ConfigurationManager.dll', '.\net6.0\System.Diagnostics.EventLog.dll', '.\net6.0\System.Drawing.Common.dll', '.\net6.0\System.Formats.Asn1.dll', '.\net6.0\System.Management.dll', '.\net6.0\System.Reactive.dll', '.\net6.0\System.Resources.Extensions.dll', '.\net6.0\System.Security.AccessControl.dll', '.\net6.0\System.Security.Cryptography.Pkcs.dll', '.\net6.0\System.Security.Cryptography.ProtectedData.dll', '.\net6.0\System.Security.Cryptography.Xml.dll', '.\net6.0\System.Security.Permissions.dll', '.\net6.0\System.ServiceProcess.ServiceController.dll', '.\net6.0\System.Text.Json.dll', '.\net6.0\System.Windows.Extensions.dll', '.\net6.0\TwinCAT.Ads.Abstractions.dll', '.\net6.0\TwinCAT.Ads.AdsOverMqtt.dll', '.\net6.0\TwinCAT.Ads.ConfigurationProviders.dll', '.\net6.0\TwinCAT.Ads.dll', '.\net6.0\TwinCAT.Ads.Reactive.dll', '.\net6.0\TwinCAT.Ads.Server.dll', '.\net6.0\TwinCAT.Core.dll', '.\net6.0\TwinCAT.Management.dll', '.\net6.0\TwinCAT.SystemService.dll', '.\net6.0\TwinCAT.Utilities.dll', '.\net6.0\de\TwinCAT.Core.resources.dll', '.\net6.0\de\TwinCAT.Utilities.resources.dll', '.\net6.0\runtimes\unix\lib\net6.0\System.Drawing.Common.dll', '.\net6.0\runtimes\win\lib\net6.0\Microsoft.Win32.SystemEvents.dll', '.\net6.0\runtimes\win\lib\net6.0\System.Diagnostics.EventLog.dll', '.\net6.0\runtimes\win\lib\net6.0\System.Diagnostics.EventLog.Messages.dll', '.\net6.0\runtimes\win\lib\net6.0\System.Drawing.Common.dll', '.\net6.0\runtimes\win\lib\net6.0\System.Management.dll', '.\net6.0\runtimes\win\lib\net6.0\System.Security.AccessControl.dll', '.\net6.0\runtimes\win\lib\net6.0\System.Security.Cryptography.Pkcs.dll', '.\net6.0\runtimes\win\lib\net6.0\System.Security.Cryptography.ProtectedData.dll', '.\net6.0\runtimes\win\lib\net6.0\System.ServiceProcess.ServiceController.dll', '.\net6.0\runtimes\win\lib\net6.0\System.Windows.Extensions.dll', '.\netstandard2.0\EtherCAT.Description.dll', '.\netstandard2.0\Microsoft.Bcl.AsyncInterfaces.dll', '.\netstandard2.0\Microsoft.CSharp.dll', '.\netstandard2.0\Microsoft.Extensions.Configuration.Abstractions.dll', '.\netstandard2.0\Microsoft.Extensions.Configuration.Binder.dll', '.\netstandard2.0\Microsoft.Extensions.Configuration.CommandLine.dll', '.\netstandard2.0\Microsoft.Extensions.Configuration.dll', '.\netstandard2.0\Microsoft.Extensions.Configuration.EnvironmentVariables.dll', '.\netstandard2.0\Microsoft.Extensions.Configuration.FileExtensions.dll', '.\netstandard2.0\Microsoft.Extensions.Configuration.Json.dll', '.\netstandard2.0\Microsoft.Extensions.Configuration.UserSecrets.dll', '.\netstandard2.0\Microsoft.Extensions.Configuration.Xml.dll', '.\netstandard2.0\Microsoft.Extensions.DependencyInjection.Abstractions.dll', '.\netstandard2.0\Microsoft.Extensions.DependencyInjection.dll', '.\netstandard2.0\Microsoft.Extensions.FileProviders.Abstractions.dll', '.\netstandard2.0\Microsoft.Extensions.FileProviders.Physical.dll', '.\netstandard2.0\Microsoft.Extensions.FileSystemGlobbing.dll', '.\netstandard2.0\Microsoft.Extensions.Hosting.Abstractions.dll', '.\netstandard2.0\Microsoft.Extensions.Hosting.dll', '.\netstandard2.0\Microsoft.Extensions.Logging.Abstractions.dll', '.\netstandard2.0\Microsoft.Extensions.Logging.Configuration.dll', '.\netstandard2.0\Microsoft.Extensions.Logging.Console.dll', '.\netstandard2.0\Microsoft.Extensions.Logging.Debug.dll', '.\netstandard2.0\Microsoft.Extensions.Logging.dll', '.\netstandard2.0\Microsoft.Extensions.Logging.EventLog.dll', '.\netstandard2.0\Microsoft.Extensions.Logging.EventSource.dll', '.\netstandard2.0\Microsoft.Extensions.Options.ConfigurationExtensions.dll', '.\netstandard2.0\Microsoft.Extensions.Options.dll', '.\netstandard2.0\Microsoft.Extensions.Primitives.dll', '.\netstandard2.0\MQTTnet.dll', '.\netstandard2.0\MQTTnet.Extensions.ManagedClient.dll', '.\netstandard2.0\System.Buffers.dll', '.\netstandard2.0\System.CodeDom.dll', '.\netstandard2.0\System.ComponentModel.Annotations.dll', '.\netstandard2.0\System.ComponentModel.Composition.dll', '.\netstandard2.0\System.Configuration.ConfigurationManager.dll', '.\netstandard2.0\System.Diagnostics.DiagnosticSource.dll', '.\netstandard2.0\System.Diagnostics.EventLog.dll', '.\netstandard2.0\System.Formats.Asn1.dll', '.\netstandard2.0\System.Management.dll', '.\netstandard2.0\System.Memory.dll', '.\netstandard2.0\System.Numerics.Vectors.dll', '.\netstandard2.0\System.Reactive.dll', '.\netstandard2.0\System.Resources.Extensions.dll', '.\netstandard2.0\System.Runtime.CompilerServices.Unsafe.dll', '.\netstandard2.0\System.Security.AccessControl.dll', '.\netstandard2.0\System.Security.Cryptography.Cng.dll', '.\netstandard2.0\System.Security.Cryptography.Pkcs.dll', '.\netstandard2.0\System.Security.Cryptography.ProtectedData.dll', '.\netstandard2.0\System.Security.Cryptography.Xml.dll', '.\netstandard2.0\System.Security.Permissions.dll', '.\netstandard2.0\System.Security.Principal.Windows.dll', '.\netstandard2.0\System.ServiceProcess.ServiceController.dll', '.\netstandard2.0\System.Text.Encoding.CodePages.dll', '.\netstandard2.0\System.Text.Encodings.Web.dll', '.\netstandard2.0\System.Text.Json.dll', '.\netstandard2.0\System.Threading.Tasks.Extensions.dll', '.\netstandard2.0\TwinCAT.Ads.Abstractions.dll', '.\netstandard2.0\TwinCAT.Ads.AdsOverMqtt.dll', '.\netstandard2.0\TwinCAT.Ads.ConfigurationProviders.dll', '.\netstandard2.0\TwinCAT.Ads.dll', '.\netstandard2.0\TwinCAT.Ads.Reactive.dll', '.\netstandard2.0\TwinCAT.Ads.Server.dll', '.\netstandard2.0\TwinCAT.Core.dll', '.\netstandard2.0\TwinCAT.Management.dll', '.\netstandard2.0\TwinCAT.SystemService.dll', '.\netstandard2.0\TwinCAT.Utilities.dll', '.\netstandard2.0\de\TwinCAT.Core.resources.dll', '.\netstandard2.0\de\TwinCAT.Utilities.resources.dll' # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. Tags = 'Powershell','Management','TcXaeMgmt','ADS','Route','Beckhoff','TwinCAT' # A URL to the license for this module. LicenseUri = 'https://github.com/Beckhoff/ADS/blob/master/LICENSE' # A URL to the main website for this project. ProjectUri = 'https://infosys.beckhoff.com/content/1033/tc3_ads_ps_tcxaemgmt/3972231819.html?id=8731138690123386389' # A URL to an icon representing this module. IconUri = 'http://nuget.beckhoff.com/image/PSTwinCATInternal.png' # ReleaseNotes of this module ReleaseNotes = '# Powershell Cmdlets for TwinCAT ADS Communication (Ads Read/Write) and TwinCAT Ads Management tasks. ## Prerequisites: >= Local winCAT XAR/XAE installation or a running .NET TcpIpRouter [Nuget Package](https://www.nuget.org/packages/Beckhoff.TwinCAT.Ads.TcpRouter) instance >= Windows Powershell 5.1 or >= Microsoft Powershell 6 Note: This version of the TcXaeMgmt Module now works also with TwinCAT Versions < 4024.10 (including TwincAT 2) locally installed. Installing a version of the 3.X Series of the TcXaeModule is not necessary anymore. ## Common Features: - Read/Write Values to Local or Remote Systems via ADS (Symbolic, Raw ProcessImage Data) - Start-Stop logical ADS Devices (PLC, SystemService) and setting Config Mode locally and remote - Collection Remote Target System Information (TwinCAT Version) - Broadcast Search (Browsing ADS Network infrastucture) - Adding / Removing ADS Routes - Session/Connection Management (ADS Sessions and connections) - Browsing symbolic information from TwinCAT Targets - many more |Version| Supported TwinCAT Versions | Description | |-------|--------------|-| | 7.X | >= TwinCAT 2 | <br>Use of .NET8 for Microsoft Powershell (>= 7.4)</br><br>Support of all TwinCAT versions</br><br>UnixSockets, Loopback channel, PInvoke and AdsOverMqtt support.</br>| | 6.2.X | >= 4024.10 | Use of .NET6 for Microsoft Powershell (>= 7.2)<br>Use of .netstandard2.0 for all below including Windows Powershell (Version 5.1)| | 6.0.X | >= 4024.10 | Uses internally .NET Standard 2.0 | | 3.X | >= TwinCAT 2 | .NET Framework 4.6.1 based | ## New Features in Version 7.X: - Use of Unix Sockets for newer TwinCAT Releases (4026) - Use of PInvoke channel for TwinCAT2 and Operating Systems that doesn''t support UnixSockets (old Windows10 Versions and below) - Uses Beckhoff.TwinCAT.Ads Version 7.X ## New Features in Version 6.2.X: - Use of Unix Sockets for newer TwinCAT Releases (4026) - Transparent use of AdsOverMqtt - Communication configuration by IConfiguration / Environmental Variables - Extended logging possibilities via ILoggerFactory/ILogger interfaces and configuration - Uses Beckhoff.TwinCAT.Ads Version 6.2 First Steps: Installation: PS> Install-Module -Name TcXaeMgmt or PS> Install-PSResource -Name TcXaeMgmt Getting global information PS> get-help about_TcXaeMgmt Getting List of commands PS> get-command -module TcXaeMgmt Getting Command Help: PS> get-help Read-TcValue -full Documentation and further learning [Documentation TcXaeMgmt Module] https://infosys.beckhoff.com/content/1033/tc3_ads_ps_tcxaemgmt/3972231819.html?id=8731138690123386389 [About the TcXaeMgmt Module] https://infosys.beckhoff.com/content/1033/tc3_ads_ps_tcxaemgmt/4130762891.html?id=4912948515382920501 ReleaseNotes: Links [Beckhoff Homepage] https://www.beckhoff.com/' # Prerelease string of this module # Prerelease = '' # Flag to indicate whether the module requires explicit user acceptance for install/update/save RequireLicenseAcceptance = $true # External dependent modules of this module # ExternalModuleDependencies = @() } # End of PSData hashtable } # End of PrivateData hashtable # HelpInfo URI of this module HelpInfoURI = 'https://infosys.beckhoff.com/content/1033/tc3_ads_ps_tcxaemgmt/9007203226972811.html?id=7774230398660908516' # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. # DefaultCommandPrefix = '' } |