TcXaeMgmt.psd1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
#
# Module manifest for module 'TcXaeMgmt'
#
# Generated by: Beckhoff
#
# Generated on: 12/3/2021
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'TcXaeMgmt.psm1'

# Version number of this module.
ModuleVersion = '5.0.164'

# 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 2021'

# 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'

# 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', '.\TwinCAT.Management.dll-Help.xml', 
               '.\net461\EtherCAT.Description.dll', 
               '.\net461\Interop.SYSSERVLib.dll', 
               '.\net461\Microsoft.Extensions.Logging.Abstractions.dll', 
               '.\net461\Microsoft.Win32.Primitives.dll', 
               '.\net461\netstandard.dll', '.\net461\System.AppContext.dll', 
               '.\net461\System.Buffers.dll', 
               '.\net461\System.Collections.Concurrent.dll', 
               '.\net461\System.Collections.dll', 
               '.\net461\System.Collections.NonGeneric.dll', 
               '.\net461\System.Collections.Specialized.dll', 
               '.\net461\System.ComponentModel.dll', 
               '.\net461\System.ComponentModel.EventBasedAsync.dll', 
               '.\net461\System.ComponentModel.Primitives.dll', 
               '.\net461\System.ComponentModel.TypeConverter.dll', 
               '.\net461\System.Configuration.ConfigurationManager.dll', 
               '.\net461\System.Console.dll', '.\net461\System.Data.Common.dll', 
               '.\net461\System.Diagnostics.Contracts.dll', 
               '.\net461\System.Diagnostics.Debug.dll', 
               '.\net461\System.Diagnostics.FileVersionInfo.dll', 
               '.\net461\System.Diagnostics.Process.dll', 
               '.\net461\System.Diagnostics.StackTrace.dll', 
               '.\net461\System.Diagnostics.TextWriterTraceListener.dll', 
               '.\net461\System.Diagnostics.Tools.dll', 
               '.\net461\System.Diagnostics.TraceSource.dll', 
               '.\net461\System.Diagnostics.Tracing.dll', 
               '.\net461\System.Drawing.Primitives.dll', 
               '.\net461\System.Dynamic.Runtime.dll', 
               '.\net461\System.Globalization.Calendars.dll', 
               '.\net461\System.Globalization.dll', 
               '.\net461\System.Globalization.Extensions.dll', 
               '.\net461\System.IO.Compression.dll', 
               '.\net461\System.IO.Compression.ZipFile.dll', 
               '.\net461\System.IO.dll', '.\net461\System.IO.FileSystem.dll', 
               '.\net461\System.IO.FileSystem.DriveInfo.dll', 
               '.\net461\System.IO.FileSystem.Primitives.dll', 
               '.\net461\System.IO.FileSystem.Watcher.dll', 
               '.\net461\System.IO.IsolatedStorage.dll', 
               '.\net461\System.IO.MemoryMappedFiles.dll', 
               '.\net461\System.IO.Pipes.dll', 
               '.\net461\System.IO.UnmanagedMemoryStream.dll', 
               '.\net461\System.Linq.dll', '.\net461\System.Linq.Expressions.dll', 
               '.\net461\System.Linq.Parallel.dll', 
               '.\net461\System.Linq.Queryable.dll', 
               '.\net461\System.Management.Automation.dll', 
               '.\net461\System.Memory.dll', '.\net461\System.Net.Http.dll', 
               '.\net461\System.Net.NameResolution.dll', 
               '.\net461\System.Net.NetworkInformation.dll', 
               '.\net461\System.Net.Ping.dll', 
               '.\net461\System.Net.Primitives.dll', 
               '.\net461\System.Net.Requests.dll', 
               '.\net461\System.Net.Security.dll', 
               '.\net461\System.Net.Sockets.dll', 
               '.\net461\System.Net.WebHeaderCollection.dll', 
               '.\net461\System.Net.WebSockets.Client.dll', 
               '.\net461\System.Net.WebSockets.dll', 
               '.\net461\System.Numerics.Vectors.dll', 
               '.\net461\System.ObjectModel.dll', '.\net461\System.Reactive.dll', 
               '.\net461\System.Reflection.dll', 
               '.\net461\System.Reflection.Extensions.dll', 
               '.\net461\System.Reflection.Primitives.dll', 
               '.\net461\System.Resources.Extensions.dll', 
               '.\net461\System.Resources.Reader.dll', 
               '.\net461\System.Resources.ResourceManager.dll', 
               '.\net461\System.Resources.Writer.dll', 
               '.\net461\System.Runtime.CompilerServices.Unsafe.dll', 
               '.\net461\System.Runtime.CompilerServices.VisualC.dll', 
               '.\net461\System.Runtime.dll', 
               '.\net461\System.Runtime.Extensions.dll', 
               '.\net461\System.Runtime.Handles.dll', 
               '.\net461\System.Runtime.InteropServices.dll', 
               '.\net461\System.Runtime.InteropServices.RuntimeInformation.dll', 
               '.\net461\System.Runtime.Numerics.dll', 
               '.\net461\System.Runtime.Serialization.Formatters.dll', 
               '.\net461\System.Runtime.Serialization.Json.dll', 
               '.\net461\System.Runtime.Serialization.Primitives.dll', 
               '.\net461\System.Runtime.Serialization.Xml.dll', 
               '.\net461\System.Security.AccessControl.dll', 
               '.\net461\System.Security.Claims.dll', 
               '.\net461\System.Security.Cryptography.Algorithms.dll', 
               '.\net461\System.Security.Cryptography.Csp.dll', 
               '.\net461\System.Security.Cryptography.Encoding.dll', 
               '.\net461\System.Security.Cryptography.Primitives.dll', 
               '.\net461\System.Security.Cryptography.X509Certificates.dll', 
               '.\net461\System.Security.Permissions.dll', 
               '.\net461\System.Security.Principal.dll', 
               '.\net461\System.Security.Principal.Windows.dll', 
               '.\net461\System.Security.SecureString.dll', 
               '.\net461\System.Text.Encoding.CodePages.dll', 
               '.\net461\System.Text.Encoding.dll', 
               '.\net461\System.Text.Encoding.Extensions.dll', 
               '.\net461\System.Text.RegularExpressions.dll', 
               '.\net461\System.Threading.dll', 
               '.\net461\System.Threading.Overlapped.dll', 
               '.\net461\System.Threading.Tasks.dll', 
               '.\net461\System.Threading.Tasks.Extensions.dll', 
               '.\net461\System.Threading.Tasks.Parallel.dll', 
               '.\net461\System.Threading.Thread.dll', 
               '.\net461\System.Threading.ThreadPool.dll', 
               '.\net461\System.Threading.Timer.dll', 
               '.\net461\System.ValueTuple.dll', 
               '.\net461\System.Xml.ReaderWriter.dll', 
               '.\net461\System.Xml.XDocument.dll', 
               '.\net461\System.Xml.XmlDocument.dll', 
               '.\net461\System.Xml.XmlSerializer.dll', 
               '.\net461\System.Xml.XPath.dll', 
               '.\net461\System.Xml.XPath.XDocument.dll', 
               '.\net461\TwinCAT.Ads.Abstractions.dll', '.\net461\TwinCAT.Ads.dll', 
               '.\net461\TwinCAT.Ads.Reactive.dll', 
               '.\net461\TwinCAT.Ads.Server.dll', '.\net461\TwinCAT.Core.dll', 
               '.\net461\TwinCAT.Management.dll', 
               '.\net461\TwinCAT.SystemService.dll', 
               '.\net461\TwinCAT.Utilities.dll', 
               '.\net461\de\TwinCAT.Core.resources.dll', 
               '.\net461\de\TwinCAT.Utilities.resources.dll', 
               '.\netcoreapp3.1\EtherCAT.Description.dll', 
               '.\netcoreapp3.1\Microsoft.Extensions.Logging.Abstractions.dll', 
               '.\netcoreapp3.1\Microsoft.Win32.Registry.dll', 
               '.\netcoreapp3.1\Microsoft.Win32.SystemEvents.dll', 
               '.\netcoreapp3.1\System.CodeDom.dll', 
               '.\netcoreapp3.1\System.ComponentModel.Composition.dll', 
               '.\netcoreapp3.1\System.Configuration.ConfigurationManager.dll', 
               '.\netcoreapp3.1\System.Drawing.Common.dll', 
               '.\netcoreapp3.1\System.Management.Automation.dll', 
               '.\netcoreapp3.1\System.Management.dll', 
               '.\netcoreapp3.1\System.Reactive.dll', 
               '.\netcoreapp3.1\System.Resources.Extensions.dll', 
               '.\netcoreapp3.1\System.Runtime.CompilerServices.Unsafe.dll', 
               '.\netcoreapp3.1\System.Security.AccessControl.dll', 
               '.\netcoreapp3.1\System.Security.Cryptography.ProtectedData.dll', 
               '.\netcoreapp3.1\System.Security.Permissions.dll', 
               '.\netcoreapp3.1\System.Security.Principal.Windows.dll', 
               '.\netcoreapp3.1\System.Text.Encoding.CodePages.dll', 
               '.\netcoreapp3.1\System.Windows.Extensions.dll', 
               '.\netcoreapp3.1\TwinCAT.Ads.Abstractions.dll', 
               '.\netcoreapp3.1\TwinCAT.Ads.dll', 
               '.\netcoreapp3.1\TwinCAT.Ads.Reactive.dll', 
               '.\netcoreapp3.1\TwinCAT.Ads.Server.dll', 
               '.\netcoreapp3.1\TwinCAT.Core.dll', 
               '.\netcoreapp3.1\TwinCAT.Management.dll', 
               '.\netcoreapp3.1\TwinCAT.SystemService.dll', 
               '.\netcoreapp3.1\TwinCAT.Utilities.dll', 
               '.\netcoreapp3.1\de\TwinCAT.Core.resources.dll', 
               '.\netcoreapp3.1\de\TwinCAT.Utilities.resources.dll', 
               '.\netcoreapp3.1\runtimes\unix\lib\netcoreapp2.1\System.Security.Principal.Windows.dll', 
               '.\netcoreapp3.1\runtimes\unix\lib\netcoreapp3.0\System.Drawing.Common.dll', 
               '.\netcoreapp3.1\runtimes\win\lib\netcoreapp2.0\System.Management.dll', 
               '.\netcoreapp3.1\runtimes\win\lib\netcoreapp2.0\System.Security.AccessControl.dll', 
               '.\netcoreapp3.1\runtimes\win\lib\netcoreapp2.0\System.Text.Encoding.CodePages.dll', 
               '.\netcoreapp3.1\runtimes\win\lib\netcoreapp2.1\System.Security.Principal.Windows.dll', 
               '.\netcoreapp3.1\runtimes\win\lib\netcoreapp3.0\Microsoft.Win32.SystemEvents.dll', 
               '.\netcoreapp3.1\runtimes\win\lib\netcoreapp3.0\System.Drawing.Common.dll', 
               '.\netcoreapp3.1\runtimes\win\lib\netcoreapp3.0\System.Windows.Extensions.dll', 
               '.\netcoreapp3.1\runtimes\win\lib\netstandard2.0\Microsoft.Win32.Registry.dll', 
               '.\netcoreapp3.1\runtimes\win\lib\netstandard2.0\System.Security.Cryptography.ProtectedData.dll', 
               '.\netstandard2.0\EtherCAT.Description.dll', 
               '.\netstandard2.0\Microsoft.CSharp.dll', 
               '.\netstandard2.0\Microsoft.Extensions.Logging.Abstractions.dll', 
               '.\netstandard2.0\System.Buffers.dll', 
               '.\netstandard2.0\System.CodeDom.dll', 
               '.\netstandard2.0\System.ComponentModel.Composition.dll', 
               '.\netstandard2.0\System.ComponentModel.dll', 
               '.\netstandard2.0\System.Configuration.ConfigurationManager.dll', 
               '.\netstandard2.0\System.Management.Automation.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.Runtime.InteropServices.WindowsRuntime.dll', 
               '.\netstandard2.0\System.Security.AccessControl.dll', 
               '.\netstandard2.0\System.Security.Cryptography.ProtectedData.dll', 
               '.\netstandard2.0\System.Security.Permissions.dll', 
               '.\netstandard2.0\System.Security.Principal.Windows.dll', 
               '.\netstandard2.0\System.Text.Encoding.CodePages.dll', 
               '.\netstandard2.0\System.Threading.Tasks.Extensions.dll', 
               '.\netstandard2.0\TwinCAT.Ads.Abstractions.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 Commandlets for TwinCAT ADS Communication and TwinCAT Ads Management tasks.
 
Prerequisites:
>= TwinCAT 3.1.4024.10 (XAR Runtime or Full) (local installation)
>= .NET Framework 4.6.1
>= Windows Powershell 5.1
>= Powershell (Core) 6.0
 
Note:
This version of the TcXaeMgmt Module only works with TwinCAT Versions >= 4024.10
locally installed. If an older TwinCAT Version is used on the system, please install
the 3.X Series of the TcXaeModule for Windows Powershell.
 
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 Management (ADS Sessions and connections)
- Browsing symbolic information from TwinCAT Targets
 
First Steps:
 
Getting global information
```powershell
PS> get-help about_TcXaeMgmt
```
 
Getting List of commands
```powershell
PS> get-command -module TcXaeMgmt
```
 
Getting Command Help:
```powershell
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:
Enh: TcXaeMgmt uses ''AmsConfiguration:LoopbackAddress'' and ''AmsConfiguration:LoopbackPort'' during module load to relocate the RouterEndpoint Address and Port (see TwinCAT.Ams.AmsConfiguration class)
Enh: New Cmdlets ''Set-AmsRouterEndpoint'' and ''Get-AmsRouterEndpoint''
Enh: Streamlining LicenseLevels to support Pending LicenseToken states, fixes #48797
Fix: Fixing error Add-AdsRoute: The CancellationTokenSource has been disposed
 
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 = ''

}